art.cllctv.block.text

cllctv.art

Documentation

main object

No description available.

Properties

direction string Optional

No description available.

Known values: ltr, rtl
facets array of ref#facet Optional

Facets for text formatting and features

format string Optional

No description available.

Known values: left, start, center, right, end, justify
indent integer Optional

No description available.

minimum: 0
text string Required

The plain text content

View raw schema
{
  "type": "object",
  "required": [
    "text"
  ],
  "properties": {
    "text": {
      "type": "string",
      "description": "The plain text content"
    },
    "facets": {
      "type": "array",
      "items": {
        "ref": "#facet",
        "type": "ref"
      },
      "description": "Facets for text formatting and features"
    },
    "format": {
      "type": "string",
      "knownValues": [
        "left",
        "start",
        "center",
        "right",
        "end",
        "justify"
      ]
    },
    "indent": {
      "type": "integer",
      "minimum": 0
    },
    "direction": {
      "type": "string",
      "knownValues": [
        "ltr",
        "rtl"
      ]
    }
  }
}
bold object

Facet feature for bold text

This object has no properties defined.

View raw schema
{
  "type": "object",
  "properties": {},
  "description": "Facet feature for bold text"
}
byteSlice object

Specifies the sub-string range a facet feature applies to. Start index is inclusive, end index is exclusive. Indices are zero-indexed, counting bytes of the UTF-8 encoded text.

Properties

byteEnd integer Required

No description available.

minimum: 0
byteStart integer Required

No description available.

minimum: 0
View raw schema
{
  "type": "object",
  "required": [
    "byteStart",
    "byteEnd"
  ],
  "properties": {
    "byteEnd": {
      "type": "integer",
      "minimum": 0
    },
    "byteStart": {
      "type": "integer",
      "minimum": 0
    }
  },
  "description": "Specifies the sub-string range a facet feature applies to. Start index is inclusive, end index is exclusive. Indices are zero-indexed, counting bytes of the UTF-8 encoded text."
}
capitalize object

Facet feature for capitalize markup

This object has no properties defined.

View raw schema
{
  "type": "object",
  "properties": {},
  "description": "Facet feature for capitalize markup"
}
facet object

No description available.

Properties

index ref #byteSlice Required

No description available.

View raw schema
{
  "type": "object",
  "required": [
    "index",
    "features"
  ],
  "properties": {
    "index": {
      "ref": "#byteSlice",
      "type": "ref"
    },
    "features": {
      "type": "array",
      "items": {
        "refs": [
          "#mention",
          "#link",
          "#tag",
          "#bold",
          "#italic",
          "#strikethrough",
          "#underline",
          "#subscript",
          "#superscript",
          "#highlight",
          "#lowercase",
          "#uppercase",
          "#capitalize",
          "#lineBreak"
        ],
        "type": "union"
      }
    }
  }
}
highlight object

Facet feature for highlighted text

This object has no properties defined.

View raw schema
{
  "type": "object",
  "properties": {},
  "description": "Facet feature for highlighted text"
}
italic object

Facet feature for italic text

This object has no properties defined.

View raw schema
{
  "type": "object",
  "properties": {},
  "description": "Facet feature for italic text"
}
lineBreak object

No description available.

This object has no properties defined.

View raw schema
{
  "type": "object",
  "properties": {}
}
link object

Facet feature for a URL. The text URL may have been simplified or truncated, but the facet reference should be a complete URL.

Properties

uri string uri Required

A valid URI.

View raw schema
{
  "type": "object",
  "required": [
    "uri"
  ],
  "properties": {
    "uri": {
      "type": "string",
      "format": "uri"
    }
  },
  "description": "Facet feature for a URL. The text URL may have been simplified or truncated, but the facet reference should be a complete URL."
}
lowercase object

Facet feature for lowercase markup

This object has no properties defined.

View raw schema
{
  "type": "object",
  "properties": {},
  "description": "Facet feature for lowercase markup"
}
mention object

Facet feature for mention of another account. The text is usually a handle, including a '@' prefix, but the facet reference is a DID.

Properties

did string did Required

A decentralized identifier (DID).

View raw schema
{
  "type": "object",
  "required": [
    "did"
  ],
  "properties": {
    "did": {
      "type": "string",
      "format": "did"
    }
  },
  "description": "Facet feature for mention of another account. The text is usually a handle, including a '@' prefix, but the facet reference is a DID."
}
strikethrough object

Facet feature for strikethrough markup

This object has no properties defined.

View raw schema
{
  "type": "object",
  "properties": {},
  "description": "Facet feature for strikethrough markup"
}
subscript object

Facet feature for subscript markup

This object has no properties defined.

View raw schema
{
  "type": "object",
  "properties": {},
  "description": "Facet feature for subscript markup"
}
superscript object

Facet feature for superscript markup

This object has no properties defined.

View raw schema
{
  "type": "object",
  "properties": {},
  "description": "Facet feature for superscript markup"
}
tag object

Facet feature for a hashtag. The text usually includes a '#' prefix, but the facet reference should not (except in the case of 'double hash tags').

Properties

tag string Required

No description available.

maxLength: 640 bytesmaxGraphemes: 64 graphemes
View raw schema
{
  "type": "object",
  "required": [
    "tag"
  ],
  "properties": {
    "tag": {
      "type": "string",
      "maxLength": 640,
      "maxGraphemes": 64
    }
  },
  "description": "Facet feature for a hashtag. The text usually includes a '#' prefix, but the facet reference should not (except in the case of 'double hash tags')."
}
underline object

Facet feature for underline markup

This object has no properties defined.

View raw schema
{
  "type": "object",
  "properties": {},
  "description": "Facet feature for underline markup"
}
uppercase object

Facet feature for uppercase markup

This object has no properties defined.

View raw schema
{
  "type": "object",
  "properties": {},
  "description": "Facet feature for uppercase markup"
}

Lexicon Garden

@