social.respawn.richtext.facet

respawn.social

Documentation

Annotation of a sub-string within rich text. Modeled on app.bsky.richtext.facet with Respawn-specific formatting features.

main object

Annotation of a sub-string within rich text. Modeled on app.bsky.richtext.facet with Respawn-specific formatting features.

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": [
          "#link",
          "#bold",
          "#italic",
          "#spoiler",
          "#blockquote",
          "#listItem"
        ],
        "type": "union"
      }
    }
  },
  "description": "Annotation of a sub-string within rich text. Modeled on app.bsky.richtext.facet with Respawn-specific formatting features."
}
blockquote object

Facet feature for a blockquote span.

This object has no properties defined.

View raw schema
{
  "type": "object",
  "properties": {},
  "description": "Facet feature for a blockquote span."
}
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."
}
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 for a list item span.

Properties

ordered boolean Optional

Whether the item belongs to an ordered (numbered) list.

View raw schema
{
  "type": "object",
  "properties": {
    "ordered": {
      "type": "boolean",
      "description": "Whether the item belongs to an ordered (numbered) list."
    }
  },
  "description": "Facet feature for a list item span."
}
spoiler object

Facet feature marking a span as a spoiler. In display text the span is scrambled; the original text lives in the accompanying textWithSpoilers field.

This object has no properties defined.

View raw schema
{
  "type": "object",
  "properties": {},
  "description": "Facet feature marking a span as a spoiler. In display text the span is scrambled; the original text lives in the accompanying textWithSpoilers field."
}

Lexicon Garden

@