games.gamesgamesgamesgames.richtext.facet

lexicon.store View official

Documentation

Annotation of a sub-string within rich text.

main object

Annotation of a sub-string within rich text.

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",
          "#heading",
          "#listItem",
          "#image",
          "#video"
        ],
        "type": "union"
      }
    }
  },
  "description": "Annotation of a sub-string within rich text."
}
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."
}
heading object

Facet feature for a section heading.

Properties

level integer Required

No description available.

minimum: 1maximum: 6
View raw schema
{
  "type": "object",
  "required": [
    "level"
  ],
  "properties": {
    "level": {
      "type": "integer",
      "maximum": 6,
      "minimum": 1
    }
  },
  "description": "Facet feature for a section heading."
}
image object

Facet feature for an inline image.

Properties

alt string Optional

No description available.

blob blob Required

No description available.

maxSize: 10.0 MB
height integer Optional

No description available.

width integer Optional

No description available.

View raw schema
{
  "type": "object",
  "required": [
    "blob"
  ],
  "properties": {
    "alt": {
      "type": "string"
    },
    "blob": {
      "type": "blob",
      "accept": [
        "image/*"
      ],
      "maxSize": 10000000
    },
    "width": {
      "type": "integer"
    },
    "height": {
      "type": "integer"
    }
  },
  "description": "Facet feature for an inline image."
}
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."
}
link object

Facet feature for a 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."
}
listItem object

Facet feature marking text as a list item.

Properties

depth integer Optional

No description available.

minimum: 0
ordered boolean Optional

No description available.

View raw schema
{
  "type": "object",
  "properties": {
    "depth": {
      "type": "integer",
      "default": 0,
      "minimum": 0
    },
    "ordered": {
      "type": "boolean"
    }
  },
  "description": "Facet feature marking text as a list item."
}
mention object

Facet feature for mention of another account.

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."
}
tag object

Facet feature for a hashtag.

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."
}
video object

Facet feature for an inline video.

Properties

alt string Optional

No description available.

blob blob Optional

No description available.

maxSize: 200.0 MB
uri string uri Optional

A valid URI.

View raw schema
{
  "type": "object",
  "properties": {
    "alt": {
      "type": "string"
    },
    "uri": {
      "type": "string",
      "format": "uri"
    },
    "blob": {
      "type": "blob",
      "accept": [
        "video/*"
      ],
      "maxSize": 200000000
    }
  },
  "description": "Facet feature for an inline video."
}

Lexicon Garden

@