blue.backyard.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",
          "#underline",
          "#strikethrough"
        ],
        "type": "union"
      },
      "description": "The feature types applied to this text range (e.g. link, mention, formatting)."
    }
  },
  "description": "Annotation of a sub-string within rich text."
}
bold object

Facet feature for bold text formatting. Spec candidate per Paul Frazee.

This object has no properties defined.

View raw schema 
{
  "type": "object",
  "properties": {},
  "description": "Facet feature for bold text formatting. Spec candidate per Paul Frazee."
}
byteSlice object

Specifies a sub-string in a utf-8 string by byte index.

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 a sub-string in a utf-8 string by byte index."
}
italic object

Facet feature for italic text formatting. Spec candidate per Paul Frazee.

This object has no properties defined.

View raw schema 
{
  "type": "object",
  "properties": {},
  "description": "Facet feature for italic text formatting. Spec candidate per Paul Frazee."
}
link object

Facet feature for a URL link.

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

Facet feature for strikethrough text formatting. Spec candidate per Paul Frazee.

This object has no properties defined.

View raw schema 
{
  "type": "object",
  "properties": {},
  "description": "Facet feature for strikethrough text formatting. Spec candidate per Paul Frazee."
}
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."
}
underline object

Facet feature for underline text formatting. Spec candidate per Paul Frazee.

This object has no properties defined.

View raw schema 
{
  "type": "object",
  "properties": {},
  "description": "Facet feature for underline text formatting. Spec candidate per Paul Frazee."
}

Lexicon Garden

@