# Swell UI

Source: https://developers.swell.is/apps/swell-ui

Swell UI (`@swell/swell-ui`) is a library of web components for the UI of Swell apps: buttons, text fields, selects, radio groups, tabs, status messages and more. Swell's hosted checkout is built from them. Each host sets their look through design tokens, so UI built from them matches the page around it and follows its light or dark theme.

The components are custom elements, such as `<swell-button>` and `<swell-input>`, so they work in any framework or none. They look finished with no configuration.

Build the UI of an app's [UI components](https://developers.swell.is/apps/components) and [frontend](https://developers.swell.is/apps/frontend) from Swell UI's elements, and style only the markup it has no element for, with its CSS variables.

## Installing Swell UI

### In a UI component

Set `ui: true` in the component's `config`. The platform loads Swell UI into the component's frame before the first render, configured like the host page, and applies the host's later changes:

```typescript
import type { ComponentProps } from '@swell/apps-sdk/components';

export const config = {
  description: 'Gift message for the order',
  ui: true,
};

export default function GiftMessage({ value, setValue, readonly }: ComponentProps<string | null>) {
  return (
    <swell-textarea
      label="Gift message"
      value={value ?? ''}
      readonly={readonly}
      oninput={(event) => setValue(event.target.value || null)}
    />
  );
}
```

The platform supplies Swell UI's code, so a component uses the elements by their tags. When you push, the CLI leaves every value import of `@swell/swell-ui` out of the component's bundle and warns: `"@swell/swell-ui" is left out of the bundle: set config.ui = true in the component and the platform loads the Swell UI kit; import the kit only as types`. Its functions are on the global `SwellUI` instead, and its React wrappers aren't available in a component.

`ui` must be `true` or `false`. `swell app push` rejects any other value with `ui must be true or false`. A component without `ui: true` never loads Swell UI, and its frame has no styles of its own. UI components need Swell CLI 2.9.36 and `@swell/apps-sdk` 2.1.0 or later for Swell UI.

To type the elements, install the package as a dev dependency:

```sh
npm install -D @swell/swell-ui
```

Then add `@swell/swell-ui`, which declares the global `SwellUI`, and `@swell/swell-ui/preact`, which types the elements in Preact's JSX, to `types` in `components/tsconfig.json`. `swell create component` writes `"types": []`:

```json
{
  "compilerOptions": {
    "types": ["@swell/swell-ui", "@swell/swell-ui/preact"]
  }
}
```

Event props are lowercase, as these types name them: `oninput`, `onchange`, `ontoggle` and `onremove`. `event.target` is the element.

#### The host's look

The look of Swell UI in a component comes from the host. Hosted checkout passes its configuration, so a payment component takes the checkout's colors, font and corner radius. The Swell dashboard passes none, so a field component takes Swell UI's default look. In both, Swell UI follows the host's light or dark theme, so a component needs no theme CSS and no `configure()` call of its own. The `ui` prop holds `{ config }`, the configuration the host passed.

When Swell UI can't load, the component still renders without it, and the frame reports the error to the host.

### In a frontend

Install the package from npm, and import it once in code that runs in the browser. Its entry holds the configuration and the loader, which loads each element the first time its tag appears on the page:

```sh
npm install @swell/swell-ui
```

```javascript
import { configure } from '@swell/swell-ui';
```

Without a bundler, load the copy that Swell serves at `/.swell/ui/v1/index.js` on every Swell domain, including an app's frontend domain and a store's storefront domains. It is a module script, and it sets the global `SwellUI`. `v1` is the major version:

```html
<script type="module" src="/.swell/ui/v1/index.js"></script>
<swell-text type="heading">Delivery</swell-text>
```

Swell UI runs in the browser only, and importing it on a server throws. A frontend that renders on the server imports it in the browser only. With the `swell-vinext` template, load a component built from Swell UI with `dynamic(() => import('./GiftForm'), { ssr: false })` from `next/dynamic`, inside a `"use client"` component. The `swell-react` template renders in the browser and imports Swell UI directly.

No host passes a configuration to a frontend, so Swell UI draws its default look until the frontend calls `configure()` with its own values, such as a storefront's brand colors. See Configuration below.

### Styling your own markup

Swell UI defines its global tokens as CSS variables on every page it loads in, named `--swell-` followed by the token's name with hyphens for dots. They carry the host's values and follow its theme, so markup of your own that reads them matches the components around it:

```css
.gift-note {
  padding: 12px 16px;
  border: var(--swell-border-width) solid var(--swell-color-border);
  border-radius: var(--swell-border-radius);
  background: var(--swell-color-secondary-background);
  color: var(--swell-color-secondary-foreground);
  font-family: var(--swell-font-family);
}
```

## Using the elements

Use the elements in plain markup, or in a framework's templates:

```html
<swell-button>Continue</swell-button>
<swell-button variant="secondary">Edit</swell-button>
<swell-button variant="secondary" appearance="plain" size="small">Cancel</swell-button>
```

Fields such as `<swell-input>`, `<swell-select>` and `<swell-radio>` take part in the form around them as native fields do: they send their `name` and `value` with the form, and `required` stops the form from being sent while they're empty.

Swell UI has no icon set. Put your own icon in an element's `start` or `end` slot. An `<svg>` there takes the element's icon size and the current color, so draw it with `currentColor`:

```html
<swell-input label="Address">
  <svg slot="start" viewBox="0 0 24 24" fill="none" stroke="currentColor" aria-hidden="true">…</svg>
</swell-input>
```

### Loading

Each element is a chunk of its own. A page downloads the entry, the configuration and the chunks of the elements it renders.

- The loader watches the document: every Swell UI element on the page when the entry runs, and every one added later, loads its chunk once.
- Until its chunk loads, an element is hidden and keeps its place in the layout.
- A component that renders elements in a shadow root of its own passes the root to `load`, which watches it as it watches the document: `SwellUI.load(this.shadowRoot)`.
- `load(tags)` loads elements before they appear, and `ready(tags)` waits until they are defined. `ready()` waits for every Swell UI element on the page now. Both reject when a chunk can't load.
- `@swell/swell-ui/elements/<name>` defines the element `swell-<name>` as soon as it is imported, and exports its class. Import the elements of a page's first screen this way and leave the rest to the loader.
- In the copy Swell serves, a chunk that fails to load, such as one a deploy replaced while the page was open, makes the loader import a fresh entry once. An element that still doesn't load stays undefined and is reported with `console.error`, and the rest of the page keeps working.

```javascript
import { load, ready } from '@swell/swell-ui';

load(['swell-button', 'swell-input']);
await ready();
```

### Frameworks

The package carries types and editor data for the elements.

- React 16.8 or later: use the typed wrappers from `@swell/swell-ui/react`, such as `SwellButton` and `SwellQuantity`, which set properties and listen to the elements' events. Each wrapper defines its element when it is imported. A handler gets the element as `event.currentTarget`. As on a native field, `onInput` fires on every change of a field's value and `onChange` once the user commits it.
- Preact, Solid, Vue and Svelte: use the elements by their tags, and add `@swell/swell-ui/preact`, `/solid`, `/vue` or `/svelte` to `compilerOptions.types` in `tsconfig.json` to type every element's attributes, properties and events. Vue renders the elements as custom elements when its compiler option `isCustomElement` returns `true` for tags that start with `swell-`.
- Editors: JetBrains IDEs read the package's `web-types.json`. In VS Code, add the package's custom data files to the workspace settings.

```javascript
import { SwellQuantity } from '@swell/swell-ui/react';

<SwellQuantity aria-label="Quantity" value={count} onChange={(event) => setCount(event.currentTarget.value)} />;
```

```json
{
  "html.customData": ["./node_modules/@swell/swell-ui/dist/editors/vscode.html-custom-data.json"],
  "css.customData": ["./node_modules/@swell/swell-ui/dist/editors/vscode.css-custom-data.json"]
}
```

### Browser support

Swell UI runs in Chrome 125, Firefox 126, Safari 17.5 and later. The elements rely on custom states (`:state()`), `light-dark()` colors, the Popover API, constructable stylesheets and `ElementInternals`.

## Configuration

A host configures Swell UI's look from JavaScript, at any time, with `configure()`. The elements on the page follow each call, before or after they render:

```javascript
SwellUI.configure({
  color: {
    background: { light: '#ffffff', dark: '#14171d' },
    foreground: { light: '#0e1117', dark: '#e8eaef' },
    accent: { light: '#0a7c4a', dark: '#3ecf8e' },
  },
  font: { family: 'Inter', size: '15px' },
  control: { height: '40px' },
  field: { appearance: 'filled', label: { position: 'above' } },
  components: {
    button: {
      border: { radius: '12px' },
      secondary: { appearance: 'filled' },
    },
    text: { heading: { font: { size: '22px', weight: 700 } } },
  },
  theme: 'system',
});
```

- The keys are the token names. A global token sits at its name, such as `control.small.height` at `control: { small: { height } }`, and a component's token under `components`, such as `button.large.height` at `components: { button: { large: { height } } }`. The type `Config` of `@swell/swell-ui` lists every key.
- A color is one value for both themes, or `{ light, dark }` with both. Every other token takes one value for both themes: a CSS string such as `"40px"`, a number for font weights, or a name or list of names for font families.
- Font families are names. The host loads the font files.
- Each call replaces the page's configuration, the theme included. A token you leave out takes its default, and `configure()` with no configuration restores the defaults.
- Unknown keys and invalid values are reported in the console and skipped.

### Themes

The theme is `light`, `dark` or `system`, which follows the system setting. Set it with the `theme` key, or with `setTheme()`, which keeps the rest of the configuration. Without a theme, Swell UI follows the `color-scheme` of the page.

```javascript
SwellUI.setTheme('dark');
```

### Areas

An area of the page can take token values of its own, such as an order summary in a brand's colors. `configure(config, id)` registers the area's configuration, and `<swell-ui config="id">` applies it to everything inside, your own markup included. Values the area leaves out come from the page:

```javascript
SwellUI.configure({ theme: 'light', color: { background: '#e7d7bc', accent: '#17130e' } }, 'summary');
```

```html
<swell-ui config="summary"><aside class="summary">…</aside></swell-ui>
```

An area's configuration holds tokens and `theme`. Settings apply to the whole page, so an area reports and skips them. A second call with the same id replaces the area's configuration, and `configure(undefined, id)` removes it.

### Reading the configuration

- `getConfig()` returns the applied configuration with the theme in effect, and `getConfig(id)` an area's own configuration.
- `onChange(listener)` calls `listener` after every `configure()` and `setTheme()`, and returns a function that removes the listener.
- `version` is the version of Swell UI on the page.
- These functions, with `load` and `ready`, are exported from `@swell/swell-ui` and are also on the global `SwellUI`.

### Tokens

Tokens are the design values of the elements. Each token has a default, and Swell UI looks finished with none configured. Global tokens hold values that several elements share, in the groups `color`, `font`, `border`, `focus`, `motion`, `control`, `field` and `overlay`. Component tokens hold the values of one element each, such as `button` and `radio`.

The base values, the ones most sites change, are `color.background`, `color.foreground`, `color.accent`, `color.danger`, `font.family`, `font.size`, `border.radius` and `control.height`. A token whose default references another one follows it until you set its own value: changing `color.accent` also changes `button.color.background` and `focus.color`. Swell UI computes no color from another, so when you change `color.background` or `color.foreground`, also set the colors drawn from them, such as `color.border` and `color.secondary.background`.

Colors are named by role: `background`, `foreground`, `border`, `accent` (text, links, outlines and icons where there is no fill), `ring` and `shadow`. `color.danger`, `color.success` and `color.warning` color errors, successes and warnings.

In CSS, each token is a variable named `--swell-` followed by its name with hyphens for dots: `color.secondary.background` is `--swell-color-secondary-background`. Every token's default and description is in the package, in `tokens/*.json` and each element's `tokens.json` under `src/components/core/`, in the W3C Design Tokens format. `TOKENS.md` in the package describes each element's appearances in detail.

### Variants

The `variant` attribute picks the palette of `color` an element takes its colors from. `primary` is an element without the attribute. `secondary` is a quieter palette, `color.secondary`. `button`, `badge`, `link`, `text` and `thumbnail` take variants.

To add a variant of your own, add a palette to `color` at its name, with `background`, `foreground`, `border` and `accent`, and optionally `shadow`. Elements take it with `variant="<name>"`. The name is a lowercase word other than `primary`, the palette roles, `variant`, `size`, `type` and `state`.

```javascript
SwellUI.configure({
  color: { promo: { background: '#fde68a', foreground: '#422006', border: '#f59e0b', accent: '#b45309' } },
});
```

```html
<swell-button variant="promo">Claim offer</swell-button>
```

### Settings

Settings hold the choices no token value expresses. Set them in the configuration at their names, such as `field: { appearance: 'filled' }` and `components: { button: { secondary: { appearance: 'filled' } } }`. An element's attribute overrides the setting on that element: `appearance` for `button.appearance`, and `indicator-position` on a radio group for `radio.indicator.position`.

| Setting | Values | Default |
| --- | --- | --- |
| button.appearance | filled, outline, plain | filled |
| button.secondary.appearance | filled, outline, plain | outline |
| status.appearance | filled, outline, plain | filled |
| badge.appearance | filled, outline | outline |
| card.appearance | outline, filled | outline |
| tabs.appearance | underline, segmented | underline |
| field.appearance | outline, filled, underline | outline |
| field.label.position | above, floating | floating |
| radio.appearance | plain, outline | plain |
| radio.indicator.position | start, end | start |

Some appearances come from the attribute only: `segmented` and `button` on a radio group, `plain` on a link, `quiet` on a status message, `card` on a skeleton and `steps` on tabs.

### Sizes

The `size` attribute is one of `xsmall`, `small`, `medium`, `large` and `xlarge`, and defaults to `medium`. Each size sets a height and a text size, in px, and every other measure of an element follows from them. Badges and chips have scales of their own. Every target stays at least 24px.

| Tokens | xsmall | small | medium | large | xlarge |
| --- | --- | --- | --- | --- | --- |
| control.<size>.height | 32 | 40 | 48 | 56 | 64 |
| control.<size>.font.size | 12 | 13 | 14 | 16 | 18 |
| badge.<size>.height | 16 | 20 | 24 | 28 | 32 |
| badge.<size>.font.size | 10 | 11 | 12 | 13 | 14 |
| chip.<size>.height | 24 | 28 | 32 | 36 | 40 |
| chip.<size>.font.size | 11 | 12 | 13 | 14 | 16 |

The control scale applies to buttons, text fields, selects, lookups, quantities, segmented radio groups, thumbnails and tabs, and its text sizes to checkboxes, radio options, status messages and plain links. A field of size `xsmall` puts its label above the field.

## Elements

Every element below is defined by the loader on first use. In React, each has a wrapper named after its tag in PascalCase, such as `SwellButton` for `<swell-button>`. Style an element's CSS parts with `::part()`, and select its states with `:state()`, such as `swell-button:state(outline)`.

## Text and layout

### swell-text

Text: a title, a heading, a subheading, strong text, body text, a caption, a footnote or an eyebrow.

| Attribute | Type | Description |
| --- | --- | --- |
| level | number | The heading level, 1 to 6: it makes text of any type a heading. A title, a heading and a subheading are headings of level 1, 2 and 3 by default. |
| variant | string | Which palette of color the text takes its color from: secondary, quiet text, or a variant of the host's own; without it, the text color. |
| type | title, heading, subheading, strong, body, caption, footnote, eyebrow | What the text is; body text by default. An eyebrow is uppercase. |

| Slot | Description |
| --- | --- |
| (default) | The text. |

### swell-card

A card: a box that groups content, such as the details of an order or a note under a choice.

| Attribute | Type | Description |
| --- | --- | --- |
| appearance | outline, filled | How the card is drawn: with a border, or filled with the quiet background; the configured setting by default. |
| size | xsmall, small, medium, large, xlarge | How large the padding is: it follows the text of the size; medium by default. |

| Slot | Description |
| --- | --- |
| (default) | The content. |

| State | Description |
| --- | --- |
| outline | The card has a border. |
| filled | The card is filled. |

### swell-divider

A divider: a line across its width, or two lines with a label between them, such as "or pay another way". Without a label it is a separator for screen readers; with one, they read the label and skip the lines. The host sets the space around it.

| Slot | Description |
| --- | --- |
| (default) | An optional label, such as text or an icon, drawn in the caption font and the secondary text color; whitespace and hidden content aren't one. |

### swell-badge

A badge: a short label or a count, such as a subscription's interval, a discount or a quantity. It is text only: screen readers read it in place, so a count needs its context in the host's markup, such as hidden text next to it.

| Attribute | Type | Description |
| --- | --- | --- |
| variant | string | Which palette of color the badge takes its colors from: secondary, quiet, or a variant of the host's own; without it, the badge's own. |
| appearance | filled, outline | How the badge is drawn; the configured setting by default. |
| size | xsmall, small, medium, large, xlarge | How large the badge is; medium by default. A small one fits a count, an extra small one a count on an icon. |

| Slot | Description |
| --- | --- |
| (default) | The label. |
| start | An icon before the label, drawn 1px larger than the text. |

| State | Description |
| --- | --- |
| filled | The badge is filled. |
| outline | The badge has an outline. |

### swell-thumbnail

A thumbnail: a picture, an icon or initials in a small box, such as the photo of a cart line or a person's avatar. It is decoration, hidden from screen readers, with its badge; with `aria-label` it is an image with that name, which then carries what the badge says, such as the quantity. `aria-hidden="true"` and `role="img"` count as the kit's; any other value is the host's and stays.

| Attribute | Type | Description |
| --- | --- | --- |
| aria-label |  | The element's accessible name, when it has no visible label. |
| variant | string | Which palette of color the box takes its colors from: secondary, the quiet colors with a border, as for a product without a photo, or a variant of the host's own; without it, the accent, as for an avatar. |
| size | xsmall, small, medium, large, xlarge | How large the box is: the height of a control of the size; medium by default. |
| shape | circle | Rounds the box fully, as for an avatar. |

| Slot | Description |
| --- | --- |
| (default) | An <img>, which covers the box, an svg icon, or initials. |
| badge | A <swell-badge> over the top end corner, such as the quantity of a cart line. |

### swell-skeleton

A skeleton: a shimmering bar that stands in for content while it loads, such as a delivery option's name and price. The host sets its width through `style` and marks the region it fills with `aria-busy="true"`; the skeleton itself is hidden from screen readers. Screen readers don't all announce `aria-busy`, so a host can also say what is loading in a polite message, such as a visually hidden `<swell-status>`.

| Attribute | Type | Description |
| --- | --- | --- |
| size | xsmall, small, medium, large, xlarge | How large the skeleton is: a bar is 4px lower than the text of the size, a card as high as a control; medium by default. The bars of a card keep their own size, so give them the card's. |
| appearance | card | card draws the empty frame of an option card with its bars at its ends; only the attribute sets it. Without it, the skeleton is a bar. |

| Slot | Description |
| --- | --- |
| (default) | The bars of a card. |

| State | Description |
| --- | --- |
| card | The skeleton is the frame of an option card. |

### swell-status

A status message: an error, a success or a warning. Screen readers announce it when it is added after the page has loaded and when its text or type changes: each message goes into a fresh visually hidden region, an alert for danger and a status otherwise.

| Attribute | Type | Description |
| --- | --- | --- |
| type | danger, success, warning | What the message means: its color, icon and how it is announced. |
| size | xsmall, small, medium, large, xlarge | How large the message is: its text, padding and icon follow the text of the size; medium by default. |
| appearance | filled, outline, plain, quiet | How the message is drawn; the configured setting by default. quiet, for a note, comes from the attribute only. |

| Slot | Description |
| --- | --- |
| (default) | The message. |
| start | An icon before the message, drawn 4px larger than the text, or 2px larger than the smaller text of a plain message; it replaces the type's icon and is hidden from screen readers. |
| end | An action after the message, such as a <swell-button size="xsmall">; it is left out of the announcement. |

| CSS part | Description |
| --- | --- |
| message | The message box. |

| State | Description |
| --- | --- |
| filled | The message has its background, border and icon. |
| outline | The message has its border and icon. |
| plain | The message has its icon only and the font of a field error. |
| quiet | The message is a note in the quiet palette, without a border or the type's icon. |
| end-content | The message has content in its end slot: its items are centered. |
| typed | The message has a known type and isn't quiet: it takes the colors of its type. |

## Actions

### swell-button

A button. It submits or resets the form it belongs to, like a native button. With `href` it is a link that looks like the button: an anchor in its shadow root fills it inside the border, takes the focus and follows the link, named by the element's own `aria-label`, or else by its content; `type`, `disabled`, `loading` and `success` belong to the button without `href`. `role="button"` and `tabindex="0"` count as the kit's and leave when `href` comes; any other role or tabindex is the host's and stays.

While `loading`, the button shows a spinner in place of its `start` content, hides its `end` content and ignores clicks; it keeps its focus. With `success`, it is filled with the success color and shows a check in place of its icons and its spinner. It is inactive, as after a payment, but keeps its focus and doesn't fade.

| Attribute | Type | Description |
| --- | --- | --- |
| disabled | boolean | Removes the button from the tab order and ignores clicks. |
| loading | boolean | Shows a spinner, marks the button busy and ignores clicks; the button stays in the tab order. |
| success | boolean | Fills the button with the success color, draws a check and makes the button inactive; it keeps its tab stop and isn't busy. |
| variant | string | Which palette of color the button takes its colors from: secondary, or a variant of the host's own; without it, the button's own. |
| appearance | filled, outline, plain | How the button is drawn; the variant's setting by default. |
| size | xsmall, small, medium, large, xlarge | How large the button is; medium by default. xsmall fits an action inside a status message. |
| shape | pill | Rounds the corners fully, in every variant, appearance and size, whatever the corner radius of the host's buttons. |
| href | string | Where the button leads; with it the element is a link, named by its own aria-label, or else by its content. |
| target | string | Where to open the link. |
| rel | string | How the link's target relates to the page. |
| type | submit, reset, button | What the button does in a form; submit by default. |

Properties and methods:

- `shake()`: Shakes the button, as after a failed attempt to submit; each call starts the shake again.
- `focus()`: Focuses the anchor with `href`, and the button itself without it.

| Slot | Description |
| --- | --- |
| (default) | The label of the button. |
| start | An icon before the label, drawn 4px larger than the text. |
| end | An icon after the label, drawn 4px larger than the text; it moves toward the end on hover. |

| State | Description |
| --- | --- |
| filled | The button is filled. |
| outline | The button has an outline. |
| plain | The button has neither a fill nor a border at rest; under the pointer it takes the quiet fill. |

### swell-link

A link. With `href`, its anchor lives in the shadow root and takes the focus for the element.

Without `href` the element itself is a button that looks like the link: it takes the button role and the tab stop, fires `click` on Enter and Space, and never submits a form. Its own `aria-label`, `aria-expanded` and `aria-controls` name and describe that button, so it can open a popover or a disclosure. `role="button"` and `tabindex="0"` count as the kit's and leave when `href` comes; any other role or tabindex is the host's and stays.

| Attribute | Type | Description |
| --- | --- | --- |
| href | string | Where the link goes; without it the element is a button. With it, the anchor is named by the element's own aria-label, as a link of an icon alone needs, or else by its content. |
| target | string | Where to open the link. |
| rel | string | How the target relates to the page. |
| variant | string | Which palette of color the link takes its color from: secondary, quiet text, or a variant of the host's own; without it, the link color. |
| appearance | underline, plain | How the link is drawn: underline, the default, in the font of the text around it; plain, for a link on its own, without an underline, in the text of a field hint, at least 24px high. Only the attribute sets it. |
| size | xsmall, small, medium, large, xlarge | How large a plain link is: its text is one step smaller than the text of the size, at least 12px; medium by default. A link in text takes the font around it. |

Properties and methods:

- `focus()`: Focuses the anchor with `href`, and the element itself without it.

| Slot | Description |
| --- | --- |
| (default) | The text of the link. |
| start | An icon before the text, 2px larger than it. |
| end | An icon after the text, 2px larger than it. |

| CSS part | Description |
| --- | --- |
| link | The anchor, or the content of the button without href. |

| State | Description |
| --- | --- |
| plain | The link is plain. |
| start-content | The link has content in its start slot. |
| end-content | The link has content in its end slot. |

## Fields

### swell-input

A text field: a native input with its label, hint and error, rendered into light DOM.

| Attribute | Type | Description |
| --- | --- | --- |
| label | string | The label of the field. |
| optional | string | A marker after the label, such as (optional), in the host's language; it joins the field's name. |
| hint | string | Help text under the field. |
| error | string | The error shown while the field is invalid. |
| invalid | boolean | Marks the field invalid and shows the error. |
| value | string | The default value. |
| type | text, email, tel, password, number, search, url | The kind of value; text by default. |
| appearance | outline, filled, underline | How the field is drawn; the configured setting by default. |
| size | xsmall, small, medium, large, xlarge | How large the field is; medium by default. At xsmall the label sits above the field. |
| disabled | boolean | Disables the field. |
| readonly | boolean | Makes the field read-only. |
| required | boolean | Makes the field required. |
| name | string | The name sent with the form. |
| placeholder | string | Text shown while the field is empty. |
| autocomplete | string | The autofill hint of the native input. |
| inputmode | string | The virtual keyboard to show. |
| minlength | number | The shortest allowed value. |
| maxlength | number | The longest allowed value. |
| pattern | string | The pattern the value matches. |
| min | string | The smallest allowed value. |
| max | string | The largest allowed value. |
| step | string | The step between allowed values. |

Properties and methods:

- `focus()`: Focuses the element.

| Event | Description |
| --- | --- |
| input | The value changes as the user types; it bubbles from the native input. |
| change | The user commits a new value; it bubbles from the native input. |

| Slot | Description |
| --- | --- |
| hint | Help content under the field in place of the hint text, such as "Did you mean <swell-link>gmail.com</swell-link>?"; it describes the input, and hiding it with hidden brings the hint text back. |
| start | Content before the text, such as an icon; an svg is drawn 4px larger than the text, in the quiet color. |
| end | Content after the text, such as a card logo, a check or a button; hide it with hidden, and disable a button in it along with the field. |

| CSS part | Description |
| --- | --- |
| frame | The box that draws the field around the native input, its start and its end. |
| start | The box of the start content. |
| end | The box of the end content. |

| State | Description |
| --- | --- |
| outline | The field has a border on all sides. |
| filled | The field has a fill and a bottom border. |
| underline | The field has a bottom border. |
| above | The label sits above the field. |
| floating | The label floats inside the field. |

### swell-textarea

A text field for several lines: a native textarea with its label, hint and error, rendered into light DOM. Enter adds a line; the field grows only when the user drags its corner.

| Attribute | Type | Description |
| --- | --- | --- |
| label | string | The label of the field. |
| optional | string | A marker after the label, such as (optional), in the host's language; it joins the field's name. |
| hint | string | Help text under the field. |
| error | string | The error shown while the field is invalid. |
| invalid | boolean | Marks the field invalid and shows the error. |
| value | string | The default value. |
| appearance | outline, filled, underline | How the field is drawn; the configured setting by default. |
| size | xsmall, small, medium, large, xlarge | How large the field is; medium by default. At xsmall the label sits above the field. |
| disabled | boolean | Disables the field. |
| readonly | boolean | Makes the field read-only. |
| required | boolean | Makes the field required. |
| name | string | The name sent with the form. |
| placeholder | string | Text shown while the field is empty. |
| autocomplete | string | The autofill hint of the native textarea. |
| minlength | number | The shortest allowed value. |
| maxlength | number | The longest allowed value. |
| rows | number | The visible lines; 2 by default. |

Properties and methods:

- `focus()`: Focuses the element.

| Event | Description |
| --- | --- |
| input | The value changes as the user types; it bubbles from the native textarea. |
| change | The user commits a new value; it bubbles from the native textarea. |

| Slot | Description |
| --- | --- |
| hint | Help content under the field in place of the hint text; it describes the textarea, and hiding it with hidden brings the hint text back. |

| CSS part | Description |
| --- | --- |
| frame | The box that draws the field around the native textarea. |

| State | Description |
| --- | --- |
| outline | The field has a border on all sides. |
| filled | The field has a fill and a bottom border. |
| underline | The field has a bottom border. |
| above | The label sits above the field. |
| floating | The label floats inside the field. |

### swell-select

A select: a field that opens a list of its `<swell-select-option>` children and shows the chosen one, with its start content; an svg there is drawn 4px larger than the text, in the quiet color. It holds the choice and takes part in its form. Typing goes to the option whose label starts with the typed text, as on a native select: keys typed within half a second, spaces included, form one search.

| Attribute | Type | Description |
| --- | --- | --- |
| label | string | The label of the field. Without it, the select takes its name from its own aria-label. |
| optional | string | A marker after the label, such as (optional), in the host's language; it joins the select's name. |
| hint | string | Help text under the field. |
| error | string | The error shown while the select is invalid. |
| invalid | boolean | Marks the select invalid and shows the error. |
| name | string | The name sent with the form. |
| value | string | The value of the option chosen by default. |
| placeholder | string | Text shown while nothing is chosen. |
| required | boolean | The form can't be sent until an option is chosen. |
| disabled | boolean | Disables the select. |
| autocomplete | string | The browser's autofill hint, such as country or address-level1, as on a native select: autofill picks the enabled option whose value or label matches the saved one, which counts as the user's choice and fires input and change. |
| aria-label |  | The element's accessible name, when it has no visible label. |
| appearance | outline, filled, underline | How the field is drawn; the configured setting by default. |
| size | xsmall, small, medium, large, xlarge | How large the field is; medium by default. At xsmall the label sits above the field. |

Properties and methods:

- `checkValidity()`: Checks the field's validity, as on a native field.
- `reportValidity()`: Checks the field's validity and shows its error, as on a native field.
- `focus()`: Focuses the element.

| Event | Description |
| --- | --- |
| input | The user chose another option. |
| change | The user chose another option, after input. |

| Slot | Description |
| --- | --- |
| (default) | The options, <swell-select-option> elements; a hidden one stays out of the list and the choice. |

| State | Description |
| --- | --- |
| outline | The field has a border on all sides. |
| filled | The field has a fill and a bottom border. |
| underline | The field has a bottom border. |
| above | The label sits above the field. |
| floating | The label floats inside the field. |
| empty | Nothing is chosen. |
| open | The list is open. |

#### swell-select-option

One option of a select. It lives only as a direct child of `<swell-select>`, which holds the choice.

| Attribute | Type | Description |
| --- | --- | --- |
| value | string | The value the select takes when the option is chosen; the option's label by default. |
| hint | string | A second line under the label. |
| disabled | boolean | Disables the option. |
| hidden |  |  |

Properties and methods:

- `selected`: Whether the option is chosen; the select sets it.
- `label`: The text of the option's label: its text and its elements outside a named slot, without the comments a framework leaves.

| Slot | Description |
| --- | --- |
| (default) | The label of the option. |
| start | Content before the label, such as an icon or an image; an svg is drawn 1px larger than the text, in the quiet color. |

| State | Description |
| --- | --- |
| selected | The option is chosen. |
| disabled | The option is disabled. |
| first | The option is the first one on show; it draws no divider above it. |

### swell-lookup

A text field with suggestions: a combobox in ARIA terms. The host loads the suggestions, such as addresses, and puts them into a `<swell-lookup-list>` child as `<swell-lookup-option>` elements; the field shows them under itself. It is a `<swell-input>` in everything else: its native input stays in light DOM, so autofill works as in any field.

The list opens while the user types and it has something to show, and closes on a choice, on Escape and when the focus leaves the field. Choosing a suggestion clicks it. After the click, unless a handler prevented its default, the field writes the suggestion's label into the input and fires `input`, with `inputType` `insertReplacementText`, and `change`; the list stays closed until the user types again.

| Attribute | Type | Description |
| --- | --- | --- |
| label | string | The label of the field. |
| optional | string | A marker after the label, such as (optional), in the host's language; it joins the field's name. |
| hint | string | Help text under the field. |
| error | string | The error shown while the field is invalid. |
| invalid | boolean | Marks the field invalid and shows the error. |
| value | string | The default value. |
| type | text, email, tel, password, number, search, url | The kind of value; text by default. |
| appearance | outline, filled, underline | How the field is drawn; the configured setting by default. |
| size | xsmall, small, medium, large, xlarge | How large the field is; medium by default. At xsmall the label sits above the field. |
| disabled | boolean | Disables the field. |
| readonly | boolean | Makes the field read-only. |
| required | boolean | Makes the field required. |
| name | string | The name sent with the form. |
| placeholder | string | Text shown while the field is empty. |
| autocomplete | string | The autofill hint of the native input. |
| inputmode | string | The virtual keyboard to show. |
| minlength | number | The shortest allowed value. |
| maxlength | number | The longest allowed value. |
| pattern | string | The pattern the value matches. |
| min | string | The smallest allowed value. |
| max | string | The largest allowed value. |
| step | string | The step between allowed values. |

Properties and methods:

- `focus()`: Focuses the element.

| Event | Description |
| --- | --- |
| input | The value changes as the user types; it bubbles from the native input. |
| change | The user commits a new value; it bubbles from the native input. |

| Slot | Description |
| --- | --- |
| (default) | The list of suggestions, a <swell-lookup-list>. While it is there, the input is a combobox and the list can open: keep it in the field, even empty, for as long as the field takes suggestions. |
| hint | Help content under the field in place of the hint text, as on an input. |
| action | A row at the end of the list, such as a <button type="button"> that opens a manual form; it shows with at least one suggestion, so it stays in the field, and a click on it closes the list. |
| start | Content before the text, such as an icon; an svg is drawn 4px larger than the text, in the quiet color. |
| end | Content after the text, such as a card logo, a check or a button; hide it with hidden, and disable a button in it along with the field. |

| CSS part | Description |
| --- | --- |
| list | The popup that holds the list and the action. |
| frame | The box that draws the field around the native input, its start and its end. |
| start | The box of the start content. |
| end | The box of the end content. |

| State | Description |
| --- | --- |
| outline | The field has a border on all sides. |
| filled | The field has a fill and a bottom border. |
| underline | The field has a bottom border. |
| above | The label sits above the field. |
| floating | The label floats inside the field. |

#### swell-lookup-list

The list of a lookup's suggestions. It lives only as a child of `<swell-lookup>`, which shows it under the field while it opens.

| Slot | Description |
| --- | --- |
| (default) | The suggestions, <swell-lookup-option> elements. |

#### swell-lookup-option

One suggestion of a lookup. It lives only as a child of `<swell-lookup-list>`. Choosing it clicks it: the host reads the option from the `click`. A click on a disabled suggestion reaches the host's handlers too, and the field ignores it.

| Attribute | Type | Description |
| --- | --- | --- |
| value | string | The value of the suggestion, such as the id of a place; the label by default. |
| hint | string | A second line under the label. |
| disabled | boolean | Disables the suggestion. |
| hidden |  |  |

Properties and methods:

- `selected`: Whether the option is chosen; the select sets it.
- `label`: The text of the option's label: its text and its elements outside a named slot, without the comments a framework leaves.

| Slot | Description |
| --- | --- |
| (default) | The label of the suggestion; the field writes its text into the input when it is chosen. |
| start | Content before the label, such as an icon. |

| State | Description |
| --- | --- |
| focused | The field's keyboard points at the suggestion. |
| disabled | The suggestion is disabled. |
| first | The option is the first one on show; it draws no divider above it. |

### swell-checkbox

A checkbox: a native checkbox with its label, hint and error, rendered into light DOM.

| Attribute | Type | Description |
| --- | --- | --- |
| label | string | The label beside the box. |
| hint | string | Help text under the checkbox. |
| error | string | The error shown while the checkbox is invalid. |
| invalid | boolean | Marks the checkbox invalid and shows the error. |
| checked | boolean | The default state. |
| value | string | The value sent with the form; on by default. |
| disabled | boolean | Disables the checkbox. |
| required | boolean | Makes the checkbox required. |
| name | string | The name sent with the form. |
| size | xsmall, small, medium, large, xlarge | How large the checkbox is: the label takes the text of the size and the box grows with it; medium by default. The target stays at least 24px. |

Properties and methods:

- `focus()`: Focuses the element.

| Event | Description |
| --- | --- |
| change | The user checks or unchecks the box; it bubbles from the native input. |

### swell-radio

A radio group: a question with one answer, chosen from its `<swell-radio-option>` children. It holds the choice and takes part in its form.

| Attribute | Type | Description |
| --- | --- | --- |
| label | string | The question. Without it, the group takes its name from its own aria-label. |
| hint | string | Help text under the options. |
| error | string | The error shown while the group is invalid. |
| invalid | boolean | Marks the group invalid and shows the error. |
| name | string | The name sent with the form. |
| value | string | The value of the option chosen by default. |
| required | boolean | The form can't be sent until an option is chosen. |
| disabled | boolean | Disables every option. |
| aria-label |  | The element's accessible name, when it has no visible label. |
| indicator-position | start, end | Where the circle sits in the row of each option; the radio.indicator.position setting gives the default. A segmented group draws no circle. |
| size | xsmall, small, medium, large, xlarge | How large the options are: their text, circle and padding follow the text of the size, and a segmented track takes the height of a control; medium by default. |
| appearance | plain, outline, segmented, button | How the options are drawn: the circle and the label, each option in a frame, the options sharing a track like a switch, or each option as a button in equal columns. segmented suits two or three short options, button short options such as languages or sizes; both are set with this attribute only. The radio.appearance setting gives the default. |

Properties and methods:

- `checkValidity()`: Checks the field's validity, as on a native field.
- `reportValidity()`: Checks the field's validity and shows its error, as on a native field.
- `focus()`: Focuses the group's Tab stop, as a Tab into the group does.

| Event | Description |
| --- | --- |
| input | The user chose another option. |
| change | The user chose another option, after input. Events of fields in the options' details bubble through the group too: the group's own have it as their target. |

| Slot | Description |
| --- | --- |
| (default) | The options, <swell-radio-option> elements. |

| State | Description |
| --- | --- |
| plain | The options are drawn plain. |
| outline | Each option is drawn in a frame. |
| segmented | The options share a track. |
| button | Each option is drawn as a button. |

#### swell-radio-option

One option of a radio group. It lives only as a direct child of `<swell-radio>`, which holds the choice. In a segmented group and as a button an option shows its `start` and its label; its hint, `end` and `details` are not drawn. An option with the `hidden` attribute is left out of its group.

| Attribute | Type | Description |
| --- | --- | --- |
| value | string | The value the group takes when the option is chosen; on by default. |
| hint | string | Help text under the label. |
| disabled | boolean | Disables the option. |
| hidden |  |  |

Properties and methods:

- `checked`: Whether the option is chosen; the group sets it.

| Slot | Description |
| --- | --- |
| (default) | The label of the option. |
| start | Content before the label, such as an icon or a logo; decoration, left out of the option's name. |
| end | Content at the end of the row, such as a price or logos. |
| details | Content shown while the option is chosen, such as card fields. While hidden it stays in the page and in the form: render it only while the option is chosen, or disable its fields. |

| State | Description |
| --- | --- |
| plain | The group draws its options plain: the circle and the label. |
| outline | The group draws each option in a frame. |
| segmented | The group draws its options as segments of one track. |
| button | The group draws each option as a button. |
| start | The circle sits at the start of the row. |
| end | The circle sits at the end of the row. |
| checked | The option is chosen. |
| disabled | The option or its group is disabled. |
| invalid | The group is invalid. |
| start-content | The option has content in its start slot. |
| details | The option has content in its details slot. |
| focused | The option's radio has the keyboard focus. |

### swell-quantity

A quantity: a count the shopper changes with − and +, such as the quantity of a cart line or of a product before it goes into the cart. It is a spinbutton with one tab stop: the up and down arrows change the count by `step`, and Home and End move it to `min` and `max`. Name it with `aria-label`, such as `Quantity, House Blend`, or with `aria-labelledby`. It holds the count and takes part in its form. While the cart updates, set `busy` rather than `disabled`: a disabled quantity leaves the tab order, so disabling the focused one drops the focus to the page.

| Attribute | Type | Description |
| --- | --- | --- |
| value | number | The starting count, a whole number; min by default. A count outside the limits is clamped, and a count the user or a script set stays at the limit that clamped it. |
| min | number | The least count, a whole number; 1 by default. |
| max | number | The greatest count, a whole number; no limit by default. A max below min counts as min. |
| step | number | How much each step changes the count, a whole number above 0; 1 by default. |
| disabled | boolean | Removes the quantity from the tab order and ignores steps. |
| busy | boolean | The quantity waits, such as while the cart updates: it keeps the focus, its count and its tab stop, ignores steps, fades and tells screen readers it is busy; a script can still set its count. |
| name | string | The name sent with the form. |
| size | xsmall, small, medium, large, xlarge | How large the quantity is: it shares a height with buttons and fields of its size; medium by default. A cart line takes xsmall. |

| Event | Description |
| --- | --- |
| input | The user changed the count. |
| change | The user changed the count, after input. |

### swell-chip

A chip: a short value the shopper can remove, such as an applied discount code or gift card. Its remove button fires `remove`; the host removes the chip and moves the focus, for example to the code field. A disabled chip, by its own attribute or a disabled fieldset around it, keeps its value legible and fades its remove button, which takes neither the focus nor presses, so a host can lock a form while it is sent.

| Attribute | Type | Description |
| --- | --- | --- |
| disabled | boolean | Disables the remove button. |
| remove-label | string | The name of the remove button in the host's language, such as Remove WELCOME10; every chip needs one. |
| size | xsmall, small, medium, large, xlarge | How large the chip is; medium by default. Its remove button is as high as the chip, at least 24px. |

Properties and methods:

- `focus()`: Focuses the remove button, the chip's only stop, so a host can hand the focus to a chip; a click on the text leaves the focus alone.

| Event | Description |
| --- | --- |
| remove | The shopper pressed the remove button; it bubbles, and the chip stays in the page. A disabled chip fires none. |

| Slot | Description |
| --- | --- |
| (default) | The value. |
| start | An icon before the value, drawn 2px larger than the text. |

| CSS part | Description |
| --- | --- |
| remove | The remove button. |

## Tabs and overlays

### swell-tabs

Tabs: a set of `<swell-tab>` children, one of them chosen, with its content shown. The group draws a tab list: a tab per child, named by its label. The arrows move between the tabs and Home and End to the ends; underlined and segmented tabs are chosen as the focus moves, steps with Enter or Space. Vertical steps draw no tab list: each step is a heading with a button that opens it, and Tab moves between the buttons.

| Attribute | Type | Description |
| --- | --- | --- |
| value | string | The value of the chosen tab; the first tab that isn't disabled by default. |
| aria-label |  | The element's accessible name, when it has no visible label. |
| orientation | horizontal, vertical | How steps line up: in a row above the chosen step's content, by default, or one under another, each a heading with its content under it. Other appearances stay in a row. |
| level | number | The heading level of vertical steps, 1 to 6; 2 by default. |
| done-label | string | The word a screen reader hears after the label of a done step, in the host's language, such as Completed; the check shows it to the eye. |
| appearance | underline, segmented, steps | How the tabs are drawn: a line under the chosen tab, a track with a marker under it, or numbered steps joined by lines, each a check once done. steps is set with this attribute only; the tabs.appearance setting gives the default. |
| size | xsmall, small, medium, large, xlarge | How large the tabs are: they take the height and the text of a control of the size; medium by default. |

| Event | Description |
| --- | --- |
| change | The user chose another tab. A listener that cancels the click on a tab, also a framework's handler on the page, keeps the choice. |
| request | The user asks for another tab, by a press or an arrow, with its value in detail.value, before the group chooses it; it bubbles. Cancelling it keeps the choice. It fires for a disabled tab too, which stays unchosen, so a host can answer a press on a locked step, such as by checking the open one. |

| Slot | Description |
| --- | --- |
| (default) | The tabs, <swell-tab> elements. |

| State | Description |
| --- | --- |
| underline | A line marks the chosen tab. |
| segmented | The tabs share a track. |
| steps | The tabs are numbered steps. |
| vertical | The steps stand one under another. |

#### swell-tab

A tab of a `<swell-tabs>` group: its label and its content, shown while it is chosen. In a tab list the group draws the tab and the element is its panel, named by the label; `role="tabpanel"` and that name count as the kit's. A step of vertical steps draws its own heading at the group's level, holding a button that opens it, tells whether it is open and controls its content under the heading.

| Attribute | Type | Description |
| --- | --- | --- |
| value | string | The group's value while the tab is chosen; the label by default. |
| label | string | The text of the tab or of the step's heading. |
| done | boolean | Marks a step as done: its number becomes a check, and the line to the next step fills. |
| disabled | boolean | The tab can't be chosen, such as a step that isn't open yet. |
| hidden |  |  |

| Slot | Description |
| --- | --- |
| (default) | The content, shown while the tab is chosen. |
| summary | Vertical steps: content under the heading while the step is closed, such as what a done step holds or what a step that isn't open yet will ask. |
| end | Vertical steps: content beside the heading, such as a link that opens a done step or a note. |

| State | Description |
| --- | --- |
| selected | The tab is chosen. |
| vertical | The tab is a step of vertical steps. |
| last | The tab is the last of its group, so a vertical step draws no line to a next one. |

### swell-disclosure

A disclosure: content that stays hidden until the shopper presses its trigger, such as "Add apartment, suite, etc." and the field it reveals. The trigger opens it and leaves; the focus moves to the first control of the content. With `toggle`, such as a collapsible order summary, the trigger stays, closes the content too and tells whether it is open with `aria-expanded`; the focus stays on it. The host can also set `open` itself, for example from a checkbox, and remove it to close the content and bring the trigger back; without a trigger, the host moves the focus out first. Closed content stays in the page and in the form: render it only while open, or disable its fields, so a required field doesn't block the submit.

| Attribute | Type | Description |
| --- | --- | --- |
| open | boolean | Shows the content and hides the trigger. Set on connect, the content shows at once. |
| toggle | boolean | Keeps the trigger while the content is open: it closes the content too and carries aria-expanded. |

| Event | Description |
| --- | --- |
| toggle | The content opened or closed: by the trigger or by script, also as it starts open. A ToggleEvent with oldState and newState, fired once the script that changed open has run; it doesn't bubble and can't be cancelled. |

| Slot | Description |
| --- | --- |
| trigger | The host's button that opens the content, such as <swell-link appearance="plain">; a button, not a link with href. Inside a form a <button> or a <swell-button> needs type="button". A listener that cancels the press, also a framework's handler on the page, keeps the content closed. |
| (default) | The content. |

| CSS part | Description |
| --- | --- |
| content | The box that expands to show the content. |

| State | Description |
| --- | --- |
| closing | The content collapses; the trigger is back, out of the flow and invisible until it ends. |

### swell-popover

A popover: a small dialog that floats at the host's trigger, such as the language and currency picker of a checkout. The trigger opens and closes it; opened by the trigger, it moves the focus to its first control. Escape closes it and gives the focus back to the trigger; a press outside it and the focus leaving it close it too. A choice inside keeps it open. The panel sits under the trigger, or above it when there is more room there, at the trigger's start edge, or at its end edge when it would leave the window there. Its content sets its width, at least the trigger's and at most the window's less 16px. Name it with `aria-label`, such as `Language and currency`.

| Attribute | Type | Description |
| --- | --- | --- |
| open | boolean | The panel is open. Set it to open the panel without moving the focus; remove it to close the panel, which gives the focus back to the trigger when the focus is inside. |
| aria-label |  | The element's accessible name, when it has no visible label. |

| Event | Description |
| --- | --- |
| toggle | The panel opened or closed: by the trigger, Escape, a press outside, the focus leaving it or script, also as it starts open or leaves the page open. A ToggleEvent with oldState and newState, fired once the script that changed open has run; it doesn't bubble and can't be cancelled. |

| Slot | Description |
| --- | --- |
| trigger | The host's button that opens and closes the panel: a <button> or a <swell-button>, with type="button" inside a form, or a <swell-link> without href. The popover sets its aria-expanded. A listener that cancels the press, also a framework's handler on the page, keeps the panel closed. |
| (default) | The content of the panel. |

| CSS part | Description |
| --- | --- |
| panel | The floating panel. |

## Areas

### swell-ui

An area of the page with token values of its own, such as an order summary in the colors of the brand. The host registers the area's configuration with `configure(config, id)`; its tokens and theme apply to everything inside the element, the host's own markup included, and every value it leaves out comes from the page. The element keeps the layout of its content: it renders nothing of its own.

| Attribute | Type | Description |
| --- | --- | --- |
| config | string | The id of the area's configuration. An id without a configuration yet applies once the host registers one. |
