Generated from the contract schemas of @taggor/contract 1.10.0 by pnpm docs:contract; do not edit.
Events, slots, parts and CSS variables are the component’s public surface towards the host page. Each is declared under its own name in the manifest.
| Field |
Type |
Required |
Description |
description |
string, 1 to 300 characters, a fixed pattern (see the JSON Schema) |
no |
What this member is for; shown in docs, the portal and to agents. |
detail |
ValueSchema |
yes |
Schema of event.detail; use { “type”: “object”, “fields”: {} } for an event without data. |
bubbles |
boolean |
no |
Defaults to true. |
composed |
boolean |
no |
Defaults to true. |
| Field |
Type |
Required |
Description |
description |
string, 1 to 300 characters, a fixed pattern (see the JSON Schema) |
no |
What this member is for; shown in docs, the portal and to agents. |
| Field |
Type |
Required |
Description |
description |
string, 1 to 300 characters, a fixed pattern (see the JSON Schema) |
no |
What this member is for; shown in docs, the portal and to agents. |
Exactly one of:
- an object, fields below
- type
"font-family", fields below
| Field |
Type |
Required |
Description |
type |
one of "color", "length", "number", "percentage" |
yes |
The kind of CSS value the variable holds (color, length, number, percentage or font-family); the build checks default against it. |
default |
string, 1 to 100 characters, a fixed pattern (see the JSON Schema) |
yes |
The value the component uses when the site does not set the variable. |
description |
string, 1 to 300 characters, a fixed pattern (see the JSON Schema) |
no |
What this member is for; shown in docs, the portal and to agents. |
| Field |
Type |
Required |
Description |
type |
the constant "font-family" |
yes |
The kind of CSS value the variable holds (color, length, number, percentage or font-family); the build checks default against it. |
default |
string, 1 to 100 characters, pattern ^[a-zA-Z0-9,\s-]+$ |
yes |
The value the component uses when the site does not set the variable. |
description |
string, 1 to 300 characters, a fixed pattern (see the JSON Schema) |
no |
What this member is for; shown in docs, the portal and to agents. |