net.wireservice.component.image

wireservice.net

Documentation

Image component. Supports blob storage for AT Protocol-native images and optional external URLs.

main object

Image component. Supports blob storage for AT Protocol-native images and optional external URLs.

Properties

accessibilityCaption string Optional

Accessibility description of the image for screen readers.

maxLength: 20000 bytesmaxGraphemes: 2000 graphemes
explicitContent boolean Optional

Whether the image contains explicit or sensitive content.

hidden boolean Optional

No description available.

identifier string Optional

No description available.

maxLength: 256 bytes
image blob Optional

The image blob.

maxSize: 5.0 MB
layout string Optional

Reference to a named component layout.

maxLength: 256 bytes
style string Optional

Reference to a named component style.

maxLength: 256 bytes
url string uri Optional

External URL for the image (e.g., CDN-hosted). Alternative or supplement to the blob.

View raw schema
{
  "description": "Image component. Supports blob storage for AT Protocol-native images and optional external URLs.",
  "properties": {
    "accessibilityCaption": {
      "description": "Accessibility description of the image for screen readers.",
      "maxGraphemes": 2000,
      "maxLength": 20000,
      "type": "string"
    },
    "aspectRatio": {
      "description": "Aspect ratio of the image.",
      "ref": "net.wireservice.defs#aspectRatio",
      "type": "ref"
    },
    "caption": {
      "description": "Visible caption as an array of text runs with optional formatting marks.",
      "items": {
        "ref": "net.wireservice.defs#textRun",
        "type": "ref"
      },
      "type": "array"
    },
    "explicitContent": {
      "description": "Whether the image contains explicit or sensitive content.",
      "type": "boolean"
    },
    "hidden": {
      "type": "boolean"
    },
    "identifier": {
      "maxLength": 256,
      "type": "string"
    },
    "image": {
      "accept": [
        "image/jpeg",
        "image/png",
        "image/webp",
        "image/gif"
      ],
      "description": "The image blob.",
      "maxSize": 5000000,
      "type": "blob"
    },
    "layout": {
      "description": "Reference to a named component layout.",
      "maxLength": 256,
      "type": "string"
    },
    "style": {
      "description": "Reference to a named component style.",
      "maxLength": 256,
      "type": "string"
    },
    "url": {
      "description": "External URL for the image (e.g., CDN-hosted). Alternative or supplement to the blob.",
      "format": "uri",
      "type": "string"
    }
  },
  "required": [
    "aspectRatio"
  ],
  "type": "object"
}

Lexicon Garden

@