@unframed/mcp 0.0.0-stage → 1.0.0-rc.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +52 -2
- package/data.json +2342 -0
- package/dist/data.js +7 -0
- package/dist/data.js.map +1 -0
- package/dist/index.js +7 -0
- package/dist/index.js.map +1 -0
- package/dist/server.js +76 -0
- package/dist/server.js.map +1 -0
- package/dist/validate.js +328 -0
- package/dist/validate.js.map +1 -0
- package/package.json +45 -4
package/data.json
ADDED
|
@@ -0,0 +1,2342 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": "1.0.0-rc.2",
|
|
3
|
+
"components": [
|
|
4
|
+
{
|
|
5
|
+
"name": "accordion",
|
|
6
|
+
"title": "Accordion",
|
|
7
|
+
"summary": "A stack of sections that expand and collapse.",
|
|
8
|
+
"tags": [
|
|
9
|
+
"uf-accordion",
|
|
10
|
+
"uf-accordion-item"
|
|
11
|
+
],
|
|
12
|
+
"imports": [
|
|
13
|
+
"@unframed/core/accordion"
|
|
14
|
+
],
|
|
15
|
+
"docs": "# Accordion\n\nGroups `<uf-accordion-item>`s. By default opening one item closes the\nothers; set `multiple` to let several stay open. Up and Down arrows move\nbetween headers, Home and End jump to the first and last.\n\nTags: `<uf-accordion>`, `<uf-accordion-item>`. Import: `import '@unframed/core/accordion';` (or `npx @unframed/cli add accordion` to copy the source).\n\n## One open at a time\n\nAdd `multiple` to let several items stay open.\n\n```html\n<uf-accordion>\n <uf-accordion-item summary=\"What is Unframed?\" open>\n A library of web components that work in any framework, or none.\n </uf-accordion-item>\n <uf-accordion-item summary=\"Can I edit the components?\">…</uf-accordion-item>\n</uf-accordion>\n```\n\n## `<uf-accordion>` API\n\n### Attributes and properties\n\n| Attribute | Property | Type | Default | Description |\n|---|---|---|---|---|\n| `multiple` | | `boolean` | `false` | Allows several items to be open at once. |\n\n### Slots\n\n| Slot | Description |\n|---|---|\n| (default) | `<uf-accordion-item>` elements. |\n\n### CSS parts\n\n| Part | Description |\n|---|---|\n| `base` | The wrapper around the items. |\n\n## `<uf-accordion-item>` API\n\n### Attributes and properties\n\n| Attribute | Property | Type | Default | Description |\n|---|---|---|---|---|\n| `open` | | `boolean` | `false` | Whether the item is expanded. |\n| `summary` | | `string \\| undefined` | | Header text. |\n| `disabled` | | `boolean` | `false` | Prevents the user from toggling the item. |\n\n### Properties only\n\n| Property | Type | Description |\n|---|---|---|\n| `header` | `HTMLElement \\| null` | Read-only. The header element, for keyboard navigation between items. |\n\n### Methods\n\n| Method | Description |\n|---|---|\n| `show()` | Expands the item. |\n| `hide()` | Collapses the item. |\n| `focus(options: FocusOptions)` | Focuses the header. |\n\n### Events\n\n| Event | Type | Description |\n|---|---|---|\n| `uf-show` | | The item opened. |\n| `uf-hide` | | The item closed. |\n\n### Slots\n\n| Slot | Description |\n|---|---|\n| (default) | The content. |\n| `summary` | The header, when you need markup. Overrides `summary`. |\n\n### CSS parts\n\n| Part | Description |\n|---|---|\n| `base` | The native `<details>`. |\n| `header` | The clickable header (`<summary>`). |\n| `chevron` | The arrow icon. |\n| `content` | The content wrapper. |\n\n### CSS custom properties\n\n| Property | Description |\n|---|---|\n| `--uf-accordion-padding` | Horizontal padding of header and content. |\n"
|
|
16
|
+
},
|
|
17
|
+
{
|
|
18
|
+
"name": "alert",
|
|
19
|
+
"title": "Alert",
|
|
20
|
+
"summary": "Shows a message in the page, by meaning: info, success, warning or danger.",
|
|
21
|
+
"tags": [
|
|
22
|
+
"uf-alert"
|
|
23
|
+
],
|
|
24
|
+
"imports": [
|
|
25
|
+
"@unframed/core/alert"
|
|
26
|
+
],
|
|
27
|
+
"docs": "# Alert\n\nA message in the page, like \"Your trial ends in 3 days\" or \"We couldn't save\nyour changes\". Unlike a toast it stays where it is until it's dismissed.\n\n`warning` and `danger` alerts are announced right away (`role=\"alert\"`), the\nothers politely (`role=\"status\"`). Assistive tech announces an alert when it's\nadded to the page or shown, not when the page loads with it.\n\nTags: `<uf-alert>`. Import: `import '@unframed/core/alert';` (or `npx @unframed/cli add alert` to copy the source).\n\n## Variants\n\nSix colors by meaning, each with its icon. `info` is the default.\n\n```html\n<uf-alert>A new version is available.</uf-alert>\n<uf-alert variant=\"success\">Your changes were published.</uf-alert>\n<uf-alert variant=\"warning\">Your trial ends in 3 days.</uf-alert>\n<uf-alert variant=\"danger\">We couldn't charge your card.</uf-alert>\n```\n\n- `warning` and `danger` alerts are announced right away, the others politely. Assistive tech announces an alert when it appears, so add it to the page (or `show()` it) when the message happens.\n\n## Heading and actions\n\n```html\n<uf-alert variant=\"warning\" heading=\"Your trial ends in 3 days\">\n Choose a plan to keep your projects and invoices.\n <uf-button slot=\"actions\" size=\"sm\">Choose a plan</uf-button>\n <uf-button slot=\"actions\" size=\"sm\" variant=\"ghost\">Remind me later</uf-button>\n</uf-alert>\n```\n\n## Closable\n\n`closable` adds a close button that hides the alert and emits `uf-hide`. `show()` brings it back.\n\n```html\n<uf-alert variant=\"success\" closable>Your changes were saved.</uf-alert>\n\n<script>\n document.querySelector('uf-alert').addEventListener('uf-hide', () => console.log('closed'));\n</script>\n```\n\n## Without an icon, or with your own\n\n```html\n<uf-alert variant=\"neutral\" without-icon>Maintenance on Sunday from 02:00 to 04:00 UTC.</uf-alert>\n<uf-alert variant=\"accent\">\n <uf-icon slot=\"icon\" name=\"user\"></uf-icon>\n John Smith shared a project with you.\n</uf-alert>\n```\n\n## `<uf-alert>` API\n\n### Attributes and properties\n\n| Attribute | Property | Type | Default | Description |\n|---|---|---|---|---|\n| `variant` | | `AlertVariant` | `'info'` | Color, icon and urgency, by meaning: `neutral`, `accent`, `info`, `success`, `warning` or `danger`. |\n| `heading` | | `string \\| undefined` | | Bold first line. |\n| `closable` | | `boolean` | `false` | Shows a close button that hides the alert. |\n| `without-icon` | `withoutIcon` | `boolean` | `false` | Hides the icon. |\n\n### Methods\n\n| Method | Description |\n|---|---|\n| `show()` | Shows the alert again after it was hidden. |\n| `hide()` | Hides the alert, like its close button. |\n\n### Events\n\n| Event | Type | Description |\n|---|---|---|\n| `uf-show` | `Event` | The alert was shown with `show()`. |\n| `uf-hide` | `Event` | The alert was hidden, with the close button or `hide()`. |\n\n### Slots\n\n| Slot | Description |\n|---|---|\n| (default) | The message. |\n| `heading` | The heading, when you need markup. Overrides `heading`. |\n| `icon` | Replaces the variant's icon. |\n| `actions` | Buttons or links below the message. |\n\n### CSS parts\n\n| Part | Description |\n|---|---|\n| `base` | The alert. |\n| `icon` | The icon. |\n| `content` | The wrapper around the heading, message and actions. |\n| `heading` | The heading. |\n| `message` | The message. |\n| `actions` | The wrapper around the actions. |\n| `close-button` | The close button, when `closable` is set. |\n\n### CSS custom properties\n\n| Property | Description |\n|---|---|\n| `--uf-alert-bg` | Background color. |\n| `--uf-alert-border-color` | Border color. |\n| `--uf-alert-color` | Text color. |\n| `--uf-alert-icon-color` | Icon color. |\n| `--uf-alert-radius` | Corner radius. |\n| `--uf-alert-padding` | Space inside the alert. |\n"
|
|
28
|
+
},
|
|
29
|
+
{
|
|
30
|
+
"name": "avatar",
|
|
31
|
+
"title": "Avatar",
|
|
32
|
+
"summary": "Shows a person's picture, initials or icon.",
|
|
33
|
+
"tags": [
|
|
34
|
+
"uf-avatar"
|
|
35
|
+
],
|
|
36
|
+
"imports": [
|
|
37
|
+
"@unframed/core/avatar"
|
|
38
|
+
],
|
|
39
|
+
"docs": "# Avatar\n\nA picture of a person or an entity. Shows the image when it loads, the\ninitials of `name` when there's no image or it fails, and a generic icon\nwhen there's neither.\n\n`name` is also the accessible name. When the name is already written next\nto the avatar, set `decorative` so screen readers don't read it twice.\n\nTags: `<uf-avatar>`. Import: `import '@unframed/core/avatar';` (or `npx @unframed/cli add avatar` to copy the source).\n\n## Image, initials or icon\n\nThe image when it loads, the initials of `name` when it doesn't, a generic icon when there's neither.\n\n```html\n<uf-avatar name=\"John Smith\" src=\"/photos/john.jpg\"></uf-avatar>\n<uf-avatar name=\"John Smith\"></uf-avatar>\n<uf-avatar></uf-avatar>\n```\n\n## Sizes and shapes\n\n```html\n<uf-avatar size=\"sm\" name=\"John Smith\"></uf-avatar>\n<uf-avatar size=\"xl\" name=\"John Smith\"></uf-avatar>\n<uf-avatar size=\"xl\" shape=\"square\" name=\"Unframed\" initials=\"U\"></uf-avatar>\n```\n\n## Next to a name\n\n```html\n<uf-avatar name=\"John Smith\" decorative></uf-avatar>\n<strong>John Smith</strong>\n```\n\n- `name` is the accessible name. When the name is written next to the avatar, add `decorative` so screen readers don't read it twice.\n\n## `<uf-avatar>` API\n\n### Attributes and properties\n\n| Attribute | Property | Type | Default | Description |\n|---|---|---|---|---|\n| `src` | | `string \\| undefined` | | Image URL. |\n| `name` | | `string \\| undefined` | | The person's or entity's name: the accessible name, and the source of the initials. |\n| `initials` | | `string \\| undefined` | | Initials to show instead of the ones taken from `name`. |\n| `size` | | `AvatarSize` | `'md'` | Size: `sm`, `md`, `lg` or `xl`. |\n| `shape` | | `AvatarShape` | `'circle'` | `circle` or `square` (rounded corners). |\n| `decorative` | | `boolean` | `false` | Hides the avatar from assistive tech, when the name is already shown next to it. |\n| `loading` | | `'eager' \\| 'lazy'` | `'eager'` | The image's `loading` attribute: `lazy` waits until it's near the viewport. |\n\n### Slots\n\n| Slot | Description |\n|---|---|\n| (default) | Custom content instead of the initials or icon, e.g. an `<uf-icon>`. |\n\n### CSS parts\n\n| Part | Description |\n|---|---|\n| `base` | The avatar. |\n| `image` | The `<img>`. |\n| `initials` | The initials. |\n| `icon` | The fallback icon. |\n\n### CSS custom properties\n\n| Property | Description |\n|---|---|\n| `--uf-avatar-size` | Width and height. Overrides `size`. |\n| `--uf-avatar-bg` | Background behind initials and icon. |\n| `--uf-avatar-color` | Color of the initials and icon. |\n| `--uf-avatar-radius` | Corner radius. Overrides `shape`. |\n"
|
|
40
|
+
},
|
|
41
|
+
{
|
|
42
|
+
"name": "badge",
|
|
43
|
+
"title": "Badge",
|
|
44
|
+
"summary": "Labels a status, a category or a count.",
|
|
45
|
+
"tags": [
|
|
46
|
+
"uf-badge"
|
|
47
|
+
],
|
|
48
|
+
"imports": [
|
|
49
|
+
"@unframed/core/badge"
|
|
50
|
+
],
|
|
51
|
+
"docs": "# Badge\n\nA short label for a status, a category or a count. It's plain text for\nassistive tech: write text that makes sense out of context (\"3 unread\", not\njust \"3\"), or describe it in the surrounding element's label.\n\nTags: `<uf-badge>`. Import: `import '@unframed/core/badge';` (or `npx @unframed/cli add badge` to copy the source).\n\n## Variants\n\nSix colors by meaning, in three appearances: `soft` (the default), `solid` and `outline`.\n\n```html\n<uf-badge>Draft</uf-badge>\n<uf-badge variant=\"success\">Paid</uf-badge>\n<uf-badge variant=\"warning\" appearance=\"solid\">Expiring</uf-badge>\n<uf-badge variant=\"info\" appearance=\"outline\">Beta</uf-badge>\n```\n\n## Dot, icon and size\n\n```html\n<uf-badge dot variant=\"success\">Online</uf-badge>\n<uf-badge variant=\"success\"><uf-icon slot=\"prefix\" name=\"check-circle\"></uf-icon>Verified</uf-badge>\n<uf-badge size=\"sm\" variant=\"accent\">New</uf-badge>\n```\n\n- Badges are read as plain text: write \"3 unread\" rather than \"3\", so the badge makes sense on its own.\n\n## `<uf-badge>` API\n\n### Attributes and properties\n\n| Attribute | Property | Type | Default | Description |\n|---|---|---|---|---|\n| `variant` | | `BadgeVariant` | `'neutral'` | Color, by meaning: `neutral`, `accent`, `info`, `success`, `warning` or `danger`. |\n| `appearance` | | `BadgeAppearance` | `'soft'` | `soft` (tinted background), `solid` (bold background) or `outline` (border only). |\n| `size` | | `BadgeSize` | `'md'` | Size: `sm`, `md` or `lg`. |\n| `dot` | | `boolean` | `false` | Shows a status dot before the text. |\n\n### Slots\n\n| Slot | Description |\n|---|---|\n| (default) | The badge text. |\n| `prefix` | An icon before the text. |\n\n### CSS parts\n\n| Part | Description |\n|---|---|\n| `base` | The badge. |\n| `dot` | The status dot, when `dot` is set. |\n\n### CSS custom properties\n\n| Property | Description |\n|---|---|\n| `--uf-badge-bg` | Background color. |\n| `--uf-badge-color` | Text color. |\n| `--uf-badge-border-color` | Border color. |\n| `--uf-badge-radius` | Corner radius. Use `999px` for a pill. |\n"
|
|
52
|
+
},
|
|
53
|
+
{
|
|
54
|
+
"name": "breadcrumbs",
|
|
55
|
+
"title": "Breadcrumbs",
|
|
56
|
+
"summary": "Shows the path to the current page.",
|
|
57
|
+
"tags": [
|
|
58
|
+
"uf-breadcrumbs",
|
|
59
|
+
"uf-breadcrumb-item"
|
|
60
|
+
],
|
|
61
|
+
"imports": [
|
|
62
|
+
"@unframed/core/breadcrumbs"
|
|
63
|
+
],
|
|
64
|
+
"docs": "# Breadcrumbs\n\nShows where the current page sits in the site: a trail of links, from the\ntop level to here. It's a navigation landmark with a list inside, and the\nlast item is marked as the current page.\n\nTags: `<uf-breadcrumbs>`, `<uf-breadcrumb-item>`. Import: `import '@unframed/core/breadcrumbs';` (or `npx @unframed/cli add breadcrumbs` to copy the source).\n\n## Basic\n\nThe last item is the current page: it is not a link, and screen readers announce it as the current page.\n\n```html\n<uf-breadcrumbs>\n <uf-breadcrumb-item href=\"/\">Home</uf-breadcrumb-item>\n <uf-breadcrumb-item href=\"/docs\">Docs</uf-breadcrumb-item>\n <uf-breadcrumb-item>Theming</uf-breadcrumb-item>\n</uf-breadcrumbs>\n```\n\n- It is a navigation landmark named \"Breadcrumb\" (translatable), or `label`. Name it differently if a page has two.\n- Separators are hidden from screen readers, which announce the trail as a list.\n\n## Custom separator and an icon\n\nPut any element in the `separator` slot: it is copied between the items.\n\n```html\n<uf-breadcrumbs>\n <span slot=\"separator\">/</span>\n <uf-breadcrumb-item href=\"/people/john-smith\">\n <uf-icon slot=\"prefix\" name=\"user\"></uf-icon>John Smith\n </uf-breadcrumb-item>\n <uf-breadcrumb-item href=\"/people/john-smith/projects\">Projects</uf-breadcrumb-item>\n <uf-breadcrumb-item>Website redesign</uf-breadcrumb-item>\n</uf-breadcrumbs>\n```\n\n## `<uf-breadcrumbs>` API\n\n### Attributes and properties\n\n| Attribute | Property | Type | Default | Description |\n|---|---|---|---|---|\n| `label` | | `string \\| undefined` | | Accessible name of the navigation. Defaults to \"Breadcrumb\", in the page's language. |\n\n### Slots\n\n| Slot | Description |\n|---|---|\n| (default) | `<uf-breadcrumb-item>` elements. |\n| `separator` | A custom separator, e.g. `<span slot=\"separator\">/</span>`. Copied between the items. |\n\n### CSS parts\n\n| Part | Description |\n|---|---|\n| `base` | The `<nav>` element. |\n| `list` | The list of items. |\n\n## `<uf-breadcrumb-item>` API\n\n### Attributes and properties\n\n| Attribute | Property | Type | Default | Description |\n|---|---|---|---|---|\n| `href` | | `string \\| undefined` | | Link to this step. |\n| `target` | | `string \\| undefined` | | Link target, used with `href`. |\n| `current` | | `boolean` | `false` | The current page. `<uf-breadcrumbs>` sets it on the last item. |\n\n### Slots\n\n| Slot | Description |\n|---|---|\n| (default) | The label. |\n| `prefix` | An icon before the label. |\n| `separator` | Set by `<uf-breadcrumbs>`; you don't need it yourself. |\n\n### CSS parts\n\n| Part | Description |\n|---|---|\n| `link` | The link, for items with `href`. |\n| `label` | The current page's label, or an item without `href`. |\n| `separator` | The separator after the item. |\n"
|
|
65
|
+
},
|
|
66
|
+
{
|
|
67
|
+
"name": "button",
|
|
68
|
+
"title": "Button",
|
|
69
|
+
"summary": "Triggers an action or navigates to a URL.",
|
|
70
|
+
"tags": [
|
|
71
|
+
"uf-button"
|
|
72
|
+
],
|
|
73
|
+
"imports": [
|
|
74
|
+
"@unframed/core/button"
|
|
75
|
+
],
|
|
76
|
+
"docs": "# Button\n\nA button that works like a native `<button>`, inside or outside a form,\nor renders as a link when `href` is set.\n\nTags: `<uf-button>`. Import: `import '@unframed/core/button';` (or `npx @unframed/cli add button` to copy the source).\n\n## Variants\n\n```html\n<uf-button>Primary</uf-button>\n<uf-button variant=\"secondary\">Secondary</uf-button>\n<uf-button variant=\"outline\">Outline</uf-button>\n<uf-button variant=\"ghost\">Ghost</uf-button>\n<uf-button variant=\"danger\">Danger</uf-button>\n<uf-button variant=\"link\">Link</uf-button>\n```\n\n## Icons, sizes and states\n\nIcon-only buttons need a `label` for screen readers.\n\n```html\n<uf-button size=\"sm\"><uf-icon slot=\"prefix\" name=\"plus\"></uf-icon>New</uf-button>\n<uf-button size=\"lg\" variant=\"secondary\">Next<uf-icon slot=\"suffix\" name=\"chevron-right\"></uf-icon></uf-button>\n<uf-button variant=\"ghost\" label=\"Search\"><uf-icon slot=\"prefix\" name=\"search\"></uf-icon></uf-button>\n<uf-button loading>Saving</uf-button>\n<uf-button disabled>Disabled</uf-button>\n```\n\n## `<uf-button>` API\n\n### Attributes and properties\n\n| Attribute | Property | Type | Default | Description |\n|---|---|---|---|---|\n| `variant` | | `ButtonVariant` | `'primary'` | Visual style. |\n| `size` | | `ButtonSize` | `'md'` | Size of the button. |\n| `type` | | `ButtonType` | `'button'` | Behaviour inside a form. Defaults to `button` so it never submits by accident. |\n| `disabled` | | `boolean` | `false` | Disables the button. |\n| `loading` | | `boolean` | `false` | Shows a spinner and ignores clicks, while keeping the button focusable. |\n| `label` | | `string \\| undefined` | | Accessible name, for icon-only buttons. |\n| `href` | | `string \\| undefined` | | Renders the button as a link to this URL. |\n| `target` | | `string \\| undefined` | | Link target, used with `href`. |\n| `rel` | | `string \\| undefined` | | Link rel, used with `href`. Defaults to `noreferrer noopener` when `target=\"_blank\"`. |\n| `download` | | `string \\| undefined` | | Download filename, used with `href`. |\n\n### Properties only\n\n| Property | Type | Description |\n|---|---|---|\n| `form` | `HTMLFormElement \\| null` | Read-only. The form this button belongs to, if any. |\n\n### Slots\n\n| Slot | Description |\n|---|---|\n| (default) | The button's label. |\n| `prefix` | An icon or element before the label. |\n| `suffix` | An icon or element after the label. ARIA state set on the host (`aria-expanded`, `aria-haspopup`, `aria-pressed`, `aria-current`, `aria-description`) is forwarded to the inner button, so popovers, tooltips and toggle patterns work with it like with a native button. |\n\n### CSS parts\n\n| Part | Description |\n|---|---|\n| `base` | The inner `<button>` or `<a>`. |\n| `label` | The wrapper around the default slot. |\n| `prefix` | The prefix slot. |\n| `suffix` | The suffix slot. |\n| `spinner` | The loading spinner. |\n\n### CSS custom properties\n\n| Property | Description |\n|---|---|\n| `--uf-button-bg` | Background color (all states unless overridden). |\n| `--uf-button-bg-hover` | Background color on hover. |\n| `--uf-button-bg-active` | Background color while pressed. |\n| `--uf-button-color` | Text color. |\n| `--uf-button-border-color` | Border color. |\n| `--uf-button-radius` | Corner radius. |\n| `--uf-button-height` | Height. |\n| `--uf-button-padding` | Horizontal padding. |\n| `--uf-button-gap` | Space between prefix, label and suffix. |\n| `--uf-button-font-family` | Font family. |\n| `--uf-button-font-weight` | Font weight. |\n"
|
|
77
|
+
},
|
|
78
|
+
{
|
|
79
|
+
"name": "button-group",
|
|
80
|
+
"title": "Button group",
|
|
81
|
+
"summary": "Joins related buttons into one bar.",
|
|
82
|
+
"tags": [
|
|
83
|
+
"uf-button-group"
|
|
84
|
+
],
|
|
85
|
+
"imports": [
|
|
86
|
+
"@unframed/core/button-group"
|
|
87
|
+
],
|
|
88
|
+
"docs": "# Button group\n\nRelated buttons joined into one bar, like \"Bold / Italic / Underline\" or\n\"Save\" with a menu of other ways to save. For one choice among a few, use\n`<uf-segmented-control>` instead.\n\nNeighbors share one border, and only the outer corners are rounded. Filled\nand ghost buttons get a thin line between them. Buttons can be wrapped, in a\n`<uf-tooltip>` or as the trigger of a `<uf-dropdown>`, and stay joined.\n\nIt's a group for assistive tech: give it a `label` that says what the\nbuttons have in common.\n\nTags: `<uf-button-group>`. Import: `import '@unframed/core/button-group';` (or `npx @unframed/cli add button-group` to copy the source).\n\n## Basic\n\nRelated actions in one bar: neighbors share a border, and only the outer corners follow the theme radius. The `label` says what they have in common.\n\n```html\n<uf-button-group label=\"Clipboard\">\n <uf-button variant=\"outline\">Cut</uf-button>\n <uf-button variant=\"outline\">Copy</uf-button>\n <uf-button variant=\"outline\">Paste</uf-button>\n</uf-button-group>\n\n<uf-button-group label=\"Pages\">\n <uf-button variant=\"secondary\" label=\"Previous page\"><uf-icon slot=\"prefix\" name=\"chevron-left\"></uf-icon></uf-button>\n <uf-button variant=\"secondary\" label=\"Next page\"><uf-icon slot=\"prefix\" name=\"chevron-right\"></uf-icon></uf-button>\n</uf-button-group>\n```\n\n- To pick one of a few options, like \"Day / Week / Month\", use a segmented control: it keeps one selected and works as a radio group.\n\n## Split button\n\nA main action with a menu of other ways to do it. Buttons stay joined inside a dropdown or a tooltip, and filled or ghost buttons get a thin line between them.\n\n```html\n<uf-button-group label=\"Save\">\n <uf-button>Save</uf-button>\n <uf-dropdown placement=\"bottom-end\">\n <uf-button slot=\"trigger\" label=\"More ways to save\"><uf-icon slot=\"prefix\" name=\"chevron-down\"></uf-icon></uf-button>\n <uf-menu label=\"Save\">\n <uf-menu-item value=\"draft\">Save as draft</uf-menu-item>\n <uf-menu-item value=\"template\">Save as template</uf-menu-item>\n </uf-menu>\n </uf-dropdown>\n</uf-button-group>\n```\n\n## Vertical\n\n`orientation=\"vertical\"` stacks the buttons, as wide as the widest.\n\n```html\n<uf-button-group label=\"Align\" orientation=\"vertical\">\n <uf-button variant=\"outline\">Top</uf-button>\n <uf-button variant=\"outline\">Middle</uf-button>\n <uf-button variant=\"outline\">Bottom</uf-button>\n</uf-button-group>\n```\n\n## `<uf-button-group>` API\n\n### Attributes and properties\n\n| Attribute | Property | Type | Default | Description |\n|---|---|---|---|---|\n| `label` | | `string \\| undefined` | | What the buttons have in common, for assistive tech. |\n| `orientation` | | `ButtonGroupOrientation` | `'horizontal'` | Side by side, or stacked. |\n\n### Slots\n\n| Slot | Description |\n|---|---|\n| (default) | `<uf-button>` elements, alone or wrapped in a tooltip or dropdown. |\n"
|
|
89
|
+
},
|
|
90
|
+
{
|
|
91
|
+
"name": "card",
|
|
92
|
+
"title": "Card",
|
|
93
|
+
"summary": "Groups related content and actions.",
|
|
94
|
+
"tags": [
|
|
95
|
+
"uf-card"
|
|
96
|
+
],
|
|
97
|
+
"imports": [
|
|
98
|
+
"@unframed/core/card"
|
|
99
|
+
],
|
|
100
|
+
"docs": "# Card\n\nA container that groups related content: an optional image, a header, the\ncontent and actions. Empty sections take no space.\n\nA card is a plain container for assistive tech. To make a whole card a link,\nput a link in the header and let it cover the card with CSS, so the card's\nbuttons stay usable.\n\nTags: `<uf-card>`. Import: `import '@unframed/core/card';` (or `npx @unframed/cli add card` to copy the source).\n\n## Media, header, content and footer\n\nEvery section is optional; empty ones take no space.\n\n```html\n<uf-card>\n <img slot=\"media\" src=\"/cover.png\" alt=\"The Unframed logo\" />\n <div slot=\"header\">\n <h3>Unframed 0.2</h3>\n <small>Released this week</small>\n </div>\n A link button variant, new colors and smaller Angular bundles.\n <uf-button slot=\"footer\">Read more</uf-button>\n <uf-button slot=\"footer\" variant=\"ghost\">Dismiss</uf-button>\n</uf-card>\n```\n\n## Appearance and orientation\n\n```html\n<uf-card appearance=\"elevated\">…</uf-card>\n<uf-card appearance=\"filled\">…</uf-card>\n<uf-card orientation=\"horizontal\">\n <img slot=\"media\" src=\"/cover.png\" alt=\"\" />\n Media beside the content.\n</uf-card>\n```\n\n## `<uf-card>` API\n\n### Attributes and properties\n\n| Attribute | Property | Type | Default | Description |\n|---|---|---|---|---|\n| `appearance` | | `CardAppearance` | `'outline'` | `outline` (a border), `elevated` (a shadow, or an accent glow in dark mode) or `filled` (a tinted background). |\n| `orientation` | | `CardOrientation` | `'vertical'` | `vertical`, or `horizontal` to put the media beside the content. |\n\n### Slots\n\n| Slot | Description |\n|---|---|\n| (default) | The main content. |\n| `media` | An image or video, edge to edge at the top (or the start, when horizontal). |\n| `header` | The title area, e.g. a heading and a subtitle. |\n| `footer` | Actions or details at the bottom. |\n\n### CSS parts\n\n| Part | Description |\n|---|---|\n| `base` | The card. |\n| `media` | The media wrapper. |\n| `header` | The header wrapper. |\n| `body` | The main content wrapper. |\n| `footer` | The footer wrapper. |\n\n### CSS custom properties\n\n| Property | Description |\n|---|---|\n| `--uf-card-padding` | Padding of header, body and footer. |\n| `--uf-card-bg` | Background color. |\n| `--uf-card-border-color` | Border color. |\n| `--uf-card-radius` | Corner radius. |\n| `--uf-card-shadow` | Shadow of an elevated card. Defaults to a soft shadow in light mode and an accent glow in dark mode. |\n| `--uf-card-media-width` | Width of the media in a horizontal card. Defaults to 40%. |\n"
|
|
101
|
+
},
|
|
102
|
+
{
|
|
103
|
+
"name": "checkbox",
|
|
104
|
+
"title": "Checkbox",
|
|
105
|
+
"summary": "Lets users turn an option on or off, or pick several options.",
|
|
106
|
+
"tags": [
|
|
107
|
+
"uf-checkbox",
|
|
108
|
+
"uf-checkbox-group"
|
|
109
|
+
],
|
|
110
|
+
"imports": [
|
|
111
|
+
"@unframed/core/checkbox",
|
|
112
|
+
"@unframed/core/checkbox-group"
|
|
113
|
+
],
|
|
114
|
+
"docs": "# Checkbox\n\nA checkbox with its label as content.\n\nTags: `<uf-checkbox>`, `<uf-checkbox-group>`. Import: `import '@unframed/core/checkbox';`, `import '@unframed/core/checkbox-group';` (or `npx @unframed/cli add checkbox checkbox-group` to copy the source).\n\n## States\n\n```html\n<uf-checkbox checked hint=\"One email a month.\">Subscribe to the newsletter</uf-checkbox>\n<uf-checkbox indeterminate>Select all</uf-checkbox>\n<uf-checkbox disabled>Disabled</uf-checkbox>\n```\n\n## Select all\n\n```html\n<uf-checkbox-group label=\"Toppings\">\n <uf-checkbox select-all>All toppings</uf-checkbox>\n <uf-checkbox name=\"topping\" value=\"cheese\">Cheese</uf-checkbox>\n <uf-checkbox name=\"topping\" value=\"olives\" checked>Olives</uf-checkbox>\n <uf-checkbox name=\"topping\" value=\"basil\">Basil</uf-checkbox>\n</uf-checkbox-group>\n```\n\n## Binding the indeterminate state\n\n```html\n<uf-checkbox indeterminate>Notify me</uf-checkbox>\n```\n\n## `<uf-checkbox>` API\n\n### Attributes and properties\n\n| Attribute | Property | Type | Default | Description |\n|---|---|---|---|---|\n| `indeterminate` | | `boolean` | `false` | Shows a dash instead of a check, for \"some selected\". Cleared when the user clicks. |\n| `select-all` | `selectAll` | `boolean` | `false` | Inside `<uf-checkbox-group>`: checks or unchecks every other checkbox in the group, and shows checked, unchecked or indeterminate to match them. |\n| `hint` | | `string \\| undefined` | | Help text below the label. |\n| `checked` | `defaultChecked` | `boolean` | `false` | Initial state, restored on form reset. Set with the `checked` attribute. |\n| `value` | | `string` | `'on'` | Value submitted with the form when checked. |\n| `size` | | `FieldSize` | `'md'` | Size of the control and its label: `sm`, `md` or `lg`. |\n| `name` | | `string` | `''` | Name submitted with the form. |\n| `disabled` | | `boolean` | `false` | Disables the control. |\n| `required` | | `boolean` | `false` | Makes the control required for form submission. |\n\n### Properties only\n\n| Property | Type | Description |\n|---|---|---|\n| `checked` | `boolean` | Whether the control is on. |\n| `form` | `HTMLFormElement \\| null` | Read-only. The form this control belongs to, if any. |\n| `validity` | `ValidityState` | Read-only. The control's validity state, like a native input's. |\n| `validationMessage` | `string` | Read-only. The error message shown when the value is invalid. |\n| `willValidate` | `boolean` | Read-only. Whether the control takes part in form validation. |\n\n### Methods\n\n| Method | Description |\n|---|---|\n| `toggle()` | Toggles the control, as if the user clicked it. |\n| `checkValidity()` | Returns whether the value is valid, without showing an error. |\n| `reportValidity()` | Returns whether the value is valid, and shows the error if not. |\n| `setCustomValidity(message: string)` | Sets a custom error message. Pass an empty string to clear it. |\n\n### Events\n\n| Event | Type | Description |\n|---|---|---|\n| `input` | | Fired when the checked state changes. |\n| `change` | `Event` | Fired when the checked state changes. |\n\n### Slots\n\n| Slot | Description |\n|---|---|\n| (default) | The label. |\n| `hint` | Help text below the label. Overrides `hint`. |\n\n### CSS parts\n\n| Part | Description |\n|---|---|\n| `base` | The `<label>` wrapping control and label. |\n| `control` | The box. |\n| `checkmark` | The check or dash icon. |\n| `label` | The label text. |\n| `hint` | The hint text. |\n| `error` | The validation message. |\n\n### CSS custom properties\n\n| Property | Description |\n|---|---|\n| `--uf-checkbox-size` | Size of the box. |\n| `--uf-checkbox-radius` | Corner radius of the box. |\n| `--uf-checkbox-checked-bg` | Background when checked. |\n| `--uf-checkbox-indeterminate-bg` | Background when indeterminate. Defaults to the checked background. |\n\n## `<uf-checkbox-group>` API\n\n### Attributes and properties\n\n| Attribute | Property | Type | Default | Description |\n|---|---|---|---|---|\n| `label` | | `string \\| undefined` | | Visible group label. |\n| `hint` | | `string \\| undefined` | | Help text below the checkboxes. |\n| `orientation` | | `'vertical' \\| 'horizontal'` | `'vertical'` | Lays the checkboxes out in a column or a row. |\n\n### Properties only\n\n| Property | Type | Description |\n|---|---|---|\n| `value` | `string[]` | The values of the checked checkboxes (other than \"select all\"). |\n\n### Events\n\n| Event | Type | Description |\n|---|---|---|\n| `change` | | A checkbox in the group changed (including through \"select all\"). |\n\n### Slots\n\n| Slot | Description |\n|---|---|\n| (default) | `<uf-checkbox>` elements. |\n| `label` | The group label, when you need markup. Overrides `label`. |\n| `hint` | Help text below the checkboxes. Overrides `hint`. |\n\n### CSS parts\n\n| Part | Description |\n|---|---|\n| `base` | The element with `role=\"group\"`. |\n| `form-label` | The group label. |\n| `options` | The wrapper around the checkboxes. |\n| `hint` | The hint text. |\n\n### CSS custom properties\n\n| Property | Description |\n|---|---|\n| `--uf-checkbox-group-indent` | Indent of the checkboxes under a \"select all\". |\n"
|
|
115
|
+
},
|
|
116
|
+
{
|
|
117
|
+
"name": "combobox",
|
|
118
|
+
"title": "Combobox",
|
|
119
|
+
"summary": "Lets users search a list and pick one option.",
|
|
120
|
+
"tags": [
|
|
121
|
+
"uf-combobox"
|
|
122
|
+
],
|
|
123
|
+
"imports": [
|
|
124
|
+
"@unframed/core/combobox"
|
|
125
|
+
],
|
|
126
|
+
"docs": "# Combobox\n\nA text field with a filterable list of options, following the WAI-ARIA\ncombobox pattern. Typing filters the list; arrow keys move through it and\nEnter picks an option. Only listed values can be chosen. Write options as\nplain `<option>` and `<optgroup>` children, like `<uf-select>`.\n\nTags: `<uf-combobox>`. Import: `import '@unframed/core/combobox';` (or `npx @unframed/cli add combobox` to copy the source).\n\n## Searchable list\n\nType to filter, arrow keys to move, Enter to pick.\n\n```html\n<uf-combobox label=\"Time zone\" placeholder=\"Search time zones\">\n <optgroup label=\"Europe\">\n <option value=\"Europe/Rome\">Rome</option>\n <option value=\"Europe/Paris\">Paris</option>\n </optgroup>\n <!-- … -->\n</uf-combobox>\n```\n\n## `<uf-combobox>` API\n\n### Attributes and properties\n\n| Attribute | Property | Type | Default | Description |\n|---|---|---|---|---|\n| `value` | `defaultValue` | `string \\| undefined` | | Initially selected value, restored on form reset. Set with the `value` attribute. |\n| `label` | | `string \\| undefined` | | Visible label. |\n| `hint` | | `string \\| undefined` | | Help text below the field. |\n| `placeholder` | | `string \\| undefined` | | Placeholder text in the field. |\n| `size` | | `FieldSize` | `'md'` | Size of the field. |\n| `open` | | `boolean` | `false` | Whether the list is showing. |\n| `name` | | `string` | `''` | Name submitted with the form. |\n| `disabled` | | `boolean` | `false` | Disables the control. |\n| `required` | | `boolean` | `false` | Makes the control required for form submission. |\n\n### Properties only\n\n| Property | Type | Description |\n|---|---|---|\n| `value` | `string` | The selected option's value, or an empty string. |\n| `form` | `HTMLFormElement \\| null` | Read-only. The form this control belongs to, if any. |\n| `validity` | `ValidityState` | Read-only. The control's validity state, like a native input's. |\n| `validationMessage` | `string` | Read-only. The error message shown when the value is invalid. |\n| `willValidate` | `boolean` | Read-only. Whether the control takes part in form validation. |\n\n### Methods\n\n| Method | Description |\n|---|---|\n| `show()` | Opens the list. |\n| `hide()` | Closes the list. |\n| `checkValidity()` | Returns whether the value is valid, without showing an error. |\n| `reportValidity()` | Returns whether the value is valid, and shows the error if not. |\n| `setCustomValidity(message: string)` | Sets a custom error message. Pass an empty string to clear it. |\n\n### Events\n\n| Event | Type | Description |\n|---|---|---|\n| `uf-show` | `Event` | The list opened. |\n| `uf-hide` | `Event` | The list closed. |\n| `input` | | Fired as the user types in the field (the search text, not the value). |\n| `change` | `Event` | Fired when the selected value changes. |\n\n### Slots\n\n| Slot | Description |\n|---|---|\n| (default) | `<option>` and `<optgroup>` elements. They are read, not rendered. |\n| `label` | The label, when you need markup. Overrides `label`. |\n| `hint` | Help text below the field. Overrides `hint`. |\n| `prefix` | An icon before the input. |\n\n### CSS parts\n\n| Part | Description |\n|---|---|\n| `field` | The wrapper around label, control, hint and error. |\n| `form-label` | The label. |\n| `box` | The bordered box. |\n| `input` | The native `<input>`. |\n| `toggle` | The button that opens the list. |\n| `listbox` | The floating list. |\n| `option` | Each option. |\n| `group-label` | Each group heading. |\n| `empty` | The \"no results\" message. |\n| `hint` | The hint text. |\n| `error` | The validation message. |\n\n### CSS custom properties\n\n| Property | Description |\n|---|---|\n| `--uf-combobox-max-height` | Maximum height of the list before it scrolls. |\n| `--uf-field-bg` | Background of the box. |\n| `--uf-field-border-color` | Border color of the box. |\n| `--uf-field-radius` | Corner radius of the box. |\n"
|
|
127
|
+
},
|
|
128
|
+
{
|
|
129
|
+
"name": "date-picker",
|
|
130
|
+
"title": "Date picker",
|
|
131
|
+
"summary": "Lets users type or pick a date.",
|
|
132
|
+
"tags": [
|
|
133
|
+
"uf-date-picker",
|
|
134
|
+
"uf-calendar"
|
|
135
|
+
],
|
|
136
|
+
"imports": [
|
|
137
|
+
"@unframed/core/date-picker",
|
|
138
|
+
"@unframed/core/calendar"
|
|
139
|
+
],
|
|
140
|
+
"docs": "# Date picker\n\nA date field: type a date in the page language's format, or pick one from a\ncalendar. The value is always `YYYY-MM-DD`, like `<input type=\"date\">`, so\nit's the same in every language and submits with the form.\n\nAlt + Down Arrow opens the calendar; Escape closes it.\n\nTags: `<uf-date-picker>`, `<uf-calendar>`. Import: `import '@unframed/core/date-picker';`, `import '@unframed/core/calendar';` (or `npx @unframed/cli add date-picker calendar` to copy the source).\n\n## Type or pick a date\n\nType a date in the page language's format, or open the calendar. The value is always `YYYY-MM-DD`.\n\n```html\n<uf-date-picker label=\"Check-in\" hint=\"From 3 pm\" name=\"checkin\" min=\"2026-10-14\" required></uf-date-picker>\n```\n\n- Arrow keys move by day and week, Page Up and Page Down by month (with Shift, by year). Alt + Down Arrow opens the calendar, Escape closes it.\n- The format, month names and first day of the week follow the nearest `lang` attribute: `14/10/2026` in Italian, `10/14/2026` in US English.\n- Typed text that isn't a date stays in the field with an error, so the user can fix it.\n\n## Disabled dates\n\n`min` and `max` limit the range; `isDateDisabled` rules out single dates, like weekends.\n\n```html\n<uf-date-picker id=\"delivery\" label=\"Delivery day\" hint=\"Weekdays only\"></uf-date-picker>\n\n<script type=\"module\">\n // A property, not an attribute: it's a function.\n document.querySelector('#delivery').isDateDisabled = (date) =>\n [0, 6].includes(new Date(date).getUTCDay());\n</script>\n```\n\n## Calendar on its own\n\n`<uf-calendar>` is the grid inside the picker. Use it inline, e.g. on a booking page.\n\n```html\n<uf-calendar value=\"2026-10-14\"></uf-calendar>\n\n<script type=\"module\">\n document.querySelector('uf-calendar').addEventListener('change', (event) => {\n console.log(event.target.value); // \"2026-10-21\"\n });\n</script>\n```\n\n## `<uf-date-picker>` API\n\n### Attributes and properties\n\n| Attribute | Property | Type | Default | Description |\n|---|---|---|---|---|\n| `value` | `defaultValue` | `string` | `''` | Initial date, restored on form reset. Set with the `value` attribute, as `YYYY-MM-DD`. |\n| `label` | | `string \\| undefined` | | The field's label, also its accessible name. |\n| `hint` | | `string \\| undefined` | | Help text below the field. |\n| `placeholder` | | `string \\| undefined` | | Shown when empty. Defaults to the date format, e.g. dd/mm/yyyy. |\n| `size` | | `FieldSize` | `'md'` | Size: `sm`, `md` or `lg`. |\n| `min` | | `string \\| undefined` | | The earliest allowed date, as `YYYY-MM-DD`. |\n| `max` | | `string \\| undefined` | | The latest allowed date, as `YYYY-MM-DD`. |\n| `readonly` | | `boolean` | `false` | Lets the user select the text but not change the date. |\n| `open` | | `boolean` | `false` | Whether the calendar is open. |\n| `name` | | `string` | `''` | Name submitted with the form. |\n| `disabled` | | `boolean` | `false` | Disables the control. |\n| `required` | | `boolean` | `false` | Makes the control required for form submission. |\n\n### Properties only\n\n| Property | Type | Description |\n|---|---|---|\n| `value` | `string` | The date, as `YYYY-MM-DD`, or an empty string. |\n| `isDateDisabled` | `((date: string) => boolean) \\| undefined` | Rules out dates, e.g. weekends: called with each date as `YYYY-MM-DD`, returns true to disable it. |\n| `form` | `HTMLFormElement \\| null` | Read-only. The form this control belongs to, if any. |\n| `validity` | `ValidityState` | Read-only. The control's validity state, like a native input's. |\n| `validationMessage` | `string` | Read-only. The error message shown when the value is invalid. |\n| `willValidate` | `boolean` | Read-only. Whether the control takes part in form validation. |\n\n### Methods\n\n| Method | Description |\n|---|---|\n| `show()` | Opens the calendar. |\n| `hide()` | Closes the calendar. |\n| `checkValidity()` | Returns whether the value is valid, without showing an error. |\n| `reportValidity()` | Returns whether the value is valid, and shows the error if not. |\n| `setCustomValidity(message: string)` | Sets a custom error message. Pass an empty string to clear it. |\n\n### Events\n\n| Event | Type | Description |\n|---|---|---|\n| `input` | `Event` | The value changed (a date was typed and committed, or picked). |\n| `change` | `Event` | The value changed (a date was typed and committed, or picked). |\n| `uf-show` | | The calendar opened. |\n| `uf-hide` | | The calendar closed. |\n\n### Slots\n\n| Slot | Description |\n|---|---|\n| `label` | The label, when you need markup. Overrides `label`. |\n| `hint` | Help text below the field. Overrides `hint`. |\n\n### CSS parts\n\n| Part | Description |\n|---|---|\n| `field` | The wrapper around label, control, hint and error. |\n| `form-label` | The label. |\n| `box` | The bordered box around the input. |\n| `input` | The text input. |\n| `toggle` | The calendar button. |\n| `popup` | The floating panel around the calendar. |\n| `calendar` | The `<uf-calendar>`. |\n| `hint` | The hint text. |\n| `error` | The validation message. |\n\n### CSS custom properties\n\n| Property | Description |\n|---|---|\n| `--uf-field-bg` | Background of the box. |\n| `--uf-field-border-color` | Border color of the box. |\n| `--uf-field-radius` | Corner radius of the box. |\n\n## `<uf-calendar>` API\n\n### Attributes and properties\n\n| Attribute | Property | Type | Default | Description |\n|---|---|---|---|---|\n| `value` | | `string` | `''` | The selected date, as `YYYY-MM-DD`, or an empty string. |\n| `min` | | `string \\| undefined` | | The earliest date that can be picked, as `YYYY-MM-DD`. |\n| `max` | | `string \\| undefined` | | The latest date that can be picked, as `YYYY-MM-DD`. |\n| `first-day-of-week` | `firstDayOfWeek` | `number \\| undefined` | | First day of the week: 0 Sunday … 6 Saturday. Defaults to the language's. |\n| `range` | | `boolean` | `false` | Picks a range, from `start` to `end`, instead of one date. |\n| `start` | | `string` | `''` | With `range`, the first date of the range, as `YYYY-MM-DD`, or an empty string. |\n| `end` | | `string` | `''` | With `range`, the last date of the range, as `YYYY-MM-DD`, or an empty string. |\n\n### Properties only\n\n| Property | Type | Description |\n|---|---|---|\n| `isDateDisabled` | `((date: string) => boolean) \\| undefined` | Rules out dates, e.g. weekends: called with each date as `YYYY-MM-DD`, returns true to disable it. |\n\n### Methods\n\n| Method | Description |\n|---|---|\n| `focus(options: FocusOptions)` | Moves keyboard focus to the selected day, or today. |\n\n### Events\n\n| Event | Type | Description |\n|---|---|---|\n| `change` | `Event` | The user picked a date (read `value`), or, with `range`, completed a range (read `start` and `end`). |\n\n### CSS parts\n\n| Part | Description |\n|---|---|\n| `base` | The calendar. |\n| `header` | The month title and the previous and next buttons. |\n| `title` | The month and year. |\n| `nav-button` | The previous and next month buttons. |\n| `grid` | The `<table>` of days. |\n| `weekday` | A weekday heading. |\n| `day` | Every day. |\n| `selected` | The selected day. |\n| `today` | Today. |\n| `range-start` | With `range`, the start date. |\n| `range-end` | With `range`, the end date. |\n| `in-range` | With `range`, a day between the start and the end. |\n\n### CSS custom properties\n\n| Property | Description |\n|---|---|\n| `--uf-calendar-day-size` | Width and height of a day. |\n"
|
|
141
|
+
},
|
|
142
|
+
{
|
|
143
|
+
"name": "date-range-picker",
|
|
144
|
+
"title": "Date range picker",
|
|
145
|
+
"summary": "Lets users type or pick a start and an end date.",
|
|
146
|
+
"tags": [
|
|
147
|
+
"uf-date-range-picker",
|
|
148
|
+
"uf-calendar"
|
|
149
|
+
],
|
|
150
|
+
"imports": [
|
|
151
|
+
"@unframed/core/date-range-picker",
|
|
152
|
+
"@unframed/core/calendar"
|
|
153
|
+
],
|
|
154
|
+
"docs": "# Date range picker\n\nA date range field: type the start and end dates in the page language's\nformat, or pick both from a calendar. The value is an ISO 8601 interval,\n`YYYY-MM-DD/YYYY-MM-DD`, the same in every language, and it submits with the\nform; `start` and `end` hold the two dates.\n\nAlt + Down Arrow opens the calendar; Escape closes it.\n\nTags: `<uf-date-range-picker>`, `<uf-calendar>`. Import: `import '@unframed/core/date-range-picker';`, `import '@unframed/core/calendar';` (or `npx @unframed/cli add date-range-picker calendar` to copy the source).\n\n## Basic\n\nType the two dates, or pick them in the calendar: the first click sets the start, the second the end.\n\n```html\n<uf-date-range-picker name=\"stay\" label=\"Stay\" hint=\"Check-in from 3 pm\"></uf-date-range-picker>\n```\n\n- The value is an ISO 8601 interval, `2026-10-14/2026-10-18`, the same in every language; `start` and `end` hold the two dates.\n- The format, month names and first day of the week follow the nearest `lang`.\n\n## Limits and validation\n\n`min`, `max` and `isDateDisabled`, as in the date picker. A missing or reversed date gets its own message.\n\n```html\n<uf-date-range-picker name=\"leave\" label=\"Leave\" required min=\"2026-10-20\" max=\"2027-01-18\"></uf-date-range-picker>\n<script>\n // A function, so it's set as a property.\n document.querySelector('uf-date-range-picker').isDateDisabled = (iso) => [0, 6].includes(new Date(iso).getUTCDay());\n</script>\n```\n\n## Calendar on its own\n\n`<uf-calendar range>` picks a range inline, e.g. on a booking page. `change` fires when both dates are picked.\n\n```html\n<uf-calendar range start=\"2026-10-22\" end=\"2026-10-26\"></uf-calendar>\n```\n\n## `<uf-date-range-picker>` API\n\n### Attributes and properties\n\n| Attribute | Property | Type | Default | Description |\n|---|---|---|---|---|\n| `value` | `defaultValue` | `string` | `''` | Initial range, restored on form reset. Set with the `value` attribute, as `YYYY-MM-DD/YYYY-MM-DD`. |\n| `label` | | `string \\| undefined` | | The field's label, also its accessible name. |\n| `hint` | | `string \\| undefined` | | Help text below the field. |\n| `placeholder` | | `string \\| undefined` | | Shown in both inputs when empty. Defaults to the date format, e.g. dd/mm/yyyy. |\n| `size` | | `FieldSize` | `'md'` | Size: `sm`, `md` or `lg`. |\n| `min` | | `string \\| undefined` | | The earliest allowed date, as `YYYY-MM-DD`. |\n| `max` | | `string \\| undefined` | | The latest allowed date, as `YYYY-MM-DD`. |\n| `readonly` | | `boolean` | `false` | Lets the user select the text but not change the dates. |\n| `open` | | `boolean` | `false` | Whether the calendar is open. |\n| `name` | | `string` | `''` | Name submitted with the form. |\n| `disabled` | | `boolean` | `false` | Disables the control. |\n| `required` | | `boolean` | `false` | Makes the control required for form submission. |\n\n### Properties only\n\n| Property | Type | Description |\n|---|---|---|\n| `start` | `string` | The first date of the range, as `YYYY-MM-DD`, or an empty string. |\n| `end` | `string` | The last date of the range, as `YYYY-MM-DD`, or an empty string. |\n| `isDateDisabled` | `((date: string) => boolean) \\| undefined` | Rules out dates, e.g. weekends: called with each date as `YYYY-MM-DD`, returns true to disable it. |\n| `value` | `string` | The range as an ISO 8601 interval, `YYYY-MM-DD/YYYY-MM-DD`, or an empty string until both dates are set. |\n| `form` | `HTMLFormElement \\| null` | Read-only. The form this control belongs to, if any. |\n| `validity` | `ValidityState` | Read-only. The control's validity state, like a native input's. |\n| `validationMessage` | `string` | Read-only. The error message shown when the value is invalid. |\n| `willValidate` | `boolean` | Read-only. Whether the control takes part in form validation. |\n\n### Methods\n\n| Method | Description |\n|---|---|\n| `show()` | Opens the calendar. |\n| `hide()` | Closes the calendar. |\n| `checkValidity()` | Returns whether the value is valid, without showing an error. |\n| `reportValidity()` | Returns whether the value is valid, and shows the error if not. |\n| `setCustomValidity(message: string)` | Sets a custom error message. Pass an empty string to clear it. |\n\n### Events\n\n| Event | Type | Description |\n|---|---|---|\n| `input` | `Event` | The range changed (a date was typed and committed, or both were picked). |\n| `change` | `Event` | The range changed (a date was typed and committed, or both were picked). |\n| `uf-show` | | The calendar opened. |\n| `uf-hide` | | The calendar closed. |\n\n### Slots\n\n| Slot | Description |\n|---|---|\n| `label` | The label, when you need markup. Overrides `label`. |\n| `hint` | Help text below the field. Overrides `hint`. |\n\n### CSS parts\n\n| Part | Description |\n|---|---|\n| `field` | The wrapper around label, control, hint and error. |\n| `form-label` | The label. |\n| `box` | The bordered box around the inputs. |\n| `start-input` | The start date input. |\n| `end-input` | The end date input. |\n| `separator` | The dash between the two inputs. |\n| `toggle` | The calendar button. |\n| `popup` | The floating panel around the calendar. |\n| `calendar` | The `<uf-calendar>`. |\n| `hint` | The hint text. |\n| `error` | The validation message. |\n\n### CSS custom properties\n\n| Property | Description |\n|---|---|\n| `--uf-field-bg` | Background of the box. |\n| `--uf-field-border-color` | Border color of the box. |\n| `--uf-field-radius` | Corner radius of the box. |\n\n## `<uf-calendar>` API\n\n### Attributes and properties\n\n| Attribute | Property | Type | Default | Description |\n|---|---|---|---|---|\n| `value` | | `string` | `''` | The selected date, as `YYYY-MM-DD`, or an empty string. |\n| `min` | | `string \\| undefined` | | The earliest date that can be picked, as `YYYY-MM-DD`. |\n| `max` | | `string \\| undefined` | | The latest date that can be picked, as `YYYY-MM-DD`. |\n| `first-day-of-week` | `firstDayOfWeek` | `number \\| undefined` | | First day of the week: 0 Sunday … 6 Saturday. Defaults to the language's. |\n| `range` | | `boolean` | `false` | Picks a range, from `start` to `end`, instead of one date. |\n| `start` | | `string` | `''` | With `range`, the first date of the range, as `YYYY-MM-DD`, or an empty string. |\n| `end` | | `string` | `''` | With `range`, the last date of the range, as `YYYY-MM-DD`, or an empty string. |\n\n### Properties only\n\n| Property | Type | Description |\n|---|---|---|\n| `isDateDisabled` | `((date: string) => boolean) \\| undefined` | Rules out dates, e.g. weekends: called with each date as `YYYY-MM-DD`, returns true to disable it. |\n\n### Methods\n\n| Method | Description |\n|---|---|\n| `focus(options: FocusOptions)` | Moves keyboard focus to the selected day, or today. |\n\n### Events\n\n| Event | Type | Description |\n|---|---|---|\n| `change` | `Event` | The user picked a date (read `value`), or, with `range`, completed a range (read `start` and `end`). |\n\n### CSS parts\n\n| Part | Description |\n|---|---|\n| `base` | The calendar. |\n| `header` | The month title and the previous and next buttons. |\n| `title` | The month and year. |\n| `nav-button` | The previous and next month buttons. |\n| `grid` | The `<table>` of days. |\n| `weekday` | A weekday heading. |\n| `day` | Every day. |\n| `selected` | The selected day. |\n| `today` | Today. |\n| `range-start` | With `range`, the start date. |\n| `range-end` | With `range`, the end date. |\n| `in-range` | With `range`, a day between the start and the end. |\n\n### CSS custom properties\n\n| Property | Description |\n|---|---|\n| `--uf-calendar-day-size` | Width and height of a day. |\n"
|
|
155
|
+
},
|
|
156
|
+
{
|
|
157
|
+
"name": "dialog",
|
|
158
|
+
"title": "Dialog",
|
|
159
|
+
"summary": "Shows content in a modal window on top of the page.",
|
|
160
|
+
"tags": [
|
|
161
|
+
"uf-dialog"
|
|
162
|
+
],
|
|
163
|
+
"imports": [
|
|
164
|
+
"@unframed/core/dialog"
|
|
165
|
+
],
|
|
166
|
+
"docs": "# Dialog\n\nA modal dialog built on the native `<dialog>`: it renders in the top layer,\ntraps focus, makes the page inert, and returns focus to the opener on close.\nAny element inside with `data-dialog=\"close\"` closes it.\n\nTags: `<uf-dialog>`. Import: `import '@unframed/core/dialog';` (or `npx @unframed/cli add dialog` to copy the source).\n\n## Confirmation\n\nEscape, the close button and any element with `data-dialog=\"close\"` close it.\n\n```html\n<uf-button variant=\"danger\" onclick=\"this.nextElementSibling.show()\">Delete project…</uf-button>\n<uf-dialog label=\"Delete project?\" light-dismiss>\n <p>This permanently deletes the project and its 128 issues.</p>\n <uf-button slot=\"footer\" variant=\"ghost\" data-dialog=\"close\">Cancel</uf-button>\n <uf-button slot=\"footer\" variant=\"danger\">Delete</uf-button>\n</uf-dialog>\n```\n\n## `<uf-dialog>` API\n\n### Attributes and properties\n\n| Attribute | Property | Type | Default | Description |\n|---|---|---|---|---|\n| `open` | | `boolean` | `false` | Whether the dialog is open. |\n| `label` | | `string \\| undefined` | | Title of the dialog, also its accessible name. |\n| `light-dismiss` | `lightDismiss` | `boolean` | `false` | Closes the dialog when the backdrop is clicked. |\n| `without-header` | `withoutHeader` | `boolean` | `false` | Hides the header. Set `label` anyway, so the dialog keeps an accessible name. |\n\n### Methods\n\n| Method | Description |\n|---|---|\n| `show()` | Opens the dialog. |\n| `hide()` | Closes the dialog, without firing `uf-request-close`. |\n| `requestClose(source?: DialogCloseSource)` | Asks to close, as a user action would. Listeners can cancel it. |\n\n### Events\n\n| Event | Type | Description |\n|---|---|---|\n| `uf-show` | `Event` | The dialog opened. |\n| `uf-hide` | `Event` | The dialog closed. |\n| `uf-request-close` | `CustomEvent<DialogRequestCloseDetail>` | The user tried to close the dialog. Call `preventDefault()` to keep it open. |\n\n### Slots\n\n| Slot | Description |\n|---|---|\n| (default) | The dialog content. |\n| `label` | The title, when you need markup. Overrides `label`. |\n| `header-actions` | Extra buttons next to the close button. |\n| `footer` | Actions at the bottom, usually buttons. |\n\n### CSS parts\n\n| Part | Description |\n|---|---|\n| `dialog` | The native `<dialog>`. |\n| `header` | The header with title and close button. |\n| `title` | The title. |\n| `close-button` | The close button. |\n| `body` | The content area. |\n| `footer` | The footer. |\n\n### CSS custom properties\n\n| Property | Description |\n|---|---|\n| `--uf-dialog-bg` | Background of the dialog. |\n| `--uf-dialog-width` | Width of the dialog. Defaults to `32rem`. |\n| `--uf-dialog-padding` | Padding of header, body and footer. |\n| `--uf-dialog-radius` | Corner radius. |\n| `--uf-dialog-backdrop` | Backdrop color. |\n"
|
|
167
|
+
},
|
|
168
|
+
{
|
|
169
|
+
"name": "divider",
|
|
170
|
+
"title": "Divider",
|
|
171
|
+
"summary": "Separates groups of content with a line.",
|
|
172
|
+
"tags": [
|
|
173
|
+
"uf-divider"
|
|
174
|
+
],
|
|
175
|
+
"imports": [
|
|
176
|
+
"@unframed/core/divider"
|
|
177
|
+
],
|
|
178
|
+
"docs": "# Divider\n\nA line between groups of content, across or beside them. Assistive tech\nannounces it as a separator. With a label (\"or\"), the label is read as plain\ntext and the line around it is decorative.\n\nTags: `<uf-divider>`. Import: `import '@unframed/core/divider';` (or `npx @unframed/cli add divider` to copy the source).\n\n## Between sections, or with a label\n\n```html\n<section>Profile</section>\n<uf-divider></uf-divider>\n<section>Notifications</section>\n\n<uf-divider>or</uf-divider>\n```\n\n- Screen readers announce a divider as a separator. A label is read as plain text, so keep it short, like \"or\".\n\n## Vertical\n\nBetween items in a row. It takes the height of the row.\n\n```html\n<div style=\"display: flex; align-items: center\">\n <uf-button variant=\"link\">Edit</uf-button>\n <uf-divider orientation=\"vertical\"></uf-divider>\n <uf-button variant=\"link\">Duplicate</uf-button>\n</div>\n```\n\n## `<uf-divider>` API\n\n### Attributes and properties\n\n| Attribute | Property | Type | Default | Description |\n|---|---|---|---|---|\n| `orientation` | | `DividerOrientation` | `'horizontal'` | `horizontal` (across the content) or `vertical` (between items in a row). |\n\n### Slots\n\n| Slot | Description |\n|---|---|\n| (default) | An optional label in the middle of the line, like \"or\". |\n\n### CSS parts\n\n| Part | Description |\n|---|---|\n| `base` | The line, or the wrapper around a labelled one. |\n| `label` | The label. |\n\n### CSS custom properties\n\n| Property | Description |\n|---|---|\n| `--uf-divider-color` | Color of the line. |\n| `--uf-divider-width` | Thickness of the line. |\n| `--uf-divider-spacing` | Space before and after the line. |\n"
|
|
179
|
+
},
|
|
180
|
+
{
|
|
181
|
+
"name": "drawer",
|
|
182
|
+
"title": "Drawer",
|
|
183
|
+
"summary": "A panel that slides in from an edge of the screen.",
|
|
184
|
+
"tags": [
|
|
185
|
+
"uf-drawer"
|
|
186
|
+
],
|
|
187
|
+
"imports": [
|
|
188
|
+
"@unframed/core/drawer"
|
|
189
|
+
],
|
|
190
|
+
"docs": "# Drawer\n\nA panel that slides in from an edge of the screen, for navigation, filters or\ndetails. It is a modal dialog, so it behaves like `<uf-dialog>`: it traps\nfocus, makes the page inert, closes with Escape, and returns focus to the\nopener. Any element inside with `data-dialog=\"close\"` closes it.\n\nTags: `<uf-drawer>`. Import: `import '@unframed/core/drawer';` (or `npx @unframed/cli add drawer` to copy the source).\n\n## Filters\n\nA modal panel from the end edge, floating a little away from the screen edges. Escape, the close button and any element with `data-dialog=\"close\"` close it.\n\n```html\n<uf-button variant=\"outline\" onclick=\"this.nextElementSibling.show()\">Filters</uf-button>\n<uf-drawer label=\"Filters\" light-dismiss>\n <uf-checkbox-group label=\"Status\">\n <uf-checkbox value=\"open\" checked>Open</uf-checkbox>\n <uf-checkbox value=\"review\">In review</uf-checkbox>\n <uf-checkbox value=\"closed\">Closed</uf-checkbox>\n </uf-checkbox-group>\n <uf-radio-group label=\"Priority\" value=\"any\">\n <uf-radio value=\"any\">Any</uf-radio>\n <uf-radio value=\"high\">High</uf-radio>\n <uf-radio value=\"low\">Low</uf-radio>\n </uf-radio-group>\n <uf-select label=\"Assignee\">\n <option value=\"anyone\">Anyone</option>\n <option value=\"john\">John Smith</option>\n </uf-select>\n <uf-button slot=\"footer\" variant=\"ghost\" data-dialog=\"close\">Cancel</uf-button>\n <uf-button slot=\"footer\" data-dialog=\"close\">Apply</uf-button>\n</uf-drawer>\n```\n\n- It is a modal dialog: focus stays inside, the page behind is inert and does not scroll, and focus returns to the button on close.\n\n## Navigation menu\n\nA site menu from the start edge, for small screens. The links are plain HTML in a `<nav>`, styled by your app.\n\n```html\n<uf-button variant=\"outline\" onclick=\"this.nextElementSibling.show()\">Menu</uf-button>\n<uf-drawer label=\"Menu\" placement=\"start\" light-dismiss style=\"--uf-drawer-size: 18rem\">\n <nav aria-label=\"Main\">\n <ul>\n <li><a href=\"/inbox\" aria-current=\"page\"><uf-icon name=\"inbox\"></uf-icon>Inbox</a></li>\n <li><a href=\"/calendar\"><uf-icon name=\"calendar\"></uf-icon>Calendar</a></li>\n <li><a href=\"/documents\"><uf-icon name=\"file\"></uf-icon>Documents</a></li>\n <li><a href=\"/team\"><uf-icon name=\"user\"></uf-icon>Team</a></li>\n </ul>\n </nav>\n <div slot=\"footer\"><uf-avatar name=\"John Smith\" size=\"sm\"></uf-avatar>John Smith</div>\n</uf-drawer>\n```\n\n- Mark the current page with `aria-current=\"page\"`: screen readers announce it, and it is a handy hook for its style.\n\n## Placement\n\n`start`, `end` (the default), `top` or `bottom`. Start and end follow the page direction. `--uf-drawer-size` sets the width, or the height for top and bottom, and `--uf-drawer-gap` the space around it: `0` puts it against the edge.\n\n```html\n<uf-drawer label=\"Menu\" placement=\"start\">…</uf-drawer>\n<uf-drawer label=\"Cart\" placement=\"end\" style=\"--uf-drawer-size: 28rem\">…</uf-drawer>\n<uf-drawer label=\"Cookies\" placement=\"bottom\" style=\"--uf-drawer-gap: 0\">…</uf-drawer>\n```\n\n## `<uf-drawer>` API\n\n### Attributes and properties\n\n| Attribute | Property | Type | Default | Description |\n|---|---|---|---|---|\n| `placement` | | `DrawerPlacement` | `'end'` | The edge it slides in from: `start` (left, in left-to-right pages), `end`, `top` or `bottom`. |\n| `open` | | `boolean` | `false` | Whether the dialog is open. |\n| `label` | | `string \\| undefined` | | Title of the dialog, also its accessible name. |\n| `light-dismiss` | `lightDismiss` | `boolean` | `false` | Closes the dialog when the backdrop is clicked. |\n| `without-header` | `withoutHeader` | `boolean` | `false` | Hides the header. Set `label` anyway, so the dialog keeps an accessible name. |\n\n### Methods\n\n| Method | Description |\n|---|---|\n| `show()` | Opens the dialog. |\n| `hide()` | Closes the dialog, without firing `uf-request-close`. |\n| `requestClose(source?: DialogCloseSource)` | Asks to close, as a user action would. Listeners can cancel it. |\n\n### Events\n\n| Event | Type | Description |\n|---|---|---|\n| `uf-show` | `Event` | The drawer opened. |\n| `uf-hide` | `Event` | The drawer closed. |\n| `uf-request-close` | `CustomEvent<DialogRequestCloseDetail>` | The user tried to close the drawer. Call `preventDefault()` to keep it open. |\n\n### Slots\n\n| Slot | Description |\n|---|---|\n| (default) | The drawer content. |\n| `label` | The title, when you need markup. Overrides `label`. |\n| `header-actions` | Extra buttons next to the close button. |\n| `footer` | Actions at the bottom, usually buttons. |\n\n### CSS parts\n\n| Part | Description |\n|---|---|\n| `dialog` | The native `<dialog>`. |\n| `header` | The header with title and close button. |\n| `title` | The title. |\n| `close-button` | The close button. |\n| `body` | The content area. |\n| `footer` | The footer. |\n\n### CSS custom properties\n\n| Property | Description |\n|---|---|\n| `--uf-drawer-size` | Width of a side drawer, or height of a top or bottom one. Defaults to `24rem`. |\n| `--uf-drawer-gap` | Space between the drawer and the screen's edges. `0` puts it against the edge. Defaults to `--uf-space-3`. |\n| `--uf-drawer-radius` | Corner radius. |\n| `--uf-dialog-bg` | Background of the drawer. |\n| `--uf-dialog-padding` | Padding of header, body and footer. |\n| `--uf-dialog-backdrop` | Backdrop color. |\n| `--uf-dialog-width` | Width of the dialog. Defaults to `32rem`. |\n| `--uf-dialog-radius` | Corner radius. |\n"
|
|
191
|
+
},
|
|
192
|
+
{
|
|
193
|
+
"name": "dropdown",
|
|
194
|
+
"title": "Dropdown menu",
|
|
195
|
+
"summary": "Opens a menu of actions from a button.",
|
|
196
|
+
"tags": [
|
|
197
|
+
"uf-dropdown",
|
|
198
|
+
"uf-menu",
|
|
199
|
+
"uf-menu-item"
|
|
200
|
+
],
|
|
201
|
+
"imports": [
|
|
202
|
+
"@unframed/core/dropdown",
|
|
203
|
+
"@unframed/core/menu"
|
|
204
|
+
],
|
|
205
|
+
"docs": "# Dropdown menu\n\nA button that opens a `<uf-menu>`, following the WAI-ARIA menu button\npattern: Enter, Space or Down open it on the first item, Up on the last;\nchoosing an item or pressing Escape closes it and returns focus to the button.\n\nTags: `<uf-dropdown>`, `<uf-menu>`, `<uf-menu-item>`. Import: `import '@unframed/core/dropdown';`, `import '@unframed/core/menu';` (or `npx @unframed/cli add dropdown menu` to copy the source).\n\n## Menu button\n\nArrow keys move, typing a letter jumps to an item, Escape closes.\n\n```html\n<uf-dropdown>\n <uf-button slot=\"trigger\" variant=\"secondary\">Actions</uf-button>\n <uf-menu label=\"Project actions\">\n <uf-menu-item value=\"edit\">Edit<span slot=\"suffix\">⌘E</span></uf-menu-item>\n <uf-menu-item value=\"duplicate\">Duplicate</uf-menu-item>\n <hr />\n <uf-menu-item value=\"pin\" type=\"checkbox\" checked>Pinned</uf-menu-item>\n </uf-menu>\n</uf-dropdown>\n```\n\n## `<uf-dropdown>` API\n\n### Attributes and properties\n\n| Attribute | Property | Type | Default | Description |\n|---|---|---|---|---|\n| `open` | | `boolean` | `false` | Whether the popover is open. |\n| `placement` | | `Placement` | `'bottom-start'` | Preferred side. Flips when there is no room. |\n| `distance` | | `number` | `6` | Gap between trigger and panel, in pixels. |\n| `label` | | `string \\| undefined` | | Accessible name of the panel. Defaults to the trigger's text. |\n\n### Methods\n\n| Method | Description |\n|---|---|\n| `show()` | Opens the popover. |\n| `hide()` | Closes the popover. |\n| `toggle()` | Opens the popover if closed, closes it if open. |\n\n### Events\n\n| Event | Type | Description |\n|---|---|---|\n| `uf-select` | `CustomEvent<MenuSelectDetail>` | An item was chosen (bubbles up from the menu). |\n| `uf-show` | `Event` | The menu opened. |\n| `uf-hide` | | The menu closed. |\n\n### Slots\n\n| Slot | Description |\n|---|---|\n| `trigger` | The button that opens the menu. |\n| (default) | A `<uf-menu>`. |\n\n### CSS parts\n\n| Part | Description |\n|---|---|\n| `panel` | The floating panel around the menu. |\n\n### CSS custom properties\n\n| Property | Description |\n|---|---|\n| `--uf-popover-padding` | Padding of the panel. |\n| `--uf-popover-width` | Width of the panel. Defaults to its content. |\n\n## `<uf-menu>` API\n\n### Attributes and properties\n\n| Attribute | Property | Type | Default | Description |\n|---|---|---|---|---|\n| `label` | | `string \\| undefined` | | Accessible name of the menu. |\n\n### Properties only\n\n| Property | Type | Description |\n|---|---|---|\n| `items` | `UfMenuItem[]` | Read-only. Enabled items that belong to this menu (not to a nested one). |\n\n### Methods\n\n| Method | Description |\n|---|---|\n| `focusFirst()` | Focuses the first enabled item. |\n| `focusLast()` | Focuses the last enabled item. |\n\n### Events\n\n| Event | Type | Description |\n|---|---|---|\n| `uf-select` | `CustomEvent<MenuSelectDetail>` | An item was chosen. Cancel it to keep a dropdown open. |\n\n### Slots\n\n| Slot | Description |\n|---|---|\n| (default) | `<uf-menu-item>` elements and `<hr>` separators. |\n\n## `<uf-menu-item>` API\n\n### Attributes and properties\n\n| Attribute | Property | Type | Default | Description |\n|---|---|---|---|---|\n| `value` | | `string` | `''` | Identifies the item in the menu's `uf-select` event. |\n| `type` | | `'normal' \\| 'checkbox'` | `'normal'` | `checkbox` items toggle `checked` when selected. |\n| `checked` | | `boolean` | `false` | Whether a checkbox item is on. |\n| `disabled` | | `boolean` | `false` | Disables the item. |\n\n### Slots\n\n| Slot | Description |\n|---|---|\n| (default) | The label. |\n| `prefix` | An icon before the label. |\n| `suffix` | Trailing content, e.g. a keyboard shortcut. |\n\n### CSS parts\n\n| Part | Description |\n|---|---|\n| `checkmark` | The check shown for checked checkbox items. |\n| `label` | The label wrapper. |\n"
|
|
206
|
+
},
|
|
207
|
+
{
|
|
208
|
+
"name": "empty-state",
|
|
209
|
+
"title": "Empty state",
|
|
210
|
+
"summary": "Fills an empty list or page with a message and what to do next.",
|
|
211
|
+
"tags": [
|
|
212
|
+
"uf-empty-state"
|
|
213
|
+
],
|
|
214
|
+
"imports": [
|
|
215
|
+
"@unframed/core/empty-state"
|
|
216
|
+
],
|
|
217
|
+
"docs": "# Empty state\n\nWhat to show where content would be: an empty list, no search results, a\nfirst visit. An icon, a heading, a short explanation and what to do next.\n\nThe `heading` attribute is bold text. For a real heading in the page's\noutline, put an `<h2>` or `<h3>` in the `heading` slot.\n\nTags: `<uf-empty-state>`. Import: `import '@unframed/core/empty-state';` (or `npx @unframed/cli add empty-state` to copy the source).\n\n## Basic\n\nAn icon, a heading, a short explanation and what to do next.\n\n```html\n<uf-empty-state heading=\"No projects yet\">\n Projects keep your files and your team together.\n <uf-button slot=\"actions\">New project</uf-button>\n</uf-empty-state>\n```\n\n## No search results\n\nAnother `icon`, and a real heading in the `heading` slot when it belongs in the page outline.\n\n```html\n<uf-empty-state icon=\"search\">\n <h3 slot=\"heading\">No results for “invoice 2019”</h3>\n Check the spelling, or try a shorter search.\n <uf-button slot=\"actions\" variant=\"outline\">Clear search</uf-button>\n</uf-empty-state>\n```\n\n## `<uf-empty-state>` API\n\n### Attributes and properties\n\n| Attribute | Property | Type | Default | Description |\n|---|---|---|---|---|\n| `heading` | | `string \\| undefined` | | Bold text above the explanation. |\n| `icon` | | `string` | `'inbox'` | A built-in or registered icon name. An empty string hides the icon. |\n\n### Slots\n\n| Slot | Description |\n|---|---|\n| (default) | The explanation. |\n| `heading` | The heading, when you need markup or a heading level. Overrides `heading`. |\n| `icon` | Replaces the icon. |\n| `actions` | Buttons or links, like \"Create a project\". |\n\n### CSS parts\n\n| Part | Description |\n|---|---|\n| `base` | The empty state. |\n| `icon` | The icon. |\n| `heading` | The heading. |\n| `description` | The explanation. |\n| `actions` | The wrapper around the actions. |\n\n### CSS custom properties\n\n| Property | Description |\n|---|---|\n| `--uf-empty-state-icon-size` | Size of the icon. |\n| `--uf-empty-state-icon-color` | Color of the icon. |\n| `--uf-empty-state-padding` | Space around the content. |\n"
|
|
218
|
+
},
|
|
219
|
+
{
|
|
220
|
+
"name": "file-upload",
|
|
221
|
+
"title": "File upload",
|
|
222
|
+
"summary": "Lets users choose files to upload.",
|
|
223
|
+
"tags": [
|
|
224
|
+
"uf-file-upload"
|
|
225
|
+
],
|
|
226
|
+
"imports": [
|
|
227
|
+
"@unframed/core/file-upload"
|
|
228
|
+
],
|
|
229
|
+
"docs": "# File upload\n\nPicks files to send with a form: from a button, or by dragging them onto the\ndrop zone. The chosen files are listed with their size and a remove button.\nFiles that don't match `accept` or are larger than `max-size` are refused,\nwith a message saying why. It submits like a native `<input type=\"file\">`.\n\nTags: `<uf-file-upload>`. Import: `import '@unframed/core/file-upload';` (or `npx @unframed/cli add file-upload` to copy the source).\n\n## Basic\n\nA button and a drop zone. The chosen files are listed with their size and a remove button.\n\n```html\n<uf-file-upload name=\"attachments\" label=\"Attachments\" hint=\"PDF or images, up to 5 MB each\" multiple accept=\".pdf, image/*\" max-size=\"5000000\"></uf-file-upload>\n```\n\n- Files that `accept` rules out, or larger than `max-size` (in bytes), are refused, with a message saying why.\n- It submits with its form like a native file input: `new FormData(form).getAll(\"attachments\")` returns the files.\n\n## One file, required\n\nWithout `multiple`, a new pick replaces the file. `required` makes the form ask for one.\n\n```html\n<form>\n <uf-file-upload name=\"cv\" label=\"Your CV\" accept=\".pdf\" required></uf-file-upload>\n <uf-button type=\"submit\">Apply</uf-button>\n</form>\n```\n\n## `<uf-file-upload>` API\n\n### Attributes and properties\n\n| Attribute | Property | Type | Default | Description |\n|---|---|---|---|---|\n| `label` | | `string \\| undefined` | | Visible label. |\n| `hint` | | `string \\| undefined` | | Help text, e.g. the accepted types and size. |\n| `accept` | | `string \\| undefined` | | Accepted files, as in a native file input: extensions (`.pdf`), MIME types (`image/png`) or wildcards (`image/*`), comma-separated. |\n| `multiple` | | `boolean` | `false` | Lets users choose more than one file. |\n| `max-size` | `maxSize` | `number \\| undefined` | | Largest accepted file, in bytes, e.g. `5000000` for 5 MB. |\n| `size` | | `FieldSize` | `'md'` | Size of the drop zone: `sm`, `md` or `lg`. |\n| `name` | | `string` | `''` | Name submitted with the form. |\n| `disabled` | | `boolean` | `false` | Disables the control. |\n| `required` | | `boolean` | `false` | Makes the control required for form submission. |\n\n### Properties only\n\n| Property | Type | Description |\n|---|---|---|\n| `files` | `File[]` | The chosen files. Set it to `[]` to clear them. |\n| `form` | `HTMLFormElement \\| null` | Read-only. The form this control belongs to, if any. |\n| `validity` | `ValidityState` | Read-only. The control's validity state, like a native input's. |\n| `validationMessage` | `string` | Read-only. The error message shown when the value is invalid. |\n| `willValidate` | `boolean` | Read-only. Whether the control takes part in form validation. |\n\n### Methods\n\n| Method | Description |\n|---|---|\n| `showPicker()` | Opens the file picker. |\n| `checkValidity()` | Returns whether the value is valid, without showing an error. |\n| `reportValidity()` | Returns whether the value is valid, and shows the error if not. |\n| `setCustomValidity(message: string)` | Sets a custom error message. Pass an empty string to clear it. |\n\n### Events\n\n| Event | Type | Description |\n|---|---|---|\n| `input` | `Event` | Fired when files are added or removed. |\n| `change` | `Event` | Fired when files are added or removed. |\n\n### Slots\n\n| Slot | Description |\n|---|---|\n| `label` | The label, when you need markup. Overrides `label`. |\n| `hint` | Help text below the label. Overrides `hint`. |\n\n### CSS parts\n\n| Part | Description |\n|---|---|\n| `field` | The wrapper around label, drop zone, files, hint and error. |\n| `form-label` | The label. |\n| `dropzone` | The area files can be dropped on. |\n| `button` | The button that opens the file picker. |\n| `files` | The list of chosen files. |\n| `file` | A chosen file. |\n| `remove-button` | A file's remove button. |\n| `rejected` | Why files were refused. |\n| `hint` | The hint text. |\n| `error` | The validation message. |\n\n### CSS custom properties\n\n| Property | Description |\n|---|---|\n| `--uf-file-upload-border-color` | Border color of the drop zone. |\n| `--uf-file-upload-bg` | Background of the drop zone. |\n| `--uf-file-upload-radius` | Corner radius of the drop zone. Defaults to the theme's control radius. |\n| `--uf-file-upload-active-color` | Border and background tint while files are dragged over. |\n"
|
|
230
|
+
},
|
|
231
|
+
{
|
|
232
|
+
"name": "icon",
|
|
233
|
+
"title": "Icon",
|
|
234
|
+
"summary": "Shows a small symbol.",
|
|
235
|
+
"tags": [
|
|
236
|
+
"uf-icon"
|
|
237
|
+
],
|
|
238
|
+
"imports": [
|
|
239
|
+
"@unframed/core/icon"
|
|
240
|
+
],
|
|
241
|
+
"docs": "# Icon\n\nAn icon from the built-in set, or one added with `registerIcons()`.\nIcons are decorative unless you give them a `label`.\n\nTags: `<uf-icon>`. Import: `import '@unframed/core/icon';` (or `npx @unframed/cli add icon` to copy the source).\n\n## Built-in set\n\nIcons are decorative unless you give them a `label`. Add your own with `registerIcons()`.\n\n```html\n<uf-icon name=\"check-circle\" label=\"Done\"></uf-icon>\n```\n\n## Your own icons\n\n```html\n<script type=\"module\">\n import { registerIcons } from '@unframed/core/icon';\n\n registerIcons({\n heart: '<svg viewBox=\"0 0 24 24\" fill=\"none\" stroke=\"currentColor\" stroke-width=\"2\">…</svg>',\n star: '<svg viewBox=\"0 0 24 24\" fill=\"currentColor\">…</svg>',\n });\n</script>\n\n<uf-icon name=\"heart\" label=\"Favorite\"></uf-icon>\n<uf-button><uf-icon slot=\"prefix\" name=\"heart\"></uf-icon>Save</uf-button>\n```\n\n- Use `currentColor` for strokes and fills, so the icon takes the text color around it (set `color` to change it).\n- Keep a `viewBox` and leave out `width`/`height`: the icon is `1em` square, so it follows the font size. Change it with `--uf-icon-size`.\n- Registering a built-in name (e.g. `x`) replaces that icon everywhere, including inside components like the dialog's close button.\n- Icons already on the page update when you register their name, so registration order doesn't matter.\n- The markup is inserted as-is: only register SVG from your own code or files, never from user input.\n\n## `<uf-icon>` API\n\n### Attributes and properties\n\n| Attribute | Property | Type | Default | Description |\n|---|---|---|---|---|\n| `name` | | `BuiltInIconName \\| (string & {})` | `''` | Icon name: a built-in icon or one added with `registerIcons()`. |\n| `label` | | `string \\| undefined` | | Accessible label. Without it the icon is hidden from assistive tech. |\n\n### CSS parts\n\n| Part | Description |\n|---|---|\n| `svg` | The `<svg>` element. |\n\n### CSS custom properties\n\n| Property | Description |\n|---|---|\n| `--uf-icon-size` | Width and height. Defaults to `1em`, so it follows the font size. |\n| `--uf-icon-stroke-width` | Stroke width of built-in icons. |\n"
|
|
242
|
+
},
|
|
243
|
+
{
|
|
244
|
+
"name": "input",
|
|
245
|
+
"title": "Input",
|
|
246
|
+
"summary": "Lets users enter a single line of text.",
|
|
247
|
+
"tags": [
|
|
248
|
+
"uf-input"
|
|
249
|
+
],
|
|
250
|
+
"imports": [
|
|
251
|
+
"@unframed/core/input"
|
|
252
|
+
],
|
|
253
|
+
"docs": "# Input\n\nA single-line text field with a built-in label, hint and validation message.\n\nTags: `<uf-input>`. Import: `import '@unframed/core/input';` (or `npx @unframed/cli add input` to copy the source).\n\n## With label, hint and validation\n\nErrors appear after the user edits the field or tries to submit.\n\n```html\n<form>\n <uf-input name=\"email\" type=\"email\" label=\"Email\" hint=\"We never share it.\" required>\n <uf-icon slot=\"prefix\" name=\"info\"></uf-icon>\n </uf-input>\n <uf-button type=\"submit\">Subscribe</uf-button>\n</form>\n```\n\n## `<uf-input>` API\n\n### Attributes and properties\n\n| Attribute | Property | Type | Default | Description |\n|---|---|---|---|---|\n| `type` | | `InputType` | `'text'` | Input type. |\n| `value` | `defaultValue` | `string` | `''` | Initial value, restored on form reset. Set with the `value` attribute. |\n| `label` | | `string \\| undefined` | | Visible label. |\n| `hint` | | `string \\| undefined` | | Help text below the field. |\n| `placeholder` | | `string \\| undefined` | | Placeholder text. |\n| `size` | | `FieldSize` | `'md'` | Size of the field. |\n| `readonly` | | `boolean` | `false` | Makes the field read-only. |\n| `autocomplete` | | `AutoFill \\| undefined` | | Native `autocomplete` hint. |\n| `inputmode` | | `string \\| undefined` | | Native `inputmode` hint for virtual keyboards. |\n| `pattern` | | `string \\| undefined` | | Regex the value must match. |\n| `min` | | `string \\| undefined` | | Minimum value, for number and date types. |\n| `max` | | `string \\| undefined` | | Maximum value, for number and date types. |\n| `step` | | `string \\| undefined` | | Step, for number and date types. |\n| `minlength` | | `number \\| undefined` | | Minimum length. |\n| `maxlength` | | `number \\| undefined` | | Maximum length. |\n| `name` | | `string` | `''` | Name submitted with the form. |\n| `disabled` | | `boolean` | `false` | Disables the control. |\n| `required` | | `boolean` | `false` | Makes the control required for form submission. |\n\n### Properties only\n\n| Property | Type | Description |\n|---|---|---|\n| `value` | `string` | Current value. |\n| `form` | `HTMLFormElement \\| null` | Read-only. The form this control belongs to, if any. |\n| `validity` | `ValidityState` | Read-only. The control's validity state, like a native input's. |\n| `validationMessage` | `string` | Read-only. The error message shown when the value is invalid. |\n| `willValidate` | `boolean` | Read-only. Whether the control takes part in form validation. |\n\n### Methods\n\n| Method | Description |\n|---|---|\n| `select()` | Selects all text in the field. |\n| `checkValidity()` | Returns whether the value is valid, without showing an error. |\n| `reportValidity()` | Returns whether the value is valid, and shows the error if not. |\n| `setCustomValidity(message: string)` | Sets a custom error message. Pass an empty string to clear it. |\n\n### Events\n\n| Event | Type | Description |\n|---|---|---|\n| `input` | | Fired on every keystroke. |\n| `change` | `Event` | Fired when the value is committed (blur or Enter). |\n\n### Slots\n\n| Slot | Description |\n|---|---|\n| `label` | The label, when you need markup. Overrides `label`. |\n| `hint` | Help text below the field. Overrides `hint`. |\n| `prefix` | An icon or text before the input. |\n| `suffix` | An icon or text after the input. |\n\n### CSS parts\n\n| Part | Description |\n|---|---|\n| `field` | The wrapper around label, control, hint and error. |\n| `form-label` | The label. |\n| `box` | The bordered box around the input. |\n| `input` | The native `<input>`. |\n| `hint` | The hint text. |\n| `error` | The validation message. |\n\n### CSS custom properties\n\n| Property | Description |\n|---|---|\n| `--uf-field-bg` | Background of the box. |\n| `--uf-field-border-color` | Border color of the box. |\n| `--uf-field-radius` | Corner radius of the box. |\n"
|
|
254
|
+
},
|
|
255
|
+
{
|
|
256
|
+
"name": "multi-select",
|
|
257
|
+
"title": "Multi-select",
|
|
258
|
+
"summary": "Lets users search a list and pick several options.",
|
|
259
|
+
"tags": [
|
|
260
|
+
"uf-multi-select"
|
|
261
|
+
],
|
|
262
|
+
"imports": [
|
|
263
|
+
"@unframed/core/multi-select"
|
|
264
|
+
],
|
|
265
|
+
"docs": "# Multi-select\n\nA field to pick several options from a list you can search. The picked ones\nshow as chips in the field, each with a remove button. Write options as plain\n`<option>` and `<optgroup>` children; `selected` ones start picked.\n\nIt follows the WAI-ARIA combobox pattern with a multi-select listbox: typing\nfilters the list, arrow keys move through it, Enter picks or unpicks an\noption and keeps the list open, and Backspace in an empty field removes the\nlast chip. With a `name`, every picked value is submitted with the form.\n\nTags: `<uf-multi-select>`. Import: `import '@unframed/core/multi-select';` (or `npx @unframed/cli add multi-select` to copy the source).\n\n## Basic\n\nType to filter, Enter or a click to pick, and the list stays open for the next one. Backspace removes the last chip. The value is an array, in the order of the options.\n\n```html\n<uf-multi-select name=\"toppings\" label=\"Toppings\" placeholder=\"Pick toppings\">\n <option value=\"cheese\" selected>Cheese</option>\n <option value=\"olives\">Olives</option>\n <option value=\"basil\">Basil</option>\n <option value=\"ham\" disabled>Ham (sold out)</option>\n</uf-multi-select>\n```\n\n- With a `name`, every picked value is submitted under that name, like a native `<select multiple>`: read them with `formData.getAll(name)`.\n\n## Groups and validation\n\n```html\n<uf-multi-select name=\"languages\" label=\"Languages\" hint=\"Pick at least one.\" required>\n <optgroup label=\"Europe\">\n <option>English</option>\n <option>Italian</option>\n </optgroup>\n <optgroup label=\"Asia\">\n <option>Japanese</option>\n </optgroup>\n</uf-multi-select>\n```\n\n## `<uf-multi-select>` API\n\n### Attributes and properties\n\n| Attribute | Property | Type | Default | Description |\n|---|---|---|---|---|\n| `label` | | `string \\| undefined` | | Visible label. |\n| `hint` | | `string \\| undefined` | | Help text below the field. |\n| `placeholder` | | `string \\| undefined` | | Placeholder text in the field, while nothing is picked. |\n| `size` | | `FieldSize` | `'md'` | Size of the field. |\n| `open` | | `boolean` | `false` | Whether the list is showing. |\n| `name` | | `string` | `''` | Name submitted with the form. |\n| `disabled` | | `boolean` | `false` | Disables the control. |\n| `required` | | `boolean` | `false` | Makes the control required for form submission. |\n\n### Properties only\n\n| Property | Type | Description |\n|---|---|---|\n| `value` | `string[]` | The picked options' values, in the order of the options. |\n| `form` | `HTMLFormElement \\| null` | Read-only. The form this control belongs to, if any. |\n| `validity` | `ValidityState` | Read-only. The control's validity state, like a native input's. |\n| `validationMessage` | `string` | Read-only. The error message shown when the value is invalid. |\n| `willValidate` | `boolean` | Read-only. Whether the control takes part in form validation. |\n\n### Methods\n\n| Method | Description |\n|---|---|\n| `show()` | Opens the list. |\n| `hide()` | Closes the list. |\n| `checkValidity()` | Returns whether the value is valid, without showing an error. |\n| `reportValidity()` | Returns whether the value is valid, and shows the error if not. |\n| `setCustomValidity(message: string)` | Sets a custom error message. Pass an empty string to clear it. |\n\n### Events\n\n| Event | Type | Description |\n|---|---|---|\n| `uf-show` | `Event` | The list opened. |\n| `uf-hide` | `Event` | The list closed. |\n| `input` | | Fired as the user types in the field (the search text, not the value). |\n| `change` | `Event` | Fired when an option is picked or removed. |\n\n### Slots\n\n| Slot | Description |\n|---|---|\n| (default) | `<option>` and `<optgroup>` elements. They are read, not rendered. |\n| `label` | The label, when you need markup. Overrides `label`. |\n| `hint` | Help text below the field. Overrides `hint`. |\n\n### CSS parts\n\n| Part | Description |\n|---|---|\n| `field` | The wrapper around label, control, hint and error. |\n| `form-label` | The label. |\n| `box` | The bordered box with the chips and the input. |\n| `chips` | The list of picked options. |\n| `chip` | A picked option. |\n| `chip-remove` | A chip's remove button. |\n| `input` | The native `<input>`. |\n| `toggle` | The button that opens the list. |\n| `listbox` | The floating list. |\n| `option` | Each option. |\n| `group-label` | Each group heading. |\n| `empty` | The \"no results\" message. |\n| `hint` | The hint text. |\n| `error` | The validation message. |\n\n### CSS custom properties\n\n| Property | Description |\n|---|---|\n| `--uf-multi-select-max-height` | Maximum height of the list before it scrolls. |\n| `--uf-multi-select-chip-bg` | Background of the chips. |\n| `--uf-multi-select-chip-color` | Text color of the chips. |\n| `--uf-field-bg` | Background of the box. |\n| `--uf-field-border-color` | Border color of the box. |\n| `--uf-field-radius` | Corner radius of the box. |\n"
|
|
266
|
+
},
|
|
267
|
+
{
|
|
268
|
+
"name": "number-input",
|
|
269
|
+
"title": "Number input",
|
|
270
|
+
"summary": "Lets users enter a number, or step it with buttons.",
|
|
271
|
+
"tags": [
|
|
272
|
+
"uf-number-input"
|
|
273
|
+
],
|
|
274
|
+
"imports": [
|
|
275
|
+
"@unframed/core/number-input"
|
|
276
|
+
],
|
|
277
|
+
"docs": "# Number input\n\nA field for a number, with buttons to step it down and up. The value is a\nnumber, or `null` while the field is empty. Arrow keys step it too, Enter\nsubmits the form, and `min`, `max` and `step` validate it like a native\nnumber input.\n\nThe buttons are out of the tab order: arrow keys do the same from the field.\n\nTags: `<uf-number-input>`. Import: `import '@unframed/core/number-input';` (or `npx @unframed/cli add number-input` to copy the source).\n\n## Basic\n\nThe value is a number, or `null` while the field is empty. The buttons and the arrow keys step it, within `min` and `max`.\n\n```html\n<uf-number-input name=\"guests\" label=\"Guests\" hint=\"Up to 10\" value=\"2\" min=\"1\" max=\"10\"></uf-number-input>\n```\n\n## Steps, units and validation\n\n`step` sets how much the buttons move, and the value must be a multiple of it. Put a unit or a currency in the `prefix` or `suffix` slot.\n\n```html\n<uf-number-input label=\"Price\" value=\"9.5\" step=\"0.5\" min=\"0\">\n <span slot=\"prefix\">€</span>\n</uf-number-input>\n<uf-number-input label=\"Weight\" value=\"250\" step=\"50\" min=\"0\" required>\n <span slot=\"suffix\">g</span>\n</uf-number-input>\n```\n\n## `<uf-number-input>` API\n\n### Attributes and properties\n\n| Attribute | Property | Type | Default | Description |\n|---|---|---|---|---|\n| `value` | `defaultValue` | `number \\| null` | `null` | Initial value, restored on form reset. Set with the `value` attribute. |\n| `label` | | `string \\| undefined` | | Visible label. |\n| `hint` | | `string \\| undefined` | | Help text below the field. |\n| `placeholder` | | `string \\| undefined` | | Placeholder text. |\n| `size` | | `FieldSize` | `'md'` | Size of the field. |\n| `readonly` | | `boolean` | `false` | Makes the field read-only, without the buttons doing anything. |\n| `min` | | `number \\| null` | `null` | Lowest value. |\n| `max` | | `number \\| null` | `null` | Highest value. |\n| `step` | | `number` | `1` | The buttons and arrow keys move by this much, and the value must be a multiple of it (from `min`). |\n| `name` | | `string` | `''` | Name submitted with the form. |\n| `disabled` | | `boolean` | `false` | Disables the control. |\n| `required` | | `boolean` | `false` | Makes the control required for form submission. |\n\n### Properties only\n\n| Property | Type | Description |\n|---|---|---|\n| `value` | `number \\| null` | Current value, or `null` while the field is empty. |\n| `form` | `HTMLFormElement \\| null` | Read-only. The form this control belongs to, if any. |\n| `validity` | `ValidityState` | Read-only. The control's validity state, like a native input's. |\n| `validationMessage` | `string` | Read-only. The error message shown when the value is invalid. |\n| `willValidate` | `boolean` | Read-only. Whether the control takes part in form validation. |\n\n### Methods\n\n| Method | Description |\n|---|---|\n| `stepUp(count?: unknown)` | Steps the value up by `step` (or `count` steps), like the plus button. |\n| `stepDown(count?: unknown)` | Steps the value down by `step` (or `count` steps), like the minus button. |\n| `checkValidity()` | Returns whether the value is valid, without showing an error. |\n| `reportValidity()` | Returns whether the value is valid, and shows the error if not. |\n| `setCustomValidity(message: string)` | Sets a custom error message. Pass an empty string to clear it. |\n\n### Events\n\n| Event | Type | Description |\n|---|---|---|\n| `input` | `Event` | Fired on every keystroke and every step. |\n| `change` | `Event` | Fired when the value is committed: blur, Enter or a step. |\n\n### Slots\n\n| Slot | Description |\n|---|---|\n| `label` | The label, when you need markup. Overrides `label`. |\n| `hint` | Help text below the field. Overrides `hint`. |\n| `prefix` | An icon or text before the number, like a currency. |\n| `suffix` | An icon or text after the number, like a unit. |\n\n### CSS parts\n\n| Part | Description |\n|---|---|\n| `field` | The wrapper around label, control, hint and error. |\n| `form-label` | The label. |\n| `box` | The bordered box around the input and the buttons. |\n| `input` | The native `<input type=\"number\">`. |\n| `steppers` | The wrapper around the two buttons. |\n| `decrement` | The minus button. |\n| `increment` | The plus button. |\n| `hint` | The hint text. |\n| `error` | The validation message. |\n\n### CSS custom properties\n\n| Property | Description |\n|---|---|\n| `--uf-field-bg` | Background of the box. |\n| `--uf-field-border-color` | Border color of the box. |\n| `--uf-field-radius` | Corner radius of the box. |\n"
|
|
278
|
+
},
|
|
279
|
+
{
|
|
280
|
+
"name": "pagination",
|
|
281
|
+
"title": "Pagination",
|
|
282
|
+
"summary": "Moves between the pages of a long list.",
|
|
283
|
+
"tags": [
|
|
284
|
+
"uf-pagination"
|
|
285
|
+
],
|
|
286
|
+
"imports": [
|
|
287
|
+
"@unframed/core/pagination"
|
|
288
|
+
],
|
|
289
|
+
"docs": "# Pagination\n\nNavigation between the pages of a list or table. Set `pages` and `page`; the\nuser changes `page`, and `uf-page-change` tells you which page to show.\n\nIt's a navigation landmark: when a page has more than one, give each a\ndifferent `label`.\n\nTags: `<uf-pagination>`. Import: `import '@unframed/core/pagination';` (or `npx @unframed/cli add pagination` to copy the source).\n\n## Pages\n\nLong ranges collapse around the current page; the number of buttons stays the same from page to page.\n\n```html\n<uf-pagination pages=\"20\" page=\"6\"></uf-pagination>\n\n<script type=\"module\">\n document.querySelector('uf-pagination').addEventListener('uf-page-change', (event) => {\n loadPage(event.detail.page);\n });\n</script>\n```\n\n## Siblings and size\n\n```html\n<uf-pagination pages=\"30\" page=\"15\" siblings=\"2\"></uf-pagination>\n<uf-pagination pages=\"30\" page=\"15\" size=\"sm\"></uf-pagination>\n```\n\n- Each pagination is a navigation landmark: when a page has more than one, give each a different `label`.\n\n## `<uf-pagination>` API\n\n### Attributes and properties\n\n| Attribute | Property | Type | Default | Description |\n|---|---|---|---|---|\n| `page` | | `number` | `1` | The current page, from 1. |\n| `pages` | | `number` | `1` | How many pages there are. |\n| `siblings` | | `number` | `1` | How many pages to show on each side of the current one. |\n| `label` | | `string \\| undefined` | | Accessible name of the navigation, e.g. \"Search results pages\". Defaults to \"Pagination\", or its translation. |\n| `size` | | `PaginationSize` | `'md'` | Size: `sm`, `md` or `lg`. |\n\n### Events\n\n| Event | Type | Description |\n|---|---|---|\n| `uf-page-change` | `CustomEvent<PageChangeDetail>` | The user chose another page. |\n\n### CSS parts\n\n| Part | Description |\n|---|---|\n| `base` | The `<nav>`. |\n| `list` | The list of buttons. |\n| `button` | Every button: pages, previous and next. |\n| `current` | The current page's button. |\n| `previous` | The previous button. |\n| `next` | The next button. |\n| `ellipsis` | The \"…\" between pages. |\n\n### CSS custom properties\n\n| Property | Description |\n|---|---|\n| `--uf-pagination-gap` | Space between the buttons. |\n"
|
|
290
|
+
},
|
|
291
|
+
{
|
|
292
|
+
"name": "popover",
|
|
293
|
+
"title": "Popover",
|
|
294
|
+
"summary": "Shows floating content next to a trigger.",
|
|
295
|
+
"tags": [
|
|
296
|
+
"uf-popover"
|
|
297
|
+
],
|
|
298
|
+
"imports": [
|
|
299
|
+
"@unframed/core/popover"
|
|
300
|
+
],
|
|
301
|
+
"docs": "# Popover\n\nA panel anchored to a trigger, built on the Popover API: it renders in the\ntop layer and closes on Escape or a click outside. Use it for menus of\nactions, filters or small forms; use a dialog for anything that blocks the page.\n\nTags: `<uf-popover>`. Import: `import '@unframed/core/popover';` (or `npx @unframed/cli add popover` to copy the source).\n\n## Floating panel\n\n```html\n<uf-popover>\n <uf-button slot=\"trigger\" variant=\"outline\">Filters</uf-button>\n <uf-checkbox checked>Open issues</uf-checkbox>\n <uf-checkbox>Closed issues</uf-checkbox>\n</uf-popover>\n```\n\n## `<uf-popover>` API\n\n### Attributes and properties\n\n| Attribute | Property | Type | Default | Description |\n|---|---|---|---|---|\n| `open` | | `boolean` | `false` | Whether the popover is open. |\n| `placement` | | `Placement` | `'bottom-start'` | Preferred side. Flips when there is no room. |\n| `distance` | | `number` | `6` | Gap between trigger and panel, in pixels. |\n| `label` | | `string \\| undefined` | | Accessible name of the panel. Defaults to the trigger's text. |\n\n### Methods\n\n| Method | Description |\n|---|---|\n| `show()` | Opens the popover. |\n| `hide()` | Closes the popover. |\n| `toggle()` | Opens the popover if closed, closes it if open. |\n\n### Events\n\n| Event | Type | Description |\n|---|---|---|\n| `uf-show` | `Event` | The popover opened. |\n| `uf-hide` | | The popover closed. |\n\n### Slots\n\n| Slot | Description |\n|---|---|\n| `trigger` | The element that toggles the popover, usually a button. |\n| (default) | The popover content. |\n\n### CSS parts\n\n| Part | Description |\n|---|---|\n| `panel` | The floating panel. |\n\n### CSS custom properties\n\n| Property | Description |\n|---|---|\n| `--uf-popover-padding` | Padding of the panel. |\n| `--uf-popover-width` | Width of the panel. Defaults to its content. |\n"
|
|
302
|
+
},
|
|
303
|
+
{
|
|
304
|
+
"name": "progress",
|
|
305
|
+
"title": "Progress",
|
|
306
|
+
"summary": "Shows how far a task has got.",
|
|
307
|
+
"tags": [
|
|
308
|
+
"uf-progress"
|
|
309
|
+
],
|
|
310
|
+
"imports": [
|
|
311
|
+
"@unframed/core/progress"
|
|
312
|
+
],
|
|
313
|
+
"docs": "# Progress\n\nA bar that shows how far a task has got. Without a `value` it's\nindeterminate: an animated bar for work whose length isn't known, like a\nnative `<progress>`.\n\nTags: `<uf-progress>`. Import: `import '@unframed/core/progress';` (or `npx @unframed/cli add progress` to copy the source).\n\n## Value\n\n`value` out of `max` (100 by default). `show-value` adds the percentage.\n\n```html\n<uf-progress label=\"Uploading report.pdf\" value=\"45\" show-value></uf-progress>\n<uf-progress label=\"Storage\" value=\"92\" variant=\"warning\" show-value></uf-progress>\n<uf-progress label=\"Profile complete\" value=\"5\" max=\"5\" variant=\"success\" size=\"sm\"></uf-progress>\n```\n\n- Screen readers announce it as a progress bar with its label and percentage. Without a `label`, it is named \"Progress\" (translatable).\n\n## Indeterminate\n\nLeave out `value` when the length of the work is not known.\n\n```html\n<uf-progress label=\"Preparing your export\"></uf-progress>\n```\n\n## `<uf-progress>` API\n\n### Attributes and properties\n\n| Attribute | Property | Type | Default | Description |\n|---|---|---|---|---|\n| `value` | | `number \\| undefined` | | Progress so far, from 0 to `max`. Leave it out for an indeterminate bar. |\n| `max` | | `number` | `100` | The value that means done. |\n| `label` | | `string \\| undefined` | | Visible label, also the bar's accessible name. Without one, it's named \"Progress\". |\n| `show-value` | `showValue` | `boolean` | `false` | Shows the percentage next to the label. |\n| `variant` | | `ProgressVariant` | `'accent'` | Color, by meaning: `accent`, `success`, `warning` or `danger`. |\n| `size` | | `ProgressSize` | `'md'` | Height of the bar: `sm`, `md` or `lg`. |\n\n### Slots\n\n| Slot | Description |\n|---|---|\n| `label` | The label, when you need markup. Overrides `label`. |\n\n### CSS parts\n\n| Part | Description |\n|---|---|\n| `base` | The wrapper around label and bar. |\n| `label` | The label. |\n| `value` | The percentage, when `show-value` is set. |\n| `track` | The bar's background. |\n| `indicator` | The filled part of the bar. |\n\n### CSS custom properties\n\n| Property | Description |\n|---|---|\n| `--uf-progress-height` | Height of the bar. |\n| `--uf-progress-radius` | Corner radius of the bar. Use `999px` for a pill. |\n| `--uf-progress-track-color` | Color of the bar's background. |\n| `--uf-progress-indicator-color` | Color of the filled part. |\n"
|
|
314
|
+
},
|
|
315
|
+
{
|
|
316
|
+
"name": "radio-group",
|
|
317
|
+
"title": "Radio group",
|
|
318
|
+
"summary": "Lets users pick exactly one option from a list.",
|
|
319
|
+
"tags": [
|
|
320
|
+
"uf-radio-group",
|
|
321
|
+
"uf-radio"
|
|
322
|
+
],
|
|
323
|
+
"imports": [
|
|
324
|
+
"@unframed/core/radio-group",
|
|
325
|
+
"@unframed/core/radio"
|
|
326
|
+
],
|
|
327
|
+
"docs": "# Radio group\n\nA group of `<uf-radio>` options with one selected value. Arrow keys move\nthe selection, and only the selected option is in the tab order.\n\nTags: `<uf-radio-group>`, `<uf-radio>`. Import: `import '@unframed/core/radio-group';`, `import '@unframed/core/radio';` (or `npx @unframed/cli add radio-group radio` to copy the source).\n\n## Pick one\n\nArrow keys move the selection; only the selected radio is in the tab order.\n\n```html\n<uf-radio-group label=\"Plan\" value=\"pro\" orientation=\"horizontal\">\n <uf-radio value=\"free\">Free</uf-radio>\n <uf-radio value=\"pro\">Pro</uf-radio>\n <uf-radio value=\"team\">Team</uf-radio>\n <uf-radio value=\"enterprise\" disabled>Enterprise</uf-radio>\n</uf-radio-group>\n```\n\n## `<uf-radio-group>` API\n\n### Attributes and properties\n\n| Attribute | Property | Type | Default | Description |\n|---|---|---|---|---|\n| `value` | `defaultValue` | `string` | `''` | Initially selected value, restored on form reset. Set with the `value` attribute. |\n| `label` | | `string \\| undefined` | | Visible group label. |\n| `hint` | | `string \\| undefined` | | Help text below the options. |\n| `orientation` | | `'vertical' \\| 'horizontal'` | `'vertical'` | Lays the options out in a column or a row. |\n| `size` | | `FieldSize` | `'md'` | Size of the radios and their labels: `sm`, `md` or `lg`. |\n| `name` | | `string` | `''` | Name submitted with the form. |\n| `disabled` | | `boolean` | `false` | Disables the control. |\n| `required` | | `boolean` | `false` | Makes the control required for form submission. |\n\n### Properties only\n\n| Property | Type | Description |\n|---|---|---|\n| `value` | `string` | The selected radio's value, or an empty string. |\n| `form` | `HTMLFormElement \\| null` | Read-only. The form this control belongs to, if any. |\n| `validity` | `ValidityState` | Read-only. The control's validity state, like a native input's. |\n| `validationMessage` | `string` | Read-only. The error message shown when the value is invalid. |\n| `willValidate` | `boolean` | Read-only. Whether the control takes part in form validation. |\n\n### Methods\n\n| Method | Description |\n|---|---|\n| `focus(options: FocusOptions)` | Moves focus to the selected radio, or the first enabled one. |\n| `checkValidity()` | Returns whether the value is valid, without showing an error. |\n| `reportValidity()` | Returns whether the value is valid, and shows the error if not. |\n| `setCustomValidity(message: string)` | Sets a custom error message. Pass an empty string to clear it. |\n\n### Events\n\n| Event | Type | Description |\n|---|---|---|\n| `input` | `Event` | Fired when the selection changes. |\n| `change` | `Event` | Fired when the selection changes. |\n\n### Slots\n\n| Slot | Description |\n|---|---|\n| (default) | `<uf-radio>` elements. |\n| `label` | The group label, when you need markup. Overrides `label`. |\n| `hint` | Help text below the options. Overrides `hint`. |\n\n### CSS parts\n\n| Part | Description |\n|---|---|\n| `base` | The element with `role=\"radiogroup\"`. |\n| `form-label` | The group label. |\n| `options` | The wrapper around the radios. |\n| `hint` | The hint text. |\n| `error` | The validation message. |\n\n## `<uf-radio>` API\n\n### Attributes and properties\n\n| Attribute | Property | Type | Default | Description |\n|---|---|---|---|---|\n| `value` | | `string` | `''` | Value the group takes when this radio is selected. |\n| `checked` | | `boolean` | `false` | Whether this radio is selected. Set by the group. |\n| `disabled` | | `boolean` | `false` | Disables this option. |\n\n### Slots\n\n| Slot | Description |\n|---|---|\n| (default) | The label. |\n\n### CSS parts\n\n| Part | Description |\n|---|---|\n| `control` | The circle. |\n| `label` | The label text. |\n\n### CSS custom properties\n\n| Property | Description |\n|---|---|\n| `--uf-radio-size` | Size of the circle. |\n| `--uf-radio-checked-bg` | Color of the circle when checked. |\n"
|
|
328
|
+
},
|
|
329
|
+
{
|
|
330
|
+
"name": "segmented-control",
|
|
331
|
+
"title": "Segmented control",
|
|
332
|
+
"summary": "Picks one of a few options, side by side.",
|
|
333
|
+
"tags": [
|
|
334
|
+
"uf-segmented-control"
|
|
335
|
+
],
|
|
336
|
+
"imports": [
|
|
337
|
+
"@unframed/core/segmented-control"
|
|
338
|
+
],
|
|
339
|
+
"docs": "# Segmented control\n\nA row of buttons for one choice among a few, like \"List / Grid\" or \"Day /\nWeek / Month\". The choices are plain `<option>` children. One is always\nselected: the `value` attribute, an option marked `selected`, or the first.\n\nIt's a radio group for assistive tech: arrow keys move and select, Home and\nEnd jump to the ends, and it submits its value with a form.\n\nTags: `<uf-segmented-control>`. Import: `import '@unframed/core/segmented-control';` (or `npx @unframed/cli add segmented-control` to copy the source).\n\n## Basic\n\nOne choice among a few, always with one picked: the `value` attribute, a `selected` option, or the first. Arrow keys move and pick.\n\n```html\n<uf-segmented-control name=\"view\" label=\"View\" value=\"week\">\n <option value=\"day\">Day</option>\n <option value=\"week\">Week</option>\n <option value=\"month\">Month</option>\n <option value=\"year\" disabled>Year</option>\n</uf-segmented-control>\n```\n\n- For more than five or six options, or long labels, use a select or a radio group instead.\n\n## Sizes\n\n```html\n<uf-segmented-control size=\"sm\" label=\"Layout\">\n <option>List</option>\n <option>Grid</option>\n</uf-segmented-control>\n```\n\n## `<uf-segmented-control>` API\n\n### Attributes and properties\n\n| Attribute | Property | Type | Default | Description |\n|---|---|---|---|---|\n| `value` | `defaultValue` | `string \\| undefined` | | Initially selected value, restored on form reset. Set with the `value` attribute. |\n| `label` | | `string \\| undefined` | | Visible label, also the group's accessible name. |\n| `hint` | | `string \\| undefined` | | Help text below the options. |\n| `size` | | `FieldSize` | `'md'` | Size of the buttons. |\n| `name` | | `string` | `''` | Name submitted with the form. |\n| `disabled` | | `boolean` | `false` | Disables the control. |\n| `required` | | `boolean` | `false` | Makes the control required for form submission. |\n\n### Properties only\n\n| Property | Type | Description |\n|---|---|---|\n| `value` | `string` | The selected option's value. |\n| `form` | `HTMLFormElement \\| null` | Read-only. The form this control belongs to, if any. |\n| `validity` | `ValidityState` | Read-only. The control's validity state, like a native input's. |\n| `validationMessage` | `string` | Read-only. The error message shown when the value is invalid. |\n| `willValidate` | `boolean` | Read-only. Whether the control takes part in form validation. |\n\n### Methods\n\n| Method | Description |\n|---|---|\n| `focus(options: FocusOptions)` | Moves focus to the selected option. |\n| `checkValidity()` | Returns whether the value is valid, without showing an error. |\n| `reportValidity()` | Returns whether the value is valid, and shows the error if not. |\n| `setCustomValidity(message: string)` | Sets a custom error message. Pass an empty string to clear it. |\n\n### Events\n\n| Event | Type | Description |\n|---|---|---|\n| `input` | `Event` | The user picked another option. |\n| `change` | `Event` | The user picked another option. |\n\n### Slots\n\n| Slot | Description |\n|---|---|\n| (default) | `<option>` elements. `disabled` options can't be picked. |\n| `label` | The label, when you need markup. Overrides `label`. |\n| `hint` | Help text below the options. Overrides `hint`. |\n\n### CSS parts\n\n| Part | Description |\n|---|---|\n| `base` | The element with `role=\"radiogroup\"`. |\n| `form-label` | The label. |\n| `options` | The row of buttons. |\n| `option` | One button. The selected one also has the part `selected`. |\n| `selected` | The selected button. |\n| `hint` | The hint text. |\n\n### CSS custom properties\n\n| Property | Description |\n|---|---|\n| `--uf-segmented-control-bg` | Background behind the buttons. |\n| `--uf-segmented-control-selected-bg` | Background of the selected button. |\n| `--uf-segmented-control-selected-color` | Text color of the selected button. |\n| `--uf-segmented-control-radius` | Corner radius of the row. |\n"
|
|
340
|
+
},
|
|
341
|
+
{
|
|
342
|
+
"name": "select",
|
|
343
|
+
"title": "Select",
|
|
344
|
+
"summary": "Lets users pick one option from a dropdown list.",
|
|
345
|
+
"tags": [
|
|
346
|
+
"uf-select"
|
|
347
|
+
],
|
|
348
|
+
"imports": [
|
|
349
|
+
"@unframed/core/select"
|
|
350
|
+
],
|
|
351
|
+
"docs": "# Select\n\nA dropdown built on the native `<select>`, so it gets the platform's\nkeyboard support, screen reader support and mobile pickers for free.\nWrite options as plain `<option>` and `<optgroup>` children.\n\nTags: `<uf-select>`. Import: `import '@unframed/core/select';` (or `npx @unframed/cli add select` to copy the source).\n\n## Native options\n\nBuilt on the native `<select>`: write plain `<option>` and `<optgroup>` children.\n\n```html\n<uf-select label=\"Country\" placeholder=\"Choose a country\">\n <option value=\"it\">Italy</option>\n <option value=\"fr\">France</option>\n <optgroup label=\"Elsewhere\">\n <option value=\"jp\">Japan</option>\n <option value=\"us\">United States</option>\n </optgroup>\n</uf-select>\n```\n\n## `<uf-select>` API\n\n### Attributes and properties\n\n| Attribute | Property | Type | Default | Description |\n|---|---|---|---|---|\n| `value` | `defaultValue` | `string \\| undefined` | | Initially selected value, restored on form reset. Set with the `value` attribute. |\n| `label` | | `string \\| undefined` | | Visible label. |\n| `hint` | | `string \\| undefined` | | Help text below the field. |\n| `placeholder` | | `string \\| undefined` | | Text shown while nothing is selected. |\n| `size` | | `FieldSize` | `'md'` | Size of the field. |\n| `autocomplete` | | `AutoFill \\| undefined` | | Native `autocomplete` hint. |\n| `name` | | `string` | `''` | Name submitted with the form. |\n| `disabled` | | `boolean` | `false` | Disables the control. |\n| `required` | | `boolean` | `false` | Makes the control required for form submission. |\n\n### Properties only\n\n| Property | Type | Description |\n|---|---|---|\n| `value` | `string` | The selected option's value. |\n| `form` | `HTMLFormElement \\| null` | Read-only. The form this control belongs to, if any. |\n| `validity` | `ValidityState` | Read-only. The control's validity state, like a native input's. |\n| `validationMessage` | `string` | Read-only. The error message shown when the value is invalid. |\n| `willValidate` | `boolean` | Read-only. Whether the control takes part in form validation. |\n\n### Methods\n\n| Method | Description |\n|---|---|\n| `checkValidity()` | Returns whether the value is valid, without showing an error. |\n| `reportValidity()` | Returns whether the value is valid, and shows the error if not. |\n| `setCustomValidity(message: string)` | Sets a custom error message. Pass an empty string to clear it. |\n\n### Events\n\n| Event | Type | Description |\n|---|---|---|\n| `input` | | Fired when the selection changes. |\n| `change` | `Event` | Fired when the selection changes. |\n\n### Slots\n\n| Slot | Description |\n|---|---|\n| (default) | `<option>` and `<optgroup>` elements. They are mirrored into the native select. |\n| `label` | The label, when you need markup. Overrides `label`. |\n| `hint` | Help text below the field. Overrides `hint`. |\n| `prefix` | An icon before the selected value. |\n\n### CSS parts\n\n| Part | Description |\n|---|---|\n| `field` | The wrapper around label, control, hint and error. |\n| `form-label` | The label. |\n| `box` | The bordered box. |\n| `select` | The native `<select>`. |\n| `chevron` | The dropdown arrow. |\n| `hint` | The hint text. |\n| `error` | The validation message. |\n\n### CSS custom properties\n\n| Property | Description |\n|---|---|\n| `--uf-field-bg` | Background of the box. |\n| `--uf-field-border-color` | Border color of the box. |\n| `--uf-field-radius` | Corner radius of the box. |\n"
|
|
352
|
+
},
|
|
353
|
+
{
|
|
354
|
+
"name": "skeleton",
|
|
355
|
+
"title": "Skeleton",
|
|
356
|
+
"summary": "Holds the place of content while it loads.",
|
|
357
|
+
"tags": [
|
|
358
|
+
"uf-skeleton"
|
|
359
|
+
],
|
|
360
|
+
"imports": [
|
|
361
|
+
"@unframed/core/skeleton"
|
|
362
|
+
],
|
|
363
|
+
"docs": "# Skeleton\n\nA grey placeholder in the shape of content that's still loading: lines of\ntext, a block or a circle. It's decorative, hidden from assistive tech: mark\nthe region that's loading with `aria-busy=\"true\"`, and announce the result\nwhen it arrives.\n\nSize it with `width` and `height` in CSS; `text` lines take the height of a\nline of text, and `circle` stays round.\n\nTags: `<uf-skeleton>`. Import: `import '@unframed/core/skeleton';` (or `npx @unframed/cli add skeleton` to copy the source).\n\n## Shapes\n\nLines of text (`lines`), a circle or a block (`rect`), sized with CSS. A shimmer sweeps across them, except for people who asked for less motion.\n\n```html\n<div aria-busy=\"true\">\n <uf-skeleton shape=\"circle\"></uf-skeleton>\n <uf-skeleton lines=\"3\"></uf-skeleton>\n\n <uf-skeleton shape=\"rect\"></uf-skeleton>\n</div>\n```\n\n- Skeletons are hidden from screen readers. Mark the region that is loading with `aria-busy=\"true\"`, and remove it when the content arrives.\n\n## A card while it loads\n\n```html\n<uf-card aria-busy=\"true\">\n <uf-skeleton slot=\"media\" shape=\"rect\" style=\"height: 8rem\"></uf-skeleton>\n <uf-skeleton slot=\"header\" style=\"width: 60%\"></uf-skeleton>\n <uf-skeleton lines=\"2\"></uf-skeleton>\n</uf-card>\n```\n\n## `<uf-skeleton>` API\n\n### Attributes and properties\n\n| Attribute | Property | Type | Default | Description |\n|---|---|---|---|---|\n| `shape` | | `SkeletonShape` | `'text'` | `text` (lines of text), `rect` (a block, like an image) or `circle` (like an avatar). |\n| `lines` | | `number` | `1` | Number of lines of a `text` placeholder. |\n\n### CSS parts\n\n| Part | Description |\n|---|---|\n| `base` | The placeholder, or the wrapper around its lines. |\n| `line` | One line of a `text` placeholder. |\n\n### CSS custom properties\n\n| Property | Description |\n|---|---|\n| `--uf-skeleton-color` | Background of the placeholder. |\n| `--uf-skeleton-highlight` | Color of the shimmer that sweeps across it. |\n| `--uf-skeleton-radius` | Corner radius of `text` and `rect` placeholders. |\n"
|
|
364
|
+
},
|
|
365
|
+
{
|
|
366
|
+
"name": "slider",
|
|
367
|
+
"title": "Slider",
|
|
368
|
+
"summary": "Lets users pick a number in a range.",
|
|
369
|
+
"tags": [
|
|
370
|
+
"uf-slider"
|
|
371
|
+
],
|
|
372
|
+
"imports": [
|
|
373
|
+
"@unframed/core/slider"
|
|
374
|
+
],
|
|
375
|
+
"docs": "# Slider\n\nPicks a number in a range by dragging a handle, or with the arrow keys. Built\non the native range input, so keyboard, touch and screen readers work as\nthey do everywhere; it submits its value with the form.\n\nTags: `<uf-slider>`. Import: `import '@unframed/core/slider';` (or `npx @unframed/cli add slider` to copy the source).\n\n## Basic\n\nA native range input underneath: arrow keys, Page Up/Down, Home and End, touch, and screen readers work as everywhere.\n\n```html\n<uf-slider name=\"volume\" label=\"Volume\" hint=\"Applies to every device\" value=\"40\" show-value></uf-slider>\n```\n\n- The value is a number. It submits with its form, and `input` fires while dragging, `change` when the user lets go.\n\n## Range and step\n\n`min`, `max` and `step`. The value always lands on a step within the range.\n\n```html\n<uf-slider label=\"Maximum price (€)\" min=\"0\" max=\"500\" step=\"10\" value=\"250\" show-value></uf-slider>\n<uf-slider label=\"Rating\" min=\"1\" max=\"5\" value=\"4\" show-value disabled></uf-slider>\n```\n\n## `<uf-slider>` API\n\n### Attributes and properties\n\n| Attribute | Property | Type | Default | Description |\n|---|---|---|---|---|\n| `value` | `defaultValue` | `number \\| undefined` | | Initial value, restored on form reset. Set with the `value` attribute. Defaults to the middle of the range, like a native slider. |\n| `min` | | `number` | `0` | Lowest value. |\n| `max` | | `number` | `100` | Highest value. |\n| `step` | | `number` | `1` | Granularity: the value moves in steps of this size. |\n| `label` | | `string \\| undefined` | | Visible label, also the slider's accessible name. |\n| `hint` | | `string \\| undefined` | | Help text below the slider. |\n| `show-value` | `showValue` | `boolean` | `false` | Shows the current value next to the label. |\n| `size` | | `FieldSize` | `'md'` | Size of the track and handle: `sm`, `md` or `lg`. |\n| `name` | | `string` | `''` | Name submitted with the form. |\n| `disabled` | | `boolean` | `false` | Disables the control. |\n| `required` | | `boolean` | `false` | Makes the control required for form submission. |\n\n### Properties only\n\n| Property | Type | Description |\n|---|---|---|\n| `value` | `number` | Current value. |\n| `form` | `HTMLFormElement \\| null` | Read-only. The form this control belongs to, if any. |\n| `validity` | `ValidityState` | Read-only. The control's validity state, like a native input's. |\n| `validationMessage` | `string` | Read-only. The error message shown when the value is invalid. |\n| `willValidate` | `boolean` | Read-only. Whether the control takes part in form validation. |\n\n### Methods\n\n| Method | Description |\n|---|---|\n| `checkValidity()` | Returns whether the value is valid, without showing an error. |\n| `reportValidity()` | Returns whether the value is valid, and shows the error if not. |\n| `setCustomValidity(message: string)` | Sets a custom error message. Pass an empty string to clear it. |\n\n### Events\n\n| Event | Type | Description |\n|---|---|---|\n| `input` | | Fired while the handle moves. |\n| `change` | `Event` | Fired when the user lets go, or after a key press. |\n\n### Slots\n\n| Slot | Description |\n|---|---|\n| `label` | The label, when you need markup. Overrides `label`. |\n| `hint` | Help text below the slider. Overrides `hint`. |\n\n### CSS parts\n\n| Part | Description |\n|---|---|\n| `field` | The wrapper around label, slider, hint and error. |\n| `form-label` | The label. |\n| `value` | The current value, when `show-value` is set. |\n| `input` | The native range `<input>`. |\n| `hint` | The hint text. |\n| `error` | The validation message. |\n\n### CSS custom properties\n\n| Property | Description |\n|---|---|\n| `--uf-slider-track-height` | Height of the track. |\n| `--uf-slider-track-color` | Color of the track's empty part. |\n| `--uf-slider-indicator-color` | Color of the track up to the handle. |\n| `--uf-slider-thumb-size` | Diameter of the handle. |\n"
|
|
376
|
+
},
|
|
377
|
+
{
|
|
378
|
+
"name": "spinner",
|
|
379
|
+
"title": "Spinner",
|
|
380
|
+
"summary": "Shows that something is loading.",
|
|
381
|
+
"tags": [
|
|
382
|
+
"uf-spinner"
|
|
383
|
+
],
|
|
384
|
+
"imports": [
|
|
385
|
+
"@unframed/core/spinner"
|
|
386
|
+
],
|
|
387
|
+
"docs": "# Spinner\n\nA spinning circle for work in progress whose length isn't known. Screen\nreaders announce it as \"Loading\" (translatable), or as its `label`.\n\nTags: `<uf-spinner>`. Import: `import '@unframed/core/spinner';` (or `npx @unframed/cli add spinner` to copy the source).\n\n## Sizes\n\n`sm`, `md` (the default) or `lg`, or any size with `--uf-spinner-size`.\n\n```html\n<uf-spinner size=\"sm\"></uf-spinner>\n<uf-spinner></uf-spinner>\n<uf-spinner size=\"lg\"></uf-spinner>\n<uf-spinner style=\"--uf-spinner-size: 3.5rem\"></uf-spinner>\n```\n\n## Label and color\n\nScreen readers announce \"Loading\" (translatable), or `label`. Colors come from the theme, or `--uf-spinner-indicator-color`.\n\n```html\n<uf-spinner label=\"Loading John Smith's orders\"></uf-spinner>\n<uf-spinner label=\"Saving\" style=\"--uf-spinner-indicator-color: var(--uf-color-success)\"></uf-spinner>\n```\n\n- For a button that is busy, use the button's `loading` instead: it keeps the button focusable and its label for screen readers.\n\n## `<uf-spinner>` API\n\n### Attributes and properties\n\n| Attribute | Property | Type | Default | Description |\n|---|---|---|---|---|\n| `label` | | `string \\| undefined` | | Accessible name. Defaults to \"Loading\", in the page's language. |\n| `size` | | `SpinnerSize` | `'md'` | Size: `sm`, `md` or `lg`. |\n\n### CSS parts\n\n| Part | Description |\n|---|---|\n| `base` | The spinner. |\n\n### CSS custom properties\n\n| Property | Description |\n|---|---|\n| `--uf-spinner-size` | Diameter. Overrides `size`. |\n| `--uf-spinner-track-color` | Color of the circle. |\n| `--uf-spinner-indicator-color` | Color of the moving arc. |\n"
|
|
388
|
+
},
|
|
389
|
+
{
|
|
390
|
+
"name": "switch",
|
|
391
|
+
"title": "Switch",
|
|
392
|
+
"summary": "Turns a setting on or off.",
|
|
393
|
+
"tags": [
|
|
394
|
+
"uf-switch"
|
|
395
|
+
],
|
|
396
|
+
"imports": [
|
|
397
|
+
"@unframed/core/switch"
|
|
398
|
+
],
|
|
399
|
+
"docs": "# Switch\n\nAn on/off switch with its label as content. Use it for settings that apply\nimmediately; use a checkbox for choices submitted later with a form.\n\nTags: `<uf-switch>`. Import: `import '@unframed/core/switch';` (or `npx @unframed/cli add switch` to copy the source).\n\n## Settings that apply immediately\n\n```html\n<uf-switch checked>Notifications</uf-switch>\n```\n\n## `<uf-switch>` API\n\n### Attributes and properties\n\n| Attribute | Property | Type | Default | Description |\n|---|---|---|---|---|\n| `hint` | | `string \\| undefined` | | Help text below the label. |\n| `checked` | `defaultChecked` | `boolean` | `false` | Initial state, restored on form reset. Set with the `checked` attribute. |\n| `value` | | `string` | `'on'` | Value submitted with the form when checked. |\n| `size` | | `FieldSize` | `'md'` | Size of the control and its label: `sm`, `md` or `lg`. |\n| `name` | | `string` | `''` | Name submitted with the form. |\n| `disabled` | | `boolean` | `false` | Disables the control. |\n| `required` | | `boolean` | `false` | Makes the control required for form submission. |\n\n### Properties only\n\n| Property | Type | Description |\n|---|---|---|\n| `checked` | `boolean` | Whether the control is on. |\n| `form` | `HTMLFormElement \\| null` | Read-only. The form this control belongs to, if any. |\n| `validity` | `ValidityState` | Read-only. The control's validity state, like a native input's. |\n| `validationMessage` | `string` | Read-only. The error message shown when the value is invalid. |\n| `willValidate` | `boolean` | Read-only. Whether the control takes part in form validation. |\n\n### Methods\n\n| Method | Description |\n|---|---|\n| `toggle()` | Toggles the control, as if the user clicked it. |\n| `checkValidity()` | Returns whether the value is valid, without showing an error. |\n| `reportValidity()` | Returns whether the value is valid, and shows the error if not. |\n| `setCustomValidity(message: string)` | Sets a custom error message. Pass an empty string to clear it. |\n\n### Events\n\n| Event | Type | Description |\n|---|---|---|\n| `input` | | Fired when the state changes. |\n| `change` | `Event` | Fired when the state changes. |\n\n### Slots\n\n| Slot | Description |\n|---|---|\n| (default) | The label. |\n| `hint` | Help text below the label. Overrides `hint`. |\n\n### CSS parts\n\n| Part | Description |\n|---|---|\n| `base` | The `<label>` wrapping control and label. |\n| `control` | The track. |\n| `thumb` | The moving knob. |\n| `label` | The label text. |\n| `hint` | The hint text. |\n| `error` | The validation message. |\n\n### CSS custom properties\n\n| Property | Description |\n|---|---|\n| `--uf-switch-width` | Width of the track. |\n| `--uf-switch-height` | Height of the track. |\n| `--uf-switch-checked-bg` | Track color when on. |\n| `--uf-switch-radius` | Corner radius of track and thumb. Use `999px` for a pill. |\n"
|
|
400
|
+
},
|
|
401
|
+
{
|
|
402
|
+
"name": "table",
|
|
403
|
+
"title": "Table",
|
|
404
|
+
"summary": "Shows data in rows and columns, with sorting.",
|
|
405
|
+
"tags": [
|
|
406
|
+
"uf-table"
|
|
407
|
+
],
|
|
408
|
+
"imports": [
|
|
409
|
+
"@unframed/core/table"
|
|
410
|
+
],
|
|
411
|
+
"docs": "# Table\n\nA table of data, from `columns` and `rows`. Users can sort by the columns\nmarked `sortable`. Rendered as a native `<table>`, so assistive tech reads\nheaders and cells as usual.\n\nSet `columns` and `rows` as properties, or as JSON attributes in plain HTML.\nThe table sorts `rows` itself; with `manual-sort` it only shows the order\nand tells you, so you can sort on the server. Combine it with\n`<uf-pagination>` for long lists.\n\nTags: `<uf-table>`. Import: `import '@unframed/core/table';` (or `npx @unframed/cli add table` to copy the source).\n\n## Columns, rows and sorting\n\nDescribe the columns and pass the rows. Columns marked `sortable` sort on click.\n\n```html\n<uf-table\n label=\"Team\"\n columns='[{\"key\": \"name\", \"label\": \"Name\", \"sortable\": true},\n {\"key\": \"role\", \"label\": \"Role\"},\n {\"key\": \"commits\", \"label\": \"Commits\", \"sortable\": true, \"align\": \"end\"}]'\n rows='[{\"name\": \"John Smith\", \"role\": \"Product designer\", \"commits\": 412},\n {\"name\": \"Jane Doe\", \"role\": \"Engineer\", \"commits\": 1290}]'\n></uf-table>\n```\n\n- In plain HTML, `columns` and `rows` can be JSON attributes. From JavaScript, set them as properties.\n- Give the table a `label`: it names the table for screen readers.\n\n## Formatting, and pages\n\n`format` turns a value into text or a DOM node, like a badge. Sorting still uses the raw values.\n\n```html\n<uf-table id=\"invoices\" label=\"Invoices\" row-key=\"id\"></uf-table>\n<uf-pagination id=\"pages\" label=\"Invoice pages\"></uf-pagination>\n\n<script type=\"module\">\n const table = document.querySelector('#invoices');\n const pages = document.querySelector('#pages');\n const pageSize = 8;\n\n table.columns = [\n { key: 'customer', label: 'Customer', sortable: true },\n { key: 'amount', label: 'Amount', sortable: true, align: 'end',\n format: (value) => euro.format(value) },\n ];\n pages.pages = Math.ceil(invoices.length / pageSize);\n\n const show = (page) => (table.rows = invoices.slice((page - 1) * pageSize, page * pageSize));\n pages.addEventListener('uf-page-change', (event) => show(event.detail.page));\n show(1);\n</script>\n```\n\n- To sort on the server, add `manual-sort`: the table shows the sort and fires `uf-sort`, and you load the rows in that order.\n- Set `--uf-table-max-height` to scroll long tables under a sticky header.\n\n## `<uf-table>` API\n\n### Attributes and properties\n\n| Attribute | Property | Type | Default | Description |\n|---|---|---|---|---|\n| `columns` | | `TableColumn[]` | `[]` | The columns, in order. As an attribute, JSON: `[{\"key\": \"name\", \"label\": \"Name\"}]`. |\n| `rows` | | `TableRow[]` | `[]` | The data, one object per row. As an attribute, JSON: `[{\"name\": \"John\"}]`. |\n| `label` | | `string \\| undefined` | | Accessible name of the table, e.g. \"Invoices\". |\n| `sort-key` | `sortKey` | `string \\| undefined` | | Key of the column the rows are sorted by. |\n| `sort-direction` | `sortDirection` | `SortDirection` | `'ascending'` | Sort order: `ascending` or `descending`. |\n| `manual-sort` | `manualSort` | `boolean` | `false` | Doesn't sort the rows: only shows the sort and fires `uf-sort`, for sorting on the server. |\n| `row-key` | `rowKey` | `string \\| undefined` | | Row property that identifies each row, so rows keep their DOM when the data changes. Defaults to the index. |\n| `striped` | | `boolean` | `false` | Shades every other row. |\n| `density` | | `TableDensity` | `'comfortable'` | Row spacing: `comfortable` or `compact`. |\n\n### Events\n\n| Event | Type | Description |\n|---|---|---|\n| `uf-sort` | `CustomEvent<TableSortDetail>` | The user sorted by a column. |\n\n### Slots\n\n| Slot | Description |\n|---|---|\n| `empty` | Shown when there are no rows. Defaults to \"No data\", or its translation. |\n\n### CSS parts\n\n| Part | Description |\n|---|---|\n| `base` | The scroll container around the table. |\n| `table` | The `<table>`. |\n| `header-cell` | Every header cell (`<th>`). |\n| `sort-button` | The button in a sortable header. |\n| `row` | Every body row. |\n| `cell` | Every body cell. |\n| `empty` | The cell shown when there are no rows. |\n\n### CSS custom properties\n\n| Property | Description |\n|---|---|\n| `--uf-table-max-height` | Height after which the body scrolls under a sticky header. |\n| `--uf-table-border-color` | Border color between rows. |\n| `--uf-table-header-bg` | Background of the header row. |\n| `--uf-table-stripe-bg` | Background of every other row, with `striped`. |\n| `--uf-table-hover-bg` | Background of the row under the pointer. |\n"
|
|
412
|
+
},
|
|
413
|
+
{
|
|
414
|
+
"name": "tabs",
|
|
415
|
+
"title": "Tabs",
|
|
416
|
+
"summary": "Organizes content into panels, one visible at a time.",
|
|
417
|
+
"tags": [
|
|
418
|
+
"uf-tabs",
|
|
419
|
+
"uf-tab",
|
|
420
|
+
"uf-tab-panel"
|
|
421
|
+
],
|
|
422
|
+
"imports": [
|
|
423
|
+
"@unframed/core/tabs"
|
|
424
|
+
],
|
|
425
|
+
"docs": "# Tabs\n\nTabs that switch between panels. Arrow keys move between tabs, Home and End\njump to the ends, and only the selected tab is in the tab order.\n\nTags: `<uf-tabs>`, `<uf-tab>`, `<uf-tab-panel>`. Import: `import '@unframed/core/tabs';` (or `npx @unframed/cli add tabs` to copy the source).\n\n## Tabs and panels\n\n```html\n<uf-tabs label=\"Project settings\">\n <uf-tab panel=\"general\">General</uf-tab>\n <uf-tab panel=\"members\">Members</uf-tab>\n <uf-tab-panel name=\"general\">General settings for the project.</uf-tab-panel>\n <uf-tab-panel name=\"members\">Invite people and manage roles.</uf-tab-panel>\n</uf-tabs>\n```\n\n## `<uf-tabs>` API\n\n### Attributes and properties\n\n| Attribute | Property | Type | Default | Description |\n|---|---|---|---|---|\n| `value` | | `string` | `''` | Name of the selected panel. Defaults to the first enabled tab. |\n| `activation` | | `'auto' \\| 'manual'` | `'auto'` | `auto` selects a tab as soon as it gets focus; `manual` waits for Enter or Space. |\n| `orientation` | | `'horizontal' \\| 'vertical'` | `'horizontal'` | Lays the tab list out horizontally or vertically. |\n| `label` | | `string \\| undefined` | | Accessible name for the tab list. |\n\n### Methods\n\n| Method | Description |\n|---|---|\n| `select(name: string)` | Selects the tab for the given panel name. |\n\n### Events\n\n| Event | Type | Description |\n|---|---|---|\n| `uf-tab-change` | `CustomEvent<TabChangeDetail>` | The selected tab changed. |\n\n### Slots\n\n| Slot | Description |\n|---|---|\n| (default) | `<uf-tab>` and `<uf-tab-panel>` elements. Tabs are moved into the tab list automatically. |\n| `nav` | The tab list. You don't need to set this yourself. |\n\n### CSS parts\n\n| Part | Description |\n|---|---|\n| `tablist` | The element with `role=\"tablist\"`. |\n| `panels` | The wrapper around the panels. |\n\n### CSS custom properties\n\n| Property | Description |\n|---|---|\n| `--uf-tabs-indicator-color` | Color of the selected tab's underline. |\n\n## `<uf-tab>` API\n\n### Attributes and properties\n\n| Attribute | Property | Type | Default | Description |\n|---|---|---|---|---|\n| `panel` | | `string` | `''` | Name of the `<uf-tab-panel>` this tab shows. |\n| `disabled` | | `boolean` | `false` | Disables the tab. |\n\n### Slots\n\n| Slot | Description |\n|---|---|\n| (default) | The tab label. |\n\n### CSS parts\n\n| Part | Description |\n|---|---|\n| `base` | The tab's inner wrapper. |\n\n## `<uf-tab-panel>` API\n\n### Attributes and properties\n\n| Attribute | Property | Type | Default | Description |\n|---|---|---|---|---|\n| `name` | | `string` | `''` | Name the matching tab refers to with `panel`. |\n\n### Slots\n\n| Slot | Description |\n|---|---|\n| (default) | The panel content. |\n\n### CSS custom properties\n\n| Property | Description |\n|---|---|\n| `--uf-tab-panel-padding` | Padding around the content. |\n"
|
|
426
|
+
},
|
|
427
|
+
{
|
|
428
|
+
"name": "textarea",
|
|
429
|
+
"title": "Textarea",
|
|
430
|
+
"summary": "Lets users enter multiple lines of text.",
|
|
431
|
+
"tags": [
|
|
432
|
+
"uf-textarea"
|
|
433
|
+
],
|
|
434
|
+
"imports": [
|
|
435
|
+
"@unframed/core/textarea"
|
|
436
|
+
],
|
|
437
|
+
"docs": "# Textarea\n\nA multi-line text field with a built-in label, hint and validation message.\n\nTags: `<uf-textarea>`. Import: `import '@unframed/core/textarea';` (or `npx @unframed/cli add textarea` to copy the source).\n\n## Grows with its content\n\n```html\n<uf-textarea label=\"Bio\" resize=\"auto\" rows=\"2\" maxlength=\"280\" hint=\"Up to 280 characters.\"></uf-textarea>\n```\n\n## `<uf-textarea>` API\n\n### Attributes and properties\n\n| Attribute | Property | Type | Default | Description |\n|---|---|---|---|---|\n| `value` | `defaultValue` | `string` | `''` | Initial value, restored on form reset. Set with the `value` attribute. |\n| `label` | | `string \\| undefined` | | Visible label. |\n| `hint` | | `string \\| undefined` | | Help text below the field. |\n| `placeholder` | | `string \\| undefined` | | Placeholder text. |\n| `rows` | | `number` | `4` | Visible number of lines. |\n| `resize` | | `TextareaResize` | `'vertical'` | How the user can resize the field. `auto` grows with the content. |\n| `size` | | `FieldSize` | `'md'` | Size of the field. |\n| `readonly` | | `boolean` | `false` | Makes the field read-only. |\n| `autocomplete` | | `AutoFill \\| undefined` | | Native `autocomplete` hint. |\n| `minlength` | | `number \\| undefined` | | Minimum length. |\n| `maxlength` | | `number \\| undefined` | | Maximum length. |\n| `name` | | `string` | `''` | Name submitted with the form. |\n| `disabled` | | `boolean` | `false` | Disables the control. |\n| `required` | | `boolean` | `false` | Makes the control required for form submission. |\n\n### Properties only\n\n| Property | Type | Description |\n|---|---|---|\n| `value` | `string` | Current value. |\n| `form` | `HTMLFormElement \\| null` | Read-only. The form this control belongs to, if any. |\n| `validity` | `ValidityState` | Read-only. The control's validity state, like a native input's. |\n| `validationMessage` | `string` | Read-only. The error message shown when the value is invalid. |\n| `willValidate` | `boolean` | Read-only. Whether the control takes part in form validation. |\n\n### Methods\n\n| Method | Description |\n|---|---|\n| `select()` | Selects all text in the field. |\n| `checkValidity()` | Returns whether the value is valid, without showing an error. |\n| `reportValidity()` | Returns whether the value is valid, and shows the error if not. |\n| `setCustomValidity(message: string)` | Sets a custom error message. Pass an empty string to clear it. |\n\n### Events\n\n| Event | Type | Description |\n|---|---|---|\n| `input` | | Fired on every keystroke. |\n| `change` | `Event` | Fired when the value is committed (blur). |\n\n### Slots\n\n| Slot | Description |\n|---|---|\n| `label` | The label, when you need markup. Overrides `label`. |\n| `hint` | Help text below the field. Overrides `hint`. |\n\n### CSS parts\n\n| Part | Description |\n|---|---|\n| `field` | The wrapper around label, control, hint and error. |\n| `form-label` | The label. |\n| `box` | The bordered box around the textarea. |\n| `textarea` | The native `<textarea>`. |\n| `hint` | The hint text. |\n| `error` | The validation message. |\n\n### CSS custom properties\n\n| Property | Description |\n|---|---|\n| `--uf-field-bg` | Background of the box. |\n| `--uf-field-border-color` | Border color of the box. |\n| `--uf-field-radius` | Corner radius of the box. |\n"
|
|
438
|
+
},
|
|
439
|
+
{
|
|
440
|
+
"name": "toast",
|
|
441
|
+
"title": "Toast",
|
|
442
|
+
"summary": "Shows short, temporary notifications.",
|
|
443
|
+
"tags": [
|
|
444
|
+
"uf-toaster"
|
|
445
|
+
],
|
|
446
|
+
"imports": [
|
|
447
|
+
"@unframed/core/toast"
|
|
448
|
+
],
|
|
449
|
+
"docs": "# Toast\n\nThe region that shows toasts. You rarely need to add it yourself: `toast()`\ncreates one on first use. Add it to choose a placement, or to hold\ntoasts in a specific place in the DOM.\n\nTags: `<uf-toaster>`. Import: `import '@unframed/core/toast';` (or `npx @unframed/cli add toast` to copy the source).\n\n## Variants\n\nCall `toast()` from anywhere; the toaster is created on first use.\n\n```html\n<script type=\"module\">\n import { toast } from '@unframed/core/toast';\n toast('Changes published.', { variant: 'success' });\n</script>\n```\n\n## `<uf-toaster>` API\n\n### Attributes and properties\n\n| Attribute | Property | Type | Default | Description |\n|---|---|---|---|---|\n| `placement` | | `ToasterPlacement` | `'bottom-end'` | Corner or edge of the viewport where toasts appear. |\n| `label` | | `string \\| undefined` | | Accessible name of the notification region. Defaults to \"Notifications\", or its translation. |\n\n### Methods\n\n| Method | Description |\n|---|---|\n| `add(message: string, options?: ToastOptions)` | Shows a toast in this region. Prefer the `toast()` function. |\n| `dismiss(id: number)` | Hides a toast by id. |\n\n### CSS parts\n\n| Part | Description |\n|---|---|\n| `region` | The list holding the toasts. |\n| `toast` | Each toast. |\n| `title` | A toast's title. |\n| `message` | A toast's message. |\n| `close-button` | A toast's dismiss button. |\n\n### CSS custom properties\n\n| Property | Description |\n|---|---|\n| `--uf-toast-width` | Width of each toast. |\n| `--uf-toaster-offset` | Distance from the viewport edges. |\n"
|
|
450
|
+
},
|
|
451
|
+
{
|
|
452
|
+
"name": "tooltip",
|
|
453
|
+
"title": "Tooltip",
|
|
454
|
+
"summary": "Shows a short hint for the element it wraps.",
|
|
455
|
+
"tags": [
|
|
456
|
+
"uf-tooltip"
|
|
457
|
+
],
|
|
458
|
+
"imports": [
|
|
459
|
+
"@unframed/core/tooltip"
|
|
460
|
+
],
|
|
461
|
+
"docs": "# Tooltip\n\nA short label that appears on hover and keyboard focus. Wrap the element it\ndescribes. The text is also set as the trigger's `aria-description` (unless it\nrepeats the trigger's own label), so screen reader users get it too. Don't put\ninteractive content in a tooltip.\n\nTags: `<uf-tooltip>`. Import: `import '@unframed/core/tooltip';` (or `npx @unframed/cli add tooltip` to copy the source).\n\n## On hover and focus\n\n```html\n<uf-tooltip content=\"Saves without publishing\">\n <uf-button variant=\"outline\">Save draft</uf-button>\n</uf-tooltip>\n```\n\n## `<uf-tooltip>` API\n\n### Attributes and properties\n\n| Attribute | Property | Type | Default | Description |\n|---|---|---|---|---|\n| `content` | | `string` | `''` | The tooltip text. |\n| `placement` | | `Placement` | `'top'` | Preferred side. Flips when there is no room. |\n| `disabled` | | `boolean` | `false` | Turns the tooltip off. |\n| `delay` | | `number` | `300` | Milliseconds to wait on hover before showing. Focus shows it immediately. |\n| `open` | | `boolean` | `false` | Whether the tooltip is showing. |\n\n### Methods\n\n| Method | Description |\n|---|---|\n| `show()` | Shows the tooltip, unless it's disabled. |\n| `hide()` | Hides the tooltip. |\n\n### Events\n\n| Event | Type | Description |\n|---|---|---|\n| `uf-show` | `Event` | The tooltip opened. |\n| `uf-hide` | `Event` | The tooltip closed. |\n\n### Slots\n\n| Slot | Description |\n|---|---|\n| (default) | The element the tooltip describes. |\n\n### CSS parts\n\n| Part | Description |\n|---|---|\n| `body` | The tooltip bubble. |\n\n### CSS custom properties\n\n| Property | Description |\n|---|---|\n| `--uf-tooltip-bg` | Background color. |\n| `--uf-tooltip-color` | Text color. |\n| `--uf-tooltip-max-width` | Maximum width. |\n| `--uf-tooltip-radius` | Corner radius. Defaults to `--uf-radius-sm`. |\n"
|
|
462
|
+
}
|
|
463
|
+
],
|
|
464
|
+
"elements": {
|
|
465
|
+
"uf-alert": {
|
|
466
|
+
"attributes": [
|
|
467
|
+
{
|
|
468
|
+
"name": "variant",
|
|
469
|
+
"values": [
|
|
470
|
+
"neutral",
|
|
471
|
+
"accent",
|
|
472
|
+
"info",
|
|
473
|
+
"success",
|
|
474
|
+
"warning",
|
|
475
|
+
"danger"
|
|
476
|
+
]
|
|
477
|
+
},
|
|
478
|
+
{
|
|
479
|
+
"name": "heading"
|
|
480
|
+
},
|
|
481
|
+
{
|
|
482
|
+
"name": "closable",
|
|
483
|
+
"boolean": true
|
|
484
|
+
},
|
|
485
|
+
{
|
|
486
|
+
"name": "without-icon",
|
|
487
|
+
"boolean": true
|
|
488
|
+
}
|
|
489
|
+
],
|
|
490
|
+
"properties": [
|
|
491
|
+
"variant",
|
|
492
|
+
"heading",
|
|
493
|
+
"closable",
|
|
494
|
+
"withoutIcon"
|
|
495
|
+
],
|
|
496
|
+
"events": [
|
|
497
|
+
"uf-show",
|
|
498
|
+
"uf-hide"
|
|
499
|
+
]
|
|
500
|
+
},
|
|
501
|
+
"uf-avatar": {
|
|
502
|
+
"attributes": [
|
|
503
|
+
{
|
|
504
|
+
"name": "src"
|
|
505
|
+
},
|
|
506
|
+
{
|
|
507
|
+
"name": "name"
|
|
508
|
+
},
|
|
509
|
+
{
|
|
510
|
+
"name": "initials"
|
|
511
|
+
},
|
|
512
|
+
{
|
|
513
|
+
"name": "size",
|
|
514
|
+
"values": [
|
|
515
|
+
"sm",
|
|
516
|
+
"md",
|
|
517
|
+
"lg",
|
|
518
|
+
"xl"
|
|
519
|
+
]
|
|
520
|
+
},
|
|
521
|
+
{
|
|
522
|
+
"name": "shape",
|
|
523
|
+
"values": [
|
|
524
|
+
"circle",
|
|
525
|
+
"square"
|
|
526
|
+
]
|
|
527
|
+
},
|
|
528
|
+
{
|
|
529
|
+
"name": "decorative",
|
|
530
|
+
"boolean": true
|
|
531
|
+
},
|
|
532
|
+
{
|
|
533
|
+
"name": "loading",
|
|
534
|
+
"values": [
|
|
535
|
+
"eager",
|
|
536
|
+
"lazy"
|
|
537
|
+
]
|
|
538
|
+
}
|
|
539
|
+
],
|
|
540
|
+
"properties": [
|
|
541
|
+
"src",
|
|
542
|
+
"name",
|
|
543
|
+
"initials",
|
|
544
|
+
"size",
|
|
545
|
+
"shape",
|
|
546
|
+
"decorative",
|
|
547
|
+
"loading"
|
|
548
|
+
],
|
|
549
|
+
"events": []
|
|
550
|
+
},
|
|
551
|
+
"uf-badge": {
|
|
552
|
+
"attributes": [
|
|
553
|
+
{
|
|
554
|
+
"name": "variant",
|
|
555
|
+
"values": [
|
|
556
|
+
"neutral",
|
|
557
|
+
"accent",
|
|
558
|
+
"info",
|
|
559
|
+
"success",
|
|
560
|
+
"warning",
|
|
561
|
+
"danger"
|
|
562
|
+
]
|
|
563
|
+
},
|
|
564
|
+
{
|
|
565
|
+
"name": "appearance",
|
|
566
|
+
"values": [
|
|
567
|
+
"soft",
|
|
568
|
+
"solid",
|
|
569
|
+
"outline"
|
|
570
|
+
]
|
|
571
|
+
},
|
|
572
|
+
{
|
|
573
|
+
"name": "size",
|
|
574
|
+
"values": [
|
|
575
|
+
"sm",
|
|
576
|
+
"md",
|
|
577
|
+
"lg"
|
|
578
|
+
]
|
|
579
|
+
},
|
|
580
|
+
{
|
|
581
|
+
"name": "dot",
|
|
582
|
+
"boolean": true
|
|
583
|
+
}
|
|
584
|
+
],
|
|
585
|
+
"properties": [
|
|
586
|
+
"variant",
|
|
587
|
+
"appearance",
|
|
588
|
+
"size",
|
|
589
|
+
"dot"
|
|
590
|
+
],
|
|
591
|
+
"events": []
|
|
592
|
+
},
|
|
593
|
+
"uf-accordion-item": {
|
|
594
|
+
"attributes": [
|
|
595
|
+
{
|
|
596
|
+
"name": "open",
|
|
597
|
+
"boolean": true
|
|
598
|
+
},
|
|
599
|
+
{
|
|
600
|
+
"name": "summary"
|
|
601
|
+
},
|
|
602
|
+
{
|
|
603
|
+
"name": "disabled",
|
|
604
|
+
"boolean": true
|
|
605
|
+
}
|
|
606
|
+
],
|
|
607
|
+
"properties": [
|
|
608
|
+
"open",
|
|
609
|
+
"summary",
|
|
610
|
+
"disabled",
|
|
611
|
+
"header"
|
|
612
|
+
],
|
|
613
|
+
"events": [
|
|
614
|
+
"uf-show",
|
|
615
|
+
"uf-hide"
|
|
616
|
+
]
|
|
617
|
+
},
|
|
618
|
+
"uf-accordion": {
|
|
619
|
+
"attributes": [
|
|
620
|
+
{
|
|
621
|
+
"name": "multiple",
|
|
622
|
+
"boolean": true
|
|
623
|
+
}
|
|
624
|
+
],
|
|
625
|
+
"properties": [
|
|
626
|
+
"multiple"
|
|
627
|
+
],
|
|
628
|
+
"events": []
|
|
629
|
+
},
|
|
630
|
+
"uf-button-group": {
|
|
631
|
+
"attributes": [
|
|
632
|
+
{
|
|
633
|
+
"name": "label"
|
|
634
|
+
},
|
|
635
|
+
{
|
|
636
|
+
"name": "orientation",
|
|
637
|
+
"values": [
|
|
638
|
+
"horizontal",
|
|
639
|
+
"vertical"
|
|
640
|
+
]
|
|
641
|
+
}
|
|
642
|
+
],
|
|
643
|
+
"properties": [
|
|
644
|
+
"label",
|
|
645
|
+
"orientation"
|
|
646
|
+
],
|
|
647
|
+
"events": []
|
|
648
|
+
},
|
|
649
|
+
"uf-breadcrumb-item": {
|
|
650
|
+
"attributes": [
|
|
651
|
+
{
|
|
652
|
+
"name": "href"
|
|
653
|
+
},
|
|
654
|
+
{
|
|
655
|
+
"name": "target"
|
|
656
|
+
},
|
|
657
|
+
{
|
|
658
|
+
"name": "current",
|
|
659
|
+
"boolean": true
|
|
660
|
+
}
|
|
661
|
+
],
|
|
662
|
+
"properties": [
|
|
663
|
+
"href",
|
|
664
|
+
"target",
|
|
665
|
+
"current"
|
|
666
|
+
],
|
|
667
|
+
"events": []
|
|
668
|
+
},
|
|
669
|
+
"uf-breadcrumbs": {
|
|
670
|
+
"attributes": [
|
|
671
|
+
{
|
|
672
|
+
"name": "label"
|
|
673
|
+
}
|
|
674
|
+
],
|
|
675
|
+
"properties": [
|
|
676
|
+
"label"
|
|
677
|
+
],
|
|
678
|
+
"events": []
|
|
679
|
+
},
|
|
680
|
+
"uf-card": {
|
|
681
|
+
"attributes": [
|
|
682
|
+
{
|
|
683
|
+
"name": "appearance",
|
|
684
|
+
"values": [
|
|
685
|
+
"outline",
|
|
686
|
+
"elevated",
|
|
687
|
+
"filled"
|
|
688
|
+
]
|
|
689
|
+
},
|
|
690
|
+
{
|
|
691
|
+
"name": "orientation",
|
|
692
|
+
"values": [
|
|
693
|
+
"vertical",
|
|
694
|
+
"horizontal"
|
|
695
|
+
]
|
|
696
|
+
}
|
|
697
|
+
],
|
|
698
|
+
"properties": [
|
|
699
|
+
"appearance",
|
|
700
|
+
"orientation"
|
|
701
|
+
],
|
|
702
|
+
"events": []
|
|
703
|
+
},
|
|
704
|
+
"uf-calendar": {
|
|
705
|
+
"attributes": [
|
|
706
|
+
{
|
|
707
|
+
"name": "value"
|
|
708
|
+
},
|
|
709
|
+
{
|
|
710
|
+
"name": "min"
|
|
711
|
+
},
|
|
712
|
+
{
|
|
713
|
+
"name": "max"
|
|
714
|
+
},
|
|
715
|
+
{
|
|
716
|
+
"name": "first-day-of-week"
|
|
717
|
+
},
|
|
718
|
+
{
|
|
719
|
+
"name": "range",
|
|
720
|
+
"boolean": true
|
|
721
|
+
},
|
|
722
|
+
{
|
|
723
|
+
"name": "start"
|
|
724
|
+
},
|
|
725
|
+
{
|
|
726
|
+
"name": "end"
|
|
727
|
+
}
|
|
728
|
+
],
|
|
729
|
+
"properties": [
|
|
730
|
+
"value",
|
|
731
|
+
"min",
|
|
732
|
+
"max",
|
|
733
|
+
"firstDayOfWeek",
|
|
734
|
+
"isDateDisabled",
|
|
735
|
+
"range",
|
|
736
|
+
"start",
|
|
737
|
+
"end"
|
|
738
|
+
],
|
|
739
|
+
"events": [
|
|
740
|
+
"change"
|
|
741
|
+
]
|
|
742
|
+
},
|
|
743
|
+
"uf-button": {
|
|
744
|
+
"attributes": [
|
|
745
|
+
{
|
|
746
|
+
"name": "variant",
|
|
747
|
+
"values": [
|
|
748
|
+
"primary",
|
|
749
|
+
"secondary",
|
|
750
|
+
"outline",
|
|
751
|
+
"ghost",
|
|
752
|
+
"danger",
|
|
753
|
+
"link"
|
|
754
|
+
]
|
|
755
|
+
},
|
|
756
|
+
{
|
|
757
|
+
"name": "size",
|
|
758
|
+
"values": [
|
|
759
|
+
"sm",
|
|
760
|
+
"md",
|
|
761
|
+
"lg"
|
|
762
|
+
]
|
|
763
|
+
},
|
|
764
|
+
{
|
|
765
|
+
"name": "type",
|
|
766
|
+
"values": [
|
|
767
|
+
"button",
|
|
768
|
+
"submit",
|
|
769
|
+
"reset"
|
|
770
|
+
]
|
|
771
|
+
},
|
|
772
|
+
{
|
|
773
|
+
"name": "disabled",
|
|
774
|
+
"boolean": true
|
|
775
|
+
},
|
|
776
|
+
{
|
|
777
|
+
"name": "loading",
|
|
778
|
+
"boolean": true
|
|
779
|
+
},
|
|
780
|
+
{
|
|
781
|
+
"name": "label"
|
|
782
|
+
},
|
|
783
|
+
{
|
|
784
|
+
"name": "href"
|
|
785
|
+
},
|
|
786
|
+
{
|
|
787
|
+
"name": "target"
|
|
788
|
+
},
|
|
789
|
+
{
|
|
790
|
+
"name": "rel"
|
|
791
|
+
},
|
|
792
|
+
{
|
|
793
|
+
"name": "download"
|
|
794
|
+
}
|
|
795
|
+
],
|
|
796
|
+
"properties": [
|
|
797
|
+
"variant",
|
|
798
|
+
"size",
|
|
799
|
+
"type",
|
|
800
|
+
"disabled",
|
|
801
|
+
"loading",
|
|
802
|
+
"label",
|
|
803
|
+
"href",
|
|
804
|
+
"target",
|
|
805
|
+
"rel",
|
|
806
|
+
"download",
|
|
807
|
+
"form"
|
|
808
|
+
],
|
|
809
|
+
"events": [],
|
|
810
|
+
"label": "icon-only"
|
|
811
|
+
},
|
|
812
|
+
"uf-checkbox": {
|
|
813
|
+
"attributes": [
|
|
814
|
+
{
|
|
815
|
+
"name": "indeterminate",
|
|
816
|
+
"boolean": true
|
|
817
|
+
},
|
|
818
|
+
{
|
|
819
|
+
"name": "select-all",
|
|
820
|
+
"boolean": true
|
|
821
|
+
},
|
|
822
|
+
{
|
|
823
|
+
"name": "hint"
|
|
824
|
+
},
|
|
825
|
+
{
|
|
826
|
+
"name": "checked",
|
|
827
|
+
"boolean": true
|
|
828
|
+
},
|
|
829
|
+
{
|
|
830
|
+
"name": "value"
|
|
831
|
+
},
|
|
832
|
+
{
|
|
833
|
+
"name": "size",
|
|
834
|
+
"values": [
|
|
835
|
+
"sm",
|
|
836
|
+
"md",
|
|
837
|
+
"lg"
|
|
838
|
+
]
|
|
839
|
+
},
|
|
840
|
+
{
|
|
841
|
+
"name": "name"
|
|
842
|
+
},
|
|
843
|
+
{
|
|
844
|
+
"name": "disabled",
|
|
845
|
+
"boolean": true
|
|
846
|
+
},
|
|
847
|
+
{
|
|
848
|
+
"name": "required",
|
|
849
|
+
"boolean": true
|
|
850
|
+
}
|
|
851
|
+
],
|
|
852
|
+
"properties": [
|
|
853
|
+
"indeterminate",
|
|
854
|
+
"selectAll",
|
|
855
|
+
"hint",
|
|
856
|
+
"checked",
|
|
857
|
+
"defaultChecked",
|
|
858
|
+
"value",
|
|
859
|
+
"size",
|
|
860
|
+
"name",
|
|
861
|
+
"disabled",
|
|
862
|
+
"required",
|
|
863
|
+
"form",
|
|
864
|
+
"validity",
|
|
865
|
+
"validationMessage",
|
|
866
|
+
"willValidate"
|
|
867
|
+
],
|
|
868
|
+
"events": [
|
|
869
|
+
"input",
|
|
870
|
+
"change"
|
|
871
|
+
],
|
|
872
|
+
"label": "content"
|
|
873
|
+
},
|
|
874
|
+
"uf-checkbox-group": {
|
|
875
|
+
"attributes": [
|
|
876
|
+
{
|
|
877
|
+
"name": "label"
|
|
878
|
+
},
|
|
879
|
+
{
|
|
880
|
+
"name": "hint"
|
|
881
|
+
},
|
|
882
|
+
{
|
|
883
|
+
"name": "orientation",
|
|
884
|
+
"values": [
|
|
885
|
+
"vertical",
|
|
886
|
+
"horizontal"
|
|
887
|
+
]
|
|
888
|
+
}
|
|
889
|
+
],
|
|
890
|
+
"properties": [
|
|
891
|
+
"label",
|
|
892
|
+
"hint",
|
|
893
|
+
"orientation",
|
|
894
|
+
"value"
|
|
895
|
+
],
|
|
896
|
+
"events": [
|
|
897
|
+
"change"
|
|
898
|
+
],
|
|
899
|
+
"label": "required"
|
|
900
|
+
},
|
|
901
|
+
"uf-combobox": {
|
|
902
|
+
"attributes": [
|
|
903
|
+
{
|
|
904
|
+
"name": "value"
|
|
905
|
+
},
|
|
906
|
+
{
|
|
907
|
+
"name": "label"
|
|
908
|
+
},
|
|
909
|
+
{
|
|
910
|
+
"name": "hint"
|
|
911
|
+
},
|
|
912
|
+
{
|
|
913
|
+
"name": "placeholder"
|
|
914
|
+
},
|
|
915
|
+
{
|
|
916
|
+
"name": "size",
|
|
917
|
+
"values": [
|
|
918
|
+
"sm",
|
|
919
|
+
"md",
|
|
920
|
+
"lg"
|
|
921
|
+
]
|
|
922
|
+
},
|
|
923
|
+
{
|
|
924
|
+
"name": "open",
|
|
925
|
+
"boolean": true
|
|
926
|
+
},
|
|
927
|
+
{
|
|
928
|
+
"name": "name"
|
|
929
|
+
},
|
|
930
|
+
{
|
|
931
|
+
"name": "disabled",
|
|
932
|
+
"boolean": true
|
|
933
|
+
},
|
|
934
|
+
{
|
|
935
|
+
"name": "required",
|
|
936
|
+
"boolean": true
|
|
937
|
+
}
|
|
938
|
+
],
|
|
939
|
+
"properties": [
|
|
940
|
+
"value",
|
|
941
|
+
"defaultValue",
|
|
942
|
+
"label",
|
|
943
|
+
"hint",
|
|
944
|
+
"placeholder",
|
|
945
|
+
"size",
|
|
946
|
+
"open",
|
|
947
|
+
"name",
|
|
948
|
+
"disabled",
|
|
949
|
+
"required",
|
|
950
|
+
"form",
|
|
951
|
+
"validity",
|
|
952
|
+
"validationMessage",
|
|
953
|
+
"willValidate"
|
|
954
|
+
],
|
|
955
|
+
"events": [
|
|
956
|
+
"uf-show",
|
|
957
|
+
"uf-hide",
|
|
958
|
+
"input",
|
|
959
|
+
"change"
|
|
960
|
+
],
|
|
961
|
+
"label": "required"
|
|
962
|
+
},
|
|
963
|
+
"uf-date-picker": {
|
|
964
|
+
"attributes": [
|
|
965
|
+
{
|
|
966
|
+
"name": "value"
|
|
967
|
+
},
|
|
968
|
+
{
|
|
969
|
+
"name": "label"
|
|
970
|
+
},
|
|
971
|
+
{
|
|
972
|
+
"name": "hint"
|
|
973
|
+
},
|
|
974
|
+
{
|
|
975
|
+
"name": "placeholder"
|
|
976
|
+
},
|
|
977
|
+
{
|
|
978
|
+
"name": "size",
|
|
979
|
+
"values": [
|
|
980
|
+
"sm",
|
|
981
|
+
"md",
|
|
982
|
+
"lg"
|
|
983
|
+
]
|
|
984
|
+
},
|
|
985
|
+
{
|
|
986
|
+
"name": "min"
|
|
987
|
+
},
|
|
988
|
+
{
|
|
989
|
+
"name": "max"
|
|
990
|
+
},
|
|
991
|
+
{
|
|
992
|
+
"name": "readonly",
|
|
993
|
+
"boolean": true
|
|
994
|
+
},
|
|
995
|
+
{
|
|
996
|
+
"name": "open",
|
|
997
|
+
"boolean": true
|
|
998
|
+
},
|
|
999
|
+
{
|
|
1000
|
+
"name": "name"
|
|
1001
|
+
},
|
|
1002
|
+
{
|
|
1003
|
+
"name": "disabled",
|
|
1004
|
+
"boolean": true
|
|
1005
|
+
},
|
|
1006
|
+
{
|
|
1007
|
+
"name": "required",
|
|
1008
|
+
"boolean": true
|
|
1009
|
+
}
|
|
1010
|
+
],
|
|
1011
|
+
"properties": [
|
|
1012
|
+
"value",
|
|
1013
|
+
"defaultValue",
|
|
1014
|
+
"label",
|
|
1015
|
+
"hint",
|
|
1016
|
+
"placeholder",
|
|
1017
|
+
"size",
|
|
1018
|
+
"min",
|
|
1019
|
+
"max",
|
|
1020
|
+
"readonly",
|
|
1021
|
+
"open",
|
|
1022
|
+
"isDateDisabled",
|
|
1023
|
+
"name",
|
|
1024
|
+
"disabled",
|
|
1025
|
+
"required",
|
|
1026
|
+
"form",
|
|
1027
|
+
"validity",
|
|
1028
|
+
"validationMessage",
|
|
1029
|
+
"willValidate"
|
|
1030
|
+
],
|
|
1031
|
+
"events": [
|
|
1032
|
+
"input",
|
|
1033
|
+
"change",
|
|
1034
|
+
"uf-show",
|
|
1035
|
+
"uf-hide"
|
|
1036
|
+
],
|
|
1037
|
+
"label": "required"
|
|
1038
|
+
},
|
|
1039
|
+
"uf-date-range-picker": {
|
|
1040
|
+
"attributes": [
|
|
1041
|
+
{
|
|
1042
|
+
"name": "value"
|
|
1043
|
+
},
|
|
1044
|
+
{
|
|
1045
|
+
"name": "label"
|
|
1046
|
+
},
|
|
1047
|
+
{
|
|
1048
|
+
"name": "hint"
|
|
1049
|
+
},
|
|
1050
|
+
{
|
|
1051
|
+
"name": "placeholder"
|
|
1052
|
+
},
|
|
1053
|
+
{
|
|
1054
|
+
"name": "size",
|
|
1055
|
+
"values": [
|
|
1056
|
+
"sm",
|
|
1057
|
+
"md",
|
|
1058
|
+
"lg"
|
|
1059
|
+
]
|
|
1060
|
+
},
|
|
1061
|
+
{
|
|
1062
|
+
"name": "min"
|
|
1063
|
+
},
|
|
1064
|
+
{
|
|
1065
|
+
"name": "max"
|
|
1066
|
+
},
|
|
1067
|
+
{
|
|
1068
|
+
"name": "readonly",
|
|
1069
|
+
"boolean": true
|
|
1070
|
+
},
|
|
1071
|
+
{
|
|
1072
|
+
"name": "open",
|
|
1073
|
+
"boolean": true
|
|
1074
|
+
},
|
|
1075
|
+
{
|
|
1076
|
+
"name": "name"
|
|
1077
|
+
},
|
|
1078
|
+
{
|
|
1079
|
+
"name": "disabled",
|
|
1080
|
+
"boolean": true
|
|
1081
|
+
},
|
|
1082
|
+
{
|
|
1083
|
+
"name": "required",
|
|
1084
|
+
"boolean": true
|
|
1085
|
+
}
|
|
1086
|
+
],
|
|
1087
|
+
"properties": [
|
|
1088
|
+
"start",
|
|
1089
|
+
"end",
|
|
1090
|
+
"defaultValue",
|
|
1091
|
+
"label",
|
|
1092
|
+
"hint",
|
|
1093
|
+
"placeholder",
|
|
1094
|
+
"size",
|
|
1095
|
+
"min",
|
|
1096
|
+
"max",
|
|
1097
|
+
"readonly",
|
|
1098
|
+
"open",
|
|
1099
|
+
"isDateDisabled",
|
|
1100
|
+
"value",
|
|
1101
|
+
"name",
|
|
1102
|
+
"disabled",
|
|
1103
|
+
"required",
|
|
1104
|
+
"form",
|
|
1105
|
+
"validity",
|
|
1106
|
+
"validationMessage",
|
|
1107
|
+
"willValidate"
|
|
1108
|
+
],
|
|
1109
|
+
"events": [
|
|
1110
|
+
"input",
|
|
1111
|
+
"change",
|
|
1112
|
+
"uf-show",
|
|
1113
|
+
"uf-hide"
|
|
1114
|
+
],
|
|
1115
|
+
"label": "required"
|
|
1116
|
+
},
|
|
1117
|
+
"uf-dialog": {
|
|
1118
|
+
"attributes": [
|
|
1119
|
+
{
|
|
1120
|
+
"name": "open",
|
|
1121
|
+
"boolean": true
|
|
1122
|
+
},
|
|
1123
|
+
{
|
|
1124
|
+
"name": "label"
|
|
1125
|
+
},
|
|
1126
|
+
{
|
|
1127
|
+
"name": "light-dismiss",
|
|
1128
|
+
"boolean": true
|
|
1129
|
+
},
|
|
1130
|
+
{
|
|
1131
|
+
"name": "without-header",
|
|
1132
|
+
"boolean": true
|
|
1133
|
+
}
|
|
1134
|
+
],
|
|
1135
|
+
"properties": [
|
|
1136
|
+
"open",
|
|
1137
|
+
"label",
|
|
1138
|
+
"lightDismiss",
|
|
1139
|
+
"withoutHeader"
|
|
1140
|
+
],
|
|
1141
|
+
"events": [
|
|
1142
|
+
"uf-show",
|
|
1143
|
+
"uf-hide",
|
|
1144
|
+
"uf-request-close"
|
|
1145
|
+
]
|
|
1146
|
+
},
|
|
1147
|
+
"uf-divider": {
|
|
1148
|
+
"attributes": [
|
|
1149
|
+
{
|
|
1150
|
+
"name": "orientation",
|
|
1151
|
+
"values": [
|
|
1152
|
+
"horizontal",
|
|
1153
|
+
"vertical"
|
|
1154
|
+
]
|
|
1155
|
+
}
|
|
1156
|
+
],
|
|
1157
|
+
"properties": [
|
|
1158
|
+
"orientation"
|
|
1159
|
+
],
|
|
1160
|
+
"events": []
|
|
1161
|
+
},
|
|
1162
|
+
"uf-drawer": {
|
|
1163
|
+
"attributes": [
|
|
1164
|
+
{
|
|
1165
|
+
"name": "placement",
|
|
1166
|
+
"values": [
|
|
1167
|
+
"start",
|
|
1168
|
+
"end",
|
|
1169
|
+
"top",
|
|
1170
|
+
"bottom"
|
|
1171
|
+
]
|
|
1172
|
+
},
|
|
1173
|
+
{
|
|
1174
|
+
"name": "open",
|
|
1175
|
+
"boolean": true
|
|
1176
|
+
},
|
|
1177
|
+
{
|
|
1178
|
+
"name": "label"
|
|
1179
|
+
},
|
|
1180
|
+
{
|
|
1181
|
+
"name": "light-dismiss",
|
|
1182
|
+
"boolean": true
|
|
1183
|
+
},
|
|
1184
|
+
{
|
|
1185
|
+
"name": "without-header",
|
|
1186
|
+
"boolean": true
|
|
1187
|
+
}
|
|
1188
|
+
],
|
|
1189
|
+
"properties": [
|
|
1190
|
+
"placement",
|
|
1191
|
+
"open",
|
|
1192
|
+
"label",
|
|
1193
|
+
"lightDismiss",
|
|
1194
|
+
"withoutHeader"
|
|
1195
|
+
],
|
|
1196
|
+
"events": [
|
|
1197
|
+
"uf-show",
|
|
1198
|
+
"uf-hide",
|
|
1199
|
+
"uf-request-close"
|
|
1200
|
+
]
|
|
1201
|
+
},
|
|
1202
|
+
"uf-dropdown": {
|
|
1203
|
+
"attributes": [
|
|
1204
|
+
{
|
|
1205
|
+
"name": "open",
|
|
1206
|
+
"boolean": true
|
|
1207
|
+
},
|
|
1208
|
+
{
|
|
1209
|
+
"name": "placement",
|
|
1210
|
+
"values": [
|
|
1211
|
+
"top",
|
|
1212
|
+
"top-start",
|
|
1213
|
+
"top-end",
|
|
1214
|
+
"bottom",
|
|
1215
|
+
"bottom-start",
|
|
1216
|
+
"bottom-end",
|
|
1217
|
+
"left",
|
|
1218
|
+
"right"
|
|
1219
|
+
]
|
|
1220
|
+
},
|
|
1221
|
+
{
|
|
1222
|
+
"name": "distance"
|
|
1223
|
+
},
|
|
1224
|
+
{
|
|
1225
|
+
"name": "label"
|
|
1226
|
+
}
|
|
1227
|
+
],
|
|
1228
|
+
"properties": [
|
|
1229
|
+
"open",
|
|
1230
|
+
"placement",
|
|
1231
|
+
"distance",
|
|
1232
|
+
"label"
|
|
1233
|
+
],
|
|
1234
|
+
"events": [
|
|
1235
|
+
"uf-select",
|
|
1236
|
+
"uf-show",
|
|
1237
|
+
"uf-hide"
|
|
1238
|
+
]
|
|
1239
|
+
},
|
|
1240
|
+
"uf-empty-state": {
|
|
1241
|
+
"attributes": [
|
|
1242
|
+
{
|
|
1243
|
+
"name": "heading"
|
|
1244
|
+
},
|
|
1245
|
+
{
|
|
1246
|
+
"name": "icon"
|
|
1247
|
+
}
|
|
1248
|
+
],
|
|
1249
|
+
"properties": [
|
|
1250
|
+
"heading",
|
|
1251
|
+
"icon"
|
|
1252
|
+
],
|
|
1253
|
+
"events": []
|
|
1254
|
+
},
|
|
1255
|
+
"uf-file-upload": {
|
|
1256
|
+
"attributes": [
|
|
1257
|
+
{
|
|
1258
|
+
"name": "label"
|
|
1259
|
+
},
|
|
1260
|
+
{
|
|
1261
|
+
"name": "hint"
|
|
1262
|
+
},
|
|
1263
|
+
{
|
|
1264
|
+
"name": "accept"
|
|
1265
|
+
},
|
|
1266
|
+
{
|
|
1267
|
+
"name": "multiple",
|
|
1268
|
+
"boolean": true
|
|
1269
|
+
},
|
|
1270
|
+
{
|
|
1271
|
+
"name": "max-size"
|
|
1272
|
+
},
|
|
1273
|
+
{
|
|
1274
|
+
"name": "size",
|
|
1275
|
+
"values": [
|
|
1276
|
+
"sm",
|
|
1277
|
+
"md",
|
|
1278
|
+
"lg"
|
|
1279
|
+
]
|
|
1280
|
+
},
|
|
1281
|
+
{
|
|
1282
|
+
"name": "name"
|
|
1283
|
+
},
|
|
1284
|
+
{
|
|
1285
|
+
"name": "disabled",
|
|
1286
|
+
"boolean": true
|
|
1287
|
+
},
|
|
1288
|
+
{
|
|
1289
|
+
"name": "required",
|
|
1290
|
+
"boolean": true
|
|
1291
|
+
}
|
|
1292
|
+
],
|
|
1293
|
+
"properties": [
|
|
1294
|
+
"files",
|
|
1295
|
+
"label",
|
|
1296
|
+
"hint",
|
|
1297
|
+
"accept",
|
|
1298
|
+
"multiple",
|
|
1299
|
+
"maxSize",
|
|
1300
|
+
"size",
|
|
1301
|
+
"name",
|
|
1302
|
+
"disabled",
|
|
1303
|
+
"required",
|
|
1304
|
+
"form",
|
|
1305
|
+
"validity",
|
|
1306
|
+
"validationMessage",
|
|
1307
|
+
"willValidate"
|
|
1308
|
+
],
|
|
1309
|
+
"events": [
|
|
1310
|
+
"input",
|
|
1311
|
+
"change"
|
|
1312
|
+
],
|
|
1313
|
+
"label": "required"
|
|
1314
|
+
},
|
|
1315
|
+
"uf-icon": {
|
|
1316
|
+
"attributes": [
|
|
1317
|
+
{
|
|
1318
|
+
"name": "name"
|
|
1319
|
+
},
|
|
1320
|
+
{
|
|
1321
|
+
"name": "label"
|
|
1322
|
+
}
|
|
1323
|
+
],
|
|
1324
|
+
"properties": [
|
|
1325
|
+
"name",
|
|
1326
|
+
"label"
|
|
1327
|
+
],
|
|
1328
|
+
"events": []
|
|
1329
|
+
},
|
|
1330
|
+
"uf-input": {
|
|
1331
|
+
"attributes": [
|
|
1332
|
+
{
|
|
1333
|
+
"name": "type",
|
|
1334
|
+
"values": [
|
|
1335
|
+
"text",
|
|
1336
|
+
"email",
|
|
1337
|
+
"password",
|
|
1338
|
+
"search",
|
|
1339
|
+
"tel",
|
|
1340
|
+
"url",
|
|
1341
|
+
"number",
|
|
1342
|
+
"date",
|
|
1343
|
+
"time"
|
|
1344
|
+
]
|
|
1345
|
+
},
|
|
1346
|
+
{
|
|
1347
|
+
"name": "value"
|
|
1348
|
+
},
|
|
1349
|
+
{
|
|
1350
|
+
"name": "label"
|
|
1351
|
+
},
|
|
1352
|
+
{
|
|
1353
|
+
"name": "hint"
|
|
1354
|
+
},
|
|
1355
|
+
{
|
|
1356
|
+
"name": "placeholder"
|
|
1357
|
+
},
|
|
1358
|
+
{
|
|
1359
|
+
"name": "size",
|
|
1360
|
+
"values": [
|
|
1361
|
+
"sm",
|
|
1362
|
+
"md",
|
|
1363
|
+
"lg"
|
|
1364
|
+
]
|
|
1365
|
+
},
|
|
1366
|
+
{
|
|
1367
|
+
"name": "readonly",
|
|
1368
|
+
"boolean": true
|
|
1369
|
+
},
|
|
1370
|
+
{
|
|
1371
|
+
"name": "autocomplete"
|
|
1372
|
+
},
|
|
1373
|
+
{
|
|
1374
|
+
"name": "inputmode"
|
|
1375
|
+
},
|
|
1376
|
+
{
|
|
1377
|
+
"name": "pattern"
|
|
1378
|
+
},
|
|
1379
|
+
{
|
|
1380
|
+
"name": "min"
|
|
1381
|
+
},
|
|
1382
|
+
{
|
|
1383
|
+
"name": "max"
|
|
1384
|
+
},
|
|
1385
|
+
{
|
|
1386
|
+
"name": "step"
|
|
1387
|
+
},
|
|
1388
|
+
{
|
|
1389
|
+
"name": "minlength"
|
|
1390
|
+
},
|
|
1391
|
+
{
|
|
1392
|
+
"name": "maxlength"
|
|
1393
|
+
},
|
|
1394
|
+
{
|
|
1395
|
+
"name": "name"
|
|
1396
|
+
},
|
|
1397
|
+
{
|
|
1398
|
+
"name": "disabled",
|
|
1399
|
+
"boolean": true
|
|
1400
|
+
},
|
|
1401
|
+
{
|
|
1402
|
+
"name": "required",
|
|
1403
|
+
"boolean": true
|
|
1404
|
+
}
|
|
1405
|
+
],
|
|
1406
|
+
"properties": [
|
|
1407
|
+
"type",
|
|
1408
|
+
"value",
|
|
1409
|
+
"defaultValue",
|
|
1410
|
+
"label",
|
|
1411
|
+
"hint",
|
|
1412
|
+
"placeholder",
|
|
1413
|
+
"size",
|
|
1414
|
+
"readonly",
|
|
1415
|
+
"autocomplete",
|
|
1416
|
+
"inputmode",
|
|
1417
|
+
"pattern",
|
|
1418
|
+
"min",
|
|
1419
|
+
"max",
|
|
1420
|
+
"step",
|
|
1421
|
+
"minlength",
|
|
1422
|
+
"maxlength",
|
|
1423
|
+
"name",
|
|
1424
|
+
"disabled",
|
|
1425
|
+
"required",
|
|
1426
|
+
"form",
|
|
1427
|
+
"validity",
|
|
1428
|
+
"validationMessage",
|
|
1429
|
+
"willValidate"
|
|
1430
|
+
],
|
|
1431
|
+
"events": [
|
|
1432
|
+
"input",
|
|
1433
|
+
"change"
|
|
1434
|
+
],
|
|
1435
|
+
"label": "required"
|
|
1436
|
+
},
|
|
1437
|
+
"uf-menu-item": {
|
|
1438
|
+
"attributes": [
|
|
1439
|
+
{
|
|
1440
|
+
"name": "value"
|
|
1441
|
+
},
|
|
1442
|
+
{
|
|
1443
|
+
"name": "type",
|
|
1444
|
+
"values": [
|
|
1445
|
+
"normal",
|
|
1446
|
+
"checkbox"
|
|
1447
|
+
]
|
|
1448
|
+
},
|
|
1449
|
+
{
|
|
1450
|
+
"name": "checked",
|
|
1451
|
+
"boolean": true
|
|
1452
|
+
},
|
|
1453
|
+
{
|
|
1454
|
+
"name": "disabled",
|
|
1455
|
+
"boolean": true
|
|
1456
|
+
}
|
|
1457
|
+
],
|
|
1458
|
+
"properties": [
|
|
1459
|
+
"value",
|
|
1460
|
+
"type",
|
|
1461
|
+
"checked",
|
|
1462
|
+
"disabled"
|
|
1463
|
+
],
|
|
1464
|
+
"events": []
|
|
1465
|
+
},
|
|
1466
|
+
"uf-menu": {
|
|
1467
|
+
"attributes": [
|
|
1468
|
+
{
|
|
1469
|
+
"name": "label"
|
|
1470
|
+
}
|
|
1471
|
+
],
|
|
1472
|
+
"properties": [
|
|
1473
|
+
"label",
|
|
1474
|
+
"items"
|
|
1475
|
+
],
|
|
1476
|
+
"events": [
|
|
1477
|
+
"uf-select"
|
|
1478
|
+
]
|
|
1479
|
+
},
|
|
1480
|
+
"uf-multi-select": {
|
|
1481
|
+
"attributes": [
|
|
1482
|
+
{
|
|
1483
|
+
"name": "label"
|
|
1484
|
+
},
|
|
1485
|
+
{
|
|
1486
|
+
"name": "hint"
|
|
1487
|
+
},
|
|
1488
|
+
{
|
|
1489
|
+
"name": "placeholder"
|
|
1490
|
+
},
|
|
1491
|
+
{
|
|
1492
|
+
"name": "size",
|
|
1493
|
+
"values": [
|
|
1494
|
+
"sm",
|
|
1495
|
+
"md",
|
|
1496
|
+
"lg"
|
|
1497
|
+
]
|
|
1498
|
+
},
|
|
1499
|
+
{
|
|
1500
|
+
"name": "open",
|
|
1501
|
+
"boolean": true
|
|
1502
|
+
},
|
|
1503
|
+
{
|
|
1504
|
+
"name": "name"
|
|
1505
|
+
},
|
|
1506
|
+
{
|
|
1507
|
+
"name": "disabled",
|
|
1508
|
+
"boolean": true
|
|
1509
|
+
},
|
|
1510
|
+
{
|
|
1511
|
+
"name": "required",
|
|
1512
|
+
"boolean": true
|
|
1513
|
+
}
|
|
1514
|
+
],
|
|
1515
|
+
"properties": [
|
|
1516
|
+
"value",
|
|
1517
|
+
"label",
|
|
1518
|
+
"hint",
|
|
1519
|
+
"placeholder",
|
|
1520
|
+
"size",
|
|
1521
|
+
"open",
|
|
1522
|
+
"name",
|
|
1523
|
+
"disabled",
|
|
1524
|
+
"required",
|
|
1525
|
+
"form",
|
|
1526
|
+
"validity",
|
|
1527
|
+
"validationMessage",
|
|
1528
|
+
"willValidate"
|
|
1529
|
+
],
|
|
1530
|
+
"events": [
|
|
1531
|
+
"uf-show",
|
|
1532
|
+
"uf-hide",
|
|
1533
|
+
"input",
|
|
1534
|
+
"change"
|
|
1535
|
+
],
|
|
1536
|
+
"label": "required"
|
|
1537
|
+
},
|
|
1538
|
+
"uf-number-input": {
|
|
1539
|
+
"attributes": [
|
|
1540
|
+
{
|
|
1541
|
+
"name": "value"
|
|
1542
|
+
},
|
|
1543
|
+
{
|
|
1544
|
+
"name": "label"
|
|
1545
|
+
},
|
|
1546
|
+
{
|
|
1547
|
+
"name": "hint"
|
|
1548
|
+
},
|
|
1549
|
+
{
|
|
1550
|
+
"name": "placeholder"
|
|
1551
|
+
},
|
|
1552
|
+
{
|
|
1553
|
+
"name": "size",
|
|
1554
|
+
"values": [
|
|
1555
|
+
"sm",
|
|
1556
|
+
"md",
|
|
1557
|
+
"lg"
|
|
1558
|
+
]
|
|
1559
|
+
},
|
|
1560
|
+
{
|
|
1561
|
+
"name": "readonly",
|
|
1562
|
+
"boolean": true
|
|
1563
|
+
},
|
|
1564
|
+
{
|
|
1565
|
+
"name": "min"
|
|
1566
|
+
},
|
|
1567
|
+
{
|
|
1568
|
+
"name": "max"
|
|
1569
|
+
},
|
|
1570
|
+
{
|
|
1571
|
+
"name": "step"
|
|
1572
|
+
},
|
|
1573
|
+
{
|
|
1574
|
+
"name": "name"
|
|
1575
|
+
},
|
|
1576
|
+
{
|
|
1577
|
+
"name": "disabled",
|
|
1578
|
+
"boolean": true
|
|
1579
|
+
},
|
|
1580
|
+
{
|
|
1581
|
+
"name": "required",
|
|
1582
|
+
"boolean": true
|
|
1583
|
+
}
|
|
1584
|
+
],
|
|
1585
|
+
"properties": [
|
|
1586
|
+
"value",
|
|
1587
|
+
"defaultValue",
|
|
1588
|
+
"label",
|
|
1589
|
+
"hint",
|
|
1590
|
+
"placeholder",
|
|
1591
|
+
"size",
|
|
1592
|
+
"readonly",
|
|
1593
|
+
"min",
|
|
1594
|
+
"max",
|
|
1595
|
+
"step",
|
|
1596
|
+
"name",
|
|
1597
|
+
"disabled",
|
|
1598
|
+
"required",
|
|
1599
|
+
"form",
|
|
1600
|
+
"validity",
|
|
1601
|
+
"validationMessage",
|
|
1602
|
+
"willValidate"
|
|
1603
|
+
],
|
|
1604
|
+
"events": [
|
|
1605
|
+
"input",
|
|
1606
|
+
"change"
|
|
1607
|
+
],
|
|
1608
|
+
"label": "required"
|
|
1609
|
+
},
|
|
1610
|
+
"uf-pagination": {
|
|
1611
|
+
"attributes": [
|
|
1612
|
+
{
|
|
1613
|
+
"name": "page"
|
|
1614
|
+
},
|
|
1615
|
+
{
|
|
1616
|
+
"name": "pages"
|
|
1617
|
+
},
|
|
1618
|
+
{
|
|
1619
|
+
"name": "siblings"
|
|
1620
|
+
},
|
|
1621
|
+
{
|
|
1622
|
+
"name": "label"
|
|
1623
|
+
},
|
|
1624
|
+
{
|
|
1625
|
+
"name": "size",
|
|
1626
|
+
"values": [
|
|
1627
|
+
"sm",
|
|
1628
|
+
"md",
|
|
1629
|
+
"lg"
|
|
1630
|
+
]
|
|
1631
|
+
}
|
|
1632
|
+
],
|
|
1633
|
+
"properties": [
|
|
1634
|
+
"page",
|
|
1635
|
+
"pages",
|
|
1636
|
+
"siblings",
|
|
1637
|
+
"label",
|
|
1638
|
+
"size"
|
|
1639
|
+
],
|
|
1640
|
+
"events": [
|
|
1641
|
+
"uf-page-change"
|
|
1642
|
+
]
|
|
1643
|
+
},
|
|
1644
|
+
"uf-popover": {
|
|
1645
|
+
"attributes": [
|
|
1646
|
+
{
|
|
1647
|
+
"name": "open",
|
|
1648
|
+
"boolean": true
|
|
1649
|
+
},
|
|
1650
|
+
{
|
|
1651
|
+
"name": "placement",
|
|
1652
|
+
"values": [
|
|
1653
|
+
"top",
|
|
1654
|
+
"top-start",
|
|
1655
|
+
"top-end",
|
|
1656
|
+
"bottom",
|
|
1657
|
+
"bottom-start",
|
|
1658
|
+
"bottom-end",
|
|
1659
|
+
"left",
|
|
1660
|
+
"right"
|
|
1661
|
+
]
|
|
1662
|
+
},
|
|
1663
|
+
{
|
|
1664
|
+
"name": "distance"
|
|
1665
|
+
},
|
|
1666
|
+
{
|
|
1667
|
+
"name": "label"
|
|
1668
|
+
}
|
|
1669
|
+
],
|
|
1670
|
+
"properties": [
|
|
1671
|
+
"open",
|
|
1672
|
+
"placement",
|
|
1673
|
+
"distance",
|
|
1674
|
+
"label"
|
|
1675
|
+
],
|
|
1676
|
+
"events": [
|
|
1677
|
+
"uf-show",
|
|
1678
|
+
"uf-hide"
|
|
1679
|
+
]
|
|
1680
|
+
},
|
|
1681
|
+
"uf-progress": {
|
|
1682
|
+
"attributes": [
|
|
1683
|
+
{
|
|
1684
|
+
"name": "value"
|
|
1685
|
+
},
|
|
1686
|
+
{
|
|
1687
|
+
"name": "max"
|
|
1688
|
+
},
|
|
1689
|
+
{
|
|
1690
|
+
"name": "label"
|
|
1691
|
+
},
|
|
1692
|
+
{
|
|
1693
|
+
"name": "show-value",
|
|
1694
|
+
"boolean": true
|
|
1695
|
+
},
|
|
1696
|
+
{
|
|
1697
|
+
"name": "variant",
|
|
1698
|
+
"values": [
|
|
1699
|
+
"accent",
|
|
1700
|
+
"success",
|
|
1701
|
+
"warning",
|
|
1702
|
+
"danger"
|
|
1703
|
+
]
|
|
1704
|
+
},
|
|
1705
|
+
{
|
|
1706
|
+
"name": "size",
|
|
1707
|
+
"values": [
|
|
1708
|
+
"sm",
|
|
1709
|
+
"md",
|
|
1710
|
+
"lg"
|
|
1711
|
+
]
|
|
1712
|
+
}
|
|
1713
|
+
],
|
|
1714
|
+
"properties": [
|
|
1715
|
+
"value",
|
|
1716
|
+
"max",
|
|
1717
|
+
"label",
|
|
1718
|
+
"showValue",
|
|
1719
|
+
"variant",
|
|
1720
|
+
"size"
|
|
1721
|
+
],
|
|
1722
|
+
"events": []
|
|
1723
|
+
},
|
|
1724
|
+
"uf-radio": {
|
|
1725
|
+
"attributes": [
|
|
1726
|
+
{
|
|
1727
|
+
"name": "value"
|
|
1728
|
+
},
|
|
1729
|
+
{
|
|
1730
|
+
"name": "checked",
|
|
1731
|
+
"boolean": true
|
|
1732
|
+
},
|
|
1733
|
+
{
|
|
1734
|
+
"name": "disabled",
|
|
1735
|
+
"boolean": true
|
|
1736
|
+
}
|
|
1737
|
+
],
|
|
1738
|
+
"properties": [
|
|
1739
|
+
"value",
|
|
1740
|
+
"checked",
|
|
1741
|
+
"disabled"
|
|
1742
|
+
],
|
|
1743
|
+
"events": [],
|
|
1744
|
+
"label": "content"
|
|
1745
|
+
},
|
|
1746
|
+
"uf-radio-group": {
|
|
1747
|
+
"attributes": [
|
|
1748
|
+
{
|
|
1749
|
+
"name": "value"
|
|
1750
|
+
},
|
|
1751
|
+
{
|
|
1752
|
+
"name": "label"
|
|
1753
|
+
},
|
|
1754
|
+
{
|
|
1755
|
+
"name": "hint"
|
|
1756
|
+
},
|
|
1757
|
+
{
|
|
1758
|
+
"name": "orientation",
|
|
1759
|
+
"values": [
|
|
1760
|
+
"vertical",
|
|
1761
|
+
"horizontal"
|
|
1762
|
+
]
|
|
1763
|
+
},
|
|
1764
|
+
{
|
|
1765
|
+
"name": "size",
|
|
1766
|
+
"values": [
|
|
1767
|
+
"sm",
|
|
1768
|
+
"md",
|
|
1769
|
+
"lg"
|
|
1770
|
+
]
|
|
1771
|
+
},
|
|
1772
|
+
{
|
|
1773
|
+
"name": "name"
|
|
1774
|
+
},
|
|
1775
|
+
{
|
|
1776
|
+
"name": "disabled",
|
|
1777
|
+
"boolean": true
|
|
1778
|
+
},
|
|
1779
|
+
{
|
|
1780
|
+
"name": "required",
|
|
1781
|
+
"boolean": true
|
|
1782
|
+
}
|
|
1783
|
+
],
|
|
1784
|
+
"properties": [
|
|
1785
|
+
"value",
|
|
1786
|
+
"defaultValue",
|
|
1787
|
+
"label",
|
|
1788
|
+
"hint",
|
|
1789
|
+
"orientation",
|
|
1790
|
+
"size",
|
|
1791
|
+
"name",
|
|
1792
|
+
"disabled",
|
|
1793
|
+
"required",
|
|
1794
|
+
"form",
|
|
1795
|
+
"validity",
|
|
1796
|
+
"validationMessage",
|
|
1797
|
+
"willValidate"
|
|
1798
|
+
],
|
|
1799
|
+
"events": [
|
|
1800
|
+
"input",
|
|
1801
|
+
"change"
|
|
1802
|
+
],
|
|
1803
|
+
"label": "required"
|
|
1804
|
+
},
|
|
1805
|
+
"uf-segmented-control": {
|
|
1806
|
+
"attributes": [
|
|
1807
|
+
{
|
|
1808
|
+
"name": "value"
|
|
1809
|
+
},
|
|
1810
|
+
{
|
|
1811
|
+
"name": "label"
|
|
1812
|
+
},
|
|
1813
|
+
{
|
|
1814
|
+
"name": "hint"
|
|
1815
|
+
},
|
|
1816
|
+
{
|
|
1817
|
+
"name": "size",
|
|
1818
|
+
"values": [
|
|
1819
|
+
"sm",
|
|
1820
|
+
"md",
|
|
1821
|
+
"lg"
|
|
1822
|
+
]
|
|
1823
|
+
},
|
|
1824
|
+
{
|
|
1825
|
+
"name": "name"
|
|
1826
|
+
},
|
|
1827
|
+
{
|
|
1828
|
+
"name": "disabled",
|
|
1829
|
+
"boolean": true
|
|
1830
|
+
},
|
|
1831
|
+
{
|
|
1832
|
+
"name": "required",
|
|
1833
|
+
"boolean": true
|
|
1834
|
+
}
|
|
1835
|
+
],
|
|
1836
|
+
"properties": [
|
|
1837
|
+
"value",
|
|
1838
|
+
"defaultValue",
|
|
1839
|
+
"label",
|
|
1840
|
+
"hint",
|
|
1841
|
+
"size",
|
|
1842
|
+
"name",
|
|
1843
|
+
"disabled",
|
|
1844
|
+
"required",
|
|
1845
|
+
"form",
|
|
1846
|
+
"validity",
|
|
1847
|
+
"validationMessage",
|
|
1848
|
+
"willValidate"
|
|
1849
|
+
],
|
|
1850
|
+
"events": [
|
|
1851
|
+
"input",
|
|
1852
|
+
"change"
|
|
1853
|
+
],
|
|
1854
|
+
"label": "required"
|
|
1855
|
+
},
|
|
1856
|
+
"uf-select": {
|
|
1857
|
+
"attributes": [
|
|
1858
|
+
{
|
|
1859
|
+
"name": "value"
|
|
1860
|
+
},
|
|
1861
|
+
{
|
|
1862
|
+
"name": "label"
|
|
1863
|
+
},
|
|
1864
|
+
{
|
|
1865
|
+
"name": "hint"
|
|
1866
|
+
},
|
|
1867
|
+
{
|
|
1868
|
+
"name": "placeholder"
|
|
1869
|
+
},
|
|
1870
|
+
{
|
|
1871
|
+
"name": "size",
|
|
1872
|
+
"values": [
|
|
1873
|
+
"sm",
|
|
1874
|
+
"md",
|
|
1875
|
+
"lg"
|
|
1876
|
+
]
|
|
1877
|
+
},
|
|
1878
|
+
{
|
|
1879
|
+
"name": "autocomplete"
|
|
1880
|
+
},
|
|
1881
|
+
{
|
|
1882
|
+
"name": "name"
|
|
1883
|
+
},
|
|
1884
|
+
{
|
|
1885
|
+
"name": "disabled",
|
|
1886
|
+
"boolean": true
|
|
1887
|
+
},
|
|
1888
|
+
{
|
|
1889
|
+
"name": "required",
|
|
1890
|
+
"boolean": true
|
|
1891
|
+
}
|
|
1892
|
+
],
|
|
1893
|
+
"properties": [
|
|
1894
|
+
"value",
|
|
1895
|
+
"defaultValue",
|
|
1896
|
+
"label",
|
|
1897
|
+
"hint",
|
|
1898
|
+
"placeholder",
|
|
1899
|
+
"size",
|
|
1900
|
+
"autocomplete",
|
|
1901
|
+
"name",
|
|
1902
|
+
"disabled",
|
|
1903
|
+
"required",
|
|
1904
|
+
"form",
|
|
1905
|
+
"validity",
|
|
1906
|
+
"validationMessage",
|
|
1907
|
+
"willValidate"
|
|
1908
|
+
],
|
|
1909
|
+
"events": [
|
|
1910
|
+
"input",
|
|
1911
|
+
"change"
|
|
1912
|
+
],
|
|
1913
|
+
"label": "required"
|
|
1914
|
+
},
|
|
1915
|
+
"uf-skeleton": {
|
|
1916
|
+
"attributes": [
|
|
1917
|
+
{
|
|
1918
|
+
"name": "shape",
|
|
1919
|
+
"values": [
|
|
1920
|
+
"text",
|
|
1921
|
+
"rect",
|
|
1922
|
+
"circle"
|
|
1923
|
+
]
|
|
1924
|
+
},
|
|
1925
|
+
{
|
|
1926
|
+
"name": "lines"
|
|
1927
|
+
}
|
|
1928
|
+
],
|
|
1929
|
+
"properties": [
|
|
1930
|
+
"shape",
|
|
1931
|
+
"lines"
|
|
1932
|
+
],
|
|
1933
|
+
"events": []
|
|
1934
|
+
},
|
|
1935
|
+
"uf-slider": {
|
|
1936
|
+
"attributes": [
|
|
1937
|
+
{
|
|
1938
|
+
"name": "value"
|
|
1939
|
+
},
|
|
1940
|
+
{
|
|
1941
|
+
"name": "min"
|
|
1942
|
+
},
|
|
1943
|
+
{
|
|
1944
|
+
"name": "max"
|
|
1945
|
+
},
|
|
1946
|
+
{
|
|
1947
|
+
"name": "step"
|
|
1948
|
+
},
|
|
1949
|
+
{
|
|
1950
|
+
"name": "label"
|
|
1951
|
+
},
|
|
1952
|
+
{
|
|
1953
|
+
"name": "hint"
|
|
1954
|
+
},
|
|
1955
|
+
{
|
|
1956
|
+
"name": "show-value",
|
|
1957
|
+
"boolean": true
|
|
1958
|
+
},
|
|
1959
|
+
{
|
|
1960
|
+
"name": "size",
|
|
1961
|
+
"values": [
|
|
1962
|
+
"sm",
|
|
1963
|
+
"md",
|
|
1964
|
+
"lg"
|
|
1965
|
+
]
|
|
1966
|
+
},
|
|
1967
|
+
{
|
|
1968
|
+
"name": "name"
|
|
1969
|
+
},
|
|
1970
|
+
{
|
|
1971
|
+
"name": "disabled",
|
|
1972
|
+
"boolean": true
|
|
1973
|
+
},
|
|
1974
|
+
{
|
|
1975
|
+
"name": "required",
|
|
1976
|
+
"boolean": true
|
|
1977
|
+
}
|
|
1978
|
+
],
|
|
1979
|
+
"properties": [
|
|
1980
|
+
"value",
|
|
1981
|
+
"defaultValue",
|
|
1982
|
+
"min",
|
|
1983
|
+
"max",
|
|
1984
|
+
"step",
|
|
1985
|
+
"label",
|
|
1986
|
+
"hint",
|
|
1987
|
+
"showValue",
|
|
1988
|
+
"size",
|
|
1989
|
+
"name",
|
|
1990
|
+
"disabled",
|
|
1991
|
+
"required",
|
|
1992
|
+
"form",
|
|
1993
|
+
"validity",
|
|
1994
|
+
"validationMessage",
|
|
1995
|
+
"willValidate"
|
|
1996
|
+
],
|
|
1997
|
+
"events": [
|
|
1998
|
+
"input",
|
|
1999
|
+
"change"
|
|
2000
|
+
],
|
|
2001
|
+
"label": "required"
|
|
2002
|
+
},
|
|
2003
|
+
"uf-spinner": {
|
|
2004
|
+
"attributes": [
|
|
2005
|
+
{
|
|
2006
|
+
"name": "label"
|
|
2007
|
+
},
|
|
2008
|
+
{
|
|
2009
|
+
"name": "size",
|
|
2010
|
+
"values": [
|
|
2011
|
+
"sm",
|
|
2012
|
+
"md",
|
|
2013
|
+
"lg"
|
|
2014
|
+
]
|
|
2015
|
+
}
|
|
2016
|
+
],
|
|
2017
|
+
"properties": [
|
|
2018
|
+
"label",
|
|
2019
|
+
"size"
|
|
2020
|
+
],
|
|
2021
|
+
"events": []
|
|
2022
|
+
},
|
|
2023
|
+
"uf-switch": {
|
|
2024
|
+
"attributes": [
|
|
2025
|
+
{
|
|
2026
|
+
"name": "hint"
|
|
2027
|
+
},
|
|
2028
|
+
{
|
|
2029
|
+
"name": "checked",
|
|
2030
|
+
"boolean": true
|
|
2031
|
+
},
|
|
2032
|
+
{
|
|
2033
|
+
"name": "value"
|
|
2034
|
+
},
|
|
2035
|
+
{
|
|
2036
|
+
"name": "size",
|
|
2037
|
+
"values": [
|
|
2038
|
+
"sm",
|
|
2039
|
+
"md",
|
|
2040
|
+
"lg"
|
|
2041
|
+
]
|
|
2042
|
+
},
|
|
2043
|
+
{
|
|
2044
|
+
"name": "name"
|
|
2045
|
+
},
|
|
2046
|
+
{
|
|
2047
|
+
"name": "disabled",
|
|
2048
|
+
"boolean": true
|
|
2049
|
+
},
|
|
2050
|
+
{
|
|
2051
|
+
"name": "required",
|
|
2052
|
+
"boolean": true
|
|
2053
|
+
}
|
|
2054
|
+
],
|
|
2055
|
+
"properties": [
|
|
2056
|
+
"hint",
|
|
2057
|
+
"checked",
|
|
2058
|
+
"defaultChecked",
|
|
2059
|
+
"value",
|
|
2060
|
+
"size",
|
|
2061
|
+
"name",
|
|
2062
|
+
"disabled",
|
|
2063
|
+
"required",
|
|
2064
|
+
"form",
|
|
2065
|
+
"validity",
|
|
2066
|
+
"validationMessage",
|
|
2067
|
+
"willValidate"
|
|
2068
|
+
],
|
|
2069
|
+
"events": [
|
|
2070
|
+
"input",
|
|
2071
|
+
"change"
|
|
2072
|
+
],
|
|
2073
|
+
"label": "content"
|
|
2074
|
+
},
|
|
2075
|
+
"uf-textarea": {
|
|
2076
|
+
"attributes": [
|
|
2077
|
+
{
|
|
2078
|
+
"name": "value"
|
|
2079
|
+
},
|
|
2080
|
+
{
|
|
2081
|
+
"name": "label"
|
|
2082
|
+
},
|
|
2083
|
+
{
|
|
2084
|
+
"name": "hint"
|
|
2085
|
+
},
|
|
2086
|
+
{
|
|
2087
|
+
"name": "placeholder"
|
|
2088
|
+
},
|
|
2089
|
+
{
|
|
2090
|
+
"name": "rows"
|
|
2091
|
+
},
|
|
2092
|
+
{
|
|
2093
|
+
"name": "resize",
|
|
2094
|
+
"values": [
|
|
2095
|
+
"none",
|
|
2096
|
+
"vertical",
|
|
2097
|
+
"auto"
|
|
2098
|
+
]
|
|
2099
|
+
},
|
|
2100
|
+
{
|
|
2101
|
+
"name": "size",
|
|
2102
|
+
"values": [
|
|
2103
|
+
"sm",
|
|
2104
|
+
"md",
|
|
2105
|
+
"lg"
|
|
2106
|
+
]
|
|
2107
|
+
},
|
|
2108
|
+
{
|
|
2109
|
+
"name": "readonly",
|
|
2110
|
+
"boolean": true
|
|
2111
|
+
},
|
|
2112
|
+
{
|
|
2113
|
+
"name": "autocomplete"
|
|
2114
|
+
},
|
|
2115
|
+
{
|
|
2116
|
+
"name": "minlength"
|
|
2117
|
+
},
|
|
2118
|
+
{
|
|
2119
|
+
"name": "maxlength"
|
|
2120
|
+
},
|
|
2121
|
+
{
|
|
2122
|
+
"name": "name"
|
|
2123
|
+
},
|
|
2124
|
+
{
|
|
2125
|
+
"name": "disabled",
|
|
2126
|
+
"boolean": true
|
|
2127
|
+
},
|
|
2128
|
+
{
|
|
2129
|
+
"name": "required",
|
|
2130
|
+
"boolean": true
|
|
2131
|
+
}
|
|
2132
|
+
],
|
|
2133
|
+
"properties": [
|
|
2134
|
+
"value",
|
|
2135
|
+
"defaultValue",
|
|
2136
|
+
"label",
|
|
2137
|
+
"hint",
|
|
2138
|
+
"placeholder",
|
|
2139
|
+
"rows",
|
|
2140
|
+
"resize",
|
|
2141
|
+
"size",
|
|
2142
|
+
"readonly",
|
|
2143
|
+
"autocomplete",
|
|
2144
|
+
"minlength",
|
|
2145
|
+
"maxlength",
|
|
2146
|
+
"name",
|
|
2147
|
+
"disabled",
|
|
2148
|
+
"required",
|
|
2149
|
+
"form",
|
|
2150
|
+
"validity",
|
|
2151
|
+
"validationMessage",
|
|
2152
|
+
"willValidate"
|
|
2153
|
+
],
|
|
2154
|
+
"events": [
|
|
2155
|
+
"input",
|
|
2156
|
+
"change"
|
|
2157
|
+
],
|
|
2158
|
+
"label": "required"
|
|
2159
|
+
},
|
|
2160
|
+
"uf-table": {
|
|
2161
|
+
"attributes": [
|
|
2162
|
+
{
|
|
2163
|
+
"name": "columns"
|
|
2164
|
+
},
|
|
2165
|
+
{
|
|
2166
|
+
"name": "rows"
|
|
2167
|
+
},
|
|
2168
|
+
{
|
|
2169
|
+
"name": "label"
|
|
2170
|
+
},
|
|
2171
|
+
{
|
|
2172
|
+
"name": "sort-key"
|
|
2173
|
+
},
|
|
2174
|
+
{
|
|
2175
|
+
"name": "sort-direction",
|
|
2176
|
+
"values": [
|
|
2177
|
+
"ascending",
|
|
2178
|
+
"descending"
|
|
2179
|
+
]
|
|
2180
|
+
},
|
|
2181
|
+
{
|
|
2182
|
+
"name": "manual-sort",
|
|
2183
|
+
"boolean": true
|
|
2184
|
+
},
|
|
2185
|
+
{
|
|
2186
|
+
"name": "row-key"
|
|
2187
|
+
},
|
|
2188
|
+
{
|
|
2189
|
+
"name": "striped",
|
|
2190
|
+
"boolean": true
|
|
2191
|
+
},
|
|
2192
|
+
{
|
|
2193
|
+
"name": "density",
|
|
2194
|
+
"values": [
|
|
2195
|
+
"comfortable",
|
|
2196
|
+
"compact"
|
|
2197
|
+
]
|
|
2198
|
+
}
|
|
2199
|
+
],
|
|
2200
|
+
"properties": [
|
|
2201
|
+
"columns",
|
|
2202
|
+
"rows",
|
|
2203
|
+
"label",
|
|
2204
|
+
"sortKey",
|
|
2205
|
+
"sortDirection",
|
|
2206
|
+
"manualSort",
|
|
2207
|
+
"rowKey",
|
|
2208
|
+
"striped",
|
|
2209
|
+
"density"
|
|
2210
|
+
],
|
|
2211
|
+
"events": [
|
|
2212
|
+
"uf-sort"
|
|
2213
|
+
],
|
|
2214
|
+
"label": "required"
|
|
2215
|
+
},
|
|
2216
|
+
"uf-toaster": {
|
|
2217
|
+
"attributes": [
|
|
2218
|
+
{
|
|
2219
|
+
"name": "placement",
|
|
2220
|
+
"values": [
|
|
2221
|
+
"top-start",
|
|
2222
|
+
"top-center",
|
|
2223
|
+
"top-end",
|
|
2224
|
+
"bottom-start",
|
|
2225
|
+
"bottom-center",
|
|
2226
|
+
"bottom-end"
|
|
2227
|
+
]
|
|
2228
|
+
},
|
|
2229
|
+
{
|
|
2230
|
+
"name": "label"
|
|
2231
|
+
}
|
|
2232
|
+
],
|
|
2233
|
+
"properties": [
|
|
2234
|
+
"placement",
|
|
2235
|
+
"label"
|
|
2236
|
+
],
|
|
2237
|
+
"events": []
|
|
2238
|
+
},
|
|
2239
|
+
"uf-tab": {
|
|
2240
|
+
"attributes": [
|
|
2241
|
+
{
|
|
2242
|
+
"name": "panel"
|
|
2243
|
+
},
|
|
2244
|
+
{
|
|
2245
|
+
"name": "disabled",
|
|
2246
|
+
"boolean": true
|
|
2247
|
+
}
|
|
2248
|
+
],
|
|
2249
|
+
"properties": [
|
|
2250
|
+
"panel",
|
|
2251
|
+
"disabled"
|
|
2252
|
+
],
|
|
2253
|
+
"events": []
|
|
2254
|
+
},
|
|
2255
|
+
"uf-tab-panel": {
|
|
2256
|
+
"attributes": [
|
|
2257
|
+
{
|
|
2258
|
+
"name": "name"
|
|
2259
|
+
}
|
|
2260
|
+
],
|
|
2261
|
+
"properties": [
|
|
2262
|
+
"name"
|
|
2263
|
+
],
|
|
2264
|
+
"events": []
|
|
2265
|
+
},
|
|
2266
|
+
"uf-tabs": {
|
|
2267
|
+
"attributes": [
|
|
2268
|
+
{
|
|
2269
|
+
"name": "value"
|
|
2270
|
+
},
|
|
2271
|
+
{
|
|
2272
|
+
"name": "activation",
|
|
2273
|
+
"values": [
|
|
2274
|
+
"auto",
|
|
2275
|
+
"manual"
|
|
2276
|
+
]
|
|
2277
|
+
},
|
|
2278
|
+
{
|
|
2279
|
+
"name": "orientation",
|
|
2280
|
+
"values": [
|
|
2281
|
+
"horizontal",
|
|
2282
|
+
"vertical"
|
|
2283
|
+
]
|
|
2284
|
+
},
|
|
2285
|
+
{
|
|
2286
|
+
"name": "label"
|
|
2287
|
+
}
|
|
2288
|
+
],
|
|
2289
|
+
"properties": [
|
|
2290
|
+
"value",
|
|
2291
|
+
"activation",
|
|
2292
|
+
"orientation",
|
|
2293
|
+
"label"
|
|
2294
|
+
],
|
|
2295
|
+
"events": [
|
|
2296
|
+
"uf-tab-change"
|
|
2297
|
+
]
|
|
2298
|
+
},
|
|
2299
|
+
"uf-tooltip": {
|
|
2300
|
+
"attributes": [
|
|
2301
|
+
{
|
|
2302
|
+
"name": "content"
|
|
2303
|
+
},
|
|
2304
|
+
{
|
|
2305
|
+
"name": "placement",
|
|
2306
|
+
"values": [
|
|
2307
|
+
"top",
|
|
2308
|
+
"top-start",
|
|
2309
|
+
"top-end",
|
|
2310
|
+
"bottom",
|
|
2311
|
+
"bottom-start",
|
|
2312
|
+
"bottom-end",
|
|
2313
|
+
"left",
|
|
2314
|
+
"right"
|
|
2315
|
+
]
|
|
2316
|
+
},
|
|
2317
|
+
{
|
|
2318
|
+
"name": "disabled",
|
|
2319
|
+
"boolean": true
|
|
2320
|
+
},
|
|
2321
|
+
{
|
|
2322
|
+
"name": "delay"
|
|
2323
|
+
},
|
|
2324
|
+
{
|
|
2325
|
+
"name": "open",
|
|
2326
|
+
"boolean": true
|
|
2327
|
+
}
|
|
2328
|
+
],
|
|
2329
|
+
"properties": [
|
|
2330
|
+
"content",
|
|
2331
|
+
"placement",
|
|
2332
|
+
"disabled",
|
|
2333
|
+
"delay",
|
|
2334
|
+
"open"
|
|
2335
|
+
],
|
|
2336
|
+
"events": [
|
|
2337
|
+
"uf-show",
|
|
2338
|
+
"uf-hide"
|
|
2339
|
+
]
|
|
2340
|
+
}
|
|
2341
|
+
}
|
|
2342
|
+
}
|