app.offprint.richtext.facet

offprint.app

Documentation

main object

No description available.

Properties

index ref #byteSlice Required

No description available.

View raw schema 
{
  "type": "object",
  "required": [
    "index",
    "features"
  ],
  "properties": {
    "index": {
      "ref": "#byteSlice",
      "type": "ref",
      "required": true
    },
    "features": {
      "type": "array",
      "items": {
        "refs": [
          "#bold",
          "#italic",
          "#underline",
          "#strikethrough",
          "#code",
          "#highlight",
          "#link",
          "#mention",
          "#webMention"
        ],
        "type": "union"
      },
      "required": true
    }
  }
}
bold object

No description available.

This object has no properties defined.

View raw schema 
{
  "type": "object",
  "properties": []
}
byteSlice object

No description available.

Properties

byteEnd integer Required

End index (exclusive), zero-indexed byte offset in UTF-8 encoded text.

minimum: 0
byteStart integer Required

Start index (inclusive), zero-indexed byte offset in UTF-8 encoded text.

minimum: 0
View raw schema 
{
  "type": "object",
  "required": [
    "byteStart",
    "byteEnd"
  ],
  "properties": {
    "byteEnd": {
      "type": "integer",
      "minimum": 0,
      "required": true,
      "description": "End index (exclusive), zero-indexed byte offset in UTF-8 encoded text."
    },
    "byteStart": {
      "type": "integer",
      "minimum": 0,
      "required": true,
      "description": "Start index (inclusive), zero-indexed byte offset in UTF-8 encoded text."
    }
  }
}
code object

No description available.

This object has no properties defined.

View raw schema 
{
  "type": "object",
  "properties": []
}
highlight object

No description available.

Properties

color string Optional

Optional highlight color (hex or CSS color)

View raw schema 
{
  "type": "object",
  "properties": {
    "color": {
      "type": "string",
      "description": "Optional highlight color (hex or CSS color)"
    }
  }
}
italic object

No description available.

This object has no properties defined.

View raw schema 
{
  "type": "object",
  "properties": []
}
link object

No description available.

Properties

uri string uri Required

A valid URI.

View raw schema 
{
  "type": "object",
  "required": [
    "uri"
  ],
  "properties": {
    "uri": {
      "type": "string",
      "format": "uri",
      "required": true
    }
  }
}
mention object

No description available.

Properties

did string did Required

A decentralized identifier (DID).

handle string handle Optional

Optional cached handle for display

View raw schema 
{
  "type": "object",
  "required": [
    "did"
  ],
  "properties": {
    "did": {
      "type": "string",
      "format": "did",
      "required": true
    },
    "handle": {
      "type": "string",
      "format": "handle",
      "description": "Optional cached handle for display"
    }
  }
}
strikethrough object

No description available.

This object has no properties defined.

View raw schema 
{
  "type": "object",
  "properties": []
}
underline object

No description available.

This object has no properties defined.

View raw schema 
{
  "type": "object",
  "properties": []
}
webMention object

No description available.

Properties

siteName string Optional

Name of the website

maxGraphemes: 50 graphemes
title string Required

Page title for display

maxGraphemes: 100 graphemes
uri string uri Required

The URL being mentioned

View raw schema 
{
  "type": "object",
  "required": [
    "uri",
    "title"
  ],
  "properties": {
    "uri": {
      "type": "string",
      "format": "uri",
      "required": true,
      "description": "The URL being mentioned"
    },
    "title": {
      "type": "string",
      "required": true,
      "description": "Page title for display",
      "maxGraphemes": 100
    },
    "siteName": {
      "type": "string",
      "description": "Name of the website",
      "maxGraphemes": 50
    }
  }
}

Lexicon Garden

@