at.inlay.component

inlay.at

Documentation

Component record - declares an implementation of a type

main record

Component record - declares an implementation of a type

Record Key tid Timestamp-based ID

Properties

accepts array of ref #acceptsEntry Optional

Data types this component can render. Used for data-driven discovery.

body union Optional

How this component is rendered. Omit for primitives rendered by the host.

Known types:
createdAt string datetime Optional

An RFC 3339 formatted timestamp.

description string Optional

No description available.

imports array of ref #import Optional

Where to resolve types from

type string nsid Required

NSID this component implements (also the XRPC procedure)

View raw schema 
{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "type"
    ],
    "properties": {
      "via": {
        "refs": [
          "at.inlay.defs#viaValtown"
        ],
        "type": "union",
        "description": "Platform-managed deployment metadata"
      },
      "body": {
        "refs": [
          "#bodyExternal",
          "#bodyTemplate"
        ],
        "type": "union",
        "description": "How this component is rendered. Omit for primitives rendered by the host."
      },
      "type": {
        "type": "string",
        "format": "nsid",
        "description": "NSID this component implements (also the XRPC procedure)"
      },
      "view": {
        "type": "array",
        "items": {
          "refs": [
            "#viewRecord",
            "#viewCollection",
            "#viewIdentity"
          ],
          "type": "union"
        },
        "description": "What kinds of pages this component is a view for"
      },
      "accepts": {
        "type": "array",
        "items": {
          "ref": "#acceptsEntry",
          "type": "ref"
        },
        "description": "Data types this component can render. Used for data-driven discovery."
      },
      "imports": {
        "type": "array",
        "items": {
          "ref": "#import",
          "type": "ref"
        },
        "description": "Where to resolve types from"
      },
      "createdAt": {
        "type": "string",
        "format": "datetime"
      },
      "description": {
        "type": "string"
      }
    }
  },
  "description": "Component record - declares an implementation of a type"
}
acceptsEntry object

A data type this component can render via a specific prop

Properties

collection string nsid Optional

For at-uri format: restrict to this collection

format string Required

Data format this entry matches

Known values: at-uri, did, blob, datetime, uri
prop string Required

Prop to bind matched data to

View raw schema 
{
  "type": "object",
  "required": [
    "format",
    "prop"
  ],
  "properties": {
    "prop": {
      "type": "string",
      "description": "Prop to bind matched data to"
    },
    "format": {
      "type": "string",
      "description": "Data format this entry matches",
      "knownValues": [
        "at-uri",
        "did",
        "blob",
        "datetime",
        "uri"
      ]
    },
    "collection": {
      "type": "string",
      "format": "nsid",
      "description": "For at-uri format: restrict to this collection"
    }
  },
  "description": "A data type this component can render via a specific prop"
}
bodyExternal object

Component rendered by calling a remote XRPC endpoint

Properties

did string did Required

DID of the service hosting this component

View raw schema 
{
  "type": "object",
  "required": [
    "did"
  ],
  "properties": {
    "did": {
      "type": "string",
      "format": "did",
      "description": "DID of the service hosting this component"
    }
  },
  "description": "Component rendered by calling a remote XRPC endpoint"
}
bodyTemplate object

Component rendered by the host from a serialized element tree

Properties

node unknown Required

Serialized element tree with bindings

View raw schema 
{
  "type": "object",
  "required": [
    "node"
  ],
  "properties": {
    "node": {
      "type": "unknown",
      "description": "Serialized element tree with bindings"
    }
  },
  "description": "Component rendered by the host from a serialized element tree"
}
import object

No description available.

Properties

pack string at-uri Required

Pack to resolve from

types string Required

Type pattern to match (glob like com.alice.* or concrete like com.alice.Avatar)

View raw schema 
{
  "type": "object",
  "required": [
    "types",
    "pack"
  ],
  "properties": {
    "pack": {
      "type": "string",
      "format": "at-uri",
      "description": "Pack to resolve from"
    },
    "types": {
      "type": "string",
      "description": "Type pattern to match (glob like com.alice.* or concrete like com.alice.Avatar)"
    }
  }
}
viewCollection object

Component is a view for a collection listing. Omit collection for a generic collection view.

Properties

collection string nsid Optional

The collection this component lists. Omit for any-collection.

View raw schema 
{
  "type": "object",
  "properties": {
    "collection": {
      "type": "string",
      "format": "nsid",
      "description": "The collection this component lists. Omit for any-collection."
    }
  },
  "description": "Component is a view for a collection listing. Omit collection for a generic collection view."
}
viewIdentity object

Component is a view for an identity (person/DID).

This object has no properties defined.

View raw schema 
{
  "type": "object",
  "properties": {},
  "description": "Component is a view for an identity (person/DID)."
}
viewRecord object

Component is a view for individual records of a collection. Omit collection for a generic record view.

Properties

collection string nsid Optional

The collection this component views. Omit for any-collection.

View raw schema 
{
  "type": "object",
  "properties": {
    "collection": {
      "type": "string",
      "format": "nsid",
      "description": "The collection this component views. Omit for any-collection."
    }
  },
  "description": "Component is a view for individual records of a collection. Omit collection for a generic record view."
}

Lexicon Garden

@