net.atview.richtext.facet

atview.net

Documentation

Annotation of a sub-string within the parent record's `textContent`. Byte offsets refer to a UTF-8 encoding of the string. A single facet may carry multiple features that all apply to the same byte range.

main object

Annotation of a sub-string within the parent record's `textContent`. Byte offsets refer to a UTF-8 encoding of the string. A single facet may carry multiple features that all apply to the same byte range.

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": [
          "#b",
          "#i",
          "#u",
          "#code",
          "#strikethrough",
          "#highlight",
          "#link",
          "#mention",
          "#h2",
          "#h3",
          "#h4",
          "#h5",
          "#h6",
          "#blockquote",
          "#codeBlock",
          "#media",
          "#bskyPost",
          "#ul",
          "#ol",
          "#website",
          "#horizontalRule",
          "#iframe",
          "#math",
          "#hardBreak"
        ],
        "type": "union"
      }
    }
  },
  "description": "Annotation of a sub-string within the parent record's `textContent`. Byte offsets refer to a UTF-8 encoding of the string. A single facet may carry multiple features that all apply to the same byte range."
}
aspectRatio object

Width/height ratio of an image, in arbitrary same-unit pixels.

Properties

height integer Required

No description available.

minimum: 1
width integer Required

No description available.

minimum: 1
View raw schema
{
  "type": "object",
  "required": [
    "width",
    "height"
  ],
  "properties": {
    "width": {
      "type": "integer",
      "minimum": 1
    },
    "height": {
      "type": "integer",
      "minimum": 1
    }
  },
  "description": "Width/height ratio of an image, in arbitrary same-unit pixels."
}
b object

Bold inline emphasis.

This object has no properties defined.

View raw schema
{
  "type": "object",
  "properties": {},
  "description": "Bold inline emphasis."
}
blockquote object

Blockquote block.

This object has no properties defined.

View raw schema
{
  "type": "object",
  "properties": {},
  "description": "Blockquote block."
}
bskyPost object

Embedded reference to a Bluesky post (app.bsky.feed.post).

Properties

cid string cid Optional

A content identifier (CID) referencing immutable data.

uri string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

View raw schema
{
  "type": "object",
  "required": [
    "uri"
  ],
  "properties": {
    "cid": {
      "type": "string",
      "format": "cid"
    },
    "uri": {
      "type": "string",
      "format": "at-uri"
    }
  },
  "description": "Embedded reference to a Bluesky post (app.bsky.feed.post)."
}
byteSlice object

Specifies the sub-string range a facet feature applies to. Start index is inclusive, end index is exclusive. Indices are in UTF-8 bytes.

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 in UTF-8 bytes."
}
code object

Inline monospace / code span.

This object has no properties defined.

View raw schema
{
  "type": "object",
  "properties": {},
  "description": "Inline monospace / code span."
}
codeBlock object

Fenced code block with optional language hint.

Properties

language string Optional

No description available.

maxLength: 100 bytes
View raw schema
{
  "type": "object",
  "properties": {
    "language": {
      "type": "string",
      "maxLength": 100
    }
  },
  "description": "Fenced code block with optional language hint."
}
h2 object

Level 2 heading block.

This object has no properties defined.

View raw schema
{
  "type": "object",
  "properties": {},
  "description": "Level 2 heading block."
}
h3 object

Level 3 heading block.

This object has no properties defined.

View raw schema
{
  "type": "object",
  "properties": {},
  "description": "Level 3 heading block."
}
h4 object

Level 4 heading block.

This object has no properties defined.

View raw schema
{
  "type": "object",
  "properties": {},
  "description": "Level 4 heading block."
}
h5 object

Level 5 heading block.

This object has no properties defined.

View raw schema
{
  "type": "object",
  "properties": {},
  "description": "Level 5 heading block."
}
h6 object

Level 6 heading block.

This object has no properties defined.

View raw schema
{
  "type": "object",
  "properties": {},
  "description": "Level 6 heading block."
}
hardBreak object

Hard line break within a paragraph.

This object has no properties defined.

View raw schema
{
  "type": "object",
  "properties": {},
  "description": "Hard line break within a paragraph."
}
highlight object

Highlighted inline emphasis.

This object has no properties defined.

View raw schema
{
  "type": "object",
  "properties": {},
  "description": "Highlighted inline emphasis."
}
horizontalRule object

Horizontal rule / thematic break block.

This object has no properties defined.

View raw schema
{
  "type": "object",
  "properties": {},
  "description": "Horizontal rule / thematic break block."
}
i object

Italic inline emphasis.

This object has no properties defined.

View raw schema
{
  "type": "object",
  "properties": {},
  "description": "Italic inline emphasis."
}
iframe object

Embedded iframe block.

Properties

height integer Optional

No description available.

minimum: 1
url string uri Required

A valid URI.

View raw schema
{
  "type": "object",
  "required": [
    "url"
  ],
  "properties": {
    "url": {
      "type": "string",
      "format": "uri"
    },
    "height": {
      "type": "integer",
      "minimum": 1
    }
  },
  "description": "Embedded iframe block."
}
link object

Hyperlink inline feature.

Properties

uri string uri Required

A valid URI.

View raw schema
{
  "type": "object",
  "required": [
    "uri"
  ],
  "properties": {
    "uri": {
      "type": "string",
      "format": "uri"
    }
  },
  "description": "Hyperlink inline feature."
}
math object

Math block expressed as TeX source.

Properties

tex string Required

No description available.

maxLength: 20000 bytesmaxGraphemes: 10000 graphemes
View raw schema
{
  "type": "object",
  "required": [
    "tex"
  ],
  "properties": {
    "tex": {
      "type": "string",
      "maxLength": 20000,
      "maxGraphemes": 10000
    }
  },
  "description": "Math block expressed as TeX source."
}
media object

Inline/embedded media (image) with optional metadata.

Properties

altText string Optional

No description available.

maxLength: 10000 bytesmaxGraphemes: 1000 graphemes
aspectRatio ref #aspectRatio Optional

No description available.

caption string Optional

No description available.

maxLength: 10000 bytesmaxGraphemes: 1000 graphemes
image blob Required

No description available.

maxSize: 5.0 MB
title string Optional

No description available.

maxLength: 5000 bytesmaxGraphemes: 500 graphemes
View raw schema
{
  "type": "object",
  "required": [
    "image"
  ],
  "properties": {
    "image": {
      "type": "blob",
      "accept": [
        "image/*"
      ],
      "maxSize": 5000000
    },
    "title": {
      "type": "string",
      "maxLength": 5000,
      "maxGraphemes": 500
    },
    "altText": {
      "type": "string",
      "maxLength": 10000,
      "maxGraphemes": 1000
    },
    "caption": {
      "type": "string",
      "maxLength": 10000,
      "maxGraphemes": 1000
    },
    "aspectRatio": {
      "ref": "#aspectRatio",
      "type": "ref"
    }
  },
  "description": "Inline/embedded media (image) with optional metadata."
}
mention object

Mention of an account by DID.

Properties

did string did Required

A decentralized identifier (DID).

View raw schema
{
  "type": "object",
  "required": [
    "did"
  ],
  "properties": {
    "did": {
      "type": "string",
      "format": "did"
    }
  },
  "description": "Mention of an account by DID."
}
ol object

Ordered list item block.

This object has no properties defined.

View raw schema
{
  "type": "object",
  "properties": {},
  "description": "Ordered list item block."
}
strikethrough object

Strikethrough inline emphasis.

This object has no properties defined.

View raw schema
{
  "type": "object",
  "properties": {},
  "description": "Strikethrough inline emphasis."
}
u object

Underline inline emphasis.

This object has no properties defined.

View raw schema
{
  "type": "object",
  "properties": {},
  "description": "Underline inline emphasis."
}
ul object

Unordered list item block.

This object has no properties defined.

View raw schema
{
  "type": "object",
  "properties": {},
  "description": "Unordered list item block."
}
website object

External website embed.

Properties

title string Optional

No description available.

maxLength: 5000 bytesmaxGraphemes: 500 graphemes
uri string uri Required

A valid URI.

View raw schema
{
  "type": "object",
  "required": [
    "uri"
  ],
  "properties": {
    "uri": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string",
      "maxLength": 5000,
      "maxGraphemes": 500
    }
  },
  "description": "External website embed."
}

Lexicon Garden

@