app.atmobb.richtext.facet

lexicons.atmobb.app

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": [
          "#bold",
          "#italic",
          "#underline",
          "#strikethrough",
          "#code",
          "#spoiler",
          "#link",
          "#mention",
          "#tag"
        ],
        "type": "union"
      }
    }
  },
  "description": "Annotation of a sub-string within rich text."
}
bold object

Bold text.

This object has no properties defined.

View raw schema
{
  "type": "object",
  "properties": {},
  "description": "Bold text."
}
byteSlice object

Sub-string range as byte offsets into the UTF-8 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": "Sub-string range as byte offsets into the UTF-8 text."
}
code object

Inline code.

This object has no properties defined.

View raw schema
{
  "type": "object",
  "properties": {},
  "description": "Inline code."
}
italic object

Italic text.

This object has no properties defined.

View raw schema
{
  "type": "object",
  "properties": {},
  "description": "Italic text."
}
link object

A hyperlink.

Properties

uri string uri Required

A valid URI.

View raw schema
{
  "type": "object",
  "required": [
    "uri"
  ],
  "properties": {
    "uri": {
      "type": "string",
      "format": "uri"
    }
  },
  "description": "A hyperlink."
}
mention object

A 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": "A mention of another account."
}
spoiler object

Spoiler text, hidden until revealed. A forum culture essential.

This object has no properties defined.

View raw schema
{
  "type": "object",
  "properties": {},
  "description": "Spoiler text, hidden until revealed. A forum culture essential."
}
strikethrough object

Struck-through text.

This object has no properties defined.

View raw schema
{
  "type": "object",
  "properties": {},
  "description": "Struck-through text."
}
tag object

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": "A hashtag."
}
underline object

Underlined text. A BBCode heritage feature.

This object has no properties defined.

View raw schema
{
  "type": "object",
  "properties": {},
  "description": "Underlined text. A BBCode heritage feature."
}

Lexicon Garden

@