com.deckbelcher.richtext.facet

deckbelcher.com

Documentation

Annotation of a sub-string within rich text. Extends Bluesky's facet system to support DeckBelcher-specific features.

main object

Annotation of a sub-string within rich text. Extends Bluesky's facet system to support DeckBelcher-specific 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": [
          "#mention",
          "#link",
          "#tag",
          "#bold",
          "#italic",
          "#code",
          "#codeBlock",
          "#cardRef"
        ],
        "type": "union"
      }
    }
  },
  "description": "Annotation of a sub-string within rich text.\nExtends Bluesky's facet system to support DeckBelcher-specific features."
}
bold object

Facet feature for bold text formatting. Typically rendered as `<strong>` in HTML.

This object has no properties defined.

View raw schema 
{
  "type": "object",
  "properties": {},
  "description": "Facet feature for bold text formatting.\nTypically rendered as `<strong>` in HTML."
}
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.\nStart index is inclusive, end index is exclusive.\nIndices are zero-indexed, counting bytes of the UTF-8 encoded text."
}
cardRef object

Facet feature for a card reference. Links to a Magic: The Gathering card. The text is usually the card name.

Properties

View raw schema 
{
  "type": "object",
  "required": [
    "ref"
  ],
  "properties": {
    "ref": {
      "ref": "com.deckbelcher.defs#cardRef",
      "type": "ref",
      "description": "Reference to the card (scryfall printing + oracle card)."
    }
  },
  "description": "Facet feature for a card reference.\nLinks to a Magic: The Gathering card.\nThe text is usually the card name."
}
code object

Facet feature for inline code. Typically rendered as `<code>` in HTML.

This object has no properties defined.

View raw schema 
{
  "type": "object",
  "properties": {},
  "description": "Facet feature for inline code.\nTypically rendered as `<code>` in HTML."
}
codeBlock object

Facet feature for code blocks. Typically rendered as `<pre><code>` in HTML.

This object has no properties defined.

View raw schema 
{
  "type": "object",
  "properties": {},
  "description": "Facet feature for code blocks.\nTypically rendered as `<pre><code>` in HTML."
}
italic object

Facet feature for italic text formatting. Typically rendered as `<em>` in HTML.

This object has no properties defined.

View raw schema 
{
  "type": "object",
  "properties": {},
  "description": "Facet feature for italic text formatting.\nTypically rendered as `<em>` in HTML."
}
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.\nThe text URL may have been simplified or truncated, but the facet reference should be a complete URL."
}
mention object

Facet feature for mention of another account. The text is usually a handle, including an `@` 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.\nThe text is usually a handle, including an `@` prefix, but the facet reference is a DID."
}
tag object

Facet feature for a hashtag. The text usually includes a '#' prefix, but the facet reference should not.

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.\nThe text usually includes a '#' prefix, but the facet reference should not."
}

Lexicon Garden

@