@getflip/swirl-ai 0.448.0

package/dist/agent/components/swirl-tabs.md

@@ -0,0 +1,88 @@
+# `<swirl-tabs>`
+
+## Purpose
+
+The SwirlTabs component is used to organize related content into multiple panels.
+
+## Required props
+
+- `label` (string) – 
+
+## Optional props
+
+- `initialTab` (string | undefined) – 
+- `justifyTabBar` ("evenly" | "start" | undefined) – 
+- `tabBarPaddingBlockEnd` ("0" | "12" | "16" | "2" | "20" | "24" | "4" | "8" | undefined) – 
+- `tabBarPaddingBlockStart` ("0" | "12" | "16" | "2" | "20" | "24" | "4" | "8" | undefined) – 
+- `tabBarPaddingInlineEnd` ("0" | "12" | "16" | "2" | "20" | "24" | "4" | "8" | undefined) – 
+- `tabBarPaddingInlineStart` ("0" | "12" | "16" | "2" | "20" | "24" | "4" | "8" | undefined) – 
+- `tabBarVariant` ("default" | "pill" | undefined) – 
+
+## Slots
+
+_None._
+
+## Events
+
+- `tabActivated` – CustomEvent<HTMLSwirlTabElement>
+
+## Methods
+
+- `activateTab()` – Activate a tab.
+
+## Related components
+
+- **[swirl-tab-bar](?path=/docs/components-swirltabbar--docs)** (child) —
+  Renders the tab strip; use inside `swirl-tabs`.
+- **[swirl-tab](?path=/docs/components-swirltab--docs)** (child) — Tab panels;
+  use as direct children of `swirl-tabs`.
+
+## Accessibility
+
+### ARIA
+
+The component follows the
+[WAI-ARIA Tabs Pattern](https://www.w3.org/WAI/ARIA/apg/patterns/tabpanel/).
+
+| ARIA              | Usage                                                             |
+| ----------------- | ----------------------------------------------------------------- |
+| `role="tablist"`  | Set on the tab bar container.                                     |
+| `role="tab"`      | Set on each tab bar element.                                      |
+| `role="tabpanel"` | Set on each tab panel.                                            |
+| `aria-label`      | Provides an accessible label for the tab list.                    |
+| `aria-labelledby` | Set on each tab panel to associate it with its tab bar item.      |
+| `aria-controls`   | Associates each tab bar element with the corresponding tab panel. |
+| `aria-selected`   | Set to `true`/`false` on each active/inactive tab bar element.    |
+
+### Keyboard
+
+| Key              | Action                                                                                                         |
+| ---------------- | -------------------------------------------------------------------------------------------------------------- |
+| <kbd>TAB</kbd>   | Moves focus to the active tab, if tab list wasn't focused before. Otherwise focus is moved to the tab content. |
+| <kbd>LEFT</kbd>  | When focus is on the tab bar, the previous tab is focused and activated.                                       |
+| <kbd>RIGHT</kbd> | When focus is on the tab bar, the next tab is focused and activated.                                           |
+
+## Minimal example
+
+```html
+<swirl-tabs label="..."></swirl-tabs>
+```
+
+## Usage example
+
+```html
+<swirl-tabs initial-tab="tab-2" label="Tabs">
+    <swirl-tab icon='<swirl-icon-emoji-satisfied size="20"></swirl-icon-emoji-satisfied>' label="Tab #1" tab-id="tab-1"
+        ><swirl-text>Tab 1</swirl-text></swirl-tab
+    >
+    <swirl-tab icon='<swirl-icon-emoji-mood size="20"></swirl-icon-emoji-mood>' label="Tab #2" tab-id="tab-2"
+        ><swirl-text>Tab 2</swirl-text></swirl-tab
+    >
+    <swirl-tab label="Tab Number 3" tab-id="tab-3"><swirl-text>Tab 3</swirl-text></swirl-tab>
+</swirl-tabs>
+```
+
+## Common mistakes
+
+- Ensure required props are set.
+- Use only allowed slot names and child components where documented.

package/dist/agent/components/swirl-tag.md

@@ -0,0 +1,70 @@
+# `<swirl-tag>`
+
+## Purpose
+
+The SwirlTag component is used to label or categorize items using keywords.
+
+## Required props
+
+- `label` (string) – 
+
+## Optional props
+
+- `bordered` (boolean | undefined) – 
+- `hideLabel` (boolean | undefined) – 
+- `icon` (string | undefined) – 
+- `iconPosition` ("end" | "start" | undefined) – 
+- `intent` ("critical" | "default" | "info" | "special" | "success" | "translucent" | "warning" | undefined) – 
+- `removable` (boolean | undefined) – 
+- `removalButtonLabel` (string | undefined) – 
+- `size` ("m" | "s" | undefined) – 
+- `variant` ("default" | "outline" | "strong" | undefined) – 
+
+## Slots
+
+_None._
+
+## Events
+
+- `remove` – CustomEvent<MouseEvent>
+
+## Methods
+
+_None._
+
+## Related components
+
+No related components.
+
+## Accessibility
+
+### ARIA
+
+| ARIA            | Usage                                                                            |
+| --------------- | -------------------------------------------------------------------------------- |
+| `role="button"` | Removable tags use a native button.                                              |
+| `aria-label`    | The removal button gets an accessible label via the `removal-button-label` prop. |
+
+### Keyboard
+
+| Key              | Action                        |
+| ---------------- | ----------------------------- |
+| <kbd>ENTER</kbd> | Activates the removal button. |
+| <kbd>SPACE</kbd> | Activates the removal button. |
+
+## Minimal example
+
+```html
+<swirl-tag label="..."></swirl-tag>
+```
+
+## Usage example
+
+```html
+<swirl-tag label="Label" removable></swirl-tag>
+```
+
+## Common mistakes
+
+- Ensure required props are set.
+- Use only allowed slot names and child components where documented.

package/dist/agent/components/swirl-text-input.md

@@ -0,0 +1,110 @@
+# `<swirl-text-input>`
+
+## Purpose
+
+The SwirlTextInput component is used to render a text input field for user input of various types. It should always be used in combination with the [SwirlFormControl component](?path=/docs/components-swirlformcontrol--docs).
+
+## Required props
+
+_None._
+
+## Optional props
+
+- `autoComplete` (string | undefined) – 
+- `autoFocus` (boolean | undefined) – 
+- `autoGrow` (boolean | undefined) – 
+- `autoSelect` (boolean | undefined) – 
+- `characterCounterLabel` (string | undefined) – 
+- `clearButtonLabel` (string | undefined) – 
+- `clearable` (boolean | undefined) – 
+- `disableDynamicWidth` (boolean | undefined) – 
+- `disabled` (boolean | undefined) – 
+- `fontSize` ("base" | "default" | "sm" | undefined) – 
+- `inline` (boolean | undefined) – 
+- `inputName` (string | undefined) – 
+- `invalid` (boolean | undefined) – 
+- `max` (number | undefined) – 
+- `maxLength` (number | undefined) – 
+- `min` (number | undefined) – 
+- `mode` ("decimal" | "email" | "numeric" | "search" | "tel" | "text" | "url" | undefined) – 
+- `passwordToggleLabel` (string | undefined) – 
+- `placeholder` (string | undefined) – 
+- `prefixLabel` (string | undefined) – 
+- `readonly` (boolean | undefined) – 
+- `required` (boolean | undefined) – 
+- `rows` (number | undefined) – 
+- `showCharacterCounter` (boolean | undefined) – 
+- `showCharacterCounterNearLimit` (boolean | undefined) – 
+- `spellCheck` (boolean | undefined) – 
+- `step` (number | undefined) – 
+- `suffixLabel` (string | undefined) – 
+- `swirlAriaAutocomplete` (string | undefined) – 
+- `swirlAriaControls` (string | undefined) – 
+- `swirlAriaDescribedby` (string | undefined) – 
+- `swirlAriaExpanded` (string | undefined) – 
+- `swirlRole` (string | undefined) – 
+- `type` ("date" | "datetime-local" | "email" | "number" | "password" | "reset" | "tel" | "text" | "url" | undefined) – 
+- `value` (string | undefined) – 
+
+## Slots
+
+_None._
+
+## Events
+
+- `clear` – CustomEvent<void>
+- `inputBlur` – CustomEvent<FocusEvent>
+- `inputFocus` – CustomEvent<FocusEvent>
+- `valueChange` – CustomEvent<string>
+
+## Methods
+
+- `blurInput()` – 
+- `focusInput()` – 
+
+## Related components
+
+- **[swirl-form-control](?path=/docs/components-swirlformcontrol--docs)**
+  (parent) — Wraps the input with label and description; use `swirl-text-input`
+  in the default slot of `swirl-form-control`.
+
+## Accessibility
+
+### ARIA
+
+The input and controls expose ARIA for form and autocomplete semantics.
+
+| ARIA                | Usage                                                       |
+| ------------------- | ----------------------------------------------------------- |
+| `aria-autocomplete` | Optional; set via `swirlAriaAutocomplete`.                  |
+| `aria-controls`     | Optional; set via `swirlAriaControls`.                      |
+| `aria-describedby`  | Optional; set via `swirlAriaDescribedby`.                   |
+| `aria-disabled`     | Set when the input is disabled.                             |
+| `aria-expanded`     | Optional; set via `swirlAriaExpanded` (e.g. for dropdowns). |
+| `aria-invalid`      | Set when the value is invalid.                              |
+| `role`              | Optional; set via `swirlRole`.                              |
+| `aria-label`        | Set on the clear and password toggle buttons.               |
+| `aria-live`         | Set to `"polite"` on the character counter when present.    |
+| `aria-hidden`       | Set on decorative prefix/suffix content.                    |
+
+### Keyboard
+
+Standard text input behavior. Clear and password toggle buttons are activated
+with <kbd>Enter</kbd> or <kbd>Space</kbd>. No component-specific shortcuts.
+
+## Minimal example
+
+```html
+<swirl-text-input></swirl-text-input>
+```
+
+## Usage example
+
+```html
+<swirl-text-input value="Value"></swirl-text-input>
+```
+
+## Common mistakes
+
+- Ensure required props are set.
+- Use only allowed slot names and child components where documented.

package/dist/agent/components/swirl-text.md

@@ -0,0 +1,72 @@
+# `<swirl-text>`
+
+## Purpose
+
+The SwirlText component is used to display simple text.
+
+## Required props
+
+_None._
+
+## Optional props
+
+- `align` ("center" | "end" | "start" | undefined) – 
+- `as` (string | undefined) – 
+- `balance` (boolean | undefined) – 
+- `color` ("critical" | "default" | "disabled" | "highlight" | "on-action-primary" | "on-image" | "on-status" | "on-surface-highlight" | "on-surface-highlight-subdued" | "subdued" | "success" | "warning" | undefined) – 
+- `fontFamily` ("code" | "text" | undefined) – 
+- `fontStyle` ("italic" | "normal" | undefined) – 
+- `lines` (number | undefined) – 
+- `responsive` (boolean | undefined) – 
+- `size` ("2xl" | "base" | "lg" | "sm" | "xl" | "xs" | undefined) – 
+- `truncate` (boolean | undefined) – 
+- `truncateDirection` ("end" | "start" | undefined) – 
+- `weight` ("bold" | "medium" | "normal" | "semibold" | undefined) – 
+- `whiteSpace` ("break-spaces" | "inherit" | "normal" | "nowrap" | "pre" | "pre-line" | "pre-wrap" | undefined) – 
+
+## Slots
+
+- **`slot`** – The text content. When provided, overrides the `text` prop.
+
+## Events
+
+_None._
+
+## Methods
+
+_None._
+
+## Related components
+
+No related components.
+
+## Accessibility
+
+SwirlText renders a text element (default <code>&lt;p&gt;</code>; overridable
+via <code>as</code>). It has no ARIA attributes or keyboard-specific behavior;
+semantics come from the chosen element and surrounding context.
+
+### Keyboard
+
+No component-specific keyboard behavior.
+
+## Minimal example
+
+```html
+<swirl-text></swirl-text>
+```
+
+## Usage example
+
+```html
+<swirl-text>
+    Est, odio dis scelerisque risus sagittis lorem rhoncus. Vivamus tristique habitant vitae cursus nisl. Sed adipiscing
+    proin suspendisse aliquam maecenas faucibus mauris purus. Tortor ut habitant erat adipiscing nulla pretium, cursus
+    tortor. Amet viverra et platea lacus, nec molestie tincidunt.
+</swirl-text>
+```
+
+## Common mistakes
+
+- Ensure required props are set.
+- Use only allowed slot names and child components where documented.

package/dist/agent/components/swirl-theme-provider.md

@@ -0,0 +1,61 @@
+# `<swirl-theme-provider>`
+
+## Purpose
+
+The SwirlThemeProvider implements automatic theme switching with respect to the user's OS theme setting, and allows to override the OS setting with a preferred user theme. Via the configuration object of the provider, deviating tenant colors can be set.
+
+## Required props
+
+- `config` ({ enabledThemes?: (keyof SwirlThemes)[]; rootElement?: HTMLElement; storage?: SwirlThemeProviderStorage; themes?: SwirlThemes; }) – 
+
+## Optional props
+
+_None._
+
+## Slots
+
+_None._
+
+## Events
+
+- `appThemeUpdated` – CustomEvent<void>
+- `themeChange` – CustomEvent<{ activeTheme: SwirlOSTheme; preferredTheme: SwirlOSTheme; }>
+
+## Methods
+
+- `getActiveOSTheme()` – Returns the active OS theme.
+- `getPreferredOSTheme()` – Returns the user's preferred OS theme stored in local storage.
+- `resetPreferredOSTheme()` – Resets the user's preferred OS theme, using the system theme instead.
+- `setPreferredOSTheme()` – Sets the user's preferred OS theme and stores it in local storage. Overrides
+the system theme.
+
+## Related components
+
+No related components.
+
+## Accessibility
+
+SwirlThemeProvider is a layout wrapper with no interactive semantics. It does
+not expose ARIA attributes or keyboard-specific behavior; ensure slotted content
+provides appropriate semantics.
+
+### Keyboard
+
+No component-specific keyboard behavior.
+
+## Minimal example
+
+```html
+<swirl-theme-provider></swirl-theme-provider>
+```
+
+## Usage example
+
+```html
+<swirl-theme-provider></swirl-theme-provider>
+```
+
+## Common mistakes
+
+- Ensure required props are set.
+- Use only allowed slot names and child components where documented.

package/dist/agent/components/swirl-thumbnail.md

@@ -0,0 +1,69 @@
+# `<swirl-thumbnail>`
+
+## Purpose
+
+The SwirlThumbnail component is used to visually represent an object via a small image.
+
+## Required props
+
+- `alt` (string) – 
+- `src` (string) – 
+
+## Optional props
+
+- `editButtonIcon` (string | undefined) – 
+- `editButtonLabel` (string | undefined) – 
+- `format` ("landscape" | "portrait" | "square" | undefined) – 
+- `interactive` (boolean | undefined) – 
+- `progress` (number | undefined) – 
+- `progressLabel` (string | undefined) – 
+- `removeButtonLabel` (string | undefined) – 
+- `showEditButton` (boolean | undefined) – 
+- `showRemoveButton` (boolean | undefined) – 
+- `size` ("2xl" | "l" | "m" | "s" | "xl" | undefined) – 
+- `timestamp` (string | undefined) – 
+
+## Slots
+
+_None._
+
+## Events
+
+- `edit` – CustomEvent<MouseEvent>
+- `remove` – CustomEvent<MouseEvent>
+- `thumbnailClick` – CustomEvent<MouseEvent>
+
+## Methods
+
+_None._
+
+## Related components
+
+No related components.
+
+## Accessibility
+
+SwirlThumbnail is a presentational image wrapper with no ARIA attributes or
+keyboard-specific behavior. Provide an accessible name for the image via slotted
+content or a parent label.
+
+### Keyboard
+
+No component-specific keyboard behavior.
+
+## Minimal example
+
+```html
+<swirl-thumbnail alt="..." src="..."></swirl-thumbnail>
+```
+
+## Usage example
+
+```html
+<swirl-thumbnail alt="Brief description of the image." src="https://picsum.photos/id/433/400/400"></swirl-thumbnail>
+```
+
+## Common mistakes
+
+- Ensure required props are set.
+- Use only allowed slot names and child components where documented.

package/dist/agent/components/swirl-time-input.md

@@ -0,0 +1,74 @@
+# `<swirl-time-input>`
+
+## Purpose
+
+The SwirlDateInput component is used to enter time values. It should always be used in combination with the [SwirlFormControl component](?path=/docs/components-swirlformcontrol--docs).
+
+## Required props
+
+_None._
+
+## Optional props
+
+- `autoFocus` (boolean | undefined) – 
+- `autoSelect` (boolean | undefined) – 
+- `disabled` (boolean | undefined) – 
+- `format` (string | undefined) – 
+- `inline` (boolean | undefined) – 
+- `invalid` (boolean | undefined) – 
+- `placeholder` (string | undefined) – 
+- `readonly` (boolean | undefined) – 
+- `required` (boolean | undefined) – 
+- `swirlAriaDescribedby` (string | undefined) – 
+- `value` (string | undefined) – 
+
+## Slots
+
+_None._
+
+## Events
+
+- `inputBlur` – CustomEvent<FocusEvent>
+- `inputFocus` – CustomEvent<FocusEvent>
+- `valueChange` – CustomEvent<string>
+
+## Methods
+
+_None._
+
+## Related components
+
+- **[swirl-form-control](?path=/docs/components-swirlformcontrol--docs)**
+  (parent) — Wraps the input with label and description; use `swirl-time-input`
+  in the default slot of `swirl-form-control`.
+
+## Accessibility
+
+### ARIA
+
+| ARIA               | Usage                                     |
+| ------------------ | ----------------------------------------- |
+| `aria-describedby` | Optional; set via `swirlAriaDescribedby`. |
+| `aria-disabled`    | Set when the input is disabled.           |
+| `aria-invalid`     | Set when the value is invalid.            |
+
+### Keyboard
+
+Standard text input behavior. No component-specific shortcuts.
+
+## Minimal example
+
+```html
+<swirl-time-input></swirl-time-input>
+```
+
+## Usage example
+
+```html
+<swirl-time-input></swirl-time-input>
+```
+
+## Common mistakes
+
+- Ensure required props are set.
+- Use only allowed slot names and child components where documented.

package/dist/agent/components/swirl-toast-provider.md

@@ -0,0 +1,75 @@
+# `<swirl-toast-provider>`
+
+## Purpose
+
+The SwirlToastProvider component is used to host and create [SwirlToast](?path=/docs/components-swirltoast--docs) messages.
+
+## Required props
+
+_None._
+
+## Optional props
+
+- `globalDuration` (number | undefined) – 
+
+## Slots
+
+_None._
+
+## Events
+
+_None._
+
+## Methods
+
+- `clearAll()` – Clear all toasts
+- `dismiss()` – Dismiss a toast
+- `toast()` – Create a new toast
+
+## Related components
+
+- **[swirl-toast](?path=/docs/components-swirltoast--docs)** (child) — Toasts
+  are created programmatically via the provider’s API; the provider renders
+  `swirl-toast` instances.
+
+## Accessibility
+
+### ARIA
+
+| ARIA            | Usage                                                     |
+| --------------- | --------------------------------------------------------- |
+| `role="status"` | The component wraps all toasts in a "polite" live region. |
+
+### Keyboard
+
+No component-specific keyboard behavior.
+
+### Positioning
+
+You should place the SwirlToastProvider component in the designated slot of the
+Layout components. This ensures that the messages are displayed correctly and
+guarantees that they appear at a predictable place in the DOM structure.
+
+### Timing/Duration
+
+Toasts can be configured to automatically close after a certain period of time,
+which is in violation with WCAG 2.1. To work around this issue, we allow the
+user via the UI of our app(s) to override the time period globally or disable
+automatic closing completely.
+
+## Minimal example
+
+```html
+<swirl-toast-provider></swirl-toast-provider>
+```
+
+## Usage example
+
+```html
+<swirl-toast-provider></swirl-toast-provider>
+```
+
+## Common mistakes
+
+- Ensure required props are set.
+- Use only allowed slot names and child components where documented.

package/dist/agent/components/swirl-toast.md

@@ -0,0 +1,68 @@
+# `<swirl-toast>`
+
+## Purpose
+
+The SwirlToast component is used to give brief, non-disruptive feedback after an action has taken place.
+
+## Required props
+
+- `toastId` (string) – 
+
+## Optional props
+
+- `accessibleDismissLabel` (string | undefined) – 
+- `actionLabel` (string | undefined) – 
+- `content` (string | undefined) – 
+- `dismissLabel` (string | undefined) – 
+- `duration` (number | undefined) – 
+- `icon` (string | undefined) – 
+- `intent` ("critical" | "default" | "success" | undefined) – 
+
+## Slots
+
+- **`slot`** – The toast content. When provided, overrides the `content` prop.
+
+## Events
+
+- `action` – CustomEvent<string>
+- `dismiss` – CustomEvent<string>
+
+## Methods
+
+_None._
+
+## Related components
+
+- **[swirl-toast-provider](?path=/docs/components-swirltoastprovider--docs)**
+  (parent) — Renders and stacks toasts; use the provider’s API to show toasts
+  (they render as `swirl-toast`).
+
+## Accessibility
+
+Please refer to the
+[ToastProvider](?path=/docs/components-swirltoastprovider--docs) component for
+information on how to use the SwirlToasts in an accessible way.
+
+### Keyboard
+
+No component-specific keyboard behavior; toasts are announced via the live
+region.
+
+## Minimal example
+
+```html
+<swirl-toast toastId="..."></swirl-toast>
+```
+
+## Usage example
+
+```html
+<swirl-toast icon="<swirl-icon-mail></swirl-icon-mail>">
+    This is toast text with multiple lines. Try to keep the info as short as possible.
+</swirl-toast>
+```
+
+## Common mistakes
+
+- Ensure required props are set.
+- Use only allowed slot names and child components where documented.