`
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :------- |
+| -- | Yes | -- | -- |
-### Forwarded events
+### Events
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
-### Dispatched events
-
-No dispatched events.
-
----
-
-## AccordionItem
-
-### Import path
-
-```js
-import { AccordionItem } from "carbon-components-svelte";
-```
+## `AccordionItem`
### Props
-| Prop name | Type | Default value | Description |
-| :-------------- | :------------------- | :------------------ | :----------------------------------------------------------------------------------------------------------------------------------------- |
-| title | string | `"title"` | Specify the title of the accordion item heading. Alternatively, use the named slot "title" (e.g. <div slot="title">...</div>). |
-| open | boolean | `false` | Set to `true` to open the first accordion item. |
-| disabled | boolean | `false` | Set to `true` to disable the accordion item. |
-| iconDescription | string | `"Expand/Collapse"` | Specify the ARIA label for the accordion item chevron icon. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------------- | :--------------- | :------- | :------------------- | ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------- |
+| disabled | let | Yes | boolean | false | Set to `true` to disable the accordion item |
+| open | let | Yes | boolean | false | Set to `true` to open the first accordion item |
+| title | let | No | string | "title" | Specify the title of the accordion item heading Alternatively, use the named slot "title" (e.g. <div slot="title">...</div>) |
+| iconDescription | let | No | string | "Expand/Collapse" | Specify the ARIA label for the accordion item chevron icon |
### Slots
-- **default**: `
...
`
-- **"title"**: `
...
`
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :------------------- |
+| -- | Yes | -- | -- |
+| title | No | -- | {title} |
-### Forwarded events
+### Events
-- `on:animationend`
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
-- `on:keydown`
+| Event name | Type | Detail |
+| :----------- | :-------- | :----- |
+| animationend | forwarded | -- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
+| keydown | forwarded | -- |
-### Dispatched events
-
-No dispatched events.
-
----
-
-## AccordionSkeleton
-
-### Import path
-
-```js
-import { AccordionSkeleton } from "carbon-components-svelte";
-```
+## `AccordionSkeleton`
### Props
-| Prop name | Type | Default value | Description |
-| :-------- | :-------------------------------- | :------------ | :------------------------------------------------ |
-| count | number | `4` | Specify the number of accordion items to render. |
-| align | "start" | "end" | `"end"` | Specify alignment of accordion item chevron icon. |
-| size | "sm" | "xl" | -- | Specify the size of the accordion. |
-| open | boolean | `true` | Set to `false` to close the first accordion item. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------- | :--------------- | :------- | :-------------------------------- | ------------------ | ------------------------------------------------ |
+| count | let | No | number | 4 | Specify the number of accordion items to render |
+| align | let | No | "start" | "end" | "end" | Specify alignment of accordion item chevron icon |
+| size | let | No | "sm" | "xl" | -- | Specify the size of the accordion |
+| open | let | No | boolean | true | Set to `false` to close the first accordion item |
### Slots
-No slots.
+None.
-### Forwarded events
+### Events
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
-### Dispatched events
-
-No dispatched events.
-
----
-
-## AspectRatio
-
-### Import path
-
-```js
-import { AspectRatio } from "carbon-components-svelte";
-```
+## `AspectRatio`
### Props
-| Prop name | Type | Default value | Description |
-| :-------- | :------------------------------------------------------------------------------------------------- | :------------ | :------------------------ |
-| ratio | "2x1" | "16x9" | "4x3" | "1x1" | "3x4" | "9x16" | "1x2" | `"2x1"` | Specify the aspect ratio. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------- | :--------------- | :------- | :------------------------------------------------------------------------------------------------- | ------------------ | ------------------------ |
+| ratio | let | No | "2x1" | "16x9" | "4x3" | "1x1" | "3x4" | "9x16" | "1x2" | "2x1" | Specify the aspect ratio |
### Slots
-- **default**: `
...
`
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :------- |
+| -- | Yes | -- | -- |
-### Forwarded events
+### Events
-No forwarded events.
+None.
-### Dispatched events
-
-No dispatched events.
-
----
-
-## Breadcrumb
-
-### Import path
-
-```js
-import { Breadcrumb } from "carbon-components-svelte";
-```
+## `Breadcrumb`
### Props
-| Prop name | Type | Default value | Description |
-| :-------------- | :------------------- | :------------ | :--------------------------------------------------- |
-| noTrailingSlash | boolean | `false` | Set to `true` to hide the breadcrumb trailing slash. |
-| skeleton | boolean | `false` | Set to `true` to display skeleton state. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------------- | :--------------- | :------- | :------------------- | ------------------ | --------------------------------------------------- |
+| noTrailingSlash | let | No | boolean | false | Set to `true` to hide the breadcrumb trailing slash |
+| skeleton | let | No | boolean | false | Set to `true` to display skeleton state |
### Slots
-- **default**: `
...
`
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :------- |
+| -- | Yes | -- | -- |
-### Forwarded events
+### Events
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
-### Dispatched events
-
-No dispatched events.
-
----
-
-## BreadcrumbItem
-
-### Import path
-
-```js
-import { BreadcrumbItem } from "carbon-components-svelte";
-```
+## `BreadcrumbItem`
### Props
-| Prop name | Type | Default value | Description |
-| :------------ | :------------------- | :------------ | :---------------------------------------------------------------- |
-| href | string | -- | Set the `href` to use an anchor link. |
-| isCurrentPage | boolean | `false` | Set to `true` if the breadcrumb item represents the current page. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :------------ | :--------------- | :------- | :------------------- | ------------------ | ---------------------------------------------------------------- |
+| href | let | No | string | -- | Set the `href` to use an anchor link |
+| isCurrentPage | let | No | boolean | false | Set to `true` if the breadcrumb item represents the current page |
### Slots
-- **default**: `
...
`
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :------- |
+| -- | Yes | -- | -- |
-### Forwarded events
+### Events
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
-### Dispatched events
-
-No dispatched events.
-
----
-
-## BreadcrumbSkeleton
-
-### Import path
-
-```js
-import { BreadcrumbSkeleton } from "carbon-components-svelte";
-```
+## `BreadcrumbSkeleton`
### Props
-| Prop name | Type | Default value | Description |
-| :-------------- | :------------------- | :------------ | :--------------------------------------------------- |
-| noTrailingSlash | boolean | `false` | Set to `true` to hide the breadcrumb trailing slash. |
-| count | number | `3` | Specify the number of breadcrumb items to render. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------------- | :--------------- | :------- | :------------------- | ------------------ | --------------------------------------------------- |
+| noTrailingSlash | let | No | boolean | false | Set to `true` to hide the breadcrumb trailing slash |
+| count | let | No | number | 3 | Specify the number of breadcrumb items to render |
### Slots
-No slots.
+None.
-### Forwarded events
+### Events
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
-### Dispatched events
-
-No dispatched events.
-
----
-
-## Button
-
-### Import path
-
-```js
-import { Button } from "carbon-components-svelte";
-```
+## `Button`
### Props
-| Prop name | Type | Default value | Description |
-| :--------------- | :---------------------------------------------------------------------------------------------------------------------------------------- | :------------ | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| kind | "primary" | "secondary" | "tertiary" | "ghost" | "danger" | "danger-tertiary" | "danger-ghost" | `"primary"` | Specify the kind of button. |
-| size | "default" | "field" | "small" | `"default"` | Specify the size of button. |
-| hasIconOnly | boolean | `false` | Set to `true` for the icon-only variant. |
-| icon | typeof import("carbon-icons-svelte/lib/Add16").default | -- | Specify the icon from `carbon-icons-svelte` to render. |
-| iconDescription | string | -- | Specify the ARIA label for the button icon. |
-| tooltipAlignment | "start" | "center" | "end" | -- | Set the alignment of the tooltip relative to the icon. `hasIconOnly` must be set to `true`. |
-| tooltipPosition | "top" | "right" | "bottom" | "left" | -- | Set the position of the tooltip relative to the icon. |
-| as | boolean | `false` | Set to `true` to render a custom HTML element. Props are destructured as `props` in the default slot (e.g. <Button let:props><div {...props}>...</div></Button>). |
-| skeleton | boolean | `false` | Set to `true` to display the skeleton state. |
-| disabled | boolean | `false` | Set to `true` to disable the button. |
-| href | string | -- | Set the `href` to use an anchor link. |
-| tabindex | string | `"0"` | Specify the tabindex. |
-| type | string | `"button"` | Specify the `type` attribute for the button element. |
-| ref | null | HTMLAnchorElement | HTMLButtonElement | `null` | Obtain a reference to the HTML element. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :--------------- | :--------------- | :------- | :---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| ref | let | Yes | null | HTMLAnchorElement | HTMLButtonElement | null | Obtain a reference to the HTML element |
+| kind | let | No | "primary" | "secondary" | "tertiary" | "ghost" | "danger" | "danger-tertiary" | "danger-ghost" | "primary" | Specify the kind of button |
+| size | let | No | "default" | "field" | "small" | "default" | Specify the size of button |
+| hasIconOnly | let | No | boolean | false | Set to `true` for the icon-only variant |
+| icon | let | No | typeof import("carbon-icons-svelte").CarbonIcon | -- | Specify the icon from `carbon-icons-svelte` to render |
+| iconDescription | let | No | string | -- | Specify the ARIA label for the button icon |
+| tooltipAlignment | let | No | "start" | "center" | "end" | -- | Set the alignment of the tooltip relative to the icon `hasIconOnly` must be set to `true` |
+| tooltipPosition | let | No | "top" | "right" | "bottom" | "left" | -- | Set the position of the tooltip relative to the icon |
+| as | let | No | boolean | false | Set to `true` to render a custom HTML element Props are destructured as `props` in the default slot (e.g. <Button let:props><div {...props}>...</div></Button>) |
+| skeleton | let | No | boolean | false | Set to `true` to display the skeleton state |
+| disabled | let | No | boolean | false | Set to `true` to disable the button |
+| href | let | No | string | -- | Set the `href` to use an anchor link |
+| tabindex | let | No | string | "0" | Specify the tabindex |
+| type | let | No | string | "button" | Specify the `type` attribute for the button element |
### Slots
-- **default**: `
`
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :------- |
+| -- | Yes | -- | -- |
-### Forwarded events
+### Events
-No forwarded events.
+None.
-### Dispatched events
-
-No dispatched events.
-
----
-
-## ButtonSkeleton
-
-### Import path
-
-```js
-import { ButtonSkeleton } from "carbon-components-svelte";
-```
+## `ButtonSkeleton`
### Props
-| Prop name | Type | Default value | Description |
-| :-------- | :--------------------------------------------------- | :------------ | :-------------------------------------- |
-| href | string | -- | Set the `href` to use an anchor link. |
-| size | "default" | "field" | "small" | `"default"` | Specify the size of button skeleton. |
-| small | boolean | `false` | Set to `true` to use the small variant. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------- | :--------------- | :------- | :--------------------------------------------------- | ---------------------- | -------------------------------------- |
+| href | let | No | string | -- | Set the `href` to use an anchor link |
+| size | let | No | "default" | "field" | "small" | "default" | Specify the size of button skeleton |
+| small | let | No | boolean | false | Set to `true` to use the small variant |
### Slots
-No slots.
+None.
-### Forwarded events
+### Events
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
-### Dispatched events
-
-No dispatched events.
-
----
-
-## Checkbox
-
-### Import path
-
-```js
-import { Checkbox } from "carbon-components-svelte";
-```
+## `Checkbox`
### Props
-| Prop name | Type | Default value | Description |
-| :------------ | :---------------------------------------- | :------------ | :------------------------------------------------- |
-| checked | boolean | `false` | Specify whether the checkbox is checked. |
-| indeterminate | boolean | `false` | Specify whether the checkbox is indeterminate. |
-| skeleton | boolean | `false` | Set to `true` to display the skeleton state. |
-| readonly | boolean | `false` | Set to `true` for the checkbox to be read-only. |
-| disabled | boolean | `false` | Set to `true` to disable the checkbox. |
-| labelText | string | `""` | Specify the label text. |
-| hideLabel | boolean | `false` | Set to `true` to visually hide the label text. |
-| name | string | `""` | Set a name for the input element. |
-| title | string | -- | Specify the title attribute for the label element. |
-| id | string | -- | Set an id for the input label. |
-| ref | null | HTMLInputElement | `null` | Obtain a reference to the input HTML element. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :------------ | :--------------- | :------- | :---------------------------------------- | ------------------------------------------------ | ------------------------------------------------- |
+| ref | let | Yes | null | HTMLInputElement | null | Obtain a reference to the input HTML element |
+| checked | let | Yes | boolean | false | Specify whether the checkbox is checked |
+| indeterminate | let | No | boolean | false | Specify whether the checkbox is indeterminate |
+| skeleton | let | No | boolean | false | Set to `true` to display the skeleton state |
+| readonly | let | No | boolean | false | Set to `true` for the checkbox to be read-only |
+| disabled | let | No | boolean | false | Set to `true` to disable the checkbox |
+| labelText | let | No | string | "" | Specify the label text |
+| hideLabel | let | No | boolean | false | Set to `true` to visually hide the label text |
+| name | let | No | string | "" | Set a name for the input element |
+| title | let | No | string | -- | Specify the title attribute for the label element |
+| id | let | No | string | "ccs-" + Math.random().toString(36) | Set an id for the input label |
### Slots
-No slots.
+None.
-### Forwarded events
+### Events
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
-- `on:change`
+| Event name | Type | Detail |
+| :--------- | :--------- | :------------------- |
+| check | dispatched | boolean |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
+| change | forwarded | -- |
-### Dispatched events
-
-- `on:check`
-
----
-
-## CheckboxSkeleton
-
-### Import path
-
-```js
-import { CheckboxSkeleton } from "carbon-components-svelte";
-```
+## `CheckboxSkeleton`
### Props
-No exported props.
+None.
### Slots
-No slots.
+None.
-### Forwarded events
+### Events
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
-### Dispatched events
-
-No dispatched events.
-
----
-
-## ClickableTile
-
-### Import path
-
-```js
-import { ClickableTile } from "carbon-components-svelte";
-```
+## `ClickableTile`
### Props
-| Prop name | Type | Default value | Description |
-| :-------- | :------------------- | :------------ | :----------------------------------------- |
-| clicked | boolean | `false` | Set to `true` to click the tile. |
-| light | boolean | `false` | Set to `true` to enable the light variant. |
-| href | string | -- | Set the `href`. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------- | :--------------- | :------- | :------------------- | ------------------ | ----------------------------------------- |
+| clicked | let | Yes | boolean | false | Set to `true` to click the tile |
+| light | let | No | boolean | false | Set to `true` to enable the light variant |
+| href | let | No | string | -- | Set the `href` |
### Slots
-- **default**: `
...
`
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :------- |
+| -- | Yes | -- | -- |
-### Forwarded events
+### Events
-- `on:click`
-- `on:keydown`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+| keydown | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
-### Dispatched events
-
-No dispatched events.
-
----
-
-## CodeSnippet
-
-### Import path
-
-```js
-import { CodeSnippet } from "carbon-components-svelte";
-```
+## `CodeSnippet`
### Props
-| Prop name | Type | Default value | Description |
-| :-------------------- | :--------------------------------------------------- | :------------ | :--------------------------------------------------------------------------------------------------------------------- |
-| type | "single" | "inline" | "multi" | `"single"` | Set the type of code snippet. |
-| code | string | -- | Set the code snippet text. Alternatively, use the default slot (e.g. <CodeSnippet>{`code`}</CodeSnippet>). |
-| expanded | boolean | `false` | Set to `true` to expand a multi-line code snippet (type="multi"). |
-| hideCopyButton | boolean | `false` | Set to `true` to hide the copy button. |
-| wrapText | boolean | `false` | Set to `true` to wrap the text. Note that `type` must be "multi". |
-| light | boolean | `false` | Set to `true` to enable the light variant. |
-| skeleton | boolean | `false` | Set to `true` to display the skeleton state. |
-| copyButtonDescription | string | -- | Specify the ARIA label for the copy button icon. |
-| copyLabel | string | -- | Specify the ARIA label of the copy button. |
-| feedback | string | `"Copied!"` | Specify the feedback text displayed when clicking the snippet. |
-| feedbackTimeout | number | `2000` | Set the timeout duration (ms) to display feedback text. |
-| showLessText | string | `"Show less"` | Specify the show less text. `type` must be "multi". |
-| showMoreText | string | `"Show more"` | Specify the show more text. `type` must be "multi". |
-| showMoreLess | boolean | `false` | Set to `true` to enable the show more/less button. |
-| id | string | -- | Set an id for the code element. |
-| ref | null | HTMLPreElement | `null` | Obtain a reference to the pre HTML element. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------------------- | :--------------- | :------- | :--------------------------------------------------- | ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------- |
+| ref | let | Yes | null | HTMLPreElement | null | Obtain a reference to the pre HTML element |
+| showMoreLess | let | Yes | boolean | false | Set to `true` to enable the show more/less button |
+| expanded | let | Yes | boolean | false | Set to `true` to expand a multi-line code snippet (type="multi") |
+| type | let | No | "single" | "inline" | "multi" | "single" | Set the type of code snippet |
+| code | let | No | string | -- | Set the code snippet text Alternatively, use the default slot (e.g. <CodeSnippet>{`code`}</CodeSnippet>) |
+| hideCopyButton | let | No | boolean | false | Set to `true` to hide the copy button |
+| wrapText | let | No | boolean | false | Set to `true` to wrap the text Note that `type` must be "multi" |
+| light | let | No | boolean | false | Set to `true` to enable the light variant |
+| skeleton | let | No | boolean | false | Set to `true` to display the skeleton state |
+| copyButtonDescription | let | No | string | -- | Specify the ARIA label for the copy button icon |
+| copyLabel | let | No | string | -- | Specify the ARIA label of the copy button |
+| feedback | let | No | string | "Copied!" | Specify the feedback text displayed when clicking the snippet |
+| feedbackTimeout | let | No | number | 2000 | Set the timeout duration (ms) to display feedback text |
+| showLessText | let | No | string | "Show less" | Specify the show less text `type` must be "multi" |
+| showMoreText | let | No | string | "Show more" | Specify the show more text `type` must be "multi" |
+| id | let | No | string | "ccs-" + Math.random().toString(36) | Set an id for the code element |
### Slots
-- **default**: `
...
`
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :------------------ |
+| -- | Yes | -- | {code} |
-### Forwarded events
+### Events
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
-- `on:animationend`
+| Event name | Type | Detail |
+| :----------- | :-------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
+| animationend | forwarded | -- |
-### Dispatched events
-
-No dispatched events.
-
----
-
-## CodeSnippetSkeleton
-
-### Import path
-
-```js
-import { CodeSnippetSkeleton } from "carbon-components-svelte";
-```
+## `CodeSnippetSkeleton`
### Props
-| Prop name | Type | Default value | Description |
-| :-------- | :--------------------------------------------------- | :------------ | :---------------------------- |
-| type | "single" | "inline" | "multi" | `"single"` | Set the type of code snippet. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------- | :--------------- | :------- | :--------------------------------------------------- | --------------------- | ---------------------------- |
+| type | let | No | "single" | "inline" | "multi" | "single" | Set the type of code snippet |
### Slots
-No slots.
+None.
-### Forwarded events
+### Events
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
-### Dispatched events
+## `Column`
-No dispatched events.
-
----
-
-## Column
-
-### Import path
-
-```js
-import { Column } from "carbon-components-svelte";
-```
-
-### Props
+### Types
```ts
-// `Column` type definitions
-
type ColumnSize = boolean | number;
interface ColumnSizeDescriptor {
@@ -732,469 +558,398 @@ interface ColumnSizeDescriptor {
type ColumnBreakpoint = ColumnSize | ColumnSizeDescriptor;
```
-| Prop name | Type | Default value | Description |
-| :------------ | :------------------------------------------------------------------------------------------------- | :------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| as | boolean | `false` | Set to `true` to render a custom HTML element. Props are destructured as `props` in the default slot (e.g. <Column let:props><article {...props}>...</article></Column>). |
-| noGutter | boolean | `false` | Set to `true` to remove the gutter. |
-| noGutterLeft | boolean | `false` | Set to `true` to remove the left gutter. |
-| noGutterRight | boolean | `false` | Set to `true` to remove the right gutter. |
-| aspectRatio | "2x1" | "16x9" | "9x16" | "1x2" | "4x3" | "3x4" | "1x1" | -- | Specify the aspect ratio of the column. |
-| sm | ColumnBreakpoint | -- | Set the small breakpoint. |
-| md | ColumnBreakpoint | -- | Set the medium breakpoint. |
-| lg | ColumnBreakpoint | -- | Set the large breakpoint. |
-| xlg | ColumnBreakpoint | -- | Set the extra large breakpoint. |
-| max | ColumnBreakpoint | -- | Set the maximum breakpoint. |
+### Props
+
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :------------ | :--------------- | :------- | :------------------------------------------------------------------------------------------------- | ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| as | let | No | boolean | false | Set to `true` to render a custom HTML element Props are destructured as `props` in the default slot (e.g. <Column let:props><article {...props}>...</article></Column>) |
+| noGutter | let | No | boolean | false | Set to `true` to remove the gutter |
+| noGutterLeft | let | No | boolean | false | Set to `true` to remove the left gutter |
+| noGutterRight | let | No | boolean | false | Set to `true` to remove the right gutter |
+| aspectRatio | let | No | "2x1" | "16x9" | "9x16" | "1x2" | "4x3" | "3x4" | "1x1" | -- | Specify the aspect ratio of the column |
+| sm | let | No | ColumnBreakpoint | -- | Set the small breakpoint |
+| md | let | No | ColumnBreakpoint | -- | Set the medium breakpoint |
+| lg | let | No | ColumnBreakpoint | -- | Set the large breakpoint |
+| xlg | let | No | ColumnBreakpoint | -- | Set the extra large breakpoint |
+| max | let | No | ColumnBreakpoint | -- | Set the maximum breakpoint |
### Slots
-- **default**: `
...
`
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :------------------------------------------------------------ | :------- |
+| -- | Yes | {props: { class: string; [key: string]: any; }} | -- |
-### Forwarded events
+### Events
-No forwarded events.
+None.
-### Dispatched events
+## `ComboBox`
-No dispatched events.
-
----
-
-## ComboBox
-
-### Import path
-
-```js
-import { ComboBox } from "carbon-components-svelte";
-```
-
-### Props
+### Types
```ts
-// `ComboBox` type definitions
-
interface ComboBoxItem {
id: string;
text: string;
}
```
-| Prop name | Type | Default value | Description |
-| :--------------- | :---------------------------------------------------------- | :------------ | :------------------------------------------------------------------------ |
-| items | ComboBoxItem[] | `[]` | Set the combobox items. |
-| itemToString | (item: ComboBoxItem) => string | -- | Override the display of a combobox item. |
-| selectedIndex | number | -- | Set the selected item by value index. |
-| value | string | `""` | Specify the selected combobox value. |
-| size | "sm" | "xl" | -- | Set the size of the combobox. |
-| disabled | boolean | `false` | Set to `true` to disable the combobox. |
-| titleText | string | `""` | Specify the title text of the combobox. |
-| placeholder | string | `""` | Specify the placeholder text. |
-| helperText | string | `""` | Specify the helper text. |
-| invalidText | string | `""` | Specify the invalid state text. |
-| invalid | boolean | `false` | Set to `true` to indicate an invalid state. |
-| light | boolean | `false` | Set to `true` to enable the light variant. |
-| open | boolean | `false` | Set to `true` to open the combobox menu dropdown. |
-| shouldFilterItem | (item: ComboBoxItem, value: string) => boolean | -- | Determine if an item should be filtered given the current combobox value. |
-| translateWithId | (id: any) => string | -- | Override the default translation ids. |
-| id | string | -- | Set an id for the list box component. |
-| name | string | -- | Specify a name attribute for the input. |
-| ref | null | HTMLInputElement | `null` | Obtain a reference to the input HTML element. |
-| listRef | null | HTMLDivElement | `null` | Obtain a reference to the list HTML element. |
+### Props
+
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :--------------- | :--------------- | :------- | :---------------------------------------------------------- | ----------------------------------------------------- | ------------------------------------------------------------------------ |
+| listRef | let | Yes | null | HTMLDivElement | null | Obtain a reference to the list HTML element |
+| ref | let | Yes | null | HTMLInputElement | null | Obtain a reference to the input HTML element |
+| open | let | Yes | boolean | false | Set to `true` to open the combobox menu dropdown |
+| value | let | Yes | string | "" | Specify the selected combobox value |
+| selectedIndex | let | Yes | number | -1 | Set the selected item by value index |
+| items | let | No | ComboBoxItem[] | [] | Set the combobox items |
+| itemToString | let | No | (item: ComboBoxItem) => string | (item) => item.text || item.id | Override the display of a combobox item |
+| size | let | No | "sm" | "xl" | -- | Set the size of the combobox |
+| disabled | let | No | boolean | false | Set to `true` to disable the combobox |
+| titleText | let | No | string | "" | Specify the title text of the combobox |
+| placeholder | let | No | string | "" | Specify the placeholder text |
+| helperText | let | No | string | "" | Specify the helper text |
+| invalidText | let | No | string | "" | Specify the invalid state text |
+| invalid | let | No | boolean | false | Set to `true` to indicate an invalid state |
+| light | let | No | boolean | false | Set to `true` to enable the light variant |
+| shouldFilterItem | let | No | (item: ComboBoxItem, value: string) => boolean | () => true | Determine if an item should be filtered given the current combobox value |
+| translateWithId | let | No | (id: any) => string | -- | Override the default translation ids |
+| id | let | No | string | "ccs-" + Math.random().toString(36) | Set an id for the list box component |
+| name | let | No | string | -- | Specify a name attribute for the input |
### Slots
-No slots.
+None.
-### Forwarded events
+### Events
-- `on:keydown`
-- `on:focus`
-- `on:blur`
-- `on:clear`
-- `on:scroll`
+| Event name | Type | Detail |
+| :--------- | :--------- | :------------------------------------------------------------------------------------- |
+| select | dispatched | { selectedId: string; selectedIndex: number; selectedItem: ComboBoxItem } |
+| keydown | forwarded | -- |
+| focus | forwarded | -- |
+| blur | forwarded | -- |
+| clear | forwarded | -- |
+| scroll | forwarded | -- |
-### Dispatched events
-
-- `on:select`
-
----
-
-## ComposedModal
-
-### Import path
-
-```js
-import { ComposedModal } from "carbon-components-svelte";
-```
+## `ComposedModal`
### Props
-| Prop name | Type | Default value | Description |
-| :------------------------- | :---------------------------------------- | :----------------------------- | :--------------------------------------------------------------------- |
-| size | "xs" | "sm" | "lg" | -- | Set the size of the composed modal. |
-| open | boolean | `false` | Set to `true` to open the modal. |
-| danger | boolean | `false` | Set to `true` to use the danger variant. |
-| preventCloseOnClickOutside | boolean | `false` | Set to `true` to prevent the modal from closing when clicking outside. |
-| containerClass | string | `""` | Specify a class for the inner modal. |
-| selectorPrimaryFocus | string | `"[data-modal-primary-focus]"` | Specify a selector to be focused when opening the modal. |
-| ref | null | HTMLElement | `null` | Obtain a reference to the top-level HTML element. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :------------------------- | :--------------- | :------- | :---------------------------------------- | ----------------------------------------- | --------------------------------------------------------------------- |
+| ref | let | Yes | null | HTMLDivElement | null | Obtain a reference to the top-level HTML element |
+| open | let | Yes | boolean | false | Set to `true` to open the modal |
+| size | let | No | "xs" | "sm" | "lg" | -- | Set the size of the composed modal |
+| danger | let | No | boolean | false | Set to `true` to use the danger variant |
+| preventCloseOnClickOutside | let | No | boolean | false | Set to `true` to prevent the modal from closing when clicking outside |
+| containerClass | let | No | string | "" | Specify a class for the inner modal |
+| selectorPrimaryFocus | let | No | null | string | "[data-modal-primary-focus]" | Specify a selector to be focused when opening the modal |
### Slots
-- **default**: `
...
`
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :------- |
+| -- | Yes | -- | -- |
-### Forwarded events
+### Events
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
-- `on:transitionend`
+| Event name | Type | Detail |
+| :------------ | :--------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
+| transitionend | forwarded | -- |
+| submit | dispatched | -- |
+| close | dispatched | -- |
+| open | dispatched | -- |
-### Dispatched events
-
-- `on:submit`
-- `on:close`
-- `on:open`
-
----
-
-## Content
-
-### Import path
-
-```js
-import { Content } from "carbon-components-svelte";
-```
+## `Content`
### Props
-| Prop name | Type | Default value | Description |
-| :-------- | :------------------ | :--------------- | :----------------------------------- |
-| id | string | `"main-content"` | Specify the id for the main element. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------- | :--------------- | :------- | :------------------ | --------------------------- | ----------------------------------- |
+| id | let | No | string | "main-content" | Specify the id for the main element |
### Slots
-- **default**: `
...
`
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :------- |
+| -- | Yes | -- | -- |
-### Forwarded events
+### Events
-No forwarded events.
+None.
-### Dispatched events
-
-No dispatched events.
-
----
-
-## ContentSwitcher
-
-### Import path
-
-```js
-import { ContentSwitcher } from "carbon-components-svelte";
-```
+## `ContentSwitcher`
### Props
-| Prop name | Type | Default value | Description |
-| :------------ | :---------------------------- | :------------ | :----------------------------------------- |
-| selectedIndex | number | `0` | Set the selected index of the switch item. |
-| light | boolean | `false` | Set to `true` to enable the light variant. |
-| size | "sm" | "xl" | -- | Specify the size of the content switcher. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :------------ | :--------------- | :------- | :---------------------------- | ------------------ | ----------------------------------------- |
+| selectedIndex | let | Yes | number | 0 | Set the selected index of the switch item |
+| light | let | No | boolean | false | Set to `true` to enable the light variant |
+| size | let | No | "sm" | "xl" | -- | Specify the size of the content switcher |
### Slots
-- **default**: `
...
`
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :------- |
+| -- | Yes | -- | -- |
-### Forwarded events
+### Events
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
+| Event name | Type | Detail |
+| :--------- | :--------- | :------------------ |
+| change | dispatched | number |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
-### Dispatched events
-
-- `on:change`
-
----
-
-## Copy
-
-### Import path
-
-```js
-import { Copy } from "carbon-components-svelte";
-```
+## `Copy`
### Props
-| Prop name | Type | Default value | Description |
-| :-------------- | :----------------------------------------- | :------------ | :------------------------------------------------------ |
-| feedback | string | `"Copied!"` | Set the feedback text shown after clicking the button. |
-| feedbackTimeout | number | `2000` | Set the timeout duration (ms) to display feedback text. |
-| ref | null | HTMLButtonElement | `null` | Obtain a reference to the button HTML element. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------------- | :--------------- | :------- | :----------------------------------------- | ---------------------- | ------------------------------------------------------ |
+| ref | let | Yes | null | HTMLButtonElement | null | Obtain a reference to the button HTML element |
+| feedback | let | No | string | "Copied!" | Set the feedback text shown after clicking the button |
+| feedbackTimeout | let | No | number | 2000 | Set the timeout duration (ms) to display feedback text |
### Slots
-- **default**: `
...
`
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :----------------------------------------------------------------------------------- |
+| -- | Yes | -- | {#if animation}{feedback || \$\$restProps['aria-label']}{/if} |
-### Forwarded events
+### Events
-- `on:click`
-- `on:animationend`
+| Event name | Type | Detail |
+| :----------- | :-------- | :----- |
+| click | forwarded | -- |
+| animationend | forwarded | -- |
-### Dispatched events
-
-No dispatched events.
-
----
-
-## CopyButton
-
-### Import path
-
-```js
-import { CopyButton } from "carbon-components-svelte";
-```
+## `CopyButton`
### Props
-| Prop name | Type | Default value | Description |
-| :-------------- | :------------------ | :-------------------- | :------------------------------------------------ |
-| iconDescription | string | `"Copy to clipboard"` | Set the title and ARIA label for the copy button. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------------- | :--------------- | :------- | :------------------ | -------------------------------- | ------------------------------------------------ |
+| iconDescription | let | No | string | "Copy to clipboard" | Set the title and ARIA label for the copy button |
### Slots
-No slots.
+None.
-### Forwarded events
+### Events
-- `on:click`
-- `on:animationend`
+| Event name | Type | Detail |
+| :----------- | :-------- | :----- |
+| click | forwarded | -- |
+| animationend | forwarded | -- |
-### Dispatched events
+## `DataTable`
-No dispatched events.
-
----
-
-## DataTable
-
-### Import path
-
-```js
-import { DataTable } from "carbon-components-svelte";
-```
-
-### Props
-
-| Prop name | Type | Default value | Description |
-| :------------- | :----------------------------------------------------------------------------------------------------------------------------------------- | :------------ | :--------------------------------------------------------------------------------------------------------------- |
-| headers | { key: string; value: string; display?: (item) => string; sort?: (a, b) => number; empty?: boolean; columnMenu?: boolean; }[] | `[]` | Specify the data table headers. |
-| rows | Object[] | `[]` | Specify the rows the data table should render. keys defined in `headers` are used for the row ids. |
-| size | "compact" | "short" | "tall" | -- | Set the size of the data table. |
-| title | string | `""` | Specify the title of the data table. |
-| description | string | `""` | Specify the description of the data table. |
-| zebra | boolean | `false` | Set to `true` to use zebra styles. |
-| sortable | boolean | `false` | Set to `true` for the sortable variant. |
-| expandable | boolean | `false` | Set to `true` for the expandable variant. Automatically set to `true` if `batchExpansion` is `true`. |
-| batchExpansion | boolean | `false` | Set to `true` to enable batch expansion. |
-| expandedRowIds | string[] | `[]` | Specify the row ids to be expanded. |
-| radio | boolean | `false` | Set to `true` for the radio selection variant. |
-| selectable | boolean | `false` | Set to `true` for the selectable variant. Automatically set to `true` if `radio` or `batchSelection` are `true`. |
-| batchSelection | boolean | `false` | Set to `true` to enable batch selection. |
-| selectedRowIds | string[] | `[]` | Specify the row ids to be selected. |
-| stickyHeader | boolean | `false` | Set to `true` to enable a sticky header. |
-
-### Slots
-
-- **default**: `
...
`
-- **"cell-header"**: `
...
`
-- **"cell"**: `
...
`
-- **"expanded-row"**: `
...
`
-
-### Forwarded events
-
-No forwarded events.
-
-### Dispatched events
-
-- `on:click:header--expand`
-- `on:click`
-- `on:click:header`
-- `on:click:row`
-- `on:mouseenter:row`
-- `on:mouseleave:row`
-- `on:click:row--expand`
-- `on:click:cell`
-
----
-
-## DataTableSkeleton
-
-### Import path
-
-```js
-import { DataTableSkeleton } from "carbon-components-svelte";
-```
-
-### Props
-
-| Prop name | Type | Default value | Description |
-| :---------- | :-------------------------------------------------- | :------------ | :--------------------------------------------------------------------------- |
-| columns | number | `5` | Specify the number of columns. |
-| rows | number | `5` | Specify the number of rows. |
-| size | "compact" | "short" | "tall" | -- | Set the size of the data table. |
-| zebra | boolean | `false` | Set to `true` to apply zebra styles to the datatable rows. |
-| showHeader | boolean | `true` | Set to `false` to hide the header. |
-| headers | string[] | `[]` | Set the column headers. If `headers` has one more items, `count` is ignored. |
-| showToolbar | boolean | `true` | Set to `false` to hide the toolbar. |
-
-### Slots
-
-No slots.
-
-### Forwarded events
-
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
-
-### Dispatched events
-
-No dispatched events.
-
----
-
-## DatePicker
-
-### Import path
-
-```js
-import { DatePicker } from "carbon-components-svelte";
-```
-
-### Props
-
-| Prop name | Type | Default value | Description |
-| :------------- | :--------------------------------------------------- | :------------ | :--------------------------------------------- |
-| datePickerType | "simple" | "single" | "range" | `"simple"` | Specify the date picker type. |
-| value | string | `""` | Specify the date picker input value. |
-| appendTo | HTMLElement | -- | Specify the element to append the calendar to. |
-| dateFormat | string | `"m/d/Y"` | Specify the date format. |
-| maxDate | null | string | Date | `null` | Specify the maximum date. |
-| minDate | null | string | Date | `null` | Specify the minimum date. |
-| locale | string | `"en"` | Specify the locale. |
-| short | boolean | `false` | Set to `true` to use the short variant. |
-| light | boolean | `false` | Set to `true` to enable the light variant. |
-| id | string | -- | Set an id for the date picker element. |
-
-### Slots
-
-- **default**: `
...
`
-
-### Forwarded events
-
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
-
-### Dispatched events
-
-- `on:change`
-
----
-
-## DatePickerInput
-
-### Import path
-
-```js
-import { DatePickerInput } from "carbon-components-svelte";
-```
-
-### Props
-
-| Prop name | Type | Default value | Description |
-| :-------------- | :---------------------------------------- | :------------------------------- | :-------------------------------------------------- |
-| size | "sm" | "xl" | -- | Set the size of the input. |
-| type | string | `"text"` | Specify the input type. |
-| placeholder | string | `""` | Specify the input placeholder text. |
-| pattern | string | `"\\d{1,2}\\/\\d{1,2}\\/\\d{4}"` | Specify the Regular Expression for the input value. |
-| disabled | boolean | `false` | Set to `true` to disable the input. |
-| iconDescription | string | `""` | Specify the ARIA label for the calendar icon. |
-| id | string | -- | Set an id for the input element. |
-| labelText | string | `""` | Specify the label text. |
-| hideLabel | boolean | `false` | Set to `true` to visually hide the label text. |
-| invalid | boolean | `false` | Set to `true` to indicate an invalid state. |
-| invalidText | string | `""` | Specify the invalid state text. |
-| name | string | -- | Set a name for the input element. |
-| ref | null | HTMLInputElement | `null` | Obtain a reference to the input HTML element. |
-
-### Slots
-
-No slots.
-
-### Forwarded events
-
-- `on:input`
-- `on:keydown`
-- `on:blur`
-
-### Dispatched events
-
-No dispatched events.
-
----
-
-## DatePickerSkeleton
-
-### Import path
-
-```js
-import { DatePickerSkeleton } from "carbon-components-svelte";
-```
-
-### Props
-
-| Prop name | Type | Default value | Description |
-| :-------- | :------------------- | :------------ | :----------------------------------------- |
-| range | boolean | `false` | Set to `true` to use the range variant. |
-| id | string | -- | Set an id to be used by the label element. |
-
-### Slots
-
-No slots.
-
-### Forwarded events
-
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
-
-### Dispatched events
-
-No dispatched events.
-
----
-
-## Dropdown
-
-### Import path
-
-```js
-import { Dropdown } from "carbon-components-svelte";
-```
-
-### Props
+### Types
```ts
-// `Dropdown` type definitions
+type Key = string;
+type Value = any;
+
+interface EmptyHeader {
+ key: Key;
+ empty: boolean;
+ display?: (item: Value) => Value;
+ sort?: (a: Value, b: Value) => 0 | -1 | 1;
+ columnMenu?: boolean;
+}
+
+interface NonEmptyHeader {
+ key: Key;
+ value: Value;
+ display?: (item: Value) => Value;
+ sort?: (a: Value, b: Value) => 0 | -1 | 1;
+ columnMenu?: boolean;
+}
+
+type DataTableHeader = NonEmptyHeader | EmptyHeader;
+
+type Row = Record;
+
+type RowId = string;
+
+interface Cell {
+ key: Key;
+ value: Value;
+}
+```
+
+### Props
+
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :------------- | :--------------- | :------- | :-------------------------------------------------- | ------------------ | ------------------------------------------------------------------------------------------------------------------- |
+| selectedRowIds | let | Yes | RowId[] | [] | Specify the row ids to be selected |
+| selectable | let | Yes | boolean | false | Set to `true` for the selectable variant Automatically set to `true` if `radio` or `batchSelection` are `true` |
+| expandedRowIds | let | Yes | RowId[] | [] | Specify the row ids to be expanded |
+| expandable | let | Yes | boolean | false | Set to `true` for the expandable variant Automatically set to `true` if `batchExpansion` is `true` |
+| rows | let | Yes | Row[] | [] | Specify the rows the data table should render keys defined in `headers` are used for the row ids |
+| headers | let | No | DataTableHeader[] | [] | Specify the data table headers |
+| size | let | No | "compact" | "short" | "tall" | -- | Set the size of the data table |
+| title | let | No | string | "" | Specify the title of the data table |
+| description | let | No | string | "" | Specify the description of the data table |
+| zebra | let | No | boolean | false | Set to `true` to use zebra styles |
+| sortable | let | No | boolean | false | Set to `true` for the sortable variant |
+| batchExpansion | let | No | boolean | false | Set to `true` to enable batch expansion |
+| radio | let | No | boolean | false | Set to `true` for the radio selection variant |
+| batchSelection | let | No | boolean | false | Set to `true` to enable batch selection |
+| stickyHeader | let | No | boolean | false | Set to `true` to enable a sticky header |
+
+### Slots
+
+| Slot name | Default | Props | Fallback |
+| :----------- | :------ | :---------------------------------------- | :------------------------------------------------------------------------------ |
+| -- | Yes | -- | -- |
+| cell | No | { row: Row; cell: Cell; } | {headers[j].display ? headers[j].display(cell.value) : cell.value} |
+| cell-header | No | { header: NonEmptyHeader; } | {header.value} |
+| expanded-row | No | { row: Row; } | -- |
+
+### Events
+
+| Event name | Type | Detail |
+| :------------------- | :--------- | :----------------------------------------------------------------------------------------------------- |
+| click | dispatched | { header?: DataTableHeader; row?: Row; cell?: Cell; } |
+| click:header--expand | dispatched | { expanded: boolean; } |
+| click:header | dispatched | { header: DataTableHeader; sortDirection: "ascending" | "descending" | "none" } |
+| click:row | dispatched | Row |
+| mouseenter:row | dispatched | Row |
+| mouseleave:row | dispatched | Row |
+| click:row--expand | dispatched | { expanded: boolean; row: Row; } |
+| click:cell | dispatched | Cell |
+
+## `DataTableSkeleton`
+
+### Props
+
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :---------- | :--------------- | :------- | :-------------------------------------------------- | ------------------ | ------------------------------------------------------------------------------- |
+| columns | let | No | number | 5 | Specify the number of columns |
+| rows | let | No | number | 5 | Specify the number of rows |
+| size | let | No | "compact" | "short" | "tall" | -- | Set the size of the data table |
+| zebra | let | No | boolean | false | Set to `true` to apply zebra styles to the datatable rows |
+| showHeader | let | No | boolean | true | Set to `false` to hide the header |
+| headers | let | No | string[] | [] | Set the column headers If `headers` has one more items, `count` is ignored |
+| showToolbar | let | No | boolean | true | Set to `false` to hide the toolbar |
+
+### Slots
+
+None.
+
+### Events
+
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
+
+## `DatePicker`
+
+### Props
+
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :------------- | :--------------- | :------- | :--------------------------------------------------- | ------------------------------------------------ | --------------------------------------------- |
+| value | let | Yes | number | string | "" | Specify the date picker input value |
+| datePickerType | let | No | "simple" | "single" | "range" | "simple" | Specify the date picker type |
+| appendTo | let | No | HTMLElement | -- | Specify the element to append the calendar to |
+| dateFormat | let | No | string | "m/d/Y" | Specify the date format |
+| maxDate | let | No | null | string | Date | null | Specify the maximum date |
+| minDate | let | No | null | string | Date | null | Specify the minimum date |
+| locale | let | No | string | "en" | Specify the locale |
+| short | let | No | boolean | false | Set to `true` to use the short variant |
+| light | let | No | boolean | false | Set to `true` to enable the light variant |
+| id | let | No | string | "ccs-" + Math.random().toString(36) | Set an id for the date picker element |
+
+### Slots
+
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :------- |
+| -- | Yes | -- | -- |
+
+### Events
+
+| Event name | Type | Detail |
+| :--------- | :--------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
+| change | dispatched | -- |
+
+## `DatePickerInput`
+
+### Props
+
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------------- | :--------------- | :------- | :---------------------------------------- | ------------------------------------------------ | -------------------------------------------------- |
+| ref | let | Yes | null | HTMLInputElement | null | Obtain a reference to the input HTML element |
+| size | let | No | "sm" | "xl" | -- | Set the size of the input |
+| type | let | No | string | "text" | Specify the input type |
+| placeholder | let | No | string | "" | Specify the input placeholder text |
+| pattern | let | No | string | "\\d{1,2}\\/\\d{1,2}\\/\\d{4}" | Specify the Regular Expression for the input value |
+| disabled | let | No | boolean | false | Set to `true` to disable the input |
+| iconDescription | let | No | string | "" | Specify the ARIA label for the calendar icon |
+| id | let | No | string | "ccs-" + Math.random().toString(36) | Set an id for the input element |
+| labelText | let | No | string | "" | Specify the label text |
+| hideLabel | let | No | boolean | false | Set to `true` to visually hide the label text |
+| invalid | let | No | boolean | false | Set to `true` to indicate an invalid state |
+| invalidText | let | No | string | "" | Specify the invalid state text |
+| name | let | No | string | -- | Set a name for the input element |
+
+### Slots
+
+None.
+
+### Events
+
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| input | forwarded | -- |
+| keydown | forwarded | -- |
+| blur | forwarded | -- |
+
+## `DatePickerSkeleton`
+
+### Props
+
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------- | :--------------- | :------- | :------------------- | ------------------------------------------------ | ----------------------------------------- |
+| range | let | No | boolean | false | Set to `true` to use the range variant |
+| id | let | No | string | "ccs-" + Math.random().toString(36) | Set an id to be used by the label element |
+
+### Slots
+
+None.
+
+### Events
+
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
+
+## `Dropdown`
+
+### Types
+
+```ts
type DropdownItemId = string;
type DropdownItemText = string;
@@ -1205,1507 +960,1121 @@ interface DropdownItem {
}
```
-| Prop name | Type | Default value | Description |
-| :-------------- | :------------------------------------------ | :------------ | :--------------------------------------------- |
-| items | DropdownItem[] | `[]` | Set the dropdown items. |
-| itemToString | (item: DropdownItem) => string | -- | Override the display of a dropdown item. |
-| selectedIndex | number | -- | Specify the selected item index. |
-| type | "default" | "inline" | `"default"` | Specify the type of dropdown. |
-| size | "sm" | "lg" | "xl" | -- | Specify the size of the dropdown field. |
-| open | boolean | `false` | Set to `true` to open the dropdown. |
-| inline | boolean | `false` | Set to `true` to use the inline variant. |
-| light | boolean | `false` | Set to `true` to enable the light variant. |
-| disabled | boolean | `false` | Set to `true` to disable the dropdown. |
-| titleText | string | `""` | Specify the title text. |
-| invalid | boolean | `false` | Set to `true` to indicate an invalid state. |
-| invalidText | string | `""` | Specify the invalid state text. |
-| helperText | string | `""` | Specify the helper text. |
-| label | string | -- | Specify the list box label. |
-| translateWithId | (id: any) => string | -- | Override the default translation ids. |
-| id | string | -- | Set an id for the list box component. |
-| name | string | -- | Specify a name attribute for the list box. |
-| ref | null | HTMLButtonElement | `null` | Obtain a reference to the button HTML element. |
+### Props
+
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------------- | :--------------- | :------- | :------------------------------------------ | ----------------------------------------------------- | --------------------------------------------- |
+| ref | let | Yes | null | HTMLButtonElement | null | Obtain a reference to the button HTML element |
+| inline | let | Yes | boolean | false | Set to `true` to use the inline variant |
+| open | let | Yes | boolean | false | Set to `true` to open the dropdown |
+| selectedIndex | let | Yes | number | -1 | Specify the selected item index |
+| items | let | No | DropdownItem[] | [] | Set the dropdown items |
+| itemToString | let | No | (item: DropdownItem) => string | (item) => item.text || item.id | Override the display of a dropdown item |
+| type | let | No | "default" | "inline" | "default" | Specify the type of dropdown |
+| size | let | No | "sm" | "lg" | "xl" | -- | Specify the size of the dropdown field |
+| light | let | No | boolean | false | Set to `true` to enable the light variant |
+| disabled | let | No | boolean | false | Set to `true` to disable the dropdown |
+| titleText | let | No | string | "" | Specify the title text |
+| invalid | let | No | boolean | false | Set to `true` to indicate an invalid state |
+| invalidText | let | No | string | "" | Specify the invalid state text |
+| helperText | let | No | string | "" | Specify the helper text |
+| label | let | No | string | -- | Specify the list box label |
+| translateWithId | let | No | (id: any) => string | -- | Override the default translation ids |
+| id | let | No | string | "ccs-" + Math.random().toString(36) | Set an id for the list box component |
+| name | let | No | string | -- | Specify a name attribute for the list box |
### Slots
-No slots.
+None.
-### Forwarded events
+### Events
-No forwarded events.
+| Event name | Type | Detail |
+| :--------- | :--------- | :--------------------------------------------------------------------------------------------- |
+| select | dispatched | { selectedId: DropdownItemId, selectedIndex: number, selectedItem: DropdownItem } |
-### Dispatched events
-
-- `on:select`
-
----
-
-## DropdownSkeleton
-
-### Import path
-
-```js
-import { DropdownSkeleton } from "carbon-components-svelte";
-```
+## `DropdownSkeleton`
### Props
-| Prop name | Type | Default value | Description |
-| :-------- | :------------------- | :------------ | :--------------------------------------- |
-| inline | boolean | `false` | Set to `true` to use the inline variant. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------- | :--------------- | :------- | :------------------- | ------------------ | --------------------------------------- |
+| inline | let | No | boolean | false | Set to `true` to use the inline variant |
### Slots
-No slots.
+None.
-### Forwarded events
+### Events
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
-### Dispatched events
-
-No dispatched events.
-
----
-
-## ExpandableTile
-
-### Import path
-
-```js
-import { ExpandableTile } from "carbon-components-svelte";
-```
+## `ExpandableTile`
### Props
-| Prop name | Type | Default value | Description |
-| :-------------------- | :----------------------------------- | :---------------------------- | :----------------------------------------------------- |
-| expanded | boolean | `false` | Set to `true` to expand the tile. |
-| light | boolean | `false` | Set to `true` to enable the light variant. |
-| tileMaxHeight | number | `0` | Specify the max height of the tile (number of pixels). |
-| tilePadding | number | `0` | Specify the padding of the tile (number of pixels). |
-| tileCollapsedIconText | string | `"Interact to expand Tile"` | Specify the icon text of the collapsed tile. |
-| tileExpandedIconText | string | `"Interact to collapse Tile"` | Specify the icon text of the expanded tile. |
-| tabindex | string | `"0"` | Specify the tabindex. |
-| id | string | -- | Set an id for the top-level div element. |
-| ref | null | HTMLElement | `null` | Obtain a reference to the input HTML element. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------------------- | :--------------- | :------- | :-------------------------------------- | ------------------------------------------------ | ----------------------------------------------------- |
+| ref | let | Yes | null | HTMLDivElement | null | Obtain a reference to the top-level element |
+| tilePadding | let | Yes | number | 0 | Specify the padding of the tile (number of pixels) |
+| tileMaxHeight | let | Yes | number | 0 | Specify the max height of the tile (number of pixels) |
+| expanded | let | Yes | boolean | false | Set to `true` to expand the tile |
+| light | let | No | boolean | false | Set to `true` to enable the light variant |
+| tileCollapsedIconText | let | No | string | "Interact to expand Tile" | Specify the icon text of the collapsed tile |
+| tileExpandedIconText | let | No | string | "Interact to collapse Tile" | Specify the icon text of the expanded tile |
+| tabindex | let | No | string | "0" | Specify the tabindex |
+| id | let | No | string | "ccs-" + Math.random().toString(36) | Set an id for the top-level div element |
### Slots
-- **"above"**: `
...
`
-- **"below"**: `
...
`
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :------- |
+| above | No | -- | -- |
+| below | No | -- | -- |
-### Forwarded events
+### Events
-- `on:click`
-- `on:keypress`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+| keypress | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
-### Dispatched events
+## `FileUploader`
-No dispatched events.
-
----
-
-## FileUploader
-
-### Import path
-
-```js
-import { FileUploader } from "carbon-components-svelte";
-```
-
-### Props
-
-| Prop name | Type | Default value | Description |
-| :---------------------- | :----------------------------------------------------------------------------------------- | :--------------------------- | :--------------------------------------------------------------------- |
-| status | "uploading" | "edit" | "complete" | `"uploading"` | Specify the file uploader status. |
-| accept | string[] | `[]` | Specify the accepted file types. |
-| files | string[] | `[]` | Obtain the uploaded file names. |
-| multiple | boolean | `false` | Set to `true` to allow multiple files. |
-| clearFiles (`constant`) | () => any | -- | Override the default behavior of clearing the array of uploaded files. |
-| labelDescription | string | `""` | Specify the label description. |
-| labelTitle | string | `""` | Specify the label title. |
-| kind | "primary" | "secondary" | "tertiary" | "ghost" | "danger" | `"primary"` | Specify the kind of file uploader button. |
-| buttonLabel | string | `""` | Specify the button label. |
-| iconDescription | string | `"Provide icon description"` | Specify the ARIA label used for the status icons. |
-| name | string | `""` | Specify a name attribute for the file button uploader input. |
-
-### Slots
-
-No slots.
-
-### Forwarded events
-
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
-- `on:change`
-- `on:keydown`
-
-### Dispatched events
-
-- `on:add`
-- `on:remove`
-
----
-
-## FileUploaderButton
-
-### Import path
-
-```js
-import { FileUploaderButton } from "carbon-components-svelte";
-```
-
-### Props
-
-| Prop name | Type | Default value | Description |
-| :------------------ | :----------------------------------------------------------------------------------------- | :------------ | :-------------------------------------------- |
-| accept | string[] | `[]` | Specify the accepted file types. |
-| multiple | boolean | `false` | Set to `true` to allow multiple files. |
-| disabled | boolean | `false` | Set to `true` to disable the input. |
-| disableLabelChanges | boolean | `false` | Set to `true` to disable label changes. |
-| kind | "primary" | "secondary" | "tertiary" | "ghost" | "danger" | `"primary"` | Specify the kind of file uploader button. |
-| labelText | string | `"Add file"` | Specify the label text. |
-| role | string | `"button"` | Specify the label role. |
-| tabindex | string | `"0"` | Specify `tabindex` attribute. |
-| id | string | -- | Set an id for the input element. |
-| name | string | `""` | Specify a name attribute for the input. |
-| ref | null | HTMLInputElement | `null` | Obtain a reference to the input HTML element. |
-
-### Slots
-
-No slots.
-
-### Forwarded events
-
-- `on:keydown`
-- `on:change`
-- `on:click`
-
-### Dispatched events
-
-No dispatched events.
-
----
-
-## FileUploaderDropContainer
-
-### Import path
-
-```js
-import { FileUploaderDropContainer } from "carbon-components-svelte";
-```
-
-### Props
+### Types
```ts
-// `FileUploaderDropContainer` type definitions
-
type Files = string[];
```
-| Prop name | Type | Default value | Description |
-| :------------ | :---------------------------------------- | :------------ | :-------------------------------------------------------------------------------------------------------- |
-| accept | string[] | `[]` | Specify the accepted file types. |
-| multiple | boolean | `false` | Set to `true` to allow multiple files. |
-| validateFiles | (files: Files) => Files | -- | Override the default behavior of validating uploaded files. The default behavior does not validate files. |
-| labelText | string | `"Add file"` | Specify the label text. |
-| role | string | `"button"` | Specify the `role` attribute of the drop container. |
-| disabled | boolean | `false` | Set to `true` to disable the input. |
-| tabindex | string | `"0"` | Specify `tabindex` attribute. |
-| id | string | -- | Set an id for the input element. |
-| name | string | `""` | Specify a name attribute for the input. |
-| ref | null | HTMLInputElement | `null` | Obtain a reference to the input HTML element. |
+### Props
+
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :--------------- | :----------------- | :------- | :----------------------------------------------------------------------------------------- | --------------------------------------- | --------------------------------------------------------------------- |
+| files | let | Yes | Files | [] | Obtain the uploaded file names |
+| status | let | No | "uploading" | "edit" | "complete" | "uploading" | Specify the file uploader status |
+| accept | let | No | Files | [] | Specify the accepted file types |
+| multiple | let | No | boolean | false | Set to `true` to allow multiple files |
+| clearFiles | const | No | () => void | () => { files = []; } | Override the default behavior of clearing the array of uploaded files |
+| labelDescription | let | No | string | "" | Specify the label description |
+| labelTitle | let | No | string | "" | Specify the label title |
+| kind | let | No | "primary" | "secondary" | "tertiary" | "ghost" | "danger" | "primary" | Specify the kind of file uploader button |
+| buttonLabel | let | No | string | "" | Specify the button label |
+| iconDescription | let | No | string | "Provide icon description" | Specify the ARIA label used for the status icons |
+| name | let | No | string | "" | Specify a name attribute for the file button uploader input |
### Slots
-No slots.
+None.
-### Forwarded events
+### Events
-- `on:dragover`
-- `on:dragleave`
-- `on:drop`
-- `on:keydown`
-- `on:change`
-- `on:click`
+| Event name | Type | Detail |
+| :--------- | :--------- | :----------------- |
+| add | dispatched | Files |
+| remove | dispatched | Files |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
+| change | forwarded | -- |
+| keydown | forwarded | -- |
-### Dispatched events
+## `FileUploaderButton`
-- `on:add`
-
----
-
-## FileUploaderItem
-
-### Import path
-
-```js
-import { FileUploaderItem } from "carbon-components-svelte";
-```
-
-### Props
-
-| Prop name | Type | Default value | Description |
-| :-------------- | :------------------------------------------------------- | :------------ | :------------------------------------------------ |
-| status | "uploading" | "edit" | "complete" | `"uploading"` | Specify the file uploader status. |
-| iconDescription | string | `""` | Specify the ARIA label used for the status icons. |
-| invalid | boolean | `false` | Set to `true` to indicate an invalid state. |
-| errorSubject | string | `""` | Specify the error subject text. |
-| errorBody | string | `""` | Specify the error body text. |
-| id | string | -- | Set an id for the top-level element. |
-| name | string | `""` | Specify the file uploader name. |
-
-### Slots
-
-No slots.
-
-### Forwarded events
-
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
-
-### Dispatched events
-
-- `on:delete`
-
----
-
-## FileUploaderSkeleton
-
-### Import path
-
-```js
-import { FileUploaderSkeleton } from "carbon-components-svelte";
-```
-
-### Props
-
-No exported props.
-
-### Slots
-
-No slots.
-
-### Forwarded events
-
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
-
-### Dispatched events
-
-No dispatched events.
-
----
-
-## Filename
-
-### Import path
-
-```js
-import { Filename } from "carbon-components-svelte";
-```
-
-### Props
-
-| Prop name | Type | Default value | Description |
-| :-------------- | :------------------------------------------------------- | :------------ | :------------------------------------------------ |
-| status | "uploading" | "edit" | "complete" | `"uploading"` | Specify the file name status. |
-| iconDescription | string | `""` | Specify the ARIA label used for the status icons. |
-| invalid | boolean | `false` | Set to `true` to indicate an invalid state. |
-
-### Slots
-
-No slots.
-
-### Forwarded events
-
-- `on:click`
-- `on:keydown`
-
-### Dispatched events
-
-No dispatched events.
-
----
-
-## FluidForm
-
-### Import path
-
-```js
-import { FluidForm } from "carbon-components-svelte";
-```
-
-### Props
-
-No exported props.
-
-### Slots
-
-- **default**: `
`
-
-### Forwarded events
-
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
-
-### Dispatched events
-
-No dispatched events.
-
----
-
-## FormLabel
-
-### Import path
-
-```js
-import { FormLabel } from "carbon-components-svelte";
-```
-
-### Props
-
-| Prop name | Type | Default value | Description |
-| :-------- | :------------------ | :------------ | :----------------------------------------- |
-| id | string | -- | Set an id to be used by the label element. |
-
-### Slots
-
-- **default**: `
...
`
-
-### Forwarded events
-
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
-
-### Dispatched events
-
-No dispatched events.
-
----
-
-## Grid
-
-### Import path
-
-```js
-import { Grid } from "carbon-components-svelte";
-```
-
-### Props
-
-| Prop name | Type | Default value | Description |
-| :------------ | :------------------- | :------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| as | boolean | `false` | Set to `true` to render a custom HTML element. Props are destructured as `props` in the default slot (e.g. <Grid let:props><header {...props}>...</header></Grid>). |
-| condensed | boolean | `false` | Set to `true` to use the condensed variant. |
-| narrow | boolean | `false` | Set to `true` to use the narrow variant. |
-| fullWidth | boolean | `false` | Set to `true` to use the fullWidth variant. |
-| noGutter | boolean | `false` | Set to `true` to remove the gutter. |
-| noGutterLeft | boolean | `false` | Set to `true` to remove the left gutter. |
-| noGutterRight | boolean | `false` | Set to `true` to remove the right gutter. |
-
-### Slots
-
-- **default**: `
...
`
-
-### Forwarded events
-
-No forwarded events.
-
-### Dispatched events
-
-No dispatched events.
-
----
-
-## Header
-
-### Import path
-
-```js
-import { Header } from "carbon-components-svelte";
-```
-
-### Props
-
-| Prop name | Type | Default value | Description |
-| :---------------- | :----------------------------------------- | :------------ | :--------------------------------------------------------------------------------------------------------------------------- |
-| expandedByDefault | boolean | `true` | Set to `false` to hide the side nav by default. |
-| isSideNavOpen | boolean | `false` | Set to `true` to open the side nav. |
-| uiShellAriaLabel | string | -- | Specify the ARIA label for the header. |
-| href | string | -- | Specify the `href` attribute. |
-| company | string | -- | Specify the company name. |
-| platformName | string | `""` | Specify the platform name. Alternatively, use the named slot "platform" (e.g. <span slot="platform">...</span>). |
-| ref | null | HTMLAnchorElement | `null` | Obtain a reference to the HTML anchor element. |
-
-### Slots
-
-- **default**: `
...
`
-- **"skip-to-content"**: `
...
`
-- **"platform"**: `
...
`
-
-### Forwarded events
-
-- `on:click`
-
-### Dispatched events
-
-No dispatched events.
-
----
-
-## HeaderAction
-
-### Import path
-
-```js
-import { HeaderAction } from "carbon-components-svelte";
-```
-
-### Props
-
-| Prop name | Type | Default value | Description |
-| :-------- | :-------------------------------------------------------------------------------------------------- | :------------ | :-------------------------------------------------------------------------------------------------------- |
-| isOpen | boolean | `false` | Set to `true` to open the panel. |
-| icon | { render: typeof import("carbon-icons-svelte/lib/Add16").default; skeleton: boolean; } | -- | Specify the icon props. |
-| text | string | -- | Specify the text. Alternatively, use the named slot "text" (e.g. <div slot="text">...</div>). |
-| ref | null | HTMLButtonElement | `null` | Obtain a reference to the button HTML element. |
-
-### Slots
-
-- **default**: `
...
`
-- **"text"**: `
...
`
-
-### Forwarded events
-
-- `on:click`
-
-### Dispatched events
-
-- `on:close`
-
----
-
-## HeaderActionLink
-
-### Import path
-
-```js
-import { HeaderActionLink } from "carbon-components-svelte";
-```
-
-### Props
-
-| Prop name | Type | Default value | Description |
-| :----------- | :-------------------------------------------------------------------------------------------------- | :------------ | :--------------------------------------------- |
-| linkIsActive | boolean | `false` | Set to `true` to use the active state. |
-| href | string | -- | Specify the `href` attribute. |
-| icon | { render: typeof import("carbon-icons-svelte/lib/Add16").default; skeleton: boolean; } | -- | Specify the icon props. |
-| ref | null | HTMLAnchorElement | `null` | Obtain a reference to the HTML anchor element. |
-
-### Slots
-
-No slots.
-
-### Forwarded events
-
-No forwarded events.
-
-### Dispatched events
-
-No dispatched events.
-
----
-
-## HeaderActionSearch
-
-### Import path
-
-```js
-import { HeaderActionSearch } from "carbon-components-svelte";
-```
-
-### Props
-
-| Prop name | Type | Default value | Description |
-| :------------- | :------------------- | :------------ | :--------------------------------- |
-| searchIsActive | boolean | `false` | Set to `true` to focus the search. |
-
-### Slots
-
-No slots.
-
-### Forwarded events
-
-No forwarded events.
-
-### Dispatched events
-
-- `on:focusInputSearch`
-- `on:focusOutInputSearch`
-- `on:inputSearch`
-
----
-
-## HeaderGlobalAction
-
-### Import path
-
-```js
-import { HeaderGlobalAction } from "carbon-components-svelte";
-```
-
-### Props
-
-| Prop name | Type | Default value | Description |
-| :-------- | :------------------------------------------------------------------ | :------------ | :--------------------------------------------- |
-| isActive | boolean | `false` | Set to `true` to use the active variant. |
-| icon | typeof import("carbon-icons-svelte/lib/Add16").default | -- | Specify the icon to render. |
-| ref | null | HTMLButtonElement | `null` | Obtain a reference to the HTML button element. |
-
-### Slots
-
-- **default**: `
...
`
-
-### Forwarded events
-
-- `on:click`
-
-### Dispatched events
-
-No dispatched events.
-
----
-
-## HeaderNav
-
-### Import path
-
-```js
-import { HeaderNav } from "carbon-components-svelte";
-```
-
-### Props
-
-| Prop name | Type | Default value | Description |
-| :-------- | :------------------ | :------------ | :---------------------------------- |
-| ariaLabel | string | -- | Specify the ARIA label for the nav. |
-
-### Slots
-
-- **default**: `
...
`
-
-### Forwarded events
-
-No forwarded events.
-
-### Dispatched events
-
-No dispatched events.
-
----
-
-## HeaderNavItem
-
-### Import path
-
-```js
-import { HeaderNavItem } from "carbon-components-svelte";
-```
-
-### Props
-
-| Prop name | Type | Default value | Description |
-| :-------- | :----------------------------------------- | :------------ | :--------------------------------------------- |
-| href | string | -- | Specify the `href` attribute. |
-| text | string | -- | Specify the text. |
-| ref | null | HTMLAnchorElement | `null` | Obtain a reference to the HTML anchor element. |
-
-### Slots
-
-No slots.
-
-### Forwarded events
-
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
-- `on:keyup`
-- `on:keydown`
-- `on:focus`
-- `on:blur`
-
-### Dispatched events
-
-No dispatched events.
-
----
-
-## HeaderNavMenu
-
-### Import path
-
-```js
-import { HeaderNavMenu } from "carbon-components-svelte";
-```
-
-### Props
-
-| Prop name | Type | Default value | Description |
-| :-------------- | :----------------------------------------- | :------------------ | :--------------------------------------------- |
-| expanded | boolean | `false` | Set to `true` to toggle the expanded state. |
-| href | string | `"/"` | Specify the `href` attribute. |
-| text | string | -- | Specify the text. |
-| ref | null | HTMLAnchorElement | `null` | Obtain a reference to the HTML anchor element. |
-| iconDescription | string | `"Expand/Collapse"` | Specify the ARIA label for the chevron icon. |
-
-### Slots
-
-- **default**: `
`
-
-### Forwarded events
-
-No forwarded events.
-
-### Dispatched events
-
-No dispatched events.
-
----
-
-## Icon
-
-### Import path
-
-```js
-import { Icon } from "carbon-components-svelte";
-```
-
-### Props
-
-| Prop name | Type | Default value | Description |
-| :-------- | :------------------------------------------------------------------ | :------------ | :------------------------------------------------------------------------------------------------------ |
-| render | typeof import("carbon-icons-svelte/lib/Add16").default | -- | Specify the icon from `carbon-icons-svelte` to render. Icon size must be 16px (e.g. `Add16`, `Task16`). |
-| skeleton | boolean | `false` | Set to `true` to display the skeleton state. |
-
-### Slots
-
-No slots.
-
-### Forwarded events
-
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
-
-### Dispatched events
-
-No dispatched events.
-
----
-
-## IconSkeleton
-
-### Import path
-
-```js
-import { IconSkeleton } from "carbon-components-svelte";
-```
-
-### Props
-
-| Prop name | Type | Default value | Description |
-| :-------- | :------------------ | :------------ | :------------------------ |
-| size | number | `16` | Set the size of the icon. |
-
-### Slots
-
-No slots.
-
-### Forwarded events
-
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
-
-### Dispatched events
-
-No dispatched events.
-
----
-
-## InlineLoading
-
-### Import path
-
-```js
-import { InlineLoading } from "carbon-components-svelte";
-```
-
-### Props
-
-| Prop name | Type | Default value | Description |
-| :-------------- | :----------------------------------------------------------------------- | :------------ | :----------------------------------------------------------------- |
-| status | "active" | "inactive" | "finished" | "error" | `"active"` | Set the loading status. |
-| description | string | -- | Set the loading description. |
-| iconDescription | string | -- | Specify the ARIA label for the loading icon. |
-| successDelay | number | `1500` | Specify the timeout delay (ms) after `status` is set to "success". |
-
-### Slots
-
-No slots.
-
-### Forwarded events
-
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
-
-### Dispatched events
-
-- `on:success`
-
----
-
-## InlineNotification
-
-### Import path
-
-```js
-import { InlineNotification } from "carbon-components-svelte";
-```
-
-### Props
-
-| Prop name | Type | Default value | Description |
-| :--------------- | :------------------------------------------------------------------------------------------------------------- | :---------------------- | :----------------------------------------------------------------------- |
-| notificationType | "toast" | "inline" | `"inline"` | Set the type of notification. |
-| kind | "error" | "info" | "info-square" | "success" | "warning" | "warning-alt" | `"error"` | Specify the kind of notification. |
-| lowContrast | boolean | `false` | Set to `true` to use the low contrast variant. |
-| timeout | number | `0` | Set the timeout duration (ms) to hide the notification after opening it. |
-| role | string | `"alert"` | Set the `role` attribute. |
-| title | string | `"Title"` | Specify the title text. |
-| subtitle | string | `""` | Specify the subtitle text. |
-| hideCloseButton | boolean | `false` | Set to `true` to hide the close button. |
-| iconDescription | string | `"Closes notification"` | Specify the ARIA label for the icon. |
-
-### Slots
-
-- **default**: `
...
`
-- **"actions"**: `
...
`
-
-### Forwarded events
-
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
-
-### Dispatched events
-
-- `on:close`
-
----
-
-## Link
-
-### Import path
-
-```js
-import { Link } from "carbon-components-svelte";
-```
-
-### Props
-
-| Prop name | Type | Default value | Description |
-| :-------- | :--------------------------------------------------------------------- | :------------ | :------------------------------------------------ |
-| size | "sm" | "lg" | -- | Specify the size of the link. |
-| href | string | -- | Specify the href value. |
-| inline | boolean | `false` | Set to `true` to use the inline variant. |
-| disabled | boolean | `false` | Set to `true` to disable the checkbox. |
-| visited | boolean | `false` | Set to `true` to allow visited styles. |
-| ref | null | HTMLAnchorElement | HTMLParagraphElement | `null` | Obtain a reference to the top-level HTML element. |
-
-### Slots
-
-- **default**: `
...
`
-
-### Forwarded events
-
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
-
-### Dispatched events
-
-No dispatched events.
-
----
-
-## ListBox
-
-### Import path
-
-```js
-import { ListBox } from "carbon-components-svelte";
-```
-
-### Props
-
-| Prop name | Type | Default value | Description |
-| :---------- | :------------------------------------- | :------------ | :------------------------------------------ |
-| size | "sm" | "xl" | -- | Set the size of the list box. |
-| type | "default" | "inline" | `"default"` | Set the type of the list box. |
-| open | boolean | `false` | Set to `true` to open the list box. |
-| light | boolean | `false` | Set to `true` to enable the light variant. |
-| disabled | boolean | `false` | Set to `true` to disable the list box. |
-| invalid | boolean | `false` | Set to `true` to indicate an invalid state. |
-| invalidText | string | `""` | Specify the invalid state text. |
-
-### Slots
-
-- **default**: `
...
`
-
-### Forwarded events
-
-- `on:keydown`
-- `on:click`
-
-### Dispatched events
-
-No dispatched events.
-
----
-
-## ListBoxField
-
-### Import path
-
-```js
-import { ListBoxField } from "carbon-components-svelte";
-```
-
-### Props
+### Types
```ts
-// `ListBoxField` type definitions
+type Files = string[];
+```
+### Props
+
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :------------------ | :--------------- | :------- | :----------------------------------------------------------------------------------------- | ------------------------------------------------ | -------------------------------------------- |
+| ref | let | Yes | null | HTMLInputElement | null | Obtain a reference to the input HTML element |
+| labelText | let | Yes | string | "Add file" | Specify the label text |
+| accept | let | No | Files | [] | Specify the accepted file types |
+| multiple | let | No | boolean | false | Set to `true` to allow multiple files |
+| disabled | let | No | boolean | false | Set to `true` to disable the input |
+| disableLabelChanges | let | No | boolean | false | Set to `true` to disable label changes |
+| kind | let | No | "primary" | "secondary" | "tertiary" | "ghost" | "danger" | "primary" | Specify the kind of file uploader button |
+| role | let | No | string | "button" | Specify the label role |
+| tabindex | let | No | string | "0" | Specify `tabindex` attribute |
+| id | let | No | string | "ccs-" + Math.random().toString(36) | Set an id for the input element |
+| name | let | No | string | "" | Specify a name attribute for the input |
+
+### Slots
+
+None.
+
+### Events
+
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| keydown | forwarded | -- |
+| change | forwarded | -- |
+| click | forwarded | -- |
+
+## `FileUploaderDropContainer`
+
+### Types
+
+```ts
+type Files = string[];
+```
+
+### Props
+
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :------------ | :--------------- | :------- | :---------------------------------------- | ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
+| ref | let | Yes | null | HTMLInputElement | null | Obtain a reference to the input HTML element |
+| accept | let | No | Files | [] | Specify the accepted file types |
+| multiple | let | No | boolean | false | Set to `true` to allow multiple files |
+| validateFiles | let | No | (files: Files) => Files | (files) => files | Override the default behavior of validating uploaded files The default behavior does not validate files |
+| labelText | let | No | string | "Add file" | Specify the label text |
+| role | let | No | string | "button" | Specify the `role` attribute of the drop container |
+| disabled | let | No | boolean | false | Set to `true` to disable the input |
+| tabindex | let | No | string | "0" | Specify `tabindex` attribute |
+| id | let | No | string | "ccs-" + Math.random().toString(36) | Set an id for the input element |
+| name | let | No | string | "" | Specify a name attribute for the input |
+
+### Slots
+
+None.
+
+### Events
+
+| Event name | Type | Detail |
+| :--------- | :--------- | :----------------- |
+| add | dispatched | Files |
+| dragover | forwarded | -- |
+| dragleave | forwarded | -- |
+| drop | forwarded | -- |
+| keydown | forwarded | -- |
+| change | forwarded | -- |
+| click | forwarded | -- |
+
+## `FileUploaderItem`
+
+### Props
+
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------------- | :--------------- | :------- | :------------------------------------------------------- | ------------------------------------------------ | ------------------------------------------------ |
+| status | let | No | "uploading" | "edit" | "complete" | "uploading" | Specify the file uploader status |
+| iconDescription | let | No | string | "" | Specify the ARIA label used for the status icons |
+| invalid | let | No | boolean | false | Set to `true` to indicate an invalid state |
+| errorSubject | let | No | string | "" | Specify the error subject text |
+| errorBody | let | No | string | "" | Specify the error body text |
+| id | let | No | string | "ccs-" + Math.random().toString(36) | Set an id for the top-level element |
+| name | let | No | string | "" | Specify the file uploader name |
+
+### Slots
+
+None.
+
+### Events
+
+| Event name | Type | Detail |
+| :--------- | :--------- | :------------------ |
+| delete | dispatched | string |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
+
+## `FileUploaderSkeleton`
+
+### Props
+
+None.
+
+### Slots
+
+None.
+
+### Events
+
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
+
+## `Filename`
+
+### Props
+
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------------- | :--------------- | :------- | :------------------------------------------------------- | ------------------------ | ------------------------------------------------ |
+| status | let | No | "uploading" | "edit" | "complete" | "uploading" | Specify the file name status |
+| iconDescription | let | No | string | "" | Specify the ARIA label used for the status icons |
+| invalid | let | No | boolean | false | Set to `true` to indicate an invalid state |
+
+### Slots
+
+None.
+
+### Events
+
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+| keydown | forwarded | -- |
+
+## `FluidForm`
+
+### Props
+
+None.
+
+### Slots
+
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :------- |
+| -- | Yes | -- | -- |
+
+### Events
+
+None.
+
+## `Form`
+
+### Props
+
+None.
+
+### Slots
+
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :------- |
+| -- | Yes | -- | -- |
+
+### Events
+
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
+| submit | forwarded | -- |
+
+## `FormGroup`
+
+### Props
+
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :---------- | :--------------- | :------- | :------------------- | ------------------ | ------------------------------------------ |
+| invalid | let | No | boolean | false | Set to `true` to indicate an invalid state |
+| message | let | No | boolean | false | Set to `true` to render a form requirement |
+| messageText | let | No | string | "" | Specify the message text |
+| legendText | let | No | string | "" | Specify the legend text |
+
+### Slots
+
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :------- |
+| -- | Yes | -- | -- |
+
+### Events
+
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
+
+## `FormItem`
+
+### Props
+
+None.
+
+### Slots
+
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :------- |
+| -- | Yes | -- | -- |
+
+### Events
+
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
+
+## `FormLabel`
+
+### Props
+
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------- | :--------------- | :------- | :------------------ | ------------------------------------------------ | ----------------------------------------- |
+| id | let | No | string | "ccs-" + Math.random().toString(36) | Set an id to be used by the label element |
+
+### Slots
+
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :------- |
+| -- | Yes | -- | -- |
+
+### Events
+
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
+
+## `Grid`
+
+### Props
+
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :------------ | :--------------- | :------- | :------------------- | ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| as | let | No | boolean | false | Set to `true` to render a custom HTML element Props are destructured as `props` in the default slot (e.g. <Grid let:props><header {...props}>...</header></Grid>) |
+| condensed | let | No | boolean | false | Set to `true` to use the condensed variant |
+| narrow | let | No | boolean | false | Set to `true` to use the narrow variant |
+| fullWidth | let | No | boolean | false | Set to `true` to use the fullWidth variant |
+| noGutter | let | No | boolean | false | Set to `true` to remove the gutter |
+| noGutterLeft | let | No | boolean | false | Set to `true` to remove the left gutter |
+| noGutterRight | let | No | boolean | false | Set to `true` to remove the right gutter |
+
+### Slots
+
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :-------------------------------------------------------------- | :------- |
+| -- | Yes | { props: { class: string; [key: string]: any; } } | -- |
+
+### Events
+
+None.
+
+## `Header`
+
+### Props
+
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :---------------------- | :--------------- | :------- | :----------------------------------------- | ------------------ | ------------------------------------------------------------------------------------------------------------------------------- |
+| ref | let | Yes | null | HTMLAnchorElement | null | Obtain a reference to the HTML anchor element |
+| isSideNavOpen | let | Yes | boolean | false | Set to `true` to open the side nav |
+| expandedByDefault | let | No | boolean | true | Set to `false` to hide the side nav by default |
+| uiShellAriaLabel | let | No | string | -- | Specify the ARIA label for the header |
+| href | let | No | string | -- | Specify the `href` attribute |
+| company | let | No | string | -- | Specify the company name |
+| platformName | let | No | string | "" | Specify the platform name Alternatively, use the named slot "platform" (e.g. <span slot="platform">...</span>) |
+| persistentHamburgerMenu | let | No | boolean | false | Set to `true` to persist the hamburger menu |
+
+### Slots
+
+| Slot name | Default | Props | Fallback |
+| :-------------- | :------ | :---- | :-------------------------- |
+| -- | Yes | -- | -- |
+| platform | No | -- | {platformName} |
+| skip-to-content | No | -- | -- |
+
+### Events
+
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+
+## `HeaderAction`
+
+### Props
+
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------- | :--------------- | :------- | :------------------------------------------------------------------------------------ | ------------------ | ------------------------------------------------------------------------------------------------------------ |
+| ref | let | Yes | null | HTMLButtonElement | null | Obtain a reference to the button HTML element |
+| isOpen | let | Yes | boolean | false | Set to `true` to open the panel |
+| icon | let | No | { render: import("carbon-icons-svelte").CarbonIcon; skeleton: boolean; } | -- | Specify the icon props |
+| text | let | No | string | -- | Specify the text Alternatively, use the named slot "text" (e.g. <div slot="text">...</div>) |
+
+### Slots
+
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :---------------------------------------------------------- |
+| -- | Yes | -- | -- |
+| text | No | -- | {#if text}<span>{text}</span>{/if} |
+
+### Events
+
+| Event name | Type | Detail |
+| :--------- | :--------- | :----- |
+| click | forwarded | -- |
+| close | dispatched | -- |
+
+## `HeaderActionLink`
+
+### Props
+
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :----------- | :--------------- | :------- | :------------------------------------------------------------------------------------ | ------------------ | --------------------------------------------- |
+| ref | let | Yes | null | HTMLAnchorElement | null | Obtain a reference to the HTML anchor element |
+| linkIsActive | let | No | boolean | false | Set to `true` to use the active state |
+| href | let | No | string | -- | Specify the `href` attribute |
+| icon | let | No | { render: import("carbon-icons-svelte").CarbonIcon; skeleton: boolean; } | -- | Specify the icon props |
+
+### Slots
+
+None.
+
+### Events
+
+None.
+
+## `HeaderActionSearch`
+
+### Props
+
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :------------- | :--------------- | :------- | :------------------- | ------------------ | --------------------------------- |
+| searchIsActive | let | Yes | boolean | false | Set to `true` to focus the search |
+
+### Slots
+
+None.
+
+### Events
+
+| Event name | Type | Detail |
+| :------------------ | :--------- | :---------------------------------------------------- |
+| inputSearch | dispatched | { action: "search"; textInput: string; } |
+| focusInputSearch | dispatched | -- |
+| focusOutInputSearch | dispatched | -- |
+
+## `HeaderGlobalAction`
+
+### Props
+
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------- | :--------------- | :------- | :----------------------------------------------------------- | ------------------ | --------------------------------------------- |
+| ref | let | Yes | null | HTMLButtonElement | null | Obtain a reference to the HTML button element |
+| isActive | let | No | boolean | false | Set to `true` to use the active variant |
+| icon | let | No | typeof import("carbon-icons-svelte").CarbonIcon | -- | Specify the icon to render |
+
+### Slots
+
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :---------------------------------------------------- |
+| -- | Yes | -- | <svelte:component this="{icon}" /> |
+
+### Events
+
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+
+## `HeaderNav`
+
+### Props
+
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------- | :--------------- | :------- | :------------------ | ------------- | ---------------------------------- |
+| ariaLabel | let | No | string | -- | Specify the ARIA label for the nav |
+
+### Slots
+
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :------- |
+| -- | Yes | -- | -- |
+
+### Events
+
+None.
+
+## `HeaderNavItem`
+
+### Props
+
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------- | :--------------- | :------- | :----------------------------------------- | ----------------- | --------------------------------------------- |
+| ref | let | Yes | null | HTMLAnchorElement | null | Obtain a reference to the HTML anchor element |
+| href | let | No | string | -- | Specify the `href` attribute |
+| text | let | No | string | -- | Specify the text |
+
+### Slots
+
+None.
+
+### Events
+
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
+| keyup | forwarded | -- |
+| keydown | forwarded | -- |
+| focus | forwarded | -- |
+| blur | forwarded | -- |
+
+## `HeaderNavMenu`
+
+### Props
+
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------------- | :--------------- | :------- | :----------------------------------------- | ------------------------------ | --------------------------------------------- |
+| ref | let | Yes | null | HTMLAnchorElement | null | Obtain a reference to the HTML anchor element |
+| expanded | let | Yes | boolean | false | Set to `true` to toggle the expanded state |
+| href | let | No | string | "/" | Specify the `href` attribute |
+| text | let | No | string | -- | Specify the text |
+| iconDescription | let | No | string | "Expand/Collapse" | Specify the ARIA label for the chevron icon |
+
+### Slots
+
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :------- |
+| -- | Yes | -- | -- |
+
+### Events
+
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| keydown | forwarded | -- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
+| keyup | forwarded | -- |
+| focus | forwarded | -- |
+| blur | forwarded | -- |
+
+## `HeaderPanelDivider`
+
+### Props
+
+None.
+
+### Slots
+
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :------- |
+| -- | Yes | -- | -- |
+
+### Events
+
+None.
+
+## `HeaderPanelLink`
+
+### Props
+
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------- | :--------------- | :------- | :----------------------------------------- | ----------------- | --------------------------------------------- |
+| ref | let | Yes | null | HTMLAnchorElement | null | Obtain a reference to the HTML anchor element |
+| href | let | No | string | -- | Specify the `href` attribute |
+
+### Slots
+
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :------- |
+| -- | Yes | -- | -- |
+
+### Events
+
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+
+## `HeaderPanelLinks`
+
+### Props
+
+None.
+
+### Slots
+
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :------- |
+| -- | Yes | -- | -- |
+
+### Events
+
+None.
+
+## `HeaderUtilities`
+
+### Props
+
+None.
+
+### Slots
+
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :------- |
+| -- | Yes | -- | -- |
+
+### Events
+
+None.
+
+## `Icon`
+
+### Props
+
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------- | :--------------- | :------- | :----------------------------------------------------------- | ------------------ | ----------------------------------------------------- |
+| render | let | No | typeof import("carbon-icons-svelte").CarbonIcon | -- | Specify the icon from `carbon-icons-svelte` to render |
+| skeleton | let | No | boolean | false | Set to `true` to display the skeleton state |
+
+### Slots
+
+None.
+
+### Events
+
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
+
+## `IconSkeleton`
+
+### Props
+
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------- | :--------------- | :------- | :------------------ | --------------- | ------------------------ |
+| size | let | No | number | 16 | Set the size of the icon |
+
+### Slots
+
+None.
+
+### Events
+
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
+
+## `InlineLoading`
+
+### Props
+
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------------- | :--------------- | :------- | :----------------------------------------------------------------------- | --------------------- | ----------------------------------------------------------------- |
+| status | let | No | "active" | "inactive" | "finished" | "error" | "active" | Set the loading status |
+| description | let | No | string | -- | Set the loading description |
+| iconDescription | let | No | string | -- | Specify the ARIA label for the loading icon |
+| successDelay | let | No | number | 1500 | Specify the timeout delay (ms) after `status` is set to "success" |
+
+### Slots
+
+None.
+
+### Events
+
+| Event name | Type | Detail |
+| :--------- | :--------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
+| success | dispatched | -- |
+
+## `InlineNotification`
+
+### Props
+
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :--------------- | :--------------- | :------- | :------------------------------------------------------------------------------------------------------------- | ---------------------------------- | ----------------------------------------------------------------------- |
+| notificationType | let | No | "toast" | "inline" | "inline" | Set the type of notification |
+| kind | let | No | "error" | "info" | "info-square" | "success" | "warning" | "warning-alt" | "error" | Specify the kind of notification |
+| lowContrast | let | No | boolean | false | Set to `true` to use the low contrast variant |
+| timeout | let | No | number | 0 | Set the timeout duration (ms) to hide the notification after opening it |
+| role | let | No | string | "alert" | Set the `role` attribute |
+| title | let | No | string | "Title" | Specify the title text |
+| subtitle | let | No | string | "" | Specify the subtitle text |
+| hideCloseButton | let | No | boolean | false | Set to `true` to hide the close button |
+| iconDescription | let | No | string | "Closes notification" | Specify the ARIA label for the icon |
+
+### Slots
+
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :------- |
+| -- | Yes | -- | -- |
+| actions | No | -- | -- |
+
+### Events
+
+| Event name | Type | Detail |
+| :--------- | :--------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
+| close | dispatched | -- |
+
+## `Link`
+
+### Props
+
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------- | :--------------- | :------- | :--------------------------------------------------------------------- | ------------------ | ------------------------------------------------ |
+| ref | let | Yes | null | HTMLAnchorElement | HTMLParagraphElement | null | Obtain a reference to the top-level HTML element |
+| size | let | No | "sm" | "lg" | -- | Specify the size of the link |
+| href | let | No | string | -- | Specify the href value |
+| inline | let | No | boolean | false | Set to `true` to use the inline variant |
+| disabled | let | No | boolean | false | Set to `true` to disable the checkbox |
+| visited | let | No | boolean | false | Set to `true` to allow visited styles |
+
+### Slots
+
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :------- |
+| -- | Yes | -- | -- |
+
+### Events
+
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
+
+## `ListBox`
+
+### Props
+
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :---------- | :--------------- | :------- | :------------------------------------- | ---------------------- | ------------------------------------------ |
+| size | let | No | "sm" | "xl" | -- | Set the size of the list box |
+| type | let | No | "default" | "inline" | "default" | Set the type of the list box |
+| open | let | No | boolean | false | Set to `true` to open the list box |
+| light | let | No | boolean | false | Set to `true` to enable the light variant |
+| disabled | let | No | boolean | false | Set to `true` to disable the list box |
+| invalid | let | No | boolean | false | Set to `true` to indicate an invalid state |
+| invalidText | let | No | string | "" | Specify the invalid state text |
+
+### Slots
+
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :------- |
+| -- | Yes | -- | -- |
+
+### Events
+
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| keydown | forwarded | -- |
+| click | forwarded | -- |
+
+## `ListBoxField`
+
+### Types
+
+```ts
type ListBoxFieldTranslationId = "close" | "open";
```
-| Prop name | Type | Default value | Description |
-| :-------------------------- | :----------------------------------------------------- | :--------------------------------- | :------------------------------------------------ |
-| disabled | boolean | `false` | Set to `true` to disable the list box field. |
-| role | string | `"combobox"` | Specify the role attribute. |
-| tabindex | string | `"-1"` | Specify the tabindex. |
-| translationIds (`constant`) | { close: "close"; open: "open"; } | `{ close: "close", open: "open" }` | Default translation ids. |
-| translateWithId | (id: ListBoxFieldTranslationId) => string | -- | Override the default translation ids. |
-| id | string | -- | Set an id for the top-level element. |
-| ref | null | HTMLElement | `null` | Obtain a reference to the top-level HTML element. |
+### Props
+
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------------- | :----------------- | :------- | :----------------------------------------------------- | ------------------------------------------------ | ------------------------------------------------ |
+| ref | let | Yes | null | HTMLDivElement | null | Obtain a reference to the top-level HTML element |
+| disabled | let | No | boolean | false | Set to `true` to disable the list box field |
+| role | let | No | string | "combobox" | Specify the role attribute |
+| tabindex | let | No | string | "-1" | Specify the tabindex |
+| translationIds | const | No | { close: "close", open: "open" } | { close: "close", open: "open" } | Default translation ids |
+| translateWithId | let | No | (id: ListBoxFieldTranslationId) => string | (id) => defaultTranslations[id] | Override the default translation ids |
+| id | let | No | string | "ccs-" + Math.random().toString(36) | Set an id for the top-level element |
### Slots
-- **default**: `
...
`
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :------- |
+| -- | Yes | -- | -- |
-### Forwarded events
+### Events
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
-- `on:keydown`
-- `on:blur`
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
+| keydown | forwarded | -- |
+| blur | forwarded | -- |
-### Dispatched events
-
-No dispatched events.
-
----
-
-## ListBoxMenu
-
-### Import path
-
-```js
-import { ListBoxMenu } from "carbon-components-svelte";
-```
+## `ListBoxMenu`
### Props
-| Prop name | Type | Default value | Description |
-| :-------- | :-------------------------------------- | :------------ | :-------------------------------------------- |
-| id | string | -- | Set an id for the top-level element. |
-| ref | null | HTMLDivElement | `null` | Obtain a reference to the input HTML element. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------- | :--------------- | :------- | :-------------------------------------- | ------------------------------------------------ | -------------------------------------- |
+| ref | let | Yes | null | HTMLDivElement | null | Obtain a reference to the HTML element |
+| id | let | No | string | "ccs-" + Math.random().toString(36) | Set an id for the top-level element |
### Slots
-- **default**: `
...
`
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :------- |
+| -- | Yes | -- | -- |
-### Forwarded events
+### Events
-- `on:scroll`
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| scroll | forwarded | -- |
-### Dispatched events
+## `ListBoxMenuIcon`
-No dispatched events.
-
----
-
-## ListBoxMenuIcon
-
-### Import path
-
-```js
-import { ListBoxMenuIcon } from "carbon-components-svelte";
-```
-
-### Props
+### Types
```ts
-// `ListBoxMenuIcon` type definitions
-
type ListBoxMenuIconTranslationId = "close" | "open";
```
-| Prop name | Type | Default value | Description |
-| :-------------------------- | :-------------------------------------------------------- | :--------------------------------- | :-------------------------------------------- |
-| open | boolean | `false` | Set to `true` to open the list box menu icon. |
-| translationIds (`constant`) | { close: "close"; open: "open" } | `{ close: "close", open: "open" }` | Default translation ids. |
-| translateWithId | (id: ListBoxMenuIconTranslationId) => string | -- | Override the default translation ids. |
+### Props
+
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------------- | :----------------- | :------- | :-------------------------------------------------------- | --------------------------------------------- | -------------------------------------------- |
+| open | let | No | boolean | false | Set to `true` to open the list box menu icon |
+| translationIds | const | No | { close: "close", open: "open" } | { close: "close", open: "open" } | Default translation ids |
+| translateWithId | let | No | (id: ListBoxMenuIconTranslationId) => string | (id) => defaultTranslations[id] | Override the default translation ids |
### Slots
-No slots.
+None.
-### Forwarded events
+### Events
-- `on:click`
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
-### Dispatched events
-
-No dispatched events.
-
----
-
-## ListBoxMenuItem
-
-### Import path
-
-```js
-import { ListBoxMenuItem } from "carbon-components-svelte";
-```
+## `ListBoxMenuItem`
### Props
-| Prop name | Type | Default value | Description |
-| :---------- | :------------------- | :------------ | :--------------------------------------------- |
-| active | boolean | `false` | Set to `true` to enable the active state. |
-| highlighted | boolean | `false` | Set to `true` to enable the highlighted state. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :---------- | :--------------- | :------- | :------------------- | ------------------ | --------------------------------------------- |
+| active | let | No | boolean | false | Set to `true` to enable the active state |
+| highlighted | let | No | boolean | false | Set to `true` to enable the highlighted state |
### Slots
-- **default**: `
...
`
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :------- |
+| -- | Yes | -- | -- |
-### Forwarded events
+### Events
-- `on:click`
-- `on:mouseenter`
-- `on:mouseleave`
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
-### Dispatched events
+## `ListBoxSelection`
-No dispatched events.
-
----
-
-## ListBoxSelection
-
-### Import path
-
-```js
-import { ListBoxSelection } from "carbon-components-svelte";
-```
-
-### Props
+### Types
```ts
-// `ListBoxSelection` type definitions
-
type ListBoxSelectionTranslationId = "clearAll" | "clearSelection";
```
-| Prop name | Type | Default value | Description |
-| :-------------------------- | :---------------------------------------------------------------------- | :------------------------------------------------------------ | :------------------------------------------------ |
-| selectionCount | any | -- | Specify the number of selected items. |
-| disabled | boolean | `false` | Set to `true` to disable the list box selection. |
-| translationIds (`constant`) | { clearAll: "clearAll"; clearSelection: "clearSelection" } | `{ clearAll: "clearAll", clearSelection: "clearSelection", }` | Default translation ids. |
-| translateWithId | (id: ListBoxSelectionTranslationId) => string | -- | Override the default translation ids. |
-| ref | null | HTMLElement | `null` | Obtain a reference to the top-level HTML element. |
+### Props
+
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------------- | :----------------- | :------- | :----------------------------------------------------------------------- | ------------------------------------------------------------------------ | ------------------------------------------------ |
+| ref | let | Yes | null | HTMLDivElement | null | Obtain a reference to the top-level HTML element |
+| selectionCount | let | No | any | -- | Specify the number of selected items |
+| disabled | let | No | boolean | false | Set to `true` to disable the list box selection |
+| translationIds | const | No | { clearAll: "clearAll", clearSelection: "clearSelection", } | { clearAll: "clearAll", clearSelection: "clearSelection", } | Default translation ids |
+| translateWithId | let | No | (id: ListBoxSelectionTranslationId) => string | (id) => defaultTranslations[id] | Override the default translation ids |
### Slots
-No slots.
+None.
-### Forwarded events
+### Events
-No forwarded events.
+| Event name | Type | Detail |
+| :--------- | :--------- | :----- |
+| clear | dispatched | -- |
-### Dispatched events
-
-- `on:clear`
-
----
-
-## ListItem
-
-### Import path
-
-```js
-import { ListItem } from "carbon-components-svelte";
-```
+## `ListItem`
### Props
-No exported props.
+None.
### Slots
-- **default**: `
...
`
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :------- |
+| -- | Yes | -- | -- |
-### Forwarded events
+### Events
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
-### Dispatched events
-
-No dispatched events.
-
----
-
-## Loading
-
-### Import path
-
-```js
-import { Loading } from "carbon-components-svelte";
-```
+## `Loading`
### Props
-| Prop name | Type | Default value | Description |
-| :---------- | :------------------- | :--------------------------- | :------------------------------------------ |
-| small | boolean | `false` | Set to `true` to use the small variant. |
-| active | boolean | `true` | Set to `false` to disable the active state. |
-| withOverlay | boolean | `true` | Set to `false` to disable the overlay. |
-| description | string | `"Active loading indicator"` | Specify the label description. |
-| id | string | -- | Set an id for the label element. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :---------- | :--------------- | :------- | :------------------- | ------------------------------------------------ | ------------------------------------------ |
+| small | let | No | boolean | false | Set to `true` to use the small variant |
+| active | let | No | boolean | true | Set to `false` to disable the active state |
+| withOverlay | let | No | boolean | true | Set to `false` to disable the overlay |
+| description | let | No | string | "Active loading indicator" | Specify the label description |
+| id | let | No | string | "ccs-" + Math.random().toString(36) | Set an id for the label element |
### Slots
-No slots.
+None.
-### Forwarded events
+### Events
-No forwarded events.
+None.
-### Dispatched events
-
-No dispatched events.
-
----
-
-## Modal
-
-### Import path
-
-```js
-import { Modal } from "carbon-components-svelte";
-```
+## `Modal`
### Props
-| Prop name | Type | Default value | Description |
-| :------------------------- | :---------------------------------------- | :----------------------------- | :-------------------------------------------------------------------------- |
-| size | "xs" | "sm" | "lg" | -- | Set the size of the modal. |
-| open | boolean | `false` | Set to `true` to open the modal. |
-| danger | boolean | `false` | Set to `true` to use the danger variant. |
-| alert | boolean | `false` | Set to `true` to enable alert mode. |
-| passiveModal | boolean | `false` | Set to `true` to use the passive variant. |
-| modalHeading | string | -- | Specify the modal heading. |
-| modalLabel | string | -- | Specify the modal label. |
-| modalAriaLabel | string | -- | Specify the ARIA label for the modal. |
-| iconDescription | string | `"Close the modal"` | Specify the ARIA label for the close icon. |
-| hasForm | boolean | `false` | Set to `true` if the modal contains form elements. |
-| hasScrollingContent | boolean | `false` | Set to `true` if the modal contains scrolling content. |
-| primaryButtonText | string | `""` | Specify the primary button text. |
-| primaryButtonDisabled | boolean | `false` | Set to `true` to disable the primary button. |
-| shouldSubmitOnEnter | boolean | `true` | Set to `true` for the primary button to be triggered when pressing "Enter". |
-| secondaryButtonText | string | `""` | Specify the secondary button text. |
-| selectorPrimaryFocus | string | `"[data-modal-primary-focus]"` | Specify a selector to be focused when opening the modal. |
-| preventCloseOnClickOutside | boolean | `false` | Set to `true` to prevent the modal from closing when clicking outside. |
-| id | string | -- | Set an id for the top-level element. |
-| ref | null | HTMLElement | `null` | Obtain a reference to the top-level HTML element. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :------------------------- | :--------------- | :------- | :---------------------------------------- | ------------------------------------------------ | -------------------------------------------------------------------------- |
+| ref | let | Yes | null | HTMLDivElement | null | Obtain a reference to the top-level HTML element |
+| open | let | Yes | boolean | false | Set to `true` to open the modal |
+| size | let | No | "xs" | "sm" | "lg" | -- | Set the size of the modal |
+| danger | let | No | boolean | false | Set to `true` to use the danger variant |
+| alert | let | No | boolean | false | Set to `true` to enable alert mode |
+| passiveModal | let | No | boolean | false | Set to `true` to use the passive variant |
+| modalHeading | let | No | string | -- | Specify the modal heading |
+| modalLabel | let | No | string | -- | Specify the modal label |
+| modalAriaLabel | let | No | string | -- | Specify the ARIA label for the modal |
+| iconDescription | let | No | string | "Close the modal" | Specify the ARIA label for the close icon |
+| hasForm | let | No | boolean | false | Set to `true` if the modal contains form elements |
+| hasScrollingContent | let | No | boolean | false | Set to `true` if the modal contains scrolling content |
+| primaryButtonText | let | No | string | "" | Specify the primary button text |
+| primaryButtonDisabled | let | No | boolean | false | Set to `true` to disable the primary button |
+| shouldSubmitOnEnter | let | No | boolean | true | Set to `true` for the primary button to be triggered when pressing "Enter" |
+| secondaryButtonText | let | No | string | "" | Specify the secondary button text |
+| selectorPrimaryFocus | let | No | string | "[data-modal-primary-focus]" | Specify a selector to be focused when opening the modal |
+| preventCloseOnClickOutside | let | No | boolean | false | Set to `true` to prevent the modal from closing when clicking outside |
+| id | let | No | string | "ccs-" + Math.random().toString(36) | Set an id for the top-level element |
### Slots
-- **default**: `
...
`
-- **"label"**: `
...
`
-- **"heading"**: `
...
`
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :-------------------------- |
+| -- | Yes | -- | -- |
+| heading | No | -- | {modalHeading} |
+| label | No | -- | {modalLabel} |
-### Forwarded events
+### Events
-- `on:keydown`
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
+| Event name | Type | Detail |
+| :---------------------- | :--------- | :----- |
+| keydown | forwarded | -- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
+| submit | dispatched | -- |
+| click:button--secondary | dispatched | -- |
+| close | dispatched | -- |
+| open | dispatched | -- |
-### Dispatched events
-
-- `on:submit`
-- `on:click:button--secondary`
-- `on:close`
-- `on:open`
-
----
-
-## ModalBody
-
-### Import path
-
-```js
-import { ModalBody } from "carbon-components-svelte";
-```
+## `ModalBody`
### Props
-| Prop name | Type | Default value | Description |
-| :------------------ | :------------------- | :------------ | :----------------------------------------------------- |
-| hasForm | boolean | `false` | Set to `true` if the modal contains form elements. |
-| hasScrollingContent | boolean | `false` | Set to `true` if the modal contains scrolling content. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :------------------ | :--------------- | :------- | :------------------- | ------------------ | ----------------------------------------------------- |
+| hasForm | let | No | boolean | false | Set to `true` if the modal contains form elements |
+| hasScrollingContent | let | No | boolean | false | Set to `true` if the modal contains scrolling content |
### Slots
-- **default**: `
...
`
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :------- |
+| -- | Yes | -- | -- |
-### Forwarded events
+### Events
-No forwarded events.
+None.
-### Dispatched events
-
-No dispatched events.
-
----
-
-## ModalFooter
-
-### Import path
-
-```js
-import { ModalFooter } from "carbon-components-svelte";
-```
+## `ModalFooter`
### Props
-| Prop name | Type | Default value | Description |
-| :-------------------- | :------------------- | :------------ | :------------------------------------------- |
-| primaryButtonText | string | `""` | Specify the primary button text. |
-| primaryButtonDisabled | boolean | `false` | Set to `true` to disable the primary button. |
-| primaryClass | string | -- | Specify a class for the primary button. |
-| secondaryButtonText | string | `""` | Specify the secondary button text. |
-| secondaryClass | string | -- | Specify a class for the secondary button. |
-| danger | boolean | `false` | Set to `true` to use the danger variant. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------------------- | :--------------- | :------- | :------------------- | ------------------ | ------------------------------------------- |
+| primaryButtonText | let | No | string | "" | Specify the primary button text |
+| primaryButtonDisabled | let | No | boolean | false | Set to `true` to disable the primary button |
+| primaryClass | let | No | string | -- | Specify a class for the primary button |
+| secondaryButtonText | let | No | string | "" | Specify the secondary button text |
+| secondaryClass | let | No | string | -- | Specify a class for the secondary button |
+| danger | let | No | boolean | false | Set to `true` to use the danger variant |
### Slots
-- **default**: `
...
`
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :------- |
+| -- | Yes | -- | -- |
-### Forwarded events
+### Events
-No forwarded events.
+None.
-### Dispatched events
-
-No dispatched events.
-
----
-
-## ModalHeader
-
-### Import path
-
-```js
-import { ModalHeader } from "carbon-components-svelte";
-```
+## `ModalHeader`
### Props
-| Prop name | Type | Default value | Description |
-| :-------------- | :------------------ | :------------ | :----------------------------------------- |
-| title | string | `""` | Specify the modal title. |
-| label | string | `""` | Specify the modal label. |
-| labelClass | string | `""` | Specify the label class. |
-| titleClass | string | `""` | Specify the title class. |
-| closeClass | string | `""` | Specify the close class. |
-| closeIconClass | string | `""` | Specify the close icon class. |
-| iconDescription | string | `"Close"` | Specify the ARIA label for the close icon. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------------- | :--------------- | :------- | :------------------ | -------------------- | ----------------------------------------- |
+| title | let | No | string | "" | Specify the modal title |
+| label | let | No | string | "" | Specify the modal label |
+| labelClass | let | No | string | "" | Specify the label class |
+| titleClass | let | No | string | "" | Specify the title class |
+| closeClass | let | No | string | "" | Specify the close class |
+| closeIconClass | let | No | string | "" | Specify the close icon class |
+| iconDescription | let | No | string | "Close" | Specify the ARIA label for the close icon |
### Slots
-- **default**: `
...
`
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :------- |
+| -- | Yes | -- | -- |
-### Forwarded events
+### Events
-- `on:click`
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
-### Dispatched events
+## `MultiSelect`
-No dispatched events.
-
----
-
-## MultiSelect
-
-### Import path
-
-```js
-import { MultiSelect } from "carbon-components-svelte";
-```
-
-### Props
+### Types
```ts
-// `MultiSelect` type definitions
-
type MultiSelectItemId = string;
type MultiSelectItemText = string;
@@ -2716,2853 +2085,2106 @@ interface MultiSelectItem {
}
```
-| Prop name | Type | Default value | Description |
-| :---------------- | :----------------------------------------------------------------------- | :------------------- | :--------------------------------------------------------------------------------- |
-| items | MultiSelectItem[] | `[]` | Set the multiselect items. |
-| itemToString | (item: MultiSelectItem) => string | -- | Override the display of a multiselect item. |
-| selectedIds | MultiSelectItemId[] | `[]` | Set the selected ids. |
-| value | string | `""` | Specify the multiselect value. |
-| size | "sm" | "lg" | "xl" | -- | Set the size of the combobox. |
-| type | "default" | "inline" | `"default"` | Specify the type of multiselect. |
-| selectionFeedback | "top" | "fixed" | "top-after-reopen" | `"top-after-reopen"` | Specify the selection feedback after selecting items. |
-| disabled | boolean | `false` | Set to `true` to disable the dropdown. |
-| filterable | boolean | `false` | Set to `true` to filter items. |
-| filterItem | (item: MultiSelectItem, value: string) => string | -- | Override the filtering logic. The default filtering is an exact string comparison. |
-| open | boolean | `false` | Set to `true` to open the dropdown. |
-| light | boolean | `false` | Set to `true` to enable the light variant. |
-| locale | string | `"en"` | Specify the locale. |
-| placeholder | string | `""` | Specify the placeholder text. |
-| sortItem | (a: MultiSelectItem, b: MultiSelectItem) => MultiSelectItem | -- | Override the sorting logic. The default sorting compare the item text value. |
-| translateWithId | (id: any) => string | -- | Override the default translation ids. |
-| titleText | string | `""` | Specify the title text. |
-| useTitleInItem | boolean | `false` | Set to `true` to pass the item to `itemToString` in the checkbox. |
-| invalid | boolean | `false` | Set to `true` to indicate an invalid state. |
-| invalidText | string | `""` | Specify the invalid state text. |
-| helperText | string | `""` | Specify the helper text. |
-| label | string | `""` | Specify the list box label. |
-| id | string | -- | Set an id for the list box component. |
-| name | string | -- | Specify a name attribute for the select. |
+### Props
+
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :---------------- | :--------------- | :------- | :--------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
+| open | let | Yes | boolean | false | Set to `true` to open the dropdown |
+| value | let | Yes | string | "" | Specify the multiselect value |
+| selectedIds | let | Yes | MultiSelectItemId[] | [] | Set the selected ids |
+| items | let | Yes | MultiSelectItem[] | [] | Set the multiselect items |
+| itemToString | let | No | (item: MultiSelectItem) => string | (item) => item.text || item.id | Override the display of a multiselect item |
+| size | let | No | "sm" | "lg" | "xl" | -- | Set the size of the combobox |
+| type | let | No | "default" | "inline" | "default" | Specify the type of multiselect |
+| selectionFeedback | let | No | "top" | "fixed" | "top-after-reopen" | "top-after-reopen" | Specify the selection feedback after selecting items |
+| disabled | let | No | boolean | false | Set to `true` to disable the dropdown |
+| filterable | let | No | boolean | false | Set to `true` to filter items |
+| filterItem | let | No | (item: MultiSelectItem, value: string) => string | (item, value) => item.text.toLowerCase().includes(value.toLowerCase()) | Override the filtering logic The default filtering is an exact string comparison |
+| light | let | No | boolean | false | Set to `true` to enable the light variant |
+| locale | let | No | string | "en" | Specify the locale |
+| placeholder | let | No | string | "" | Specify the placeholder text |
+| sortItem | let | No | ((a: MultiSelectItem, b: MultiSelectItem) => MultiSelectItem) | (() => void) | (a, b) => a.text.localeCompare(b.text, locale, { numeric: true }) | Override the sorting logic The default sorting compare the item text value |
+| translateWithId | let | No | (id: any) => string | -- | Override the default translation ids |
+| titleText | let | No | string | "" | Specify the title text |
+| useTitleInItem | let | No | boolean | false | Set to `true` to pass the item to `itemToString` in the checkbox |
+| invalid | let | No | boolean | false | Set to `true` to indicate an invalid state |
+| invalidText | let | No | string | "" | Specify the invalid state text |
+| helperText | let | No | string | "" | Specify the helper text |
+| label | let | No | string | "" | Specify the list box label |
+| id | let | No | string | "ccs-" + Math.random().toString(36) | Set an id for the list box component |
+| name | let | No | string | -- | Specify a name attribute for the select |
### Slots
-No slots.
+None.
-### Forwarded events
+### Events
-- `on:clear`
-- `on:keydown`
-- `on:focus`
-- `on:blur`
+| Event name | Type | Detail |
+| :--------- | :--------- | :----- |
+| clear | forwarded | -- |
+| keydown | forwarded | -- |
+| focus | forwarded | -- |
+| blur | forwarded | -- |
+| select | dispatched | -- |
-### Dispatched events
-
-- `on:select`
-
----
-
-## NotificationActionButton
-
-### Import path
-
-```js
-import { NotificationActionButton } from "carbon-components-svelte";
-```
+## `NotificationActionButton`
### Props
-No exported props.
+None.
### Slots
-- **default**: `
...
`
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :------- |
+| -- | Yes | -- | -- |
-### Forwarded events
+### Events
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
-### Dispatched events
-
-No dispatched events.
-
----
-
-## NotificationButton
-
-### Import path
-
-```js
-import { NotificationButton } from "carbon-components-svelte";
-```
+## `NotificationButton`
### Props
-| Prop name | Type | Default value | Description |
-| :--------------- | :------------------------------------------------------------------ | :------------- | :----------------------------------------------------- |
-| notificationType | "toast" | "inline" | `"toast"` | Set the type of notification. |
-| renderIcon | typeof import("carbon-icons-svelte/lib/Add16").default | -- | Specify the icon from `carbon-icons-svelte` to render. |
-| title | string | -- | Specify the title of the icon. |
-| iconDescription | string | `"Close icon"` | Specify the ARIA label for the icon. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :--------------- | :--------------- | :------- | :----------------------------------------------------------- | ------------------------- | ----------------------------------------------------- |
+| notificationType | let | No | "toast" | "inline" | "toast" | Set the type of notification |
+| renderIcon | let | No | typeof import("carbon-icons-svelte").CarbonIcon | -- | Specify the icon from `carbon-icons-svelte` to render |
+| title | let | No | string | -- | Specify the title of the icon |
+| iconDescription | let | No | string | "Close icon" | Specify the ARIA label for the icon |
### Slots
-No slots.
+None.
-### Forwarded events
+### Events
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
-### Dispatched events
-
-No dispatched events.
-
----
-
-## NotificationIcon
-
-### Import path
-
-```js
-import { NotificationIcon } from "carbon-components-svelte";
-```
+## `NotificationIcon`
### Props
-| Prop name | Type | Default value | Description |
-| :--------------- | :------------------------------------------------------------------------------------------------------------- | :---------------------- | :------------------------------------- |
-| kind | "error" | "info" | "info-square" | "success" | "warning" | "warning-alt" | `"error"` | Specify the kind of notification icon. |
-| notificationType | "toast" | "inline" | `"toast"` | Set the type of notification. |
-| iconDescription | string | `"Closes notification"` | Specify the ARIA label for the icon. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :--------------- | :--------------- | :------- | :------------------------------------------------------------------------------------------------------------- | ---------------------------------- | ------------------------------------- |
+| kind | let | No | "error" | "info" | "info-square" | "success" | "warning" | "warning-alt" | "error" | Specify the kind of notification icon |
+| notificationType | let | No | "toast" | "inline" | "toast" | Set the type of notification |
+| iconDescription | let | No | string | "Closes notification" | Specify the ARIA label for the icon |
### Slots
-No slots.
+None.
-### Forwarded events
+### Events
-No forwarded events.
+None.
-### Dispatched events
-
-No dispatched events.
-
----
-
-## NotificationTextDetails
-
-### Import path
-
-```js
-import { NotificationTextDetails } from "carbon-components-svelte";
-```
+## `NotificationTextDetails`
### Props
-| Prop name | Type | Default value | Description |
-| :--------------- | :----------------------------------- | :------------ | :---------------------------- |
-| notificationType | "toast" | "inline" | `"toast"` | Set the type of notification. |
-| title | string | `"Title"` | Specify the title text. |
-| subtitle | string | `""` | Specify the subtitle text. |
-| caption | string | `"Caption"` | Specify the caption text. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :--------------- | :--------------- | :------- | :----------------------------------- | ---------------------- | ---------------------------- |
+| notificationType | let | No | "toast" | "inline" | "toast" | Set the type of notification |
+| title | let | No | string | "Title" | Specify the title text |
+| subtitle | let | No | string | "" | Specify the subtitle text |
+| caption | let | No | string | "Caption" | Specify the caption text |
### Slots
-- **default**: `
...
`
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :------- |
+| -- | Yes | -- | -- |
-### Forwarded events
+### Events
-No forwarded events.
+None.
-### Dispatched events
+## `NumberInput`
-No dispatched events.
-
----
-
-## NumberInput
-
-### Import path
-
-```js
-import { NumberInput } from "carbon-components-svelte";
-```
-
-### Props
+### Types
```ts
-// `NumberInput` type definitions
-
type NumberInputTranslationId = "increment" | "decrement";
```
-| Prop name | Type | Default value | Description |
-| :-------------------------- | :-------------------------------------------------------------- | :---------------------------------------------------- | :---------------------------------------------- |
-| size | "sm" | "xl" | -- | Set the size of the input. |
-| value | string | `""` | Specify the input value. |
-| step | number | `1` | Specify the step increment. |
-| max | number | -- | Specify the maximum value. |
-| min | number | -- | Specify the minimum value. |
-| light | boolean | `false` | Set to `true` to enable the light variant. |
-| readonly | boolean | `false` | Set to `true` for the input to be read-only. |
-| mobile | boolean | `false` | Set to `true` to enable the mobile variant. |
-| allowEmpty | boolean | `false` | Set to `true` to allow for an empty value. |
-| disabled | boolean | `false` | Set to `true` to disable the input. |
-| iconDescription | string | `""` | Specify the ARIA label for the increment icons. |
-| invalid | boolean | `false` | Set to `true` to indicate an invalid state. |
-| invalidText | string | `""` | Specify the invalid state text. |
-| helperText | string | `""` | Specify the helper text. |
-| label | string | `""` | Specify the label text. |
-| hideLabel | boolean | `false` | Set to `true` to visually hide the label text. |
-| translateWithId | (id: NumberInputTranslationId) => string | -- | Override the default translation ids. |
-| translationIds (`constant`) | { increment: "increment"; decrement: "decrement" } | `{ increment: "increment", decrement: "decrement", }` | Default translation ids. |
-| id | string | -- | Set an id for the input element. |
-| name | string | -- | Specify a name attribute for the input. |
-| ref | null | HTMLInputElement | `null` | Obtain a reference to the input HTML element. |
-
-### Slots
-
-- **"label"**: `
...
`
-
-### Forwarded events
-
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
-- `on:input`
+### Props
-### Dispatched events
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------------- | :----------------- | :------- | :-------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------- |
+| ref | let | Yes | null | HTMLInputElement | null | Obtain a reference to the input HTML element |
+| value | let | Yes | number | string | "" | Specify the input value |
+| size | let | No | "sm" | "xl" | -- | Set the size of the input |
+| step | let | No | number | 1 | Specify the step increment |
+| max | let | No | number | -- | Specify the maximum value |
+| min | let | No | number | -- | Specify the minimum value |
+| light | let | No | boolean | false | Set to `true` to enable the light variant |
+| readonly | let | No | boolean | false | Set to `true` for the input to be read-only |
+| mobile | let | No | boolean | false | Set to `true` to enable the mobile variant |
+| allowEmpty | let | No | boolean | false | Set to `true` to allow for an empty value |
+| disabled | let | No | boolean | false | Set to `true` to disable the input |
+| iconDescription | let | No | string | "" | Specify the ARIA label for the increment icons |
+| invalid | let | No | boolean | false | Set to `true` to indicate an invalid state |
+| invalidText | let | No | string | "" | Specify the invalid state text |
+| helperText | let | No | string | "" | Specify the helper text |
+| label | let | No | string | "" | Specify the label text |
+| hideLabel | let | No | boolean | false | Set to `true` to visually hide the label text |
+| translateWithId | let | No | (id: NumberInputTranslationId) => string | (id) => defaultTranslations[id] | Override the default translation ids |
+| translationIds | const | No | { increment: "increment"; decrement: "decrement" } | { increment: "increment", decrement: "decrement", } | Default translation ids |
+| id | let | No | string | "ccs-" + Math.random().toString(36) | Set an id for the input element |
+| name | let | No | string | -- | Specify a name attribute for the input |
-- `on:change`
+### Slots
----
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :------------------- |
+| label | No | -- | {label} |
-## NumberInputSkeleton
+### Events
-### Import path
+| Event name | Type | Detail |
+| :--------- | :--------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
+| input | forwarded | -- |
+| change | dispatched | -- |
-```js
-import { NumberInputSkeleton } from "carbon-components-svelte";
-```
+## `NumberInputSkeleton`
### Props
-| Prop name | Type | Default value | Description |
-| :-------- | :------------------- | :------------ | :------------------------------------ |
-| hideLabel | boolean | `false` | Set to `true` to hide the label text. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------- | :--------------- | :------- | :------------------- | ------------------ | ------------------------------------ |
+| hideLabel | let | No | boolean | false | Set to `true` to hide the label text |
### Slots
-No slots.
+None.
-### Forwarded events
+### Events
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
-### Dispatched events
-
-No dispatched events.
-
----
-
-## OrderedList
-
-### Import path
-
-```js
-import { OrderedList } from "carbon-components-svelte";
-```
+## `OrderedList`
### Props
-| Prop name | Type | Default value | Description |
-| :-------- | :------------------- | :------------ | :--------------------------------------- |
-| nested | boolean | `false` | Set to `true` to use the nested variant. |
-| native | boolean | `false` | Set to `true` to use native list styles. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------- | :--------------- | :------- | :------------------- | ------------------ | --------------------------------------- |
+| nested | let | No | boolean | false | Set to `true` to use the nested variant |
+| native | let | No | boolean | false | Set to `true` to use native list styles |
### Slots
-- **default**: `
...
`
-
-### Forwarded events
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :------- |
+| -- | Yes | -- | -- |
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
+### Events
-### Dispatched events
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
-No dispatched events.
-
----
-
-## OverflowMenu
-
-### Import path
-
-```js
-import { OverflowMenu } from "carbon-components-svelte";
-```
+## `OverflowMenu`
### Props
-| Prop name | Type | Default value | Description |
-| :--------------- | :------------------------------------------------------------------ | :--------------------------------- | :----------------------------------------------------------------- |
-| size | "sm" | "xl" | -- | Specify the size of the overflow menu. |
-| direction | "top" | "bottom" | `"bottom"` | Specify the direction of the overflow menu relative to the button. |
-| open | boolean | `false` | Set to `true` to open the menu. |
-| light | boolean | `false` | Set to `true` to enable the light variant. |
-| flipped | boolean | `false` | Set to `true` to flip the menu relative to the button. |
-| menuOptionsClass | string | -- | Specify the menu options class. |
-| icon | typeof import("carbon-icons-svelte/lib/Add16").default | -- | Specify the icon from `carbon-icons-svelte` to render. |
-| iconClass | string | -- | Specify the icon class. |
-| iconDescription | string | `"Open and close list of options"` | Specify the ARIA label for the icon. |
-| id | string | -- | Set an id for the button element. |
-| buttonRef | null | HTMLButtonElement | `null` | Obtain a reference to the trigger button element. |
-| menuRef | null | HTMLUListElement | `null` | Obtain a reference to the overflow menu element. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :--------------- | :--------------- | :------- | :----------------------------------------------------------- | ------------------------------------------------ | ----------------------------------------------------------------- |
+| menuRef | let | Yes | null | HTMLUListElement | null | Obtain a reference to the overflow menu element |
+| buttonRef | let | Yes | null | HTMLButtonElement | null | Obtain a reference to the trigger button element |
+| open | let | Yes | boolean | false | Set to `true` to open the menu |
+| size | let | No | "sm" | "xl" | -- | Specify the size of the overflow menu |
+| direction | let | No | "top" | "bottom" | "bottom" | Specify the direction of the overflow menu relative to the button |
+| light | let | No | boolean | false | Set to `true` to enable the light variant |
+| flipped | let | No | boolean | false | Set to `true` to flip the menu relative to the button |
+| menuOptionsClass | let | No | string | -- | Specify the menu options class |
+| icon | let | No | typeof import("carbon-icons-svelte").CarbonIcon | -- | Specify the icon from `carbon-icons-svelte` to render |
+| iconClass | let | No | string | -- | Specify the icon class |
+| iconDescription | let | No | string | "Open and close list of options" | Specify the ARIA label for the icon |
+| id | let | No | string | "ccs-" + Math.random().toString(36) | Set an id for the button element |
### Slots
-- **default**: `
...
`
-- **"menu"**: `
...
`
-
-### Forwarded events
-
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
-- `on:keydown`
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| -- | Yes | -- | -- |
+| menu | No | -- | <svelte:component this="{icon}" aria-label="{iconDescription}" title="{iconDescription}" class="bx--overflow-menu\_\_icon {iconClass}" /> |
-### Dispatched events
+### Events
-- `on:close`
+| Event name | Type | Detail |
+| :--------- | :--------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
+| keydown | forwarded | -- |
+| close | dispatched | -- |
----
-
-## OverflowMenuItem
-
-### Import path
-
-```js
-import { OverflowMenuItem } from "carbon-components-svelte";
-```
+## `OverflowMenuItem`
### Props
-| Prop name | Type | Default value | Description |
-| :----------- | :------------------------------------------------------------------ | :--------------- | :------------------------------------------------------------------------------- |
-| text | string | `"Provide text"` | Specify the item text. Alternatively, use the default slot for a custom element. |
-| href | string | `""` | Specify the `href` attribute if the item is a link. |
-| primaryFocus | boolean | `false` | Set to `true` if the item should be focused when opening the menu. |
-| disabled | boolean | `false` | Set to `true` to disable the item. |
-| hasDivider | boolean | `false` | Set to `true` to include a divider. |
-| danger | boolean | `false` | Set to `true` to use the danger variant. |
-| requireTitle | boolean | `true` | Set to `false` to omit the button `title` attribute. |
-| id | string | -- | Set an id for the top-level element. |
-| ref | null | HTMLAnchorElement | HTMLButtonElement | `null` | Obtain a reference to the HTML element. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :----------- | :--------------- | :------- | :------------------------------------------------------------------ | ------------------------------------------------ | ----------------------------------------------------------------------------------- |
+| ref | let | Yes | null | HTMLAnchorElement | HTMLButtonElement | null | Obtain a reference to the HTML element |
+| primaryFocus | let | Yes | boolean | false | Set to `true` if the item should be focused when opening the menu |
+| text | let | No | string | "Provide text" | Specify the item text Alternatively, use the default slot for a custom element |
+| href | let | No | string | "" | Specify the `href` attribute if the item is a link |
+| disabled | let | No | boolean | false | Set to `true` to disable the item |
+| hasDivider | let | No | boolean | false | Set to `true` to include a divider |
+| danger | let | No | boolean | false | Set to `true` to use the danger variant |
+| requireTitle | let | No | boolean | true | Set to `false` to omit the button `title` attribute |
+| id | let | No | string | "ccs-" + Math.random().toString(36) | Set an id for the top-level element |
### Slots
-- **default**: `
...
`
-
-### Forwarded events
-
-- `on:click`
-- `on:keydown`
-
-### Dispatched events
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :------------------------------------------------------------------------------------------------------------------ |
+| -- | Yes | -- | <div class:bx--overflow-menu-options\_\_option-content="{true}"> {text} </div> |
-No dispatched events.
+### Events
----
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+| keydown | forwarded | -- |
-## Pagination
-
-### Import path
-
-```js
-import { Pagination } from "carbon-components-svelte";
-```
+## `Pagination`
### Props
-| Prop name | Type | Default value | Description |
-| :-------------------- | :--------------------------------------------------------------- | :------------------ | :------------------------------------------------ |
-| page | number | `1` | Specify the current page index. |
-| totalItems | number | `0` | Specify the total number of items. |
-| disabled | boolean | `false` | Set to `true` to disable the pagination. |
-| forwardText | string | `"Next page"` | Specify the forward button text. |
-| backwardText | string | `"Previous page"` | Specify the backward button text. |
-| itemsPerPageText | string | `"Items per page:"` | Specify the items per page text. |
-| itemText | (min: number, max: number) => string | -- | Override the item text. |
-| itemRangeText | (min: number, max: number, total: number) => string | -- | Override the item range text. |
-| pageInputDisabled | boolean | `false` | Set to `true` to disable the page input. |
-| pageSizeInputDisabled | boolean | `false` | Set to `true` to disable the page size input. |
-| pageSize | number | `10` | Specify the number of items to display in a page. |
-| pageSizes | number[] | `[10]` | Specify the available page sizes. |
-| pagesUnknown | boolean | `false` | Set to `true` if the number of pages is unknown. |
-| pageText | (page: number) => string | -- | Override the page text. |
-| pageRangeText | (current: number, total: number) => string | -- | Override the page range text. |
-| id | string | -- | Set an id for the top-level element. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------------------- | :--------------- | :------- | :--------------------------------------------------------------- | ------------------------------------------------------------------------------ | ------------------------------------------------ |
+| pageSize | let | Yes | number | 10 | Specify the number of items to display in a page |
+| page | let | Yes | number | 1 | Specify the current page index |
+| totalItems | let | No | number | 0 | Specify the total number of items |
+| disabled | let | No | boolean | false | Set to `true` to disable the pagination |
+| forwardText | let | No | string | "Next page" | Specify the forward button text |
+| backwardText | let | No | string | "Previous page" | Specify the backward button text |
+| itemsPerPageText | let | No | string | "Items per page:" | Specify the items per page text |
+| itemText | let | No | (min: number, max: number) => string | (min, max) => \`${min}–${max} items\` | Override the item text |
+| itemRangeText | let | No | (min: number, max: number, total: number) => string | (min, max, total) => \`${min}–${max} of \${total} items\` | Override the item range text |
+| pageInputDisabled | let | No | boolean | false | Set to `true` to disable the page input |
+| pageSizeInputDisabled | let | No | boolean | false | Set to `true` to disable the page size input |
+| pageSizes | let | No | number[] | [10] | Specify the available page sizes |
+| pagesUnknown | let | No | boolean | false | Set to `true` if the number of pages is unknown |
+| pageText | let | No | (page: number) => string | (page) => \`page \${page}\` | Override the page text |
+| pageRangeText | let | No | (current: number, total: number) => string | (current, total) => \`of ${total} page${total === 1 ? "" : "s"}\` | Override the page range text |
+| id | let | No | string | "ccs-" + Math.random().toString(36) | Set an id for the top-level element |
### Slots
-No slots.
-
-### Forwarded events
-
-No forwarded events.
-
-### Dispatched events
-
-- `on:update`
+None.
----
+### Events
-## PaginationNav
+| Event name | Type | Detail |
+| :--------- | :--------- | :----- |
+| update | dispatched | -- |
-### Import path
-
-```js
-import { PaginationNav } from "carbon-components-svelte";
-```
+## `PaginationNav`
### Props
-| Prop name | Type | Default value | Description |
-| :----------- | :------------------- | :---------------- | :----------------------------------------- |
-| page | number | `0` | Specify the current page index. |
-| total | number | `10` | Specify the total number of pages. |
-| shown | number | `10` | Specify the total number of pages to show. |
-| loop | boolean | `false` | Set to `true` to loop the navigation. |
-| forwardText | string | `"Next page"` | Specify the forward button text. |
-| backwardText | string | `"Previous page"` | Specify the backward button text. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :----------- | :--------------- | :------- | :------------------- | ---------------------------- | ----------------------------------------- |
+| page | let | Yes | number | 0 | Specify the current page index |
+| total | let | No | number | 10 | Specify the total number of pages |
+| shown | let | No | number | 10 | Specify the total number of pages to show |
+| loop | let | No | boolean | false | Set to `true` to loop the navigation |
+| forwardText | let | No | string | "Next page" | Specify the forward button text |
+| backwardText | let | No | string | "Previous page" | Specify the backward button text |
### Slots
-No slots.
-
-### Forwarded events
-
-No forwarded events.
-
-### Dispatched events
-
-- `on:click:button--previous`
-- `on:click:button--next`
-- `on:change`
-
----
+None.
-## PaginationSkeleton
+### Events
-### Import path
+| Event name | Type | Detail |
+| :--------------------- | :--------- | :----- |
+| click:button--previous | dispatched | -- |
+| click:button--next | dispatched | -- |
+| change | dispatched | -- |
-```js
-import { PaginationSkeleton } from "carbon-components-svelte";
-```
+## `PaginationSkeleton`
### Props
-No exported props.
+None.
### Slots
-No slots.
+None.
-### Forwarded events
+### Events
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
-### Dispatched events
-
-No dispatched events.
-
----
-
-## PasswordInput
-
-### Import path
-
-```js
-import { PasswordInput } from "carbon-components-svelte";
-```
+## `PasswordInput`
### Props
-| Prop name | Type | Default value | Description |
-| :---------------- | :-------------------------------------------------------------- | :---------------- | :----------------------------------------------------- |
-| size | "sm" | "xl" | -- | Set the size of the input. |
-| value | string | `""` | Specify the input value. |
-| type | string | `"password"` | Specify the input type. |
-| placeholder | string | `""` | Specify the placeholder text. |
-| hidePasswordLabel | string | `"Hide password"` | Specify the hide password label text. |
-| showPasswordLabel | string | `"Show password"` | Specify the show password label text. |
-| tooltipAlignment | "start" | "center" | "end" | -- | Set the alignment of the tooltip relative to the icon. |
-| tooltipPosition | "top" | "right" | "bottom" | "left" | -- | Set the position of the tooltip relative to the icon. |
-| light | boolean | `false` | Set to `true` to enable the light variant. |
-| disabled | boolean | `false` | Set to `true` to disable the input. |
-| helperText | string | `""` | Specify the helper text. |
-| labelText | string | `""` | Specify the label text. |
-| hideLabel | boolean | `false` | Set to `true` to visually hide the label text. |
-| invalid | boolean | `false` | Set to `true` to indicate an invalid state. |
-| invalidText | string | `""` | Specify the text for the invalid state. |
-| id | string | -- | Set an id for the input element. |
-| name | string | -- | Specify a name attribute for the input. |
-| ref | null | HTMLInputElement | `null` | Obtain a reference to the input HTML element. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :---------------- | :--------------- | :------- | :-------------------------------------------------------------- | ------------------------------------------------ | ----------------------------------------------------- |
+| ref | let | Yes | null | HTMLInputElement | null | Obtain a reference to the input HTML element |
+| type | let | Yes | "text" | "password" | "password" | Set to `"text"` to toggle the password visibility |
+| value | let | Yes | number | string | "" | Specify the input value |
+| size | let | No | "sm" | "xl" | -- | Set the size of the input |
+| placeholder | let | No | string | "" | Specify the placeholder text |
+| hidePasswordLabel | let | No | string | "Hide password" | Specify the hide password label text |
+| showPasswordLabel | let | No | string | "Show password" | Specify the show password label text |
+| tooltipAlignment | let | No | "start" | "center" | "end" | -- | Set the alignment of the tooltip relative to the icon |
+| tooltipPosition | let | No | "top" | "right" | "bottom" | "left" | -- | Set the position of the tooltip relative to the icon |
+| light | let | No | boolean | false | Set to `true` to enable the light variant |
+| disabled | let | No | boolean | false | Set to `true` to disable the input |
+| helperText | let | No | string | "" | Specify the helper text |
+| labelText | let | No | string | "" | Specify the label text |
+| hideLabel | let | No | boolean | false | Set to `true` to visually hide the label text |
+| invalid | let | No | boolean | false | Set to `true` to indicate an invalid state |
+| invalidText | let | No | string | "" | Specify the text for the invalid state |
+| id | let | No | string | "ccs-" + Math.random().toString(36) | Set an id for the input element |
+| name | let | No | string | -- | Specify a name attribute for the input |
### Slots
-No slots.
-
-### Forwarded events
+None.
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
-- `on:change`
-- `on:input`
-- `on:keydown`
-- `on:focus`
-- `on:blur`
+### Events
-### Dispatched events
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
+| change | forwarded | -- |
+| input | forwarded | -- |
+| keydown | forwarded | -- |
+| focus | forwarded | -- |
+| blur | forwarded | -- |
-No dispatched events.
-
----
-
-## ProgressIndicator
-
-### Import path
-
-```js
-import { ProgressIndicator } from "carbon-components-svelte";
-```
+## `ProgressIndicator`
### Props
-| Prop name | Type | Default value | Description |
-| :------------------- | :------------------- | :------------ | :---------------------------------------------------------------------------------------------- |
-| currentIndex | number | `0` | Specify the current step index. |
-| vertical | boolean | `false` | Set to `true` to use the vertical variant. |
-| spaceEqually | boolean | `false` | Set to `true` to specify whether the progress steps should be split equally in size in the div. |
-| preventChangeOnClick | boolean | `false` | Set to `true` to prevent updating `currentIndex`. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :------------------- | :--------------- | :------- | :------------------- | ------------------ | ---------------------------------------------------------------------------------------------- |
+| currentIndex | let | Yes | number | 0 | Specify the current step index |
+| vertical | let | No | boolean | false | Set to `true` to use the vertical variant |
+| spaceEqually | let | No | boolean | false | Set to `true` to specify whether the progress steps should be split equally in size in the div |
+| preventChangeOnClick | let | No | boolean | false | Set to `true` to prevent updating `currentIndex` |
### Slots
-- **default**: `
...
`
-
-### Forwarded events
-
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :------- |
+| -- | Yes | -- | -- |
-### Dispatched events
+### Events
-- `on:change`
+| Event name | Type | Detail |
+| :--------- | :--------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
+| change | dispatched | -- |
----
-
-## ProgressIndicatorSkeleton
-
-### Import path
-
-```js
-import { ProgressIndicatorSkeleton } from "carbon-components-svelte";
-```
+## `ProgressIndicatorSkeleton`
### Props
-| Prop name | Type | Default value | Description |
-| :-------- | :------------------- | :------------ | :----------------------------------------- |
-| vertical | boolean | `false` | Set to `true` to use the vertical variant. |
-| count | number | `4` | Specify the number of steps to render. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------- | :--------------- | :------- | :------------------- | ------------------ | ----------------------------------------- |
+| vertical | let | No | boolean | false | Set to `true` to use the vertical variant |
+| count | let | No | number | 4 | Specify the number of steps to render |
### Slots
-No slots.
-
-### Forwarded events
-
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
-
-### Dispatched events
-
-No dispatched events.
+None.
----
+### Events
-## ProgressStep
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
-### Import path
-
-```js
-import { ProgressStep } from "carbon-components-svelte";
-```
+## `ProgressStep`
### Props
-| Prop name | Type | Default value | Description |
-| :------------- | :------------------- | :------------ | :------------------------------------------ |
-| complete | boolean | `false` | Set to `true` for the complete variant. |
-| current | boolean | `false` | Set to `true` to use the current variant. |
-| disabled | boolean | `false` | Set to `true` to disable the progress step. |
-| invalid | boolean | `false` | Set to `true` to indicate an invalid state. |
-| description | string | `""` | Specify the step description. |
-| label | string | `""` | Specify the step label. |
-| secondaryLabel | string | `""` | Specify the step secondary label. |
-| id | string | -- | Set an id for the top-level element. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :------------- | :--------------- | :------- | :------------------- | ------------------------------------------------ | ------------------------------------------ |
+| current | let | Yes | boolean | false | Set to `true` to use the current variant |
+| complete | let | Yes | boolean | false | Set to `true` for the complete variant |
+| disabled | let | No | boolean | false | Set to `true` to disable the progress step |
+| invalid | let | No | boolean | false | Set to `true` to indicate an invalid state |
+| description | let | No | string | "" | Specify the step description |
+| label | let | No | string | "" | Specify the step label |
+| secondaryLabel | let | No | string | "" | Specify the step secondary label |
+| id | let | No | string | "ccs-" + Math.random().toString(36) | Set an id for the top-level element |
### Slots
-- **default**: `
...
`
-
-### Forwarded events
-
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
-- `on:keydown`
-
-### Dispatched events
-
-No dispatched events.
-
----
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :------------------------------------------------------- | :------------------------------------------------------------------------ |
+| -- | Yes | { props: { class: 'bx--progress-label' } } | <p class:bx--progress-label="{true}">{label}</p> |
-## RadioButton
+### Events
-### Import path
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
+| keydown | forwarded | -- |
-```js
-import { RadioButton } from "carbon-components-svelte";
-```
+## `RadioButton`
### Props
-| Prop name | Type | Default value | Description |
-| :------------ | :---------------------------------------- | :------------ | :----------------------------------------------- |
-| value | string | `""` | Specify the value of the radio button. |
-| checked | boolean | `false` | Set to `true` to check the radio button. |
-| disabled | boolean | `false` | Set to `true` to disable the radio button. |
-| labelPosition | "right" | "left" | `"right"` | Specify the label position. |
-| labelText | string | `""` | Specify the label text. |
-| hideLabel | boolean | `false` | Set to `true` to visually hide the label text. |
-| id | string | -- | Set an id for the input element. |
-| name | string | `""` | Specify a name attribute for the checkbox input. |
-| ref | null | HTMLInputElement | `null` | Obtain a reference to the input HTML element. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :------------ | :--------------- | :------- | :---------------------------------------- | ------------------------------------------------ | ----------------------------------------------- |
+| ref | let | Yes | null | HTMLInputElement | null | Obtain a reference to the input HTML element |
+| checked | let | Yes | boolean | false | Set to `true` to check the radio button |
+| value | let | No | string | "" | Specify the value of the radio button |
+| disabled | let | No | boolean | false | et to `true` to disable the radio button |
+| labelPosition | let | No | "right" | "left" | "right" | Specify the label position |
+| labelText | let | No | string | "" | Specify the label text |
+| hideLabel | let | No | boolean | false | Set to `true` to visually hide the label text |
+| id | let | No | string | "ccs-" + Math.random().toString(36) | Set an id for the input element |
+| name | let | No | string | "" | Specify a name attribute for the checkbox input |
### Slots
-No slots.
+None.
-### Forwarded events
+### Events
-- `on:change`
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| change | forwarded | -- |
-### Dispatched events
-
-No dispatched events.
-
----
-
-## RadioButtonGroup
-
-### Import path
-
-```js
-import { RadioButtonGroup } from "carbon-components-svelte";
-```
+## `RadioButtonGroup`
### Props
-| Prop name | Type | Default value | Description |
-| :------------ | :------------------------------------------ | :------------- | :-------------------------------------------- |
-| selected | string | -- | Set the selected radio button value. |
-| disabled | boolean | `false` | Set to `true` to disable the radio buttons. |
-| labelPosition | "right" | "left" | `"right"` | Specify the label position. |
-| orientation | "horizontal" | "vertical" | `"horizontal"` | Specify the orientation of the radio buttons. |
-| id | string | -- | Set an id for the container div element. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :------------ | :--------------- | :------- | :------------------------------------------ | ------------------------- | -------------------------------------------- |
+| selected | let | Yes | string | -- | Set the selected radio button value |
+| disabled | let | No | boolean | false | Set to `true` to disable the radio buttons |
+| labelPosition | let | No | "right" | "left" | "right" | Specify the label position |
+| orientation | let | No | "horizontal" | "vertical" | "horizontal" | Specify the orientation of the radio buttons |
+| id | let | No | string | -- | Set an id for the container div element |
### Slots
-- **default**: `
...
`
-
-### Forwarded events
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :------- |
+| -- | Yes | -- | -- |
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
+### Events
-### Dispatched events
+| Event name | Type | Detail |
+| :--------- | :--------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
+| change | dispatched | -- |
-- `on:change`
-
----
-
-## RadioButtonSkeleton
-
-### Import path
-
-```js
-import { RadioButtonSkeleton } from "carbon-components-svelte";
-```
+## `RadioButtonSkeleton`
### Props
-No exported props.
+None.
### Slots
-No slots.
-
-### Forwarded events
-
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
+None.
-### Dispatched events
+### Events
-No dispatched events.
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
----
-
-## RadioTile
-
-### Import path
-
-```js
-import { RadioTile } from "carbon-components-svelte";
-```
+## `RadioTile`
### Props
-| Prop name | Type | Default value | Description |
-| :-------------- | :------------------- | :----------------- | :-------------------------------------------------------- |
-| checked | boolean | `false` | Set to `true` to check the tile. |
-| light | boolean | `false` | Set to `true` to enable the light variant. |
-| value | string | `""` | Specify the value of the radio input. |
-| tabindex | string | `"0"` | Specify the tabindex. |
-| iconDescription | string | `"Tile checkmark"` | Specify the ARIA label for the radio tile checkmark icon. |
-| id | string | -- | Set an id for the input element. |
-| name | string | `""` | Specify a name attribute for the input. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------------- | :--------------- | :------- | :------------------- | ------------------------------------------------ | -------------------------------------------------------- |
+| checked | let | Yes | boolean | false | Set to `true` to check the tile |
+| light | let | No | boolean | false | Set to `true` to enable the light variant |
+| value | let | No | string | "" | Specify the value of the radio input |
+| tabindex | let | No | string | "0" | Specify the tabindex |
+| iconDescription | let | No | string | "Tile checkmark" | Specify the ARIA label for the radio tile checkmark icon |
+| id | let | No | string | "ccs-" + Math.random().toString(36) | Set an id for the input element |
+| name | let | No | string | "" | Specify a name attribute for the input |
### Slots
-- **default**: `
...
`
-
-### Forwarded events
-
-- `on:change`
-- `on:keydown`
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
-
-### Dispatched events
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :------- |
+| -- | Yes | -- | -- |
-No dispatched events.
+### Events
----
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| change | forwarded | -- |
+| keydown | forwarded | -- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
-## Row
-
-### Import path
-
-```js
-import { Row } from "carbon-components-svelte";
-```
+## `Row`
### Props
-| Prop name | Type | Default value | Description |
-| :------------ | :------------------- | :------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| as | boolean | `false` | Set to `true` to render a custom HTML element. Props are destructured as `props` in the default slot (e.g. <Row let:props><section {...props}>...</section></Row>). |
-| condensed | boolean | `false` | Set to `true` to use the condensed variant. |
-| narrow | boolean | `false` | Set to `true` to use the narrow variant. |
-| noGutter | boolean | `false` | Set to `true` to remove the gutter. |
-| noGutterLeft | boolean | `false` | Set to `true` to remove the left gutter. |
-| noGutterRight | boolean | `false` | Set to `true` to remove the right gutter. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :------------ | :--------------- | :------- | :------------------- | ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| as | let | No | boolean | false | Set to `true` to render a custom HTML element Props are destructured as `props` in the default slot (e.g. <Row let:props><section {...props}>...</section></Row>) |
+| condensed | let | No | boolean | false | Set to `true` to use the condensed variant |
+| narrow | let | No | boolean | false | Set to `true` to use the narrow variant |
+| noGutter | let | No | boolean | false | Set to `true` to remove the gutter |
+| noGutterLeft | let | No | boolean | false | Set to `true` to remove the left gutter |
+| noGutterRight | let | No | boolean | false | Set to `true` to remove the right gutter |
### Slots
-- **default**: `
...
`
-
-### Forwarded events
-
-No forwarded events.
-
-### Dispatched events
-
-No dispatched events.
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :-------------------------------------------------------------- | :------- |
+| -- | Yes | { props: { class: string; [key: string]: any; } } | -- |
----
+### Events
-## Search
+None.
-### Import path
-
-```js
-import { Search } from "carbon-components-svelte";
-```
+## `Search`
### Props
-| Prop name | Type | Default value | Description |
-| :------------------- | :---------------------------------------- | :--------------------- | :------------------------------------------------------- |
-| small | boolean | `false` | . |
-| size | "sm" | "lg" | "xl" | `"xl"` | Specify the size of the search input. |
-| skeleton | boolean | `false` | Set to `true` to display the skeleton state. |
-| light | boolean | `false` | Set to `true` to enable the light variant. |
-| disabled | boolean | `false` | Set to `true` to disable the search input. |
-| value | string | `""` | Specify the value of the search input. |
-| type | string | `"text"` | Specify the `type` attribute of the search input. |
-| placeholder | string | `"Search..."` | Specify the `placeholder` attribute of the search input. |
-| autocomplete | "on" | "off" | `"off"` | Specify the `autocomplete` attribute. |
-| autofocus | boolean | `false` | Set to `true` to auto focus the search element. |
-| closeButtonLabelText | string | `"Clear search input"` | Specify the close button label text. |
-| labelText | string | `""` | Specify the label text. |
-| id | string | -- | Set an id for the input element. |
-| ref | null | HTMLInputElement | `null` | Obtain a reference to the input HTML element. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :------------------- | :--------------- | :------- | :---------------------------------------- | ------------------------------------------------ | ------------------------------------------------------- |
+| ref | let | Yes | null | HTMLInputElement | null | Obtain a reference to the input HTML element |
+| value | let | Yes | string | "" | Specify the value of the search input |
+| small | let | No | boolean | false | -- |
+| size | let | No | "sm" | "lg" | "xl" | "xl" | Specify the size of the search input |
+| skeleton | let | No | boolean | false | Set to `true` to display the skeleton state |
+| light | let | No | boolean | false | Set to `true` to enable the light variant |
+| disabled | let | No | boolean | false | Set to `true` to disable the search input |
+| type | let | No | string | "text" | Specify the `type` attribute of the search input |
+| placeholder | let | No | string | "Search..." | Specify the `placeholder` attribute of the search input |
+| autocomplete | let | No | "on" | "off" | "off" | Specify the `autocomplete` attribute |
+| autofocus | let | No | boolean | false | Set to `true` to auto focus the search element |
+| closeButtonLabelText | let | No | string | "Clear search input" | Specify the close button label text |
+| labelText | let | No | string | "" | Specify the label text |
+| id | let | No | string | "ccs-" + Math.random().toString(36) | Set an id for the input element |
### Slots
-No slots.
-
-### Forwarded events
-
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
-- `on:change`
-- `on:input`
-- `on:focus`
-- `on:blur`
-
-### Dispatched events
-
-- `on:clear`
-
----
+None.
-## SearchSkeleton
+### Events
-### Import path
+| Event name | Type | Detail |
+| :--------- | :--------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
+| change | forwarded | -- |
+| input | forwarded | -- |
+| focus | forwarded | -- |
+| blur | forwarded | -- |
+| clear | dispatched | -- |
-```js
-import { SearchSkeleton } from "carbon-components-svelte";
-```
+## `SearchSkeleton`
### Props
-| Prop name | Type | Default value | Description |
-| :-------- | :---------------------------------------- | :------------ | :------------------------------------ |
-| small | boolean | `false` | . |
-| size | "sm" | "lg" | "xl" | `"xl"` | Specify the size of the search input. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------- | :--------------- | :------- | :---------------------------------------- | ------------------ | ------------------------------------ |
+| small | let | No | boolean | false | -- |
+| size | let | No | "sm" | "lg" | "xl" | "xl" | Specify the size of the search input |
### Slots
-No slots.
+None.
-### Forwarded events
+### Events
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
-### Dispatched events
-
-No dispatched events.
-
----
-
-## Select
-
-### Import path
-
-```js
-import { Select } from "carbon-components-svelte";
-```
+## `Select`
### Props
-| Prop name | Type | Default value | Description |
-| :---------- | :----------------------------------------- | :------------ | :----------------------------------------------- |
-| selected | string | -- | Specify the selected item value. |
-| size | "sm" | "xl" | -- | Set the size of the select input. |
-| inline | boolean | `false` | Set to `true` to use the inline variant. |
-| light | boolean | `false` | Set to `true` to enable the light variant. |
-| disabled | boolean | `false` | Set to `true` to disable the select element. |
-| id | string | -- | Set an id for the select element. |
-| name | string | -- | Specify a name attribute for the select element. |
-| invalid | boolean | `false` | Set to `true` to indicate an invalid state. |
-| invalidText | string | `""` | Specify the invalid state text. |
-| helperText | string | `""` | Specify the helper text. |
-| noLabel | boolean | `false` | Set to `true` to not render a label. |
-| labelText | string | `""` | Specify the label text. |
-| hideLabel | boolean | `false` | Set to `true` to visually hide the label text. |
-| ref | null | HTMLSelectElement | `null` | Obtain a reference to the select HTML element. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :---------- | :--------------- | :------- | :----------------------------------------- | ------------------------------------------------ | ----------------------------------------------- |
+| ref | let | Yes | null | HTMLSelectElement | null | Obtain a reference to the select HTML element |
+| selected | let | Yes | string | -- | Specify the selected item value |
+| size | let | No | "sm" | "xl" | -- | Set the size of the select input |
+| inline | let | No | boolean | false | Set to `true` to use the inline variant |
+| light | let | No | boolean | false | Set to `true` to enable the light variant |
+| disabled | let | No | boolean | false | Set to `true` to disable the select element |
+| id | let | No | string | "ccs-" + Math.random().toString(36) | Set an id for the select element |
+| name | let | No | string | -- | Specify a name attribute for the select element |
+| invalid | let | No | boolean | false | Set to `true` to indicate an invalid state |
+| invalidText | let | No | string | "" | Specify the invalid state text |
+| helperText | let | No | string | "" | Specify the helper text |
+| noLabel | let | No | boolean | false | Set to `true` to not render a label |
+| labelText | let | No | string | "" | Specify the label text |
+| hideLabel | let | No | boolean | false | Set to `true` to visually hide the label text |
### Slots
-- **default**: `
...
`
-
-### Forwarded events
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :------- |
+| -- | Yes | -- | -- |
-- `on:blur`
+### Events
-### Dispatched events
+| Event name | Type | Detail |
+| :--------- | :--------- | :----- |
+| blur | forwarded | -- |
+| change | dispatched | -- |
-- `on:change`
-
----
-
-## SelectItem
-
-### Import path
-
-```js
-import { SelectItem } from "carbon-components-svelte";
-```
+## `SelectItem`
### Props
-| Prop name | Type | Default value | Description |
-| :-------- | :------------------- | :------------ | :----------------------------------- |
-| value | string | `""` | Specify the option value. |
-| text | string | `""` | Specify the option text. |
-| hidden | boolean | `false` | Set to `true` to hide the option. |
-| disabled | boolean | `false` | Set to `true` to disable the option. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------- | :--------------- | :------- | :------------------- | ------------------ | ----------------------------------- |
+| value | let | No | string | "" | Specify the option value |
+| text | let | No | string | "" | Specify the option text |
+| hidden | let | No | boolean | false | Set to `true` to hide the option |
+| disabled | let | No | boolean | false | Set to `true` to disable the option |
### Slots
-No slots.
-
-### Forwarded events
-
-No forwarded events.
-
-### Dispatched events
+None.
-No dispatched events.
+### Events
----
+None.
-## SelectItemGroup
-
-### Import path
-
-```js
-import { SelectItemGroup } from "carbon-components-svelte";
-```
+## `SelectItemGroup`
### Props
-| Prop name | Type | Default value | Description |
-| :-------- | :------------------- | :---------------- | :--------------------------------------------------- |
-| disabled | boolean | `false` | Set to `true` to disable the optgroup element. |
-| label | string | `"Provide label"` | Specify the label attribute of the optgroup element. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------- | :--------------- | :------- | :------------------- | ---------------------------- | --------------------------------------------------- |
+| disabled | let | No | boolean | false | Set to `true` to disable the optgroup element |
+| label | let | No | string | "Provide label" | Specify the label attribute of the optgroup element |
### Slots
-- **default**: `
...
`
-
-### Forwarded events
-
-No forwarded events.
-
-### Dispatched events
-
-No dispatched events.
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :------- |
+| -- | Yes | -- | -- |
----
+### Events
-## SelectSkeleton
+None.
-### Import path
-
-```js
-import { SelectSkeleton } from "carbon-components-svelte";
-```
+## `SelectSkeleton`
### Props
-| Prop name | Type | Default value | Description |
-| :-------- | :------------------- | :------------ | :------------------------------------ |
-| hideLabel | boolean | `false` | Set to `true` to hide the label text. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------- | :--------------- | :------- | :------------------- | ------------------ | ------------------------------------ |
+| hideLabel | let | No | boolean | false | Set to `true` to hide the label text |
### Slots
-No slots.
-
-### Forwarded events
-
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
-
-### Dispatched events
-
-No dispatched events.
-
----
+None.
-## SelectableTile
+### Events
-### Import path
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
-```js
-import { SelectableTile } from "carbon-components-svelte";
-```
+## `SelectableTile`
### Props
-| Prop name | Type | Default value | Description |
-| :-------------- | :---------------------------------------- | :----------------- | :------------------------------------------------------------- |
-| selected | boolean | `false` | Set to `true` to select the tile. |
-| light | boolean | `false` | Set to `true` to enable the light variant. |
-| title | string | `"title"` | Specify the title of the selectable tile. |
-| value | string | `"value"` | Specify the value of the selectable tile. |
-| tabindex | string | `"0"` | Specify the tabindex. |
-| iconDescription | string | `"Tile checkmark"` | Specify the ARIA label for the selectable tile checkmark icon. |
-| id | string | -- | Set an id for the input element. |
-| name | string | `""` | Specify a name attribute for the input. |
-| ref | null | HTMLInputElement | `null` | Obtain a reference to the input HTML element. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------------- | :--------------- | :------- | :---------------------------------------- | ------------------------------------------------ | ------------------------------------------------------------- |
+| ref | let | Yes | null | HTMLInputElement | null | Obtain a reference to the input HTML element |
+| selected | let | Yes | boolean | false | Set to `true` to select the tile |
+| light | let | No | boolean | false | Set to `true` to enable the light variant |
+| title | let | No | string | "title" | Specify the title of the selectable tile |
+| value | let | No | string | "value" | Specify the value of the selectable tile |
+| tabindex | let | No | string | "0" | Specify the tabindex |
+| iconDescription | let | No | string | "Tile checkmark" | Specify the ARIA label for the selectable tile checkmark icon |
+| id | let | No | string | "ccs-" + Math.random().toString(36) | Set an id for the input element |
+| name | let | No | string | "" | Specify a name attribute for the input |
### Slots
-- **default**: `
...
`
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :------- |
+| -- | Yes | -- | -- |
-### Forwarded events
+### Events
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
-- `on:keydown`
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
+| keydown | forwarded | -- |
-### Dispatched events
-
-No dispatched events.
-
----
-
-## SideNav
-
-### Import path
-
-```js
-import { SideNav } from "carbon-components-svelte";
-```
+## `SideNav`
### Props
-| Prop name | Type | Default value | Description |
-| :-------- | :------------------- | :------------ | :------------------------------------------ |
-| fixed | boolean | `false` | Set to `true` to use the fixed variant. |
-| ariaLabel | string | -- | Specify the ARIA label for the nav. |
-| isOpen | boolean | `false` | Set to `true` to toggle the expanded state. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------- | :--------------- | :------- | :------------------- | ------------------ | ------------------------------------------ |
+| isOpen | let | Yes | boolean | false | Set to `true` to toggle the expanded state |
+| fixed | let | No | boolean | false | Set to `true` to use the fixed variant |
+| ariaLabel | let | No | string | -- | Specify the ARIA label for the nav |
### Slots
-- **default**: `
`
-
-### Forwarded events
-
-No forwarded events.
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :------- |
+| -- | Yes | -- | -- |
-### Dispatched events
+### Events
-No dispatched events.
+None.
----
-
-## SideNavLink
-
-### Import path
-
-```js
-import { SideNavLink } from "carbon-components-svelte";
-```
+## `SideNavLink`
### Props
-| Prop name | Type | Default value | Description |
-| :--------- | :-------------------------------------------------------------------------------------------------- | :------------ | :--------------------------------------------- |
-| isSelected | boolean | `false` | Set to `true` to select the current link. |
-| href | string | -- | Specify the `href` attribute. |
-| text | string | -- | Specify the text. |
-| icon | { render: typeof import("carbon-icons-svelte/lib/Add16").default; skeleton: boolean; } | -- | Specify the icon props. |
-| ref | null | HTMLAnchorElement | `null` | Obtain a reference to the HTML anchor element. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :--------- | :--------------- | :------- | :------------------------------------------------------------------------------------ | ------------------ | --------------------------------------------- |
+| ref | let | Yes | null | HTMLAnchorElement | null | Obtain a reference to the HTML anchor element |
+| isSelected | let | No | boolean | false | Set to `true` to select the current link |
+| href | let | No | string | -- | Specify the `href` attribute |
+| text | let | No | string | -- | Specify the text |
+| icon | let | No | { render: import("carbon-icons-svelte").CarbonIcon; skeleton: boolean; } | -- | Specify the icon props |
### Slots
-No slots.
-
-### Forwarded events
-
-- `on:click`
-
-### Dispatched events
+None.
-No dispatched events.
+### Events
----
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
-## SideNavMenu
-
-### Import path
-
-```js
-import { SideNavMenu } from "carbon-components-svelte";
-```
+## `SideNavMenu`
### Props
-| Prop name | Type | Default value | Description |
-| :-------- | :-------------------------------------------------------------------------------------------------- | :------------ | :--------------------------------------------- |
-| expanded | boolean | `false` | Set to `true` to toggle the expanded state. |
-| text | string | -- | Specify the text. |
-| icon | { render: typeof import("carbon-icons-svelte/lib/Add16").default; skeleton: boolean; } | -- | Specify the icon props. |
-| ref | null | HTMLButtonElement | `null` | Obtain a reference to the HTML button element. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------- | :--------------- | :------- | :------------------------------------------------------------------------------------ | ------------------ | --------------------------------------------- |
+| ref | let | Yes | null | HTMLButtonElement | null | Obtain a reference to the HTML button element |
+| expanded | let | Yes | boolean | false | Set to `true` to toggle the expanded state |
+| text | let | No | string | -- | Specify the text |
+| icon | let | No | { render: import("carbon-icons-svelte").CarbonIcon; skeleton: boolean; } | -- | Specify the icon props |
### Slots
-- **default**: `
...
`
-
-### Forwarded events
-
-- `on:click`
-
-### Dispatched events
-
-No dispatched events.
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :------- |
+| -- | Yes | -- | -- |
----
+### Events
-## SideNavMenuItem
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
-### Import path
-
-```js
-import { SideNavMenuItem } from "carbon-components-svelte";
-```
+## `SideNavMenuItem`
### Props
-| Prop name | Type | Default value | Description |
-| :--------- | :----------------------------------------- | :------------ | :--------------------------------------------- |
-| isSelected | boolean | -- | Set to `true` to select the item. |
-| href | string | -- | Specify the `href` attribute. |
-| text | string | -- | Specify the item text. |
-| ref | null | HTMLAnchorElement | `null` | Obtain a reference to the HTML anchor element. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :--------- | :--------------- | :------- | :----------------------------------------- | ----------------- | --------------------------------------------- |
+| ref | let | Yes | null | HTMLAnchorElement | null | Obtain a reference to the HTML anchor element |
+| isSelected | let | No | boolean | -- | Set to `true` to select the item |
+| href | let | No | string | -- | Specify the `href` attribute |
+| text | let | No | string | -- | Specify the item text |
### Slots
-No slots.
-
-### Forwarded events
-
-- `on:click`
-
-### Dispatched events
-
-No dispatched events.
-
----
+None.
-## SkeletonPlaceholder
+### Events
-### Import path
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
-```js
-import { SkeletonPlaceholder } from "carbon-components-svelte";
-```
+## `SkeletonPlaceholder`
### Props
-No exported props.
+None.
### Slots
-No slots.
+None.
-### Forwarded events
+### Events
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
-### Dispatched events
-
-No dispatched events.
-
----
-
-## SkeletonText
-
-### Import path
-
-```js
-import { SkeletonText } from "carbon-components-svelte";
-```
+## `SkeletonText`
### Props
-| Prop name | Type | Default value | Description |
-| :-------- | :------------------- | :------------ | :----------------------------------------------- |
-| lines | number | `3` | Specify the number of lines to render. |
-| heading | boolean | `false` | Set to `true` to use the heading size variant. |
-| paragraph | boolean | `false` | Set to `true` to use the paragraph size variant. |
-| width | string | `"100%"` | Specify the width of the text (% or px). |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------- | :--------------- | :------- | :------------------- | ------------------- | ----------------------------------------------- |
+| lines | let | No | number | 3 | Specify the number of lines to render |
+| heading | let | No | boolean | false | Set to `true` to use the heading size variant |
+| paragraph | let | No | boolean | false | Set to `true` to use the paragraph size variant |
+| width | let | No | string | "100%" | Specify the width of the text (% or px) |
### Slots
-No slots.
-
-### Forwarded events
+None.
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
+### Events
-### Dispatched events
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
-No dispatched events.
-
----
-
-## SkipToContent
-
-### Import path
-
-```js
-import { SkipToContent } from "carbon-components-svelte";
-```
+## `SkipToContent`
### Props
-| Prop name | Type | Default value | Description |
-| :-------- | :------------------ | :---------------- | :---------------------------- |
-| href | string | `"#main-content"` | Specify the `href` attribute. |
-| tabindex | string | `"0"` | Specify the tabindex. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------- | :--------------- | :------- | :------------------ | ---------------------------- | ---------------------------- |
+| href | let | No | string | "#main-content" | Specify the `href` attribute |
+| tabindex | let | No | string | "0" | Specify the tabindex |
### Slots
-- **default**: `
...
`
-
-### Forwarded events
-
-- `on:click`
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :-------------------------------- |
+| -- | Yes | -- | Skip to main content |
-### Dispatched events
+### Events
-No dispatched events.
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
----
-
-## Slider
-
-### Import path
-
-```js
-import { Slider } from "carbon-components-svelte";
-```
+## `Slider`
### Props
-| Prop name | Type | Default value | Description |
-| :------------- | :----------------------------------- | :------------ | :------------------------------------------ |
-| value | number | `0` | Specify the value of the slider. |
-| max | number | `100` | Set the maximum slider value. |
-| maxLabel | string | `""` | Specify the label for the max value. |
-| min | number | `0` | Set the minimum slider value. |
-| minLabel | string | `""` | Specify the label for the min value. |
-| step | number | `1` | Set the step value. |
-| stepMultiplier | number | `4` | Set the step multiplier value. |
-| required | boolean | `false` | Set to `true` to require a value. |
-| inputType | string | `"number"` | Specify the input type. |
-| disabled | boolean | `false` | Set to `true` to disable the slider. |
-| light | boolean | `false` | Set to `true` to enable the light variant. |
-| hideTextInput | boolean | `false` | Set to `true` to hide the text input. |
-| id | string | -- | Set an id for the slider div element. |
-| invalid | boolean | `false` | Set to `true` to indicate an invalid state. |
-| labelText | string | `""` | Specify the label text. |
-| name | string | `""` | Set a name for the slider element. |
-| ref | null | HTMLElement | `null` | Obtain a reference to the HTML element. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :------------- | :--------------- | :------- | :-------------------------------------- | ------------------------------------------------ | ------------------------------------------ |
+| ref | let | Yes | null | HTMLDivElement | null | Obtain a reference to the HTML element |
+| value | let | Yes | number | 0 | Specify the value of the slider |
+| max | let | No | number | 100 | Set the maximum slider value |
+| maxLabel | let | No | string | "" | Specify the label for the max value |
+| min | let | No | number | 0 | Set the minimum slider value |
+| minLabel | let | No | string | "" | Specify the label for the min value |
+| step | let | No | number | 1 | Set the step value |
+| stepMultiplier | let | No | number | 4 | Set the step multiplier value |
+| required | let | No | boolean | false | Set to `true` to require a value |
+| inputType | let | No | string | "number" | Specify the input type |
+| disabled | let | No | boolean | false | Set to `true` to disable the slider |
+| light | let | No | boolean | false | Set to `true` to enable the light variant |
+| hideTextInput | let | No | boolean | false | Set to `true` to hide the text input |
+| id | let | No | string | "ccs-" + Math.random().toString(36) | Set an id for the slider div element |
+| invalid | let | No | boolean | false | Set to `true` to indicate an invalid state |
+| labelText | let | No | string | "" | Specify the label text |
+| name | let | No | string | "" | Set a name for the slider element |
### Slots
-No slots.
-
-### Forwarded events
-
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
-
-### Dispatched events
+None.
-- `on:change`
+### Events
----
+| Event name | Type | Detail |
+| :--------- | :--------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
+| change | dispatched | -- |
-## SliderSkeleton
-
-### Import path
-
-```js
-import { SliderSkeleton } from "carbon-components-svelte";
-```
+## `SliderSkeleton`
### Props
-| Prop name | Type | Default value | Description |
-| :-------- | :------------------- | :------------ | :------------------------------------ |
-| hideLabel | boolean | `false` | Set to `true` to hide the label text. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------- | :--------------- | :------- | :------------------- | ------------------ | ------------------------------------ |
+| hideLabel | let | No | boolean | false | Set to `true` to hide the label text |
### Slots
-No slots.
-
-### Forwarded events
-
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
-
-### Dispatched events
-
-No dispatched events.
+None.
----
+### Events
-## StructuredList
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
-### Import path
-
-```js
-import { StructuredList } from "carbon-components-svelte";
-```
+## `StructuredList`
### Props
-| Prop name | Type | Default value | Description |
-| :-------- | :------------------- | :------------ | :---------------------------------------------- |
-| selected | string | -- | Specify the selected structured list row value. |
-| border | boolean | `false` | Set to `true` to use the bordered variant. |
-| selection | boolean | `false` | Set to `true` to use the selection variant. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------- | :--------------- | :------- | :------------------- | ------------------ | ---------------------------------------------- |
+| selected | let | Yes | string | -- | Specify the selected structured list row value |
+| border | let | No | boolean | false | Set to `true` to use the bordered variant |
+| selection | let | No | boolean | false | Set to `true` to use the selection variant |
### Slots
-- **default**: `
`
-
-### Forwarded events
-
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :------- |
+| -- | Yes | -- | -- |
-### Dispatched events
+### Events
-No dispatched events.
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
----
-
-## StructuredListInput
-
-### Import path
-
-```js
-import { StructuredListInput } from "carbon-components-svelte";
-```
+## `StructuredListInput`
### Props
-| Prop name | Type | Default value | Description |
-| :-------- | :---------------------------------------- | :------------ | :-------------------------------------------- |
-| checked | boolean | `false` | Set to `true` to check the input. |
-| title | string | `"title"` | Specify the title of the input. |
-| value | string | `"value"` | Specify the value of the input. |
-| id | string | -- | Set an id for the input element. |
-| name | string | `""` | Specify a name attribute for the input. |
-| ref | null | HTMLInputElement | `null` | Obtain a reference to the input HTML element. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------- | :--------------- | :------- | :---------------------------------------- | ------------------------------------------------ | -------------------------------------------- |
+| ref | let | Yes | null | HTMLInputElement | null | Obtain a reference to the input HTML element |
+| checked | let | Yes | boolean | false | Set to `true` to check the input |
+| title | let | No | string | "title" | Specify the title of the input |
+| value | let | No | string | "value" | Specify the value of the input |
+| id | let | No | string | "ccs-" + Math.random().toString(36) | Set an id for the input element |
+| name | let | No | string | "" | Specify a name attribute for the input |
### Slots
-No slots.
-
-### Forwarded events
-
-No forwarded events.
-
-### Dispatched events
+None.
-No dispatched events.
+### Events
----
+None.
-## StructuredListRow
-
-### Import path
-
-```js
-import { StructuredListRow } from "carbon-components-svelte";
-```
+## `StructuredListRow`
### Props
-| Prop name | Type | Default value | Description |
-| :-------- | :------------------- | :------------ | :------------------------------------ |
-| head | boolean | `false` | Set to `true` to use as a header. |
-| label | boolean | `false` | Set to `true` to render a label slot. |
-| tabindex | string | `"0"` | Specify the tabindex. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------- | :--------------- | :------- | :------------------- | ------------------ | ------------------------------------ |
+| head | let | No | boolean | false | Set to `true` to use as a header |
+| label | let | No | boolean | false | Set to `true` to render a label slot |
+| tabindex | let | No | string | "0" | Specify the tabindex |
### Slots
-- **default**: `
...
`
-
-### Forwarded events
-
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
-- `on:keydown`
-
-### Dispatched events
-
-No dispatched events.
-
----
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :------- |
+| -- | Yes | -- | -- |
-## StructuredListSkeleton
+### Events
-### Import path
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
+| keydown | forwarded | -- |
-```js
-import { StructuredListSkeleton } from "carbon-components-svelte";
-```
+## `StructuredListSkeleton`
### Props
-| Prop name | Type | Default value | Description |
-| :-------- | :------------------- | :------------ | :----------------------------------------- |
-| rows | number | `5` | Specify the number of rows. |
-| border | boolean | `false` | Set to `true` to use the bordered variant. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------- | :--------------- | :------- | :------------------- | ------------------ | ----------------------------------------- |
+| rows | let | No | number | 5 | Specify the number of rows |
+| border | let | No | boolean | false | Set to `true` to use the bordered variant |
### Slots
-No slots.
+None.
-### Forwarded events
+### Events
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
-### Dispatched events
-
-No dispatched events.
-
----
-
-## Switch
-
-### Import path
-
-```js
-import { Switch } from "carbon-components-svelte";
-```
+## `Switch`
### Props
-| Prop name | Type | Default value | Description |
-| :-------- | :----------------------------------------- | :--------------- | :----------------------------------------------------------------------------------------------------------------- |
-| text | string | `"Provide text"` | Specify the switch text. Alternatively, use the named slot "text" (e.g. <span slot="text">...</span>). |
-| selected | boolean | `false` | Set to `true` for the switch to be selected. |
-| disabled | boolean | `false` | Set to `true` to disable the switch. |
-| id | string | -- | Set an id for the button element. |
-| ref | null | HTMLButtonElement | `null` | Obtain a reference to the button HTML element. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------- | :--------------- | :------- | :----------------------------------------- | ------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------- |
+| ref | let | Yes | null | HTMLButtonElement | null | Obtain a reference to the button HTML element |
+| selected | let | Yes | boolean | false | Set to `true` for the switch to be selected |
+| text | let | No | string | "Provide text" | Specify the switch text Alternatively, use the named slot "text" (e.g. <span slot="text">...</span>) |
+| disabled | let | No | boolean | false | Set to `true` to disable the switch |
+| id | let | No | string | "ccs-" + Math.random().toString(36) | Set an id for the button element |
### Slots
-- **default**: `
...
`
-
-### Forwarded events
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :------------------ |
+| -- | Yes | -- | {text} |
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
-- `on:keydown`
+### Events
-### Dispatched events
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
+| keydown | forwarded | -- |
-No dispatched events.
-
----
-
-## Tab
-
-### Import path
-
-```js
-import { Tab } from "carbon-components-svelte";
-```
+## `Tab`
### Props
-| Prop name | Type | Default value | Description |
-| :-------- | :----------------------------------------- | :------------ | :----------------------------------------------------------------------------------------------------------------------- |
-| label | string | `""` | Specify the tab label. Alternatively, use the default slot (e.g. <Tab><span>Label</span></Tab>). |
-| href | string | `"#"` | Specify the href attribute. |
-| disabled | boolean | `false` | Set to `true` to disable the tab. |
-| tabindex | string | `"0"` | Specify the tabindex. |
-| id | string | -- | Set an id for the top-level element. |
-| ref | null | HTMLAnchorElement | `null` | Obtain a reference to the anchor HTML element. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------- | :--------------- | :------- | :----------------------------------------- | ------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------- |
+| ref | let | Yes | null | HTMLAnchorElement | null | Obtain a reference to the anchor HTML element |
+| label | let | No | string | "" | Specify the tab label Alternatively, use the default slot (e.g. <Tab><span>Label</span></Tab>) |
+| href | let | No | string | "#" | Specify the href attribute |
+| disabled | let | No | boolean | false | Set to `true` to disable the tab |
+| tabindex | let | No | string | "0" | Specify the tabindex |
+| id | let | No | string | "ccs-" + Math.random().toString(36) | Set an id for the top-level element |
### Slots
-- **default**: `
...
`
-
-### Forwarded events
-
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :------------------- |
+| -- | Yes | -- | {label} |
-### Dispatched events
+### Events
-No dispatched events.
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
----
-
-## TabContent
-
-### Import path
-
-```js
-import { TabContent } from "carbon-components-svelte";
-```
+## `TabContent`
### Props
-| Prop name | Type | Default value | Description |
-| :-------- | :------------------ | :------------ | :----------------------------------- |
-| id | string | -- | Set an id for the top-level element. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------- | :--------------- | :------- | :------------------ | ------------------------------------------------ | ----------------------------------- |
+| id | let | No | string | "ccs-" + Math.random().toString(36) | Set an id for the top-level element |
### Slots
-- **default**: `
...
`
-
-### Forwarded events
-
-No forwarded events.
-
-### Dispatched events
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :------- |
+| -- | Yes | -- | -- |
-No dispatched events.
+### Events
----
+None.
-## Table
-
-### Import path
-
-```js
-import { Table } from "carbon-components-svelte";
-```
+## `Table`
### Props
-| Prop name | Type | Default value | Description |
-| :--------------- | :-------------------------------------------------- | :------------ | :--------------------------------------- |
-| size | "compact" | "short" | "tall" | -- | Set the size of the table. |
-| zebra | boolean | `false` | Set to `true` to use zebra styles. |
-| useStaticWidth | boolean | `false` | Set to `true` to use static width. |
-| shouldShowBorder | boolean | `false` | Set to `true` for the bordered variant. |
-| sortable | boolean | `false` | Set to `true` for the sortable variant. |
-| stickyHeader | boolean | `false` | Set to `true` to enable a sticky header. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :--------------- | :--------------- | :------- | :-------------------------------------------------- | ------------------ | --------------------------------------- |
+| size | let | No | "compact" | "short" | "tall" | -- | Set the size of the table |
+| zebra | let | No | boolean | false | Set to `true` to use zebra styles |
+| useStaticWidth | let | No | boolean | false | Set to `true` to use static width |
+| shouldShowBorder | let | No | boolean | false | Set to `true` for the bordered variant |
+| sortable | let | No | boolean | false | Set to `true` for the sortable variant |
+| stickyHeader | let | No | boolean | false | Set to `true` to enable a sticky header |
### Slots
-- **default**: `
`
-
-### Forwarded events
-
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
-
-### Dispatched events
-
-No dispatched events.
-
----
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :------- |
+| -- | Yes | -- | -- |
-## Tabs
+### Events
-### Import path
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
-```js
-import { Tabs } from "carbon-components-svelte";
-```
+## `Tabs`
### Props
-| Prop name | Type | Default value | Description |
-| :-------------- | :---------------------------------------- | :-------------------- | :------------------------------------------- |
-| selected | number | `0` | Specify the selected tab index. |
-| type | "default" | "container" | `"default"` | Specify the type of tabs. |
-| iconDescription | string | `"Show menu options"` | Specify the ARIA label for the chevron icon. |
-| triggerHref | string | `"#"` | Specify the tab trigger href attribute. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------------- | :--------------- | :------- | :---------------------------------------- | -------------------------------- | ------------------------------------------- |
+| selected | let | Yes | number | 0 | Specify the selected tab index |
+| type | let | No | "default" | "container" | "default" | Specify the type of tabs |
+| iconDescription | let | No | string | "Show menu options" | Specify the ARIA label for the chevron icon |
+| triggerHref | let | No | string | "#" | Specify the tab trigger href attribute |
### Slots
-- **default**: `
...
`
-- **"content"**: `
...
`
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :------- |
+| -- | Yes | -- | -- |
+| content | No | -- | -- |
-### Forwarded events
+### Events
-- `on:keypress`
-- `on:click`
+| Event name | Type | Detail |
+| :--------- | :--------- | :----- |
+| keypress | forwarded | -- |
+| click | forwarded | -- |
+| change | dispatched | -- |
-### Dispatched events
-
-- `on:change`
-
----
-
-## TabsSkeleton
-
-### Import path
-
-```js
-import { TabsSkeleton } from "carbon-components-svelte";
-```
+## `TabsSkeleton`
### Props
-| Prop name | Type | Default value | Description |
-| :-------- | :------------------ | :------------ | :------------------------------------ |
-| count | number | `4` | Specify the number of tabs to render. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------- | :--------------- | :------- | :------------------ | -------------- | ------------------------------------ |
+| count | let | No | number | 4 | Specify the number of tabs to render |
### Slots
-No slots.
-
-### Forwarded events
+None.
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
+### Events
-### Dispatched events
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
-No dispatched events.
-
----
-
-## Tag
-
-### Import path
-
-```js
-import { Tag } from "carbon-components-svelte";
-```
+## `Tag`
### Props
-| Prop name | Type | Default value | Description |
-| :-------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :--------------- | :------------------------------------------------------ |
-| type | "red" | "magenta" | "purple" | "blue" | "cyan" | "teal" | "green" | "gray" | "cool-gray" | "warm-gray" | "high-contrast" | -- | Specify the type of tag. |
-| filter | boolean | `false` | Set to `true` to use filterable variant. |
-| disabled | boolean | `false` | Set to `true` to disable a filterable tag. |
-| skeleton | boolean | `false` | Set to `true` to display the skeleton state. |
-| title | string | `"Clear filter"` | Set the title for the close button in a filterable tag. |
-| id | string | -- | Set an id for the filterable tag. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------- | :--------------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------ | ------------------------------------------------------ |
+| type | let | No | "red" | "magenta" | "purple" | "blue" | "cyan" | "teal" | "green" | "gray" | "cool-gray" | "warm-gray" | "high-contrast" | -- | Specify the type of tag |
+| filter | let | No | boolean | false | Set to `true` to use filterable variant |
+| disabled | let | No | boolean | false | Set to `true` to disable a filterable tag |
+| skeleton | let | No | boolean | false | Set to `true` to display the skeleton state |
+| title | let | No | string | "Clear filter" | Set the title for the close button in a filterable tag |
+| id | let | No | string | "ccs-" + Math.random().toString(36) | Set an id for the filterable tag |
### Slots
-- **default**: `
...
`
-
-### Forwarded events
-
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :----------------------------------------------------- | :------- |
+| -- | Yes | { props: { class: 'bx--tag\_\_label' } } | -- |
-### Dispatched events
+### Events
-No dispatched events.
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
----
-
-## TagSkeleton
-
-### Import path
-
-```js
-import { TagSkeleton } from "carbon-components-svelte";
-```
+## `TagSkeleton`
### Props
-No exported props.
+None.
### Slots
-No slots.
-
-### Forwarded events
-
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
-
-### Dispatched events
+None.
-No dispatched events.
+### Events
----
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
-## TextArea
-
-### Import path
-
-```js
-import { TextArea } from "carbon-components-svelte";
-```
+## `TextArea`
### Props
-| Prop name | Type | Default value | Description |
-| :---------- | :------------------------------------------- | :------------ | :----------------------------------------------- |
-| value | string | `""` | Specify the textarea value. |
-| placeholder | string | `""` | Specify the placeholder text. |
-| cols | number | `50` | Specify the number of cols. |
-| rows | number | `4` | Specify the number of rows. |
-| light | boolean | `false` | Set to `true` to enable the light variant. |
-| disabled | boolean | `false` | Set to `true` to disable the input. |
-| helperText | string | `""` | Specify the helper text. |
-| labelText | string | `""` | Specify the label text. |
-| hideLabel | boolean | `false` | Set to `true` to visually hide the label text. |
-| invalid | boolean | `false` | Set to `true` to indicate an invalid state. |
-| invalidText | string | `""` | Specify the text for the invalid state. |
-| id | string | -- | Set an id for the textarea element. |
-| name | string | -- | Specify a name attribute for the input. |
-| ref | null | HTMLTextAreaElement | `null` | Obtain a reference to the textarea HTML element. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :---------- | :--------------- | :------- | :------------------------------------------- | ------------------------------------------------ | ----------------------------------------------- |
+| ref | let | Yes | null | HTMLTextAreaElement | null | Obtain a reference to the textarea HTML element |
+| value | let | Yes | string | "" | Specify the textarea value |
+| placeholder | let | No | string | "" | Specify the placeholder text |
+| cols | let | No | number | 50 | Specify the number of cols |
+| rows | let | No | number | 4 | Specify the number of rows |
+| light | let | No | boolean | false | Set to `true` to enable the light variant |
+| disabled | let | No | boolean | false | Set to `true` to disable the input |
+| helperText | let | No | string | "" | Specify the helper text |
+| labelText | let | No | string | "" | Specify the label text |
+| hideLabel | let | No | boolean | false | Set to `true` to visually hide the label text |
+| invalid | let | No | boolean | false | Set to `true` to indicate an invalid state |
+| invalidText | let | No | string | "" | Specify the text for the invalid state |
+| id | let | No | string | "ccs-" + Math.random().toString(36) | Set an id for the textarea element |
+| name | let | No | string | -- | Specify a name attribute for the input |
### Slots
-No slots.
-
-### Forwarded events
-
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
-- `on:change`
-- `on:input`
-- `on:focus`
-- `on:blur`
-
-### Dispatched events
-
-No dispatched events.
+None.
----
+### Events
-## TextAreaSkeleton
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
+| change | forwarded | -- |
+| input | forwarded | -- |
+| focus | forwarded | -- |
+| blur | forwarded | -- |
-### Import path
-
-```js
-import { TextAreaSkeleton } from "carbon-components-svelte";
-```
+## `TextAreaSkeleton`
### Props
-| Prop name | Type | Default value | Description |
-| :-------- | :------------------- | :------------ | :--------------------------------------------- |
-| hideLabel | boolean | `false` | Set to `true` to visually hide the label text. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------- | :--------------- | :------- | :------------------- | ------------------ | --------------------------------------------- |
+| hideLabel | let | No | boolean | false | Set to `true` to visually hide the label text |
### Slots
-No slots.
-
-### Forwarded events
-
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
-
-### Dispatched events
-
-No dispatched events.
-
----
+None.
-## TextInput
+### Events
-### Import path
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
-```js
-import { TextInput } from "carbon-components-svelte";
-```
+## `TextInput`
### Props
-| Prop name | Type | Default value | Description |
-| :---------- | :---------------------------------------- | :------------ | :--------------------------------------------- |
-| size | "sm" | "xl" | -- | Set the size of the input. |
-| value | string | `""` | Specify the input value. |
-| type | string | `""` | Specify the input type. |
-| placeholder | string | `""` | Specify the placeholder text. |
-| light | boolean | `false` | Set to `true` to enable the light variant. |
-| disabled | boolean | `false` | Set to `true` to disable the input. |
-| helperText | string | `""` | Specify the helper text. |
-| id | string | -- | Set an id for the input element. |
-| name | string | -- | Specify a name attribute for the input. |
-| labelText | string | `""` | Specify the label text. |
-| hideLabel | boolean | `false` | Set to `true` to visually hide the label text. |
-| invalid | boolean | `false` | Set to `true` to indicate an invalid state. |
-| invalidText | string | `""` | Specify the invalid state text. |
-| warn | boolean | `false` | Set to `true` to indicate an warning state. |
-| warnText | string | `""` | Specify the warning state text. |
-| ref | null | HTMLInputElement | `null` | Obtain a reference to the input HTML element. |
-| required | boolean | `false` | Set to `true` to mark the field as required. |
-| inline | boolean | `false` | Set to `true` to use inline version. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :---------- | :--------------- | :------- | :---------------------------------------- | ------------------------------------------------ | --------------------------------------------- |
+| ref | let | Yes | null | HTMLInputElement | null | Obtain a reference to the input HTML element |
+| value | let | Yes | number | string | "" | Specify the input value |
+| size | let | No | "sm" | "xl" | -- | Set the size of the input |
+| type | let | No | string | "" | Specify the input type |
+| placeholder | let | No | string | "" | Specify the placeholder text |
+| light | let | No | boolean | false | Set to `true` to enable the light variant |
+| disabled | let | No | boolean | false | Set to `true` to disable the input |
+| helperText | let | No | string | "" | Specify the helper text |
+| id | let | No | string | "ccs-" + Math.random().toString(36) | Set an id for the input element |
+| name | let | No | string | -- | Specify a name attribute for the input |
+| labelText | let | No | string | "" | Specify the label text |
+| hideLabel | let | No | boolean | false | Set to `true` to visually hide the label text |
+| invalid | let | No | boolean | false | Set to `true` to indicate an invalid state |
+| invalidText | let | No | string | "" | Specify the invalid state text |
+| warn | let | No | boolean | false | Set to `true` to indicate an warning state |
+| warnText | let | No | string | "" | Specify the warning state text |
+| required | let | No | boolean | false | Set to `true` to mark the field as required |
+| inline | let | No | boolean | false | Set to `true` to use inline version |
### Slots
-No slots.
+None.
-### Forwarded events
+### Events
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
-- `on:change`
-- `on:input`
-- `on:keydown`
-- `on:focus`
-- `on:blur`
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
+| change | forwarded | -- |
+| input | forwarded | -- |
+| keydown | forwarded | -- |
+| focus | forwarded | -- |
+| blur | forwarded | -- |
-### Dispatched events
-
-No dispatched events.
-
----
-
-## TextInputSkeleton
-
-### Import path
-
-```js
-import { TextInputSkeleton } from "carbon-components-svelte";
-```
+## `TextInputSkeleton`
### Props
-| Prop name | Type | Default value | Description |
-| :-------- | :------------------- | :------------ | :------------------------------------ |
-| hideLabel | boolean | `false` | Set to `true` to hide the label text. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------- | :--------------- | :------- | :------------------- | ------------------ | ------------------------------------ |
+| hideLabel | let | No | boolean | false | Set to `true` to hide the label text |
### Slots
-No slots.
-
-### Forwarded events
+None.
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
+### Events
-### Dispatched events
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
-No dispatched events.
-
----
-
-## Tile
-
-### Import path
-
-```js
-import { Tile } from "carbon-components-svelte";
-```
+## `Tile`
### Props
-| Prop name | Type | Default value | Description |
-| :-------- | :------------------- | :------------ | :----------------------------------------- |
-| light | boolean | `false` | Set to `true` to enable the light variant. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------- | :--------------- | :------- | :------------------- | ------------------ | ----------------------------------------- |
+| light | let | No | boolean | false | Set to `true` to enable the light variant |
### Slots
-- **default**: `
...
`
-
-### Forwarded events
-
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
-
-### Dispatched events
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :------- |
+| -- | Yes | -- | -- |
-No dispatched events.
+### Events
----
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
-## TileGroup
-
-### Import path
-
-```js
-import { TileGroup } from "carbon-components-svelte";
-```
+## `TileGroup`
### Props
-| Prop name | Type | Default value | Description |
-| :-------- | :------------------- | :------------ | :--------------------------------------- |
-| selected | string | -- | Specify the selected tile value. |
-| disabled | boolean | `false` | Set to `true` to disable the tile group. |
-| legend | string | `""` | Specify the legend text. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------- | :--------------- | :------- | :------------------- | ------------------ | --------------------------------------- |
+| selected | let | Yes | string | -- | Specify the selected tile value |
+| disabled | let | No | boolean | false | Set to `true` to disable the tile group |
+| legend | let | No | string | "" | Specify the legend text |
### Slots
-- **default**: `
...
`
-
-### Forwarded events
-
-No forwarded events.
-
-### Dispatched events
-
-- `on:select`
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :------- |
+| -- | Yes | -- | -- |
----
+### Events
-## TimePicker
+| Event name | Type | Detail |
+| :--------- | :--------- | :----- |
+| select | dispatched | -- |
-### Import path
-
-```js
-import { TimePicker } from "carbon-components-svelte";
-```
+## `TimePicker`
### Props
-| Prop name | Type | Default value | Description |
-| :---------- | :---------------------------------------- | :------------ | :--------------------------------------------- |
-| size | "sm" | "xl" | -- | Specify the size of the input. |
-| value | string | `""` | Specify the input value. |
-| type | string | `"text"` | Specify the input type. |
-| placeholder | string | `"hh=mm"` | Specify the input placeholder text. |
-| pattern | string | `"(1[012] | [1-9]):[0-5][0-9](\\s)?"` | Specify the `pattern` attribute for the input element. |
-| maxlength | number | `5` | Specify the `maxlength` input attribute. |
-| light | boolean | `false` | Set to `true` to enable the light variant. |
-| disabled | boolean | `false` | Set to `true` to disable the input. |
-| labelText | string | `""` | Specify the label text. |
-| hideLabel | boolean | `false` | Set to `true` to visually hide the label text. |
-| invalid | boolean | `false` | Set to `true` to indicate an invalid state. |
-| invalidText | string | `""` | Specify the invalid state text. |
-| id | string | -- | Set an id for the input element. |
-| name | string | -- | Specify a name attribute for the input. |
-| ref | null | HTMLInputElement | `null` | Obtain a reference to the input HTML element. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :---------- | :--------------- | :------- | :---------------------------------------- | --------------------------------------------------- | ----------------------------------------------------- |
+| ref | let | Yes | null | HTMLInputElement | null | Obtain a reference to the input HTML element |
+| value | let | Yes | string | "" | Specify the input value |
+| size | let | No | "sm" | "xl" | -- | Specify the size of the input |
+| type | let | No | string | "text" | Specify the input type |
+| placeholder | let | No | string | "hh=mm" | Specify the input placeholder text |
+| pattern | let | No | string | "(1[012]|[1-9]):[0-5][0-9](\\s)?" | Specify the `pattern` attribute for the input element |
+| maxlength | let | No | number | 5 | Specify the `maxlength` input attribute |
+| light | let | No | boolean | false | Set to `true` to enable the light variant |
+| disabled | let | No | boolean | false | Set to `true` to disable the input |
+| labelText | let | No | string | "" | Specify the label text |
+| hideLabel | let | No | boolean | false | Set to `true` to visually hide the label text |
+| invalid | let | No | boolean | false | Set to `true` to indicate an invalid state |
+| invalidText | let | No | string | "" | Specify the invalid state text |
+| id | let | No | string | "ccs-" + Math.random().toString(36) | Set an id for the input element |
+| name | let | No | string | -- | Specify a name attribute for the input |
### Slots
-- **default**: `
...
`
-
-### Forwarded events
-
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
-- `on:change`
-- `on:input`
-- `on:focus`
-- `on:blur`
-
-### Dispatched events
-
-No dispatched events.
-
----
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :------- |
+| -- | Yes | -- | -- |
-## TimePickerSelect
+### Events
-### Import path
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
+| change | forwarded | -- |
+| input | forwarded | -- |
+| focus | forwarded | -- |
+| blur | forwarded | -- |
-```js
-import { TimePickerSelect } from "carbon-components-svelte";
-```
+## `TimePickerSelect`
### Props
-| Prop name | Type | Default value | Description |
-| :-------------- | :----------------------------------------- | :----------------------- | :----------------------------------------------- |
-| value | string | `""` | Specify the select value. |
-| disabled | boolean | `false` | Set to `true` to disable the select. |
-| iconDescription | string | `"Open list of options"` | Specify the ARIA label for the chevron icon. |
-| labelText | string | `""` | Specify the label text. |
-| hideLabel | boolean | `true` | . |
-| id | string | -- | Set an id for the select element. |
-| name | string | -- | Specify a name attribute for the select element. |
-| ref | null | HTMLSelectElement | `null` | Obtain a reference to the select HTML element. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------------- | :--------------- | :------- | :----------------------------------------- | ------------------------------------------------ | ----------------------------------------------- |
+| ref | let | Yes | null | HTMLSelectElement | null | Obtain a reference to the select HTML element |
+| value | let | Yes | number | string | "" | Specify the select value |
+| disabled | let | No | boolean | false | Set to `true` to disable the select |
+| iconDescription | let | No | string | "Open list of options" | Specify the ARIA label for the chevron icon |
+| labelText | let | No | string | "" | Specify the label text |
+| hideLabel | let | No | boolean | true | -- |
+| id | let | No | string | "ccs-" + Math.random().toString(36) | Set an id for the select element |
+| name | let | No | string | -- | Specify a name attribute for the select element |
### Slots
-- **default**: `
...
`
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :------- |
+| -- | Yes | -- | -- |
-### Forwarded events
+### Events
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
-### Dispatched events
-
-No dispatched events.
-
----
-
-## ToastNotification
-
-### Import path
-
-```js
-import { ToastNotification } from "carbon-components-svelte";
-```
+## `ToastNotification`
### Props
-| Prop name | Type | Default value | Description |
-| :--------------- | :------------------------------------------------------------------------------------------------------------- | :---------------------- | :----------------------------------------------------------------------- |
-| notificationType | "toast" | "inline" | `"toast"` | Set the type of notification. |
-| kind | "error" | "info" | "info-square" | "success" | "warning" | "warning-alt" | `"error"` | Specify the kind of notification. |
-| lowContrast | boolean | `false` | Set to `true` to use the low contrast variant. |
-| timeout | number | `0` | Set the timeout duration (ms) to hide the notification after opening it. |
-| role | string | `"alert"` | Set the `role` attribute. |
-| title | string | `"Title"` | Specify the title text. |
-| subtitle | string | `""` | Specify the subtitle text. |
-| caption | string | `"Caption"` | Specify the caption text. |
-| iconDescription | string | `"Closes notification"` | Specify the ARIA label for the icon. |
-| hideCloseButton | boolean | `false` | Set to `true` to hide the close button. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :--------------- | :--------------- | :------- | :------------------------------------------------------------------------------------------------------------- | ---------------------------------- | ----------------------------------------------------------------------- |
+| notificationType | let | No | "toast" | "inline" | "toast" | Set the type of notification |
+| kind | let | No | "error" | "info" | "info-square" | "success" | "warning" | "warning-alt" | "error" | Specify the kind of notification |
+| lowContrast | let | No | boolean | false | Set to `true` to use the low contrast variant |
+| timeout | let | No | number | 0 | Set the timeout duration (ms) to hide the notification after opening it |
+| role | let | No | string | "alert" | Set the `role` attribute |
+| title | let | No | string | "Title" | Specify the title text |
+| subtitle | let | No | string | "" | Specify the subtitle text |
+| caption | let | No | string | "Caption" | Specify the caption text |
+| iconDescription | let | No | string | "Closes notification" | Specify the ARIA label for the icon |
+| hideCloseButton | let | No | boolean | false | Set to `true` to hide the close button |
### Slots
-- **default**: `
...
`
-
-### Forwarded events
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :------- |
+| -- | Yes | -- | -- |
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
+### Events
-### Dispatched events
+| Event name | Type | Detail |
+| :--------- | :--------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
+| close | dispatched | -- |
-- `on:close`
-
----
-
-## Toggle
-
-### Import path
-
-```js
-import { Toggle } from "carbon-components-svelte";
-```
+## `Toggle`
### Props
-| Prop name | Type | Default value | Description |
-| :-------- | :------------------- | :------------ | :----------------------------------------------- |
-| toggled | boolean | `false` | Set to `true` to toggle the checkbox input. |
-| disabled | boolean | `false` | Set to `true` to disable checkbox input. |
-| labelA | string | `"Off"` | Specify the label for the untoggled state. |
-| labelB | string | `"On"` | Specify the label for the toggled state. |
-| labelText | string | `""` | Specify the label text. |
-| id | string | -- | Set an id for the input element. |
-| name | string | -- | Specify a name attribute for the checkbox input. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------- | :--------------- | :------- | :------------------- | ------------------------------------------------ | ----------------------------------------------- |
+| toggled | let | Yes | boolean | false | Set to `true` to toggle the checkbox input |
+| disabled | let | No | boolean | false | Set to `true` to disable checkbox input |
+| labelA | let | No | string | "Off" | Specify the label for the untoggled state |
+| labelB | let | No | string | "On" | Specify the label for the toggled state |
+| labelText | let | No | string | "" | Specify the label text |
+| id | let | No | string | "ccs-" + Math.random().toString(36) | Set an id for the input element |
+| name | let | No | string | -- | Specify a name attribute for the checkbox input |
### Slots
-No slots.
-
-### Forwarded events
-
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
-- `on:change`
-- `on:keyup`
-- `on:focus`
-- `on:blur`
+None.
-### Dispatched events
+### Events
-No dispatched events.
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
+| change | forwarded | -- |
+| keyup | forwarded | -- |
+| focus | forwarded | -- |
+| blur | forwarded | -- |
----
-
-## ToggleSkeleton
-
-### Import path
-
-```js
-import { ToggleSkeleton } from "carbon-components-svelte";
-```
+## `ToggleSkeleton`
### Props
-| Prop name | Type | Default value | Description |
-| :-------- | :------------------ | :------------ | :------------------------------- |
-| labelText | string | `""` | Specify the label text. |
-| id | string | -- | Set an id for the input element. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------- | :--------------- | :------- | :------------------ | ------------------------------------------------ | ------------------------------- |
+| labelText | let | No | string | "" | Specify the label text |
+| id | let | No | string | "ccs-" + Math.random().toString(36) | Set an id for the input element |
### Slots
-No slots.
-
-### Forwarded events
-
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
-
-### Dispatched events
+None.
-No dispatched events.
+### Events
----
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
-## ToggleSmall
-
-### Import path
-
-```js
-import { ToggleSmall } from "carbon-components-svelte";
-```
+## `ToggleSmall`
### Props
-| Prop name | Type | Default value | Description |
-| :-------- | :------------------- | :------------ | :----------------------------------------------- |
-| toggled | boolean | `false` | Set to `true` to toggle the checkbox input. |
-| disabled | boolean | `false` | Set to `true` to disable checkbox input. |
-| labelA | string | `"Off"` | Specify the label for the untoggled state. |
-| labelB | string | `"On"` | Specify the label for the toggled state. |
-| labelText | string | `""` | Specify the label text. |
-| id | string | -- | Set an id for the input element. |
-| name | string | -- | Specify a name attribute for the checkbox input. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------- | :--------------- | :------- | :------------------- | ------------------------------------------------ | ----------------------------------------------- |
+| toggled | let | Yes | boolean | false | Set to `true` to toggle the checkbox input |
+| disabled | let | No | boolean | false | Set to `true` to disable checkbox input |
+| labelA | let | No | string | "Off" | Specify the label for the untoggled state |
+| labelB | let | No | string | "On" | Specify the label for the toggled state |
+| labelText | let | No | string | "" | Specify the label text |
+| id | let | No | string | "ccs-" + Math.random().toString(36) | Set an id for the input element |
+| name | let | No | string | -- | Specify a name attribute for the checkbox input |
### Slots
-No slots.
-
-### Forwarded events
-
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
-- `on:change`
-- `on:keyup`
-- `on:focus`
-- `on:blur`
-
-### Dispatched events
-
-No dispatched events.
+None.
----
+### Events
-## ToggleSmallSkeleton
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
+| change | forwarded | -- |
+| keyup | forwarded | -- |
+| focus | forwarded | -- |
+| blur | forwarded | -- |
-### Import path
-
-```js
-import { ToggleSmallSkeleton } from "carbon-components-svelte";
-```
+## `ToggleSmallSkeleton`
### Props
-| Prop name | Type | Default value | Description |
-| :-------- | :------------------ | :------------ | :------------------------------- |
-| labelText | string | `""` | Specify the label text. |
-| id | string | -- | Set an id for the input element. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------- | :--------------- | :------- | :------------------ | ------------------------------------------------ | ------------------------------- |
+| labelText | let | No | string | "" | Specify the label text |
+| id | let | No | string | "ccs-" + Math.random().toString(36) | Set an id for the input element |
### Slots
-No slots.
-
-### Forwarded events
-
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
-
-### Dispatched events
-
-No dispatched events.
-
----
+None.
-## Toolbar
+### Events
-### Import path
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
-```js
-import { Toolbar } from "carbon-components-svelte";
-```
+## `Toolbar`
### Props
-| Prop name | Type | Default value | Description |
-| :-------- | :--------------------------------- | :------------ | :------------------------ |
-| size | "sm" | "default" | `"default"` | Specify the toolbar size. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------- | :--------------- | :------- | :--------------------------------- | ---------------------- | ------------------------ |
+| size | let | No | "sm" | "default" | "default" | Specify the toolbar size |
### Slots
-- **default**: `
`
-
-### Forwarded events
-
-- `on:click`
-- `on:keydown`
-
-### Dispatched events
-
-No dispatched events.
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :------- |
+| -- | Yes | -- | -- |
----
+### Events
-## ToolbarSearch
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+| keydown | forwarded | -- |
-### Import path
-
-```js
-import { ToolbarSearch } from "carbon-components-svelte";
-```
+## `ToolbarSearch`
### Props
-| Prop name | Type | Default value | Description |
-| :--------- | :---------------------------------------- | :------------ | :--------------------------------------------- |
-| value | string | `""` | Specify the value of the search input. |
-| expanded | boolean | `false` | Set to `true` to expand the search bar. |
-| persistent | boolean | `false` | Set to `true` to keep the search bar expanded. |
-| tabindex | string | `"0"` | Specify the tabindex. |
-| ref | null | HTMLInputElement | `null` | Obtain a reference to the input HTML element. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :--------- | :--------------- | :------- | :---------------------------------------- | ------------------ | --------------------------------------------- |
+| ref | let | Yes | null | HTMLInputElement | null | Obtain a reference to the input HTML element |
+| expanded | let | Yes | boolean | false | Set to `true` to expand the search bar |
+| value | let | Yes | number | string | "" | Specify the value of the search input |
+| persistent | let | No | boolean | false | Set to `true` to keep the search bar expanded |
+| tabindex | let | No | string | "0" | Specify the tabindex |
### Slots
-No slots.
-
-### Forwarded events
-
-- `on:change`
-- `on:input`
-- `on:focus`
-- `on:blur`
-
-### Dispatched events
-
-No dispatched events.
-
----
+None.
-## Tooltip
+### Events
-### Import path
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| change | forwarded | -- |
+| input | forwarded | -- |
+| focus | forwarded | -- |
+| blur | forwarded | -- |
-```js
-import { Tooltip } from "carbon-components-svelte";
-```
+## `Tooltip`
### Props
-| Prop name | Type | Default value | Description |
-| :-------------- | :------------------------------------------------------------------ | :------------ | :----------------------------------------------------------------------------------------------------------------------------- |
-| direction | "top" | "right" | "bottom" | "left" | `"bottom"` | Set the direction of the tooltip relative to the button. |
-| open | boolean | `false` | Set to `true` to open the tooltip. |
-| hideIcon | boolean | `false` | Set to `true` to hide the tooltip icon. |
-| icon | typeof import("carbon-icons-svelte/lib/Add16").default | -- | Specify the icon from `carbon-icons-svelte` to render for the tooltip button. Icon size must be 16px (e.g. `Add16`, `Task16`). |
-| iconDescription | string | `""` | Specify the ARIA label for the tooltip button. |
-| iconName | string | `""` | Specify the icon name attribute. |
-| tabindex | string | `"0"` | Set the button tabindex. |
-| tooltipId | string | -- | Set an id for the tooltip. |
-| triggerId | string | -- | Set an id for the tooltip button. |
-| triggerText | string | `""` | Set the tooltip button text. |
-| ref | null | HTMLElement | `null` | Obtain a reference to the trigger text HTML element. |
-| refTooltip | null | HTMLElement | `null` | Obtain a reference to the tooltip HTML element. |
-| refIcon | null | HTMLElement | `null` | Obtain a reference to the icon HTML element. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------------- | :--------------- | :------- | :-------------------------------------------------------------- | ------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |
+| refIcon | let | Yes | null | HTMLDivElement | null | Obtain a reference to the icon HTML element |
+| refTooltip | let | Yes | null | HTMLDivElement | null | Obtain a reference to the tooltip HTML element |
+| ref | let | Yes | null | HTMLDivElement | null | Obtain a reference to the trigger text HTML element |
+| open | let | Yes | boolean | false | Set to `true` to open the tooltip |
+| direction | let | No | "top" | "right" | "bottom" | "left" | "bottom" | Set the direction of the tooltip relative to the button |
+| hideIcon | let | No | boolean | false | Set to `true` to hide the tooltip icon |
+| icon | let | No | typeof import("carbon-icons-svelte").CarbonIcon | -- | Specify the icon from `carbon-icons-svelte` to render for the tooltip button Icon size must be 16px (e.g. `Add16`, `Task16`) |
+| iconDescription | let | No | string | "" | Specify the ARIA label for the tooltip button |
+| iconName | let | No | string | "" | Specify the icon name attribute |
+| tabindex | let | No | string | "0" | Set the button tabindex |
+| tooltipId | let | No | string | "ccs-" + Math.random().toString(36) | Set an id for the tooltip |
+| triggerId | let | No | string | "ccs-" + Math.random().toString(36) | Set an id for the tooltip button |
+| triggerText | let | No | string | "" | Set the tooltip button text |
### Slots
-- **default**: `
...
`
-- **"triggerText"**: `
...
`
-- **"icon"**: `
...
`
+| Slot name | Default | Props | Fallback |
+| :---------- | :------ | :---- | :---------------------------------------------------------------------- |
+| -- | Yes | -- | -- |
+| icon | No | -- | <svelte:component this="{icon}" name="{iconName}" /> |
+| triggerText | No | -- | {triggerText} |
-### Forwarded events
+### Events
-No forwarded events.
+None.
-### Dispatched events
-
-No dispatched events.
-
----
-
-## TooltipDefinition
-
-### Import path
-
-```js
-import { TooltipDefinition } from "carbon-components-svelte";
-```
+## `TooltipDefinition`
### Props
-| Prop name | Type | Default value | Description |
-| :---------- | :------------------------------------------------ | :------------ | :----------------------------------------------------- |
-| tooltipText | string | `""` | Specify the tooltip text. |
-| align | "start" | "center" | "end" | `"center"` | Set the alignment of the tooltip relative to the icon. |
-| direction | "top" | "bottom" | `"bottom"` | Set the direction of the tooltip relative to the icon. |
-| id | string | -- | Set an id for the tooltip div element. |
-| ref | null | HTMLButtonElement | `null` | Obtain a reference to the button HTML element. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :---------- | :--------------- | :------- | :------------------------------------------------ | ------------------------------------------------ | ----------------------------------------------------- |
+| ref | let | Yes | null | HTMLButtonElement | null | Obtain a reference to the button HTML element |
+| tooltipText | let | No | string | "" | Specify the tooltip text |
+| align | let | No | "start" | "center" | "end" | "center" | Set the alignment of the tooltip relative to the icon |
+| direction | let | No | "top" | "bottom" | "bottom" | Set the direction of the tooltip relative to the icon |
+| id | let | No | string | "ccs-" + Math.random().toString(36) | Set an id for the tooltip div element |
### Slots
-- **default**: `
...
`
-- **"tooltip"**: `
...
`
-
-### Forwarded events
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :------------------------- |
+| -- | Yes | -- | -- |
+| tooltip | No | -- | {tooltipText} |
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
-- `on:focus`
+### Events
-### Dispatched events
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
+| focus | forwarded | -- |
-No dispatched events.
-
----
-
-## TooltipIcon
-
-### Import path
-
-```js
-import { TooltipIcon } from "carbon-components-svelte";
-```
+## `TooltipIcon`
### Props
-| Prop name | Type | Default value | Description |
-| :---------- | :-------------------------------------------------------------- | :------------ | :----------------------------------------------------- |
-| tooltipText | string | `""` | Specify the tooltip text. |
-| align | "start" | "center" | "end" | `"center"` | Set the alignment of the tooltip relative to the icon. |
-| direction | "top" | "right" | "bottom" | "left" | `"bottom"` | Set the direction of the tooltip relative to the icon. |
-| id | string | -- | Set an id for the span element. |
-| ref | null | HTMLButtonElement | `null` | Obtain a reference to the button HTML element. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :---------- | :--------------- | :------- | :-------------------------------------------------------------- | ------------------------------------------------ | ----------------------------------------------------- |
+| ref | let | Yes | null | HTMLButtonElement | null | Obtain a reference to the button HTML element |
+| tooltipText | let | No | string | "" | Specify the tooltip text |
+| align | let | No | "start" | "center" | "end" | "center" | Set the alignment of the tooltip relative to the icon |
+| direction | let | No | "top" | "right" | "bottom" | "left" | "bottom" | Set the direction of the tooltip relative to the icon |
+| id | let | No | string | "ccs-" + Math.random().toString(36) | Set an id for the span element |
### Slots
-- **default**: `
...
`
-
-### Forwarded events
-
-- `on:click`
-- `on:mouseover`
-- `on:mouseenter`
-- `on:mouseleave`
-- `on:focus`
+| Slot name | Default | Props | Fallback |
+| :-------- | :------ | :---- | :------- |
+| -- | Yes | -- | -- |
-### Dispatched events
+### Events
-No dispatched events.
+| Event name | Type | Detail |
+| :--------- | :-------- | :----- |
+| click | forwarded | -- |
+| mouseover | forwarded | -- |
+| mouseenter | forwarded | -- |
+| mouseleave | forwarded | -- |
+| focus | forwarded | -- |
----
-
-## UnorderedList
-
-### Import path
-
-```js
-import { UnorderedList } from "carbon-components-svelte";
-```
+## `UnorderedList`
### Props
-| Prop name | Type | Default value | Description |
-| :-------- | :------------------- | :------------ | :--------------------------------------- |
-| nested | boolean | `false` | Set to `true` to use the nested variant. |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------- | :--------------- | :------- | :------------------- | ------------------ | --------------------------------------- |
+| nested | let | No | boolean | false | Set to `true` to use the nested variant |
### Slots
-- **default**: `
+ {#if component.rest_props}
+ {component.moduleName}
+ spreads
+ $$restProps
+ to the
+ {#if component.rest_props.type === 'Element'}
+ {component.rest_props.name}
+ element.
+ {:else}{component.rest_props.name} component.{/if}
+ {:else}This component does not spread restProps{/if}
+
diff --git a/docs/src/layouts/ComponentLayout.svelte b/docs/src/layouts/ComponentLayout.svelte
index 9d323448..1d462868 100644
--- a/docs/src/layouts/ComponentLayout.svelte
+++ b/docs/src/layouts/ComponentLayout.svelte
@@ -12,18 +12,13 @@
Tabs,
Tab,
TabContent,
- StructuredList,
- StructuredListHead,
- StructuredListRow,
- StructuredListCell,
- StructuredListBody,
} from "carbon-components-svelte";
import Code16 from "carbon-icons-svelte/lib/Code16";
import { page, metatags } from "@sveltech/routify";
import { onMount } from "svelte";
import { theme } from "../store";
import ComponentApi from "../components/ComponentApi.svelte";
- import API from "../PUBLIC_API.json";
+ import COMPONENT_API from "../COMPONENT_API.json";
export let component = $page.title;
export let components = [component];
@@ -33,8 +28,11 @@
metatags.title = $page.title;
- $: api = components.map((_) => API.components[_]).filter(Boolean);
- $: multiple = api.length > 1;
+ // TODO: `find` is not supported in IE
+ $: api_components = components.map((i) =>
+ COMPONENT_API.components.find((_) => _.moduleName === i)
+ );
+ $: multiple = api_components.length > 1;
onMount(() => {
const currentTheme = window.location.search.split("?theme=")[1];
@@ -173,15 +171,10 @@
Component API
- Component API documentation is
-
- auto-generated
+ Component documentation is
+
+ auto-generated by sveld.
- from a build script.
@@ -190,11 +183,11 @@
{#if multiple}
- {#each api as component, i (component.moduleName)}
+ {#each api_components as component (component.moduleName)}
{/each}
- {#each api as component, i (component.moduleName)}
+ {#each api_components as component (component.moduleName)}
@@ -202,7 +195,7 @@
+ /**
+ * @event {string} delete
+ */
+
/**
* Specify the file uploader status
- * @type {"uploading" | "edit" | "complete"} [status="uploading"]
+ * @type {"uploading" | "edit" | "complete"}
*/
export let status = "uploading";
- /**
- * Specify the ARIA label used for the status icons
- * @type {string} [iconDescription=""]
- */
+ /** Specify the ARIA label used for the status icons */
export let iconDescription = "";
- /**
- * Set to `true` to indicate an invalid state
- * @type {boolean} [invalid=false]
- */
+ /** Set to `true` to indicate an invalid state */
export let invalid = false;
- /**
- * Specify the error subject text
- * @type {string} [errorSubject=""]
- */
+ /** Specify the error subject text */
export let errorSubject = "";
- /**
- * Specify the error body text
- * @type {string} [errorBody=""]
- */
+ /** Specify the error body text */
export let errorBody = "";
- /**
- * Set an id for the top-level element
- * @type {string} [id]
- */
+ /** Set an id for the top-level element */
export let id = "ccs-" + Math.random().toString(36);
- /**
- * Specify the file uploader name
- * @type {string} [name=""]
- */
+ /** Specify the file uploader name */
export let name = "";
import { createEventDispatcher } from "svelte";
diff --git a/src/FileUploader/FileUploader.Skeleton.svelte b/src/FileUploader/FileUploaderSkeleton.svelte
similarity index 100%
rename from src/FileUploader/FileUploader.Skeleton.svelte
rename to src/FileUploader/FileUploaderSkeleton.svelte
diff --git a/src/FileUploader/Filename.svelte b/src/FileUploader/Filename.svelte
index 36d0f040..d8d913a7 100644
--- a/src/FileUploader/Filename.svelte
+++ b/src/FileUploader/Filename.svelte
@@ -1,20 +1,14 @@
diff --git a/src/FormLabel/FormLabel.svelte b/src/FormLabel/FormLabel.svelte
index 937d136b..535e6dee 100644
--- a/src/FormLabel/FormLabel.svelte
+++ b/src/FormLabel/FormLabel.svelte
@@ -1,8 +1,5 @@
diff --git a/src/Grid/Column.svelte b/src/Grid/Column.svelte
index 7734f509..7964d317 100644
--- a/src/Grid/Column.svelte
+++ b/src/Grid/Column.svelte
@@ -1,76 +1,67 @@
{#if skeleton}
diff --git a/src/Icon/Icon.Skeleton.svelte b/src/Icon/IconSkeleton.svelte
similarity index 76%
rename from src/Icon/Icon.Skeleton.svelte
rename to src/Icon/IconSkeleton.svelte
index 4d958fbd..e67da320 100644
--- a/src/Icon/Icon.Skeleton.svelte
+++ b/src/Icon/IconSkeleton.svelte
@@ -1,8 +1,5 @@
diff --git a/src/Icon/index.js b/src/Icon/index.js
index 41f46931..551efcd3 100644
--- a/src/Icon/index.js
+++ b/src/Icon/index.js
@@ -1,2 +1,2 @@
export { default as Icon } from "./Icon.svelte";
-export { default as IconSkeleton } from "./Icon.Skeleton.svelte";
+export { default as IconSkeleton } from "./IconSkeleton.svelte";
diff --git a/src/InlineLoading/InlineLoading.svelte b/src/InlineLoading/InlineLoading.svelte
index 8498100f..081d05e8 100644
--- a/src/InlineLoading/InlineLoading.svelte
+++ b/src/InlineLoading/InlineLoading.svelte
@@ -1,26 +1,23 @@
diff --git a/src/ListBox/ListBox.svelte b/src/ListBox/ListBox.svelte
index 5e519d95..9e3298e9 100644
--- a/src/ListBox/ListBox.svelte
+++ b/src/ListBox/ListBox.svelte
@@ -1,44 +1,29 @@
diff --git a/src/ListBox/ListBoxField.svelte b/src/ListBox/ListBoxField.svelte
index 9c06b8e1..5341a42e 100644
--- a/src/ListBox/ListBoxField.svelte
+++ b/src/ListBox/ListBoxField.svelte
@@ -1,51 +1,32 @@
diff --git a/src/ListBox/ListBoxMenuIcon.svelte b/src/ListBox/ListBoxMenuIcon.svelte
index dd4c8836..d1cd1485 100644
--- a/src/ListBox/ListBoxMenuIcon.svelte
+++ b/src/ListBox/ListBoxMenuIcon.svelte
@@ -1,27 +1,20 @@
diff --git a/src/ListBox/ListBoxSelection.svelte b/src/ListBox/ListBoxSelection.svelte
index 8df1bfb7..6fc1d25e 100644
--- a/src/ListBox/ListBoxSelection.svelte
+++ b/src/ListBox/ListBoxSelection.svelte
@@ -1,21 +1,18 @@
diff --git a/src/Notification/ToastNotification.svelte b/src/Notification/ToastNotification.svelte
index 2eebb2a2..597295fc 100644
--- a/src/Notification/ToastNotification.svelte
+++ b/src/Notification/ToastNotification.svelte
@@ -1,62 +1,38 @@
diff --git a/src/NumberInput/index.js b/src/NumberInput/index.js
index af304831..d58c80e1 100644
--- a/src/NumberInput/index.js
+++ b/src/NumberInput/index.js
@@ -1,2 +1,2 @@
export { default as NumberInput } from "./NumberInput.svelte";
-export { default as NumberInputSkeleton } from "./NumberInput.Skeleton.svelte";
+export { default as NumberInputSkeleton } from "./NumberInputSkeleton.svelte";
diff --git a/src/OrderedList/OrderedList.svelte b/src/OrderedList/OrderedList.svelte
index 449e39f9..d4facb31 100644
--- a/src/OrderedList/OrderedList.svelte
+++ b/src/OrderedList/OrderedList.svelte
@@ -1,14 +1,8 @@
diff --git a/src/OverflowMenu/OverflowMenu.svelte b/src/OverflowMenu/OverflowMenu.svelte
index 26121925..4d2b4080 100644
--- a/src/OverflowMenu/OverflowMenu.svelte
+++ b/src/OverflowMenu/OverflowMenu.svelte
@@ -1,74 +1,53 @@
diff --git a/src/PaginationNav/PaginationNav.svelte b/src/PaginationNav/PaginationNav.svelte
index 0292d977..1e97b5e9 100644
--- a/src/PaginationNav/PaginationNav.svelte
+++ b/src/PaginationNav/PaginationNav.svelte
@@ -1,38 +1,20 @@
diff --git a/src/ProgressIndicator/ProgressStep.svelte b/src/ProgressIndicator/ProgressStep.svelte
index 3ed26843..96f7b6fd 100644
--- a/src/ProgressIndicator/ProgressStep.svelte
+++ b/src/ProgressIndicator/ProgressStep.svelte
@@ -1,50 +1,26 @@
diff --git a/src/Search/Search.Skeleton.svelte b/src/Search/SearchSkeleton.svelte
similarity index 88%
rename from src/Search/Search.Skeleton.svelte
rename to src/Search/SearchSkeleton.svelte
index 8ca6a06c..a8059b17 100644
--- a/src/Search/Search.Skeleton.svelte
+++ b/src/Search/SearchSkeleton.svelte
@@ -2,13 +2,12 @@
/**
* @deprecated this prop will be removed in the next major release
* Set to `true` to use the small variant
- * @type {boolean} [small=false]
*/
export let small = false;
/**
* Specify the size of the search input
- * @type {"sm" | "lg" | "xl"} [size="xl"]
+ * @type {"sm" | "lg" | "xl"}
*/
export let size = "xl";
diff --git a/src/Search/index.js b/src/Search/index.js
index 535981c0..5ce0608a 100644
--- a/src/Search/index.js
+++ b/src/Search/index.js
@@ -1,2 +1,2 @@
export { default as Search } from "./Search.svelte";
-export { default as SearchSkeleton } from "./Search.Skeleton.svelte";
+export { default as SearchSkeleton } from "./SearchSkeleton.svelte";
diff --git a/src/Select/Select.svelte b/src/Select/Select.svelte
index b6884aac..1a1620ac 100644
--- a/src/Select/Select.svelte
+++ b/src/Select/Select.svelte
@@ -1,86 +1,53 @@
diff --git a/src/Select/Select.Skeleton.svelte b/src/Select/SelectSkeleton.svelte
similarity index 80%
rename from src/Select/Select.Skeleton.svelte
rename to src/Select/SelectSkeleton.svelte
index df67e270..4b0382ef 100644
--- a/src/Select/Select.Skeleton.svelte
+++ b/src/Select/SelectSkeleton.svelte
@@ -1,8 +1,5 @@
diff --git a/src/Select/index.js b/src/Select/index.js
index 22f8cd67..06350614 100644
--- a/src/Select/index.js
+++ b/src/Select/index.js
@@ -1,4 +1,4 @@
export { default as Select } from "./Select.svelte";
-export { default as SelectSkeleton } from "./Select.Skeleton.svelte";
+export { default as SelectSkeleton } from "./SelectSkeleton.svelte";
export { default as SelectItem } from "./SelectItem.svelte";
export { default as SelectItemGroup } from "./SelectItemGroup.svelte";
diff --git a/src/SkeletonText/SkeletonText.svelte b/src/SkeletonText/SkeletonText.svelte
index 0b8e0571..745d6299 100644
--- a/src/SkeletonText/SkeletonText.svelte
+++ b/src/SkeletonText/SkeletonText.svelte
@@ -1,33 +1,16 @@
diff --git a/src/Slider/index.js b/src/Slider/index.js
index 558290e1..5f440043 100644
--- a/src/Slider/index.js
+++ b/src/Slider/index.js
@@ -1,2 +1,2 @@
export { default as Slider } from "./Slider.svelte";
-export { default as SliderSkeleton } from "./Slider.Skeleton.svelte";
+export { default as SliderSkeleton } from "./SliderSkeleton.svelte";
diff --git a/src/StructuredList/StructuredList.svelte b/src/StructuredList/StructuredList.svelte
index 7e4ab923..919b9fbd 100644
--- a/src/StructuredList/StructuredList.svelte
+++ b/src/StructuredList/StructuredList.svelte
@@ -1,20 +1,14 @@
diff --git a/src/StructuredList/StructuredListInput.svelte b/src/StructuredList/StructuredListInput.svelte
index d1314b5f..2b0f365e 100644
--- a/src/StructuredList/StructuredListInput.svelte
+++ b/src/StructuredList/StructuredListInput.svelte
@@ -1,38 +1,20 @@
diff --git a/src/StructuredList/StructuredList.Skeleton.svelte b/src/StructuredList/StructuredListSkeleton.svelte
similarity index 86%
rename from src/StructuredList/StructuredList.Skeleton.svelte
rename to src/StructuredList/StructuredListSkeleton.svelte
index 0b04ccdd..a52ede00 100644
--- a/src/StructuredList/StructuredList.Skeleton.svelte
+++ b/src/StructuredList/StructuredListSkeleton.svelte
@@ -1,14 +1,8 @@
diff --git a/src/StructuredList/index.js b/src/StructuredList/index.js
index 6b3bf38e..41c131b0 100644
--- a/src/StructuredList/index.js
+++ b/src/StructuredList/index.js
@@ -1,5 +1,5 @@
export { default as StructuredList } from "./StructuredList.svelte";
-export { default as StructuredListSkeleton } from "./StructuredList.Skeleton.svelte";
+export { default as StructuredListSkeleton } from "./StructuredListSkeleton.svelte";
export { default as StructuredListBody } from "./StructuredListBody.svelte";
export { default as StructuredListHead } from "./StructuredListHead.svelte";
export { default as StructuredListCell } from "./StructuredListCell.svelte";
diff --git a/src/Tabs/Tab.svelte b/src/Tabs/Tab.svelte
index b8d53cca..43c49adc 100644
--- a/src/Tabs/Tab.svelte
+++ b/src/Tabs/Tab.svelte
@@ -2,38 +2,22 @@
/**
* Specify the tab label
* Alternatively, use the default slot (e.g. Label)
- * @type {string} [label=""]
*/
export let label = "";
- /**
- * Specify the href attribute
- * @type {string} [href="#"]
- */
+ /** Specify the href attribute */
export let href = "#";
- /**
- * Set to `true` to disable the tab
- * @type {boolean} [disabled=false]
- */
+ /** Set to `true` to disable the tab */
export let disabled = false;
- /**
- * Specify the tabindex
- * @type {string} [tabindex="0"]
- */
+ /** Specify the tabindex */
export let tabindex = "0";
- /**
- * Set an id for the top-level element
- * @type {string} [id]
- */
+ /** Set an id for the top-level element */
export let id = "ccs-" + Math.random().toString(36);
- /**
- * Obtain a reference to the anchor HTML element
- * @type {null | HTMLAnchorElement} [ref=null]
- */
+ /** Obtain a reference to the anchor HTML element */
export let ref = null;
import { getContext } from "svelte";
diff --git a/src/Tabs/TabContent.svelte b/src/Tabs/TabContent.svelte
index fcaa2dff..b04cacf5 100644
--- a/src/Tabs/TabContent.svelte
+++ b/src/Tabs/TabContent.svelte
@@ -1,8 +1,5 @@
diff --git a/src/Tag/Tag.svelte b/src/Tag/Tag.svelte
index eca4b4f5..f80abfc7 100644
--- a/src/Tag/Tag.svelte
+++ b/src/Tag/Tag.svelte
@@ -1,42 +1,31 @@
{#if skeleton}
diff --git a/src/Tag/Tag.Skeleton.svelte b/src/Tag/TagSkeleton.svelte
similarity index 100%
rename from src/Tag/Tag.Skeleton.svelte
rename to src/Tag/TagSkeleton.svelte
diff --git a/src/Tag/index.js b/src/Tag/index.js
index 21b86b2c..b33646f6 100644
--- a/src/Tag/index.js
+++ b/src/Tag/index.js
@@ -1,2 +1,2 @@
export { default as Tag } from "./Tag.svelte";
-export { default as TagSkeleton } from "./Tag.Skeleton.svelte";
+export { default as TagSkeleton } from "./TagSkeleton.svelte";
diff --git a/src/TextArea/TextArea.svelte b/src/TextArea/TextArea.svelte
index edecf626..fa338b41 100644
--- a/src/TextArea/TextArea.svelte
+++ b/src/TextArea/TextArea.svelte
@@ -1,86 +1,47 @@
diff --git a/src/TextArea/index.js b/src/TextArea/index.js
index 74782672..91cd083d 100644
--- a/src/TextArea/index.js
+++ b/src/TextArea/index.js
@@ -1,2 +1,2 @@
export { default as TextArea } from "./TextArea.svelte";
-export { default as TextAreaSkeleton } from "./TextArea.Skeleton.svelte";
+export { default as TextAreaSkeleton } from "./TextAreaSkeleton.svelte";
diff --git a/src/TextInput/PasswordInput.svelte b/src/TextInput/PasswordInput.svelte
index c92f933f..f0ef0613 100644
--- a/src/TextInput/PasswordInput.svelte
+++ b/src/TextInput/PasswordInput.svelte
@@ -1,110 +1,74 @@
diff --git a/src/TextInput/index.js b/src/TextInput/index.js
index 6a3d8273..a3399154 100644
--- a/src/TextInput/index.js
+++ b/src/TextInput/index.js
@@ -1,3 +1,3 @@
export { default as TextInput } from "./TextInput.svelte";
-export { default as TextInputSkeleton } from "./TextInput.Skeleton.svelte";
+export { default as TextInputSkeleton } from "./TextInputSkeleton.svelte";
export { default as PasswordInput } from "./PasswordInput.svelte";
diff --git a/src/Tile/ClickableTile.svelte b/src/Tile/ClickableTile.svelte
index 61dce622..980216c4 100644
--- a/src/Tile/ClickableTile.svelte
+++ b/src/Tile/ClickableTile.svelte
@@ -1,19 +1,13 @@
diff --git a/src/Tile/ExpandableTile.svelte b/src/Tile/ExpandableTile.svelte
index f47c933c..ee5a2349 100644
--- a/src/Tile/ExpandableTile.svelte
+++ b/src/Tile/ExpandableTile.svelte
@@ -1,56 +1,29 @@
diff --git a/src/Tile/TileGroup.svelte b/src/Tile/TileGroup.svelte
index eda7a7c9..4a5cc508 100644
--- a/src/Tile/TileGroup.svelte
+++ b/src/Tile/TileGroup.svelte
@@ -1,20 +1,14 @@
diff --git a/src/TimePicker/TimePickerSelect.svelte b/src/TimePicker/TimePickerSelect.svelte
index 7cae55ad..2eb46a25 100644
--- a/src/TimePicker/TimePickerSelect.svelte
+++ b/src/TimePicker/TimePickerSelect.svelte
@@ -1,51 +1,35 @@
diff --git a/src/Toggle/Toggle.Skeleton.svelte b/src/Toggle/ToggleSkeleton.svelte
similarity index 84%
rename from src/Toggle/Toggle.Skeleton.svelte
rename to src/Toggle/ToggleSkeleton.svelte
index a063e6ae..0098a51e 100644
--- a/src/Toggle/Toggle.Skeleton.svelte
+++ b/src/Toggle/ToggleSkeleton.svelte
@@ -1,14 +1,8 @@
diff --git a/src/Toggle/index.js b/src/Toggle/index.js
index 47df71f0..44cffe37 100644
--- a/src/Toggle/index.js
+++ b/src/Toggle/index.js
@@ -1,2 +1,2 @@
export { default as Toggle } from "./Toggle.svelte";
-export { default as ToggleSkeleton } from "./Toggle.Skeleton.svelte";
+export { default as ToggleSkeleton } from "./ToggleSkeleton.svelte";
diff --git a/src/ToggleSmall/ToggleSmall.svelte b/src/ToggleSmall/ToggleSmall.svelte
index dbba1bd5..6afb4371 100644
--- a/src/ToggleSmall/ToggleSmall.svelte
+++ b/src/ToggleSmall/ToggleSmall.svelte
@@ -1,43 +1,25 @@
diff --git a/src/ToggleSmall/ToggleSmall.Skeleton.svelte b/src/ToggleSmall/ToggleSmallSkeleton.svelte
similarity index 86%
rename from src/ToggleSmall/ToggleSmall.Skeleton.svelte
rename to src/ToggleSmall/ToggleSmallSkeleton.svelte
index d55c6a1e..98b61228 100644
--- a/src/ToggleSmall/ToggleSmall.Skeleton.svelte
+++ b/src/ToggleSmall/ToggleSmallSkeleton.svelte
@@ -1,14 +1,8 @@
diff --git a/src/ToggleSmall/index.js b/src/ToggleSmall/index.js
index 48daac0b..ad88325b 100644
--- a/src/ToggleSmall/index.js
+++ b/src/ToggleSmall/index.js
@@ -1,2 +1,2 @@
export { default as ToggleSmall } from "./ToggleSmall.svelte";
-export { default as ToggleSmallSkeleton } from "./ToggleSmall.Skeleton.svelte";
+export { default as ToggleSmallSkeleton } from "./ToggleSmallSkeleton.svelte";
diff --git a/src/Tooltip/Tooltip.svelte b/src/Tooltip/Tooltip.svelte
index 2eb7ee7a..fb1a8479 100644
--- a/src/Tooltip/Tooltip.svelte
+++ b/src/Tooltip/Tooltip.svelte
@@ -1,81 +1,60 @@
- /**
- * Specify the id for the main element
- * @type {string} [id="main-content"]
- */
+ /** Specify the id for the main element */
export let id = "main-content";
diff --git a/src/UIShell/GlobalHeader/Header.svelte b/src/UIShell/GlobalHeader/Header.svelte
index 311f9725..d542bb21 100644
--- a/src/UIShell/GlobalHeader/Header.svelte
+++ b/src/UIShell/GlobalHeader/Header.svelte
@@ -1,51 +1,38 @@
diff --git a/src/UIShell/GlobalHeader/HeaderNavItem.svelte b/src/UIShell/GlobalHeader/HeaderNavItem.svelte
index b7dd47c4..3d8c752e 100644
--- a/src/UIShell/GlobalHeader/HeaderNavItem.svelte
+++ b/src/UIShell/GlobalHeader/HeaderNavItem.svelte
@@ -1,20 +1,17 @@
diff --git a/src/UIShell/GlobalHeader/HeaderNavMenu.svelte b/src/UIShell/GlobalHeader/HeaderNavMenu.svelte
index 0d9506d0..66e25483 100644
--- a/src/UIShell/GlobalHeader/HeaderNavMenu.svelte
+++ b/src/UIShell/GlobalHeader/HeaderNavMenu.svelte
@@ -1,32 +1,20 @@
diff --git a/src/UIShell/HeaderGlobalAction.svelte b/src/UIShell/HeaderGlobalAction.svelte
index 18d442b9..6f574918 100644
--- a/src/UIShell/HeaderGlobalAction.svelte
+++ b/src/UIShell/HeaderGlobalAction.svelte
@@ -1,20 +1,14 @@
diff --git a/src/UIShell/SideNav/HamburgerMenu.svelte b/src/UIShell/SideNav/HamburgerMenu.svelte
index 4e550d61..c75aa8a3 100644
--- a/src/UIShell/SideNav/HamburgerMenu.svelte
+++ b/src/UIShell/SideNav/HamburgerMenu.svelte
@@ -1,20 +1,14 @@
diff --git a/src/UIShell/SideNav/SideNavLink.svelte b/src/UIShell/SideNav/SideNavLink.svelte
index 2443af4b..d79c59bf 100644
--- a/src/UIShell/SideNav/SideNavLink.svelte
+++ b/src/UIShell/SideNav/SideNavLink.svelte
@@ -1,32 +1,26 @@
diff --git a/src/UIShell/SkipToContent.svelte b/src/UIShell/SkipToContent.svelte
index 6fc15809..cbba79ce 100644
--- a/src/UIShell/SkipToContent.svelte
+++ b/src/UIShell/SkipToContent.svelte
@@ -1,14 +1,8 @@
diff --git a/src/UnorderedList/UnorderedList.svelte b/src/UnorderedList/UnorderedList.svelte
index 7ab560ae..83632d00 100644
--- a/src/UnorderedList/UnorderedList.svelte
+++ b/src/UnorderedList/UnorderedList.svelte
@@ -1,8 +1,5 @@
diff --git a/tests/Accordion.test.svelte b/tests/Accordion.test.svelte
new file mode 100644
index 00000000..53b649a1
--- /dev/null
+++ b/tests/Accordion.test.svelte
@@ -0,0 +1,219 @@
+
+
+
+
+
+ Natural Language Classifier uses advanced natural language processing and
+ machine learning techniques to create custom classification models. Users
+ train their data and the service predicts the appropriate category for the
+ inputted text.
+
+
+
+
+ Analyze text to extract meta-data from content such as concepts, entities,
+ emotion, relations, sentiment and more.
+
+
+
+
+ Translate text, documents, and websites from one language to another.
+ Create industry or region-specific translations via the service's
+ customization capability.
+
+
+
+
+
+
+
+ Natural Language Classifier uses advanced natural language processing and
+ machine learning techniques to create custom classification models. Users
+ train their data and the service predicts the appropriate category for the
+ inputted text.
+
+
+
+
+ Analyze text to extract meta-data from content such as concepts, entities,
+ emotion, relations, sentiment and more.
+
+
+
+
+ Translate text, documents, and websites from one language to another.
+ Create industry or region-specific translations via the service's
+ customization capability.
+
+
+
+
+
+
+
+
Natural Language Classifier
+
AI / Machine Learning
+
+
+ Natural Language Classifier uses advanced natural language processing and
+ machine learning techniques to create custom classification models. Users
+ train their data and the service predicts the appropriate category for the
+ inputted text.
+
+
+
+
+
Natural Language Understanding
+
AI / Machine Learning
+
+
+ Analyze text to extract meta-data from content such as concepts, entities,
+ emotion, relations, sentiment and more.
+
+
+
+
+
Language Translator
+
AI / Machine Learning
+
+
+ Translate text, documents, and websites from one language to another.
+ Create industry or region-specific translations via the service's
+ customization capability.
+
+
+
+
+
+
+
+ Natural Language Classifier uses advanced natural language processing and
+ machine learning techniques to create custom classification models. Users
+ train their data and the service predicts the appropriate category for the
+ inputted text.
+
+
+
+
+ Analyze text to extract meta-data from content such as concepts, entities,
+ emotion, relations, sentiment and more.
+
+
+
+
+ Translate text, documents, and websites from one language to another.
+ Create industry or region-specific translations via the service's
+ customization capability.
+
+
+
+
+
+
+
+ Natural Language Classifier uses advanced natural language processing and
+ machine learning techniques to create custom classification models. Users
+ train their data and the service predicts the appropriate category for the
+ inputted text.
+
+
+
+
+ Analyze text to extract meta-data from content such as concepts, entities,
+ emotion, relations, sentiment and more.
+
+
+
+
+ Translate text, documents, and websites from one language to another.
+ Create industry or region-specific translations via the service's
+ customization capability.
+
+
+
+
+
+
+
+ Natural Language Classifier uses advanced natural language processing and
+ machine learning techniques to create custom classification models. Users
+ train their data and the service predicts the appropriate category for the
+ inputted text.
+
+
+
+
+ Analyze text to extract meta-data from content such as concepts, entities,
+ emotion, relations, sentiment and more.
+
+
+
+
+ Translate text, documents, and websites from one language to another.
+ Create industry or region-specific translations via the service's
+ customization capability.
+
+
+
+
+
+
+
+ Natural Language Classifier uses advanced natural language processing and
+ machine learning techniques to create custom classification models. Users
+ train their data and the service predicts the appropriate category for the
+ inputted text.
+
+
+
+
+ Analyze text to extract meta-data from content such as concepts, entities,
+ emotion, relations, sentiment and more.
+
+
+
+
+ Translate text, documents, and websites from one language to another.
+ Create industry or region-specific translations via the service's
+ customization capability.
+
+
+
+
+
+
+
+ Natural Language Classifier uses advanced natural language processing and
+ machine learning techniques to create custom classification models. Users
+ train their data and the service predicts the appropriate category for the
+ inputted text.
+
+
+
+
+ Analyze text to extract meta-data from content such as concepts, entities,
+ emotion, relations, sentiment and more.
+
+
+
+
+ Translate text, documents, and websites from one language to another.
+ Create industry or region-specific translations via the service's
+ customization capability.
+