let
| No | "default" | "field" | "small" | "lg" | "xl"
| "default"
| Specify the size of button |
| expressive | No | let
| No | boolean
| false
| Set to `true` to use Carbon's expressive typesetting |
| isSelected | No | let
| No | boolean
| false
| Set to `true` to enable the selected state for an icon-only, ghost button |
-| icon | No | let
| No | typeof import("svelte").SvelteComponent
| undefined
| Specify the icon to renderlet
| No | any
| undefined
| Specify the icon to renderlet
| No | string
| undefined
| Specify the ARIA label for the button icon |
| tooltipAlignment | No | let
| No | "start" | "center" | "end"
| "center"
| Set the alignment of the tooltip relative to the icon.let
| No | "top" | "right" | "bottom" | "left"
| "bottom"
| Set the position of the tooltip relative to the icon |
@@ -671,6 +671,7 @@ export interface ComboBoxItem {
| size | No | let
| No | "sm" | "xl"
| undefined
| Set the size of the combobox |
| disabled | No | let
| No | boolean
| false
| Set to `true` to disable the combobox |
| titleText | No | let
| No | string
| ""
| Specify the title text of the combobox |
+| hideLabel | No | let
| No | boolean
| false
| Set to `true` to visually hide the label text |
| placeholder | No | let
| No | string
| ""
| Specify the placeholder text |
| helperText | No | let
| No | string
| ""
| Specify the helper text |
| invalidText | No | let
| No | string
| ""
| Specify the invalid state text |
@@ -847,18 +848,18 @@ None.
### Props
-| Prop name | Required | Kind | Reactive | Type | Default value | Description |
-| :----------- | :------- | :--------------- | :------- | --------------------------------------------------------- | ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------- |
-| ref | No | let
| Yes | null | HTMLLIElement
| null
| Obtain a reference to the list item HTML element |
-| selectable | No | let
| Yes | boolean
| false
| Set to `true` to enable the selectable variantlet
| Yes | boolean
| false
| Set to `true` to use the selected variant |
-| icon | No | let
| Yes | typeof import("svelte").SvelteComponent
| undefined
| Specify the icon to renderlet
| Yes | boolean
| false
| Set to `true` to indent the label |
-| kind | No | let
| No | "default" | "danger"
| "default"
| Specify the kind of option |
-| disabled | No | let
| No | boolean
| false
| Set to `true` to enable the disabled state |
-| labelText | No | let
| No | string
| ""
| Specify the label text.let
| No | string
| ""
| Specify the shortcut text.let
| No | string
| "ccs-" + Math.random().toString(36)
| Specify the idlet
| Yes | null | HTMLLIElement
| null
| Obtain a reference to the list item HTML element |
+| selectable | No | let
| Yes | boolean
| false
| Set to `true` to enable the selectable variantlet
| Yes | boolean
| false
| Set to `true` to use the selected variant |
+| icon | No | let
| Yes | any
| undefined
| Specify the icon to renderlet
| Yes | boolean
| false
| Set to `true` to indent the label |
+| kind | No | let
| No | "default" | "danger"
| "default"
| Specify the kind of option |
+| disabled | No | let
| No | boolean
| false
| Set to `true` to enable the disabled state |
+| labelText | No | let
| No | string
| ""
| Specify the label text.let
| No | string
| ""
| Specify the shortcut text.let
| No | string
| "ccs-" + Math.random().toString(36)
| Specify the idlet
| Yes | ReadonlyArray
| []
| Specify the row ids to be selected |
-| selectable | No | let
| Yes | boolean
| false
| Set to `true` for the selectable variantlet
| Yes | ReadonlyArray
| []
| Specify the row ids to be expanded |
-| expandable | No | let
| Yes | boolean
| false
| Set to `true` for the expandable variantlet
| Yes | "none" | "ascending" | "descending"
| "none"
| Specify the sort direction |
-| sortKey | No | let
| Yes | DataTableKey|
| null
| Specify the header key to sort by |
-| headers | No | let
| No | ReadonlyArray>
| []
| Specify the data table headers |
-| rows | No | let
| No | ReadonlyArray|
| []
| Specify the rows the data table should renderlet
| No | "compact" | "short" | "medium" | "tall"
| undefined
| Set the size of the data table |
-| title | No | let
| No | string
| ""
| Specify the title of the data table |
-| description | No | let
| No | string
| ""
| Specify the description of the data table |
-| zebra | No | let
| No | boolean
| false
| Set to `true` to use zebra styles |
-| sortable | No | let
| No | boolean
| false
| Set to `true` for the sortable variant |
-| batchExpansion | No | let
| No | boolean
| false
| Set to `true` to enable batch expansion |
-| nonExpandableRowIds | No | let
| No | ReadonlyArray
| []
| Specify the ids for rows that should not be expandable |
-| radio | No | let
| No | boolean
| false
| Set to `true` for the radio selection variant |
-| batchSelection | No | let
| No | boolean
| false
| Set to `true` to enable batch selection |
-| nonSelectableRowIds | No | let
| No | ReadonlyArray
| []
| Specify the ids of rows that should not be selectable |
-| stickyHeader | No | let
| No | boolean
| false
| Set to `true` to enable a sticky header |
-| useStaticWidth | No | let
| No | boolean
| false
| Set to `true` to use static width |
-| pageSize | No | let
| No | number
| 0
| Specify the number of items to display in a page |
-| page | No | let
| No | number
| 0
| Set to `number` to set current page |
+| Prop name | Required | Kind | Reactive | Type | Default value | Description |
+| :------------------ | :------- | :--------------- | :------- | ------------------------------------------------------------------- | ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| selectedRowIds | No | let
| Yes | ReadonlyArray
| []
| Specify the row ids to be selected |
+| selectable | No | let
| Yes | boolean
| false
| Set to `true` for the selectable variantlet
| Yes | ReadonlyArray
| []
| Specify the row ids to be expanded |
+| expandable | No | let
| Yes | boolean
| false
| Set to `true` for the expandable variantlet
| Yes | "none" | "ascending" | "descending"
| "none"
| Specify the sort direction |
+| sortKey | No | let
| Yes | DataTableKey|
| null
| Specify the header key to sort by |
+| headers | No | let
| No | ReadonlyArray>
| []
| Specify the data table headers |
+| rows | No | let
| No | ReadonlyArray|
| []
| Specify the rows the data table should renderlet
| No | "compact" | "short" | "medium" | "tall"
| undefined
| Set the size of the data table |
+| title | No | let
| No | string
| ""
| Specify the title of the data table |
+| description | No | let
| No | string
| ""
| Specify the description of the data table |
+| inputName | No | let
| No | string
| "ccs-" + Math.random().toString(36)
| Specify a name attribute for the input elementslet
| No | boolean
| false
| Set to `true` to use zebra styles |
+| sortable | No | let
| No | boolean
| false
| Set to `true` for the sortable variant |
+| batchExpansion | No | let
| No | boolean
| false
| Set to `true` to enable batch expansion |
+| nonExpandableRowIds | No | let
| No | ReadonlyArray
| []
| Specify the ids for rows that should not be expandable |
+| radio | No | let
| No | boolean
| false
| Set to `true` for the radio selection variant |
+| batchSelection | No | let
| No | boolean
| false
| Set to `true` to enable batch selection |
+| nonSelectableRowIds | No | let
| No | ReadonlyArray
| []
| Specify the ids of rows that should not be selectable |
+| stickyHeader | No | let
| No | boolean
| false
| Set to `true` to enable a sticky header |
+| useStaticWidth | No | let
| No | boolean
| false
| Set to `true` to use static width |
+| pageSize | No | let
| No | number
| 0
| Specify the number of items to display in a page |
+| page | No | let
| No | number
| 0
| Set to `number` to set current page |
### Slots
@@ -1582,19 +1584,19 @@ None.
### Props
-| Prop name | Required | Kind | Reactive | Type | Default value | Description |
-| :---------------------- | :------- | :--------------- | :------- | --------------------------------------------------------- | ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| ref | No | let
| Yes | null | HTMLAnchorElement
| null
| Obtain a reference to the HTML anchor element |
-| isSideNavOpen | No | let
| Yes | boolean
| false
| Set to `true` to open the side nav |
-| expandedByDefault | No | let
| No | boolean
| true
| Set to `false` to hide the side nav by default |
-| uiShellAriaLabel | No | let
| No | string
| undefined
| Specify the ARIA label for the header |
-| href | No | let
| No | string
| undefined
| Specify the `href` attribute |
-| company | No | let
| No | string
| undefined
| Specify the company name.let
| No | string
| ""
| Specify the platform name.let
| No | boolean
| false
| Set to `true` to persist the hamburger menu |
-| expansionBreakpoint | No | let
| No | number
| 1056
| The window width (px) at which the SideNav is expanded and the hamburger menu is hidden.let
| No | typeof import("svelte").SvelteComponent
| undefined
| Specify the icon to render for the closed state.let
| No | typeof import("svelte").SvelteComponent
| undefined
| Specify the icon to render for the opened state.let
| Yes | null | HTMLAnchorElement
| null
| Obtain a reference to the HTML anchor element |
+| isSideNavOpen | No | let
| Yes | boolean
| false
| Set to `true` to open the side nav |
+| expandedByDefault | No | let
| No | boolean
| true
| Set to `false` to hide the side nav by default |
+| uiShellAriaLabel | No | let
| No | string
| undefined
| Specify the ARIA label for the header |
+| href | No | let
| No | string
| undefined
| Specify the `href` attribute |
+| company | No | let
| No | string
| undefined
| Specify the company name.let
| No | string
| ""
| Specify the platform name.let
| No | boolean
| false
| Set to `true` to persist the hamburger menu |
+| expansionBreakpoint | No | let
| No | number
| 1056
| The window width (px) at which the SideNav is expanded and the hamburger menu is hidden.let
| No | any
| undefined
| Specify the icon to render for the closed state.let
| No | any
| undefined
| Specify the icon to render for the opened state.let
| Yes | null | HTMLButtonElement
| null
| Obtain a reference to the button HTML element |
-| isOpen | No | let
| Yes | boolean
| false
| Set to `true` to open the panel |
-| icon | No | let
| No | typeof import("svelte").SvelteComponent
| undefined
| Specify the icon to render when the action panel is closed.let
| No | typeof import("svelte").SvelteComponent
| undefined
| Specify the icon to render when the action panel is open.let
| No | string
| undefined
| Specify the text.let
| No | false | import("svelte/transition").SlideParams
| { duration: 200 }
| Customize the panel transition (i.e., `transition:slide`).let
| No | boolean
| false
| Set to `true` to prevent the panel from closing when clicking outside |
+| Prop name | Required | Kind | Reactive | Type | Default value | Description |
+| :------------------------- | :------- | :--------------- | :------- | ----------------------------------------------------------------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------- |
+| ref | No | let
| Yes | null | HTMLButtonElement
| null
| Obtain a reference to the button HTML element |
+| isOpen | No | let
| Yes | boolean
| false
| Set to `true` to open the panel |
+| icon | No | let
| No | any
| undefined
| Specify the icon to render when the action panel is closed.let
| No | any
| undefined
| Specify the icon to render when the action panel is open.let
| No | string
| undefined
| Specify the text displayed next to the icon.let
| No | string
| undefined
| Specify an icon tooltip. The tooltip will not be displayedlet
| No | "start" | "center" | "end"
| "center"
| Set the alignment of the tooltip relative to the icon.let
| No | false | import("svelte/transition").SlideParams
| { duration: 200 }
| Customize the panel transition (i.e., `transition:slide`).let
| No | boolean
| false
| Set to `true` to prevent the panel from closing when clicking outside |
### Slots
@@ -1646,12 +1650,12 @@ None.
### Props
-| Prop name | Required | Kind | Reactive | Type | Default value | Description |
-| :----------- | :------- | :--------------- | :------- | --------------------------------------------------------- | ---------------------- | --------------------------------------------- |
-| ref | No | let
| Yes | null | HTMLAnchorElement
| null
| Obtain a reference to the HTML anchor element |
-| linkIsActive | No | let
| No | boolean
| false
| Set to `true` to use the active state |
-| href | No | let
| No | string
| undefined
| Specify the `href` attribute |
-| icon | No | let
| No | typeof import("svelte").SvelteComponent
| undefined
| Specify the icon to render |
+| Prop name | Required | Kind | Reactive | Type | Default value | Description |
+| :----------- | :------- | :--------------- | :------- | ------------------------------------------ | ---------------------- | --------------------------------------------- |
+| ref | No | let
| Yes | null | HTMLAnchorElement
| null
| Obtain a reference to the HTML anchor element |
+| linkIsActive | No | let
| No | boolean
| false
| Set to `true` to use the active state |
+| href | No | let
| No | string
| undefined
| Specify the `href` attribute |
+| icon | No | let
| No | any
| undefined
| Specify the icon to render |
### Slots
@@ -1669,11 +1673,11 @@ None.
### Props
-| Prop name | Required | Kind | Reactive | Type | Default value | Description |
-| :-------- | :------- | :--------------- | :------- | --------------------------------------------------------- | ---------------------- | --------------------------------------------- |
-| ref | No | let
| Yes | HTMLButtonElement
| null
| Obtain a reference to the HTML button element |
-| isActive | No | let
| No | boolean
| false
| Set to `true` to use the active variant |
-| icon | No | let
| No | typeof import("svelte").SvelteComponent
| undefined
| Specify the icon to render |
+| Prop name | Required | Kind | Reactive | Type | Default value | Description |
+| :-------- | :------- | :--------------- | :------- | ------------------------------ | ---------------------- | --------------------------------------------- |
+| ref | No | let
| Yes | HTMLButtonElement
| null
| Obtain a reference to the HTML button element |
+| isActive | No | let
| No | boolean
| false
| Set to `true` to use the active variant |
+| icon | No | let
| No | any
| undefined
| Specify the icon to render |
### Slots
@@ -1966,15 +1970,15 @@ None.
### Props
-| Prop name | Required | Kind | Reactive | Type | Default value | Description |
-| :-------- | :------- | :--------------- | :------- | --------------------------------------------------------- | ---------------------- | -------------------------------------------------------- |
-| ref | No | let
| Yes | null | HTMLAnchorElement
| null
| Obtain a reference to the top-level HTML element |
-| size | No | let
| No | "sm" | "lg"
| undefined
| Specify the size of the link |
-| href | No | let
| No | string
| undefined
| Specify the href value |
-| inline | No | let
| No | boolean
| false
| Set to `true` to use the inline variant |
-| icon | No | let
| No | typeof import("svelte").SvelteComponent
| undefined
| Specify the icon to renderlet
| No | boolean
| false
| Set to `true` to disable the checkbox |
-| visited | No | let
| No | boolean
| false
| Set to `true` to allow visited styles |
+| Prop name | Required | Kind | Reactive | Type | Default value | Description |
+| :-------- | :------- | :--------------- | :------- | ------------------------------------------ | ---------------------- | -------------------------------------------------------- |
+| ref | No | let
| Yes | null | HTMLAnchorElement
| null
| Obtain a reference to the top-level HTML element |
+| size | No | let
| No | "sm" | "lg"
| undefined
| Specify the size of the link |
+| href | No | let
| No | string
| undefined
| Specify the href value |
+| inline | No | let
| No | boolean
| false
| Set to `true` to use the inline variant |
+| icon | No | let
| No | any
| undefined
| Specify the icon to renderlet
| No | boolean
| false
| Set to `true` to disable the checkbox |
+| visited | No | let
| No | boolean
| false
| Set to `true` to allow visited styles |
### Slots
@@ -2224,29 +2228,29 @@ None.
### Props
-| Prop name | Required | Kind | Reactive | Type | Default value | Description |
-| :------------------------- | :------- | :--------------- | :------- | --------------------------------------------------------- | ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------- |
-| ref | No | let
| Yes | null | HTMLDivElement
| null
| Obtain a reference to the top-level HTML element |
-| open | No | let
| Yes | boolean
| false
| Set to `true` to open the modal |
-| size | No | let
| No | "xs" | "sm" | "lg"
| undefined
| Set the size of the modal |
-| danger | No | let
| No | boolean
| false
| Set to `true` to use the danger variant |
-| alert | No | let
| No | boolean
| false
| Set to `true` to enable alert mode |
-| passiveModal | No | let
| No | boolean
| false
| Set to `true` to use the passive variant |
-| modalHeading | No | let
| No | string
| undefined
| Specify the modal heading |
-| modalLabel | No | let
| No | string
| undefined
| Specify the modal label |
-| modalAriaLabel | No | let
| No | string
| undefined
| Specify the ARIA label for the modal |
-| iconDescription | No | let
| No | string
| "Close the modal"
| Specify the ARIA label for the close icon |
-| hasForm | No | let
| No | boolean
| false
| Set to `true` if the modal contains form elements |
-| hasScrollingContent | No | let
| No | boolean
| false
| Set to `true` if the modal contains scrolling content |
-| primaryButtonText | No | let
| No | string
| ""
| Specify the primary button text |
-| primaryButtonDisabled | No | let
| No | boolean
| false
| Set to `true` to disable the primary button |
-| primaryButtonIcon | No | let
| No | typeof import("svelte").SvelteComponent
| undefined
| Specify the primary button icon |
-| shouldSubmitOnEnter | No | let
| No | boolean
| true
| Set to `true` for the "submit" and "click:button--primary" eventslet
| No | string
| ""
| Specify the secondary button text |
-| secondaryButtons | No | let
| No | [{ text: string; }, { text: string; }]
| []
| 2-tuple prop to render two secondary buttons for a 3 button modallet
| No | string
| "[data-modal-primary-focus]"
| Specify a selector to be focused when opening the modal |
-| preventCloseOnClickOutside | No | let
| No | boolean
| false
| Set to `true` to prevent the modal from closing when clicking outside |
-| id | No | let
| No | string
| "ccs-" + Math.random().toString(36)
| Set an id for the top-level element |
+| Prop name | Required | Kind | Reactive | Type | Default value | Description |
+| :------------------------- | :------- | :--------------- | :------- | --------------------------------------------------- | ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------- |
+| ref | No | let
| Yes | null | HTMLDivElement
| null
| Obtain a reference to the top-level HTML element |
+| open | No | let
| Yes | boolean
| false
| Set to `true` to open the modal |
+| size | No | let
| No | "xs" | "sm" | "lg"
| undefined
| Set the size of the modal |
+| danger | No | let
| No | boolean
| false
| Set to `true` to use the danger variant |
+| alert | No | let
| No | boolean
| false
| Set to `true` to enable alert mode |
+| passiveModal | No | let
| No | boolean
| false
| Set to `true` to use the passive variant |
+| modalHeading | No | let
| No | string
| undefined
| Specify the modal heading |
+| modalLabel | No | let
| No | string
| undefined
| Specify the modal label |
+| modalAriaLabel | No | let
| No | string
| undefined
| Specify the ARIA label for the modal |
+| iconDescription | No | let
| No | string
| "Close the modal"
| Specify the ARIA label for the close icon |
+| hasForm | No | let
| No | boolean
| false
| Set to `true` if the modal contains form elements |
+| hasScrollingContent | No | let
| No | boolean
| false
| Set to `true` if the modal contains scrolling content |
+| primaryButtonText | No | let
| No | string
| ""
| Specify the primary button text |
+| primaryButtonDisabled | No | let
| No | boolean
| false
| Set to `true` to disable the primary button |
+| primaryButtonIcon | No | let
| No | any
| undefined
| Specify the primary button icon |
+| shouldSubmitOnEnter | No | let
| No | boolean
| true
| Set to `true` for the "submit" and "click:button--primary" eventslet
| No | string
| ""
| Specify the secondary button text |
+| secondaryButtons | No | let
| No | [{ text: string; }, { text: string; }]
| []
| 2-tuple prop to render two secondary buttons for a 3 button modallet
| No | string
| "[data-modal-primary-focus]"
| Specify a selector to be focused when opening the modal |
+| preventCloseOnClickOutside | No | let
| No | boolean
| false
| Set to `true` to prevent the modal from closing when clicking outside |
+| id | No | let
| No | string
| "ccs-" + Math.random().toString(36)
| Set an id for the top-level element |
### Slots
@@ -2295,16 +2299,16 @@ None.
### Props
-| Prop name | Required | Kind | Reactive | Type | Default value | Description |
-| :-------------------- | :------- | :--------------- | :------- | --------------------------------------------------------- | ---------------------- | ------------------------------------------------------------------------------------------------------- |
-| primaryButtonText | No | let
| No | string
| ""
| Specify the primary button text |
-| primaryButtonIcon | No | let
| No | typeof import("svelte").SvelteComponent
| undefined
| Specify the primary button icon |
-| primaryButtonDisabled | No | let
| No | boolean
| false
| Set to `true` to disable the primary button |
-| primaryClass | No | let
| No | string
| undefined
| Specify a class for the primary button |
-| secondaryButtonText | No | let
| No | string
| ""
| Specify the secondary button text |
-| secondaryButtons | No | let
| No | [{ text: string; }, { text: string; }]
| []
| 2-tuple prop to render two secondary buttons for a 3 button modallet
| No | string
| undefined
| Specify a class for the secondary button |
-| danger | No | let
| No | boolean
| false
| Set to `true` to use the danger variant |
+| Prop name | Required | Kind | Reactive | Type | Default value | Description |
+| :-------------------- | :------- | :--------------- | :------- | --------------------------------------------------- | ---------------------- | ------------------------------------------------------------------------------------------------------- |
+| primaryButtonText | No | let
| No | string
| ""
| Specify the primary button text |
+| primaryButtonIcon | No | let
| No | any
| undefined
| Specify the primary button icon |
+| primaryButtonDisabled | No | let
| No | boolean
| false
| Set to `true` to disable the primary button |
+| primaryClass | No | let
| No | string
| undefined
| Specify a class for the primary button |
+| secondaryButtonText | No | let
| No | string
| ""
| Specify the secondary button text |
+| secondaryButtons | No | let
| No | [{ text: string; }, { text: string; }]
| []
| 2-tuple prop to render two secondary buttons for a 3 button modallet
| No | string
| undefined
| Specify a class for the secondary button |
+| danger | No | let
| No | boolean
| false
| Set to `true` to use the danger variant |
### Slots
@@ -2415,6 +2419,7 @@ export interface MultiSelectItem {
| clear | dispatched | null
|
| blur | dispatched | FocusEvent | CustomEvent
|
| keydown | forwarded | -- |
+| input | forwarded | -- |
| keyup | forwarded | -- |
| focus | forwarded | -- |
| paste | forwarded | -- |
@@ -2444,12 +2449,12 @@ None.
### Props
-| Prop name | Required | Kind | Reactive | Type | Default value | Description |
-| :--------------- | :------- | :--------------- | :------- | --------------------------------------------------------- | ------------------------- | ----------------------------------- |
-| notificationType | No | let
| No | "toast" | "inline"
| "toast"
| Set the type of notification |
-| icon | No | let
| No | typeof import("svelte").SvelteComponent
| undefined
| Specify the icon to render |
-| title | No | let
| No | string
| undefined
| Specify the title of the icon |
-| iconDescription | No | let
| No | string
| "Close icon"
| Specify the ARIA label for the icon |
+| Prop name | Required | Kind | Reactive | Type | Default value | Description |
+| :--------------- | :------- | :--------------- | :------- | ------------------------------------ | ------------------------- | ----------------------------------- |
+| notificationType | No | let
| No | "toast" | "inline"
| "toast"
| Set the type of notification |
+| icon | No | let
| No | any
| undefined
| Specify the icon to render |
+| title | No | let
| No | string
| undefined
| Specify the title of the icon |
+| iconDescription | No | let
| No | string
| "Close icon"
| Specify the ARIA label for the icon |
### Slots
@@ -2611,20 +2616,20 @@ None.
### Props
-| Prop name | Required | Kind | Reactive | Type | Default value | Description |
-| :--------------- | :------- | :--------------- | :------- | --------------------------------------------------------- | ------------------------------------------------ | ----------------------------------------------------------------------------- |
-| menuRef | No | let
| Yes | null | HTMLUListElement
| null
| Obtain a reference to the overflow menu element |
-| buttonRef | No | let
| Yes | null | HTMLButtonElement
| null
| Obtain a reference to the trigger button element |
-| icon | No | let
| Yes | typeof import("svelte").SvelteComponent
| undefined
| Specify the icon to render.let
| Yes | boolean
| false
| Set to `true` to open the menu |
-| size | No | let
| No | "sm" | "xl"
| undefined
| Specify the size of the overflow menu |
-| direction | No | let
| No | "top" | "bottom"
| "bottom"
| Specify the direction of the overflow menu relative to the button |
-| light | No | let
| No | boolean
| false
| Set to `true` to enable the light variant |
-| flipped | No | let
| No | boolean
| false
| Set to `true` to flip the menu relative to the button |
-| menuOptionsClass | No | let
| No | string
| undefined
| Specify the menu options class |
-| iconClass | No | let
| No | string
| undefined
| Specify the icon class |
-| iconDescription | No | let
| No | string
| "Open and close list of options"
| Specify the ARIA label for the icon |
-| id | No | let
| No | string
| "ccs-" + Math.random().toString(36)
| Set an id for the button element |
+| Prop name | Required | Kind | Reactive | Type | Default value | Description |
+| :--------------- | :------- | :--------------- | :------- | ------------------------------------------ | ------------------------------------------------ | ----------------------------------------------------------------------------- |
+| menuRef | No | let
| Yes | null | HTMLUListElement
| null
| Obtain a reference to the overflow menu element |
+| buttonRef | No | let
| Yes | null | HTMLButtonElement
| null
| Obtain a reference to the trigger button element |
+| icon | No | let
| Yes | any
| undefined
| Specify the icon to render.let
| Yes | boolean
| false
| Set to `true` to open the menu |
+| size | No | let
| No | "sm" | "xl"
| undefined
| Specify the size of the overflow menu |
+| direction | No | let
| No | "top" | "bottom"
| "bottom"
| Specify the direction of the overflow menu relative to the button |
+| light | No | let
| No | boolean
| false
| Set to `true` to enable the light variant |
+| flipped | No | let
| No | boolean
| false
| Set to `true` to flip the menu relative to the button |
+| menuOptionsClass | No | let
| No | string
| undefined
| Specify the menu options class |
+| iconClass | No | let
| No | string
| undefined
| Specify the icon class |
+| iconDescription | No | let
| No | string
| "Open and close list of options"
| Specify the ARIA label for the icon |
+| id | No | let
| No | string
| "ccs-" + Math.random().toString(36)
| Set an id for the button element |
### Slots
@@ -2677,24 +2682,25 @@ None.
### Props
-| Prop name | Required | Kind | Reactive | Type | Default value | Description |
-| :-------------------- | :------- | :--------------- | :------- | ---------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------ |
-| pageSize | No | let
| Yes | number
| 10
| Specify the number of items to display in a page |
-| page | No | let
| Yes | number
| 1
| Specify the current page index |
-| totalItems | No | let
| No | number
| 0
| Specify the total number of items |
-| disabled | No | let
| No | boolean
| false
| Set to `true` to disable the pagination |
-| forwardText | No | let
| No | string
| "Next page"
| Specify the forward button text |
-| backwardText | No | let
| No | string
| "Previous page"
| Specify the backward button text |
-| itemsPerPageText | No | let
| No | string
| "Items per page:"
| Specify the items per page text |
-| itemText | No | let
| No | (min: number, max: number) => string
| (min, max) => \`${min}–${max} item${max === 1 ? "" : "s"}\`
| Override the item text |
-| itemRangeText | No | let
| No | (min: number, max: number, total: number) => string
| (min, max, total) => \`${min}–${max} of ${total} item${max === 1 ? "" : "s"}\`
| Override the item range text |
-| pageInputDisabled | No | let
| No | boolean
| false
| Set to `true` to disable the page input |
-| pageSizeInputDisabled | No | let
| No | boolean
| false
| Set to `true` to disable the page size input |
-| pageSizes | No | let
| No | ReadonlyArray
| [10]
| Specify the available page sizes |
-| pagesUnknown | No | let
| No | boolean
| false
| Set to `true` if the number of pages is unknown |
-| pageText | No | let
| No | (page: number) => string
| (page) => \`page ${page}\`
| Override the page text |
-| pageRangeText | No | let
| No | (current: number, total: number) => string
| (current, total) => \`of ${total} page${total === 1 ? "" : "s"}\`
| Override the page range text |
-| id | No | let
| No | string
| "ccs-" + Math.random().toString(36)
| Set an id for the top-level element |
+| Prop name | Required | Kind | Reactive | Type | Default value | Description |
+| :-------------------- | :------- | :--------------- | :------- | ---------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| pageSize | No | let
| Yes | number
| 10
| Specify the number of items to display in a page |
+| page | No | let
| Yes | number
| 1
| Specify the current page index |
+| totalItems | No | let
| No | number
| 0
| Specify the total number of items |
+| pageWindow | No | let
| No | number
| 1000
| If `totalItems` is a large number, it can affect thelet
| No | boolean
| false
| Set to `true` to disable the pagination |
+| forwardText | No | let
| No | string
| "Next page"
| Specify the forward button text |
+| backwardText | No | let
| No | string
| "Previous page"
| Specify the backward button text |
+| itemsPerPageText | No | let
| No | string
| "Items per page:"
| Specify the items per page text |
+| itemText | No | let
| No | (min: number, max: number) => string
| (min, max) => \`${min.toLocaleString()}–${max.toLocaleString()} item${max === 1 ? "" : "s"}\`
| Override the item text |
+| itemRangeText | No | let
| No | (min: number, max: number, total: number) => string
| (min, max, total) => \`${min.toLocaleString()}–${max.toLocaleString()} of ${total.toLocaleString()} item${max === 1 ? "" : "s"}\`
| Override the item range text |
+| pageInputDisabled | No | let
| No | boolean
| false
| Set to `true` to disable the page input |
+| pageSizeInputDisabled | No | let
| No | boolean
| false
| Set to `true` to disable the page size input |
+| pageSizes | No | let
| No | ReadonlyArray
| [10]
| Specify the available page sizes |
+| pagesUnknown | No | let
| No | boolean
| false
| Set to `true` if the number of pages is unknown |
+| pageText | No | let
| No | (page: number) => string
| (page) => \`page ${page.toLocaleString()}\`
| Override the page text |
+| pageRangeText | No | let
| No | (current: number, total: number) => string
| (current, total) => \`of ${total.toLocaleString()} page${total === 1 ? "" : "s"}\`
| Override the page range text |
+| id | No | let
| No | string
| "ccs-" + Math.random().toString(36)
| Set an id for the top-level element |
### Slots
@@ -2963,6 +2969,8 @@ None.
| Event name | Type | Detail |
| :--------- | :-------- | :----- |
+| focus | forwarded | -- |
+| blur | forwarded | -- |
| change | forwarded | -- |
## `RadioButtonGroup`
@@ -3105,24 +3113,24 @@ None.
### Props
-| Prop name | Required | Kind | Reactive | Type | Default value | Description |
-| :------------------- | :------- | :--------------- | :------- | --------------------------------------------------------- | ------------------------------------------------ | --------------------------------------------------------------- |
-| ref | No | let
| Yes | null | HTMLInputElement
| null
| Obtain a reference to the input HTML element |
-| expanded | No | let
| Yes | boolean
| false
| Set to `true to expand the search input |
-| value | No | let
| Yes | any
| ""
| Specify the value of the search input |
-| size | No | let
| No | "sm" | "lg" | "xl"
| "xl"
| Specify the size of the search input |
-| searchClass | No | let
| No | string
| ""
| Specify the class name passed to the outer div element |
-| skeleton | No | let
| No | boolean
| false
| Set to `true` to display the skeleton state |
-| light | No | let
| No | boolean
| false
| Set to `true` to enable the light variant |
-| disabled | No | let
| No | boolean
| false
| Set to `true` to disable the search input |
-| expandable | No | let
| No | boolean
| false
| Set to `true` to enable the expandable variant |
-| placeholder | No | let
| No | string
| "Search..."
| Specify the `placeholder` attribute of the search input |
-| autocomplete | No | let
| No | "on" | "off"
| "off"
| Specify the `autocomplete` attribute |
-| autofocus | No | let
| No | boolean
| false
| Set to `true` to auto focus the search element |
-| closeButtonLabelText | No | let
| No | string
| "Clear search input"
| Specify the close button label text |
-| labelText | No | let
| No | string
| ""
| Specify the label text |
-| icon | No | let
| No | typeof import("svelte").SvelteComponent
| undefined
| Specify the icon to render.let
| No | string
| "ccs-" + Math.random().toString(36)
| Set an id for the input element |
+| Prop name | Required | Kind | Reactive | Type | Default value | Description |
+| :------------------- | :------- | :--------------- | :------- | ----------------------------------------- | ------------------------------------------------ | --------------------------------------------------------------- |
+| ref | No | let
| Yes | null | HTMLInputElement
| null
| Obtain a reference to the input HTML element |
+| expanded | No | let
| Yes | boolean
| false
| Set to `true to expand the search input |
+| value | No | let
| Yes | any
| ""
| Specify the value of the search input |
+| size | No | let
| No | "sm" | "lg" | "xl"
| "xl"
| Specify the size of the search input |
+| searchClass | No | let
| No | string
| ""
| Specify the class name passed to the outer div element |
+| skeleton | No | let
| No | boolean
| false
| Set to `true` to display the skeleton state |
+| light | No | let
| No | boolean
| false
| Set to `true` to enable the light variant |
+| disabled | No | let
| No | boolean
| false
| Set to `true` to disable the search input |
+| expandable | No | let
| No | boolean
| false
| Set to `true` to enable the expandable variant |
+| placeholder | No | let
| No | string
| "Search..."
| Specify the `placeholder` attribute of the search input |
+| autocomplete | No | let
| No | "on" | "off"
| "off"
| Specify the `autocomplete` attribute |
+| autofocus | No | let
| No | boolean
| false
| Set to `true` to auto focus the search element |
+| closeButtonLabelText | No | let
| No | string
| "Clear search input"
| Specify the close button label text |
+| labelText | No | let
| No | string
| ""
| Specify the label text |
+| icon | No | let
| No | any
| undefined
| Specify the icon to render.let
| No | string
| "ccs-" + Math.random().toString(36)
| Set an id for the input element |
### Slots
@@ -3215,14 +3223,14 @@ None.
### Props
-| Prop name | Required | Kind | Reactive | Type | Default value | Description |
-| :-------- | :------- | :--------------- | :------- | --------------------------------- | ---------------------- | ----------------------------------------- |
-| value | No | let
| No | string | number
| ""
| Specify the option value |
-| text | No | let
| No | string
| ""
| Specify the option text |
-| hidden | No | let
| No | boolean
| false
| Set to `true` to hide the option |
-| disabled | No | let
| No | boolean
| false
| Set to `true` to disable the option |
-| class | No | let
| No | string
| undefined
| Specify the class of the `option` element |
-| style | No | let
| No | string
| undefined
| Specify the style of the `option` element |
+| Prop name | Required | Kind | Reactive | Type | Default value | Description |
+| :-------- | :------- | :--------------- | :------- | --------------------------------- | ---------------------- | ---------------------------------------------------------------------------------- |
+| value | No | let
| No | string | number
| ""
| Specify the option value |
+| text | No | let
| No | string
| undefined
| Specify the option textlet
| No | boolean
| false
| Set to `true` to hide the option |
+| disabled | No | let
| No | boolean
| false
| Set to `true` to disable the option |
+| class | No | let
| No | string
| undefined
| Specify the class of the `option` element |
+| style | No | let
| No | string
| undefined
| Specify the style of the `option` element |
### Slots
@@ -3367,13 +3375,13 @@ None.
### Props
-| Prop name | Required | Kind | Reactive | Type | Default value | Description |
-| :--------- | :------- | :--------------- | :------- | --------------------------------------------------------- | ---------------------- | --------------------------------------------- |
-| ref | No | let
| Yes | null | HTMLAnchorElement
| null
| Obtain a reference to the HTML anchor element |
-| isSelected | No | let
| No | boolean
| false
| Set to `true` to select the current link |
-| href | No | let
| No | string
| undefined
| Specify the `href` attribute |
-| text | No | let
| No | string
| undefined
| Specify the text |
-| icon | No | let
| No | typeof import("svelte").SvelteComponent
| undefined
| Specify the icon to render |
+| Prop name | Required | Kind | Reactive | Type | Default value | Description |
+| :--------- | :------- | :--------------- | :------- | ------------------------------------------ | ---------------------- | --------------------------------------------- |
+| ref | No | let
| Yes | null | HTMLAnchorElement
| null
| Obtain a reference to the HTML anchor element |
+| isSelected | No | let
| No | boolean
| false
| Set to `true` to select the current link |
+| href | No | let
| No | string
| undefined
| Specify the `href` attribute |
+| text | No | let
| No | string
| undefined
| Specify the text |
+| icon | No | let
| No | any
| undefined
| Specify the icon to render |
### Slots
@@ -3392,12 +3400,12 @@ None.
### Props
-| Prop name | Required | Kind | Reactive | Type | Default value | Description |
-| :-------- | :------- | :--------------- | :------- | --------------------------------------------------------- | ---------------------- | --------------------------------------------- |
-| ref | No | let
| Yes | null | HTMLButtonElement
| null
| Obtain a reference to the HTML button element |
-| expanded | No | let
| Yes | boolean
| false
| Set to `true` to toggle the expanded state |
-| text | No | let
| No | string
| undefined
| Specify the text |
-| icon | No | let
| No | typeof import("svelte").SvelteComponent
| undefined
| Specify the icon to render |
+| Prop name | Required | Kind | Reactive | Type | Default value | Description |
+| :-------- | :------- | :--------------- | :------- | ------------------------------------------ | ---------------------- | --------------------------------------------- |
+| ref | No | let
| Yes | null | HTMLButtonElement
| null
| Obtain a reference to the HTML button element |
+| expanded | No | let
| Yes | boolean
| false
| Set to `true` to toggle the expanded state |
+| text | No | let
| No | string
| undefined
| Specify the text |
+| icon | No | let
| No | any
| undefined
| Specify the icon to render |
### Slots
@@ -4011,7 +4019,7 @@ None.
| interactive | No | let
| No | boolean
| false
| Set to `true` to render a `button` element instead of a `div` |
| skeleton | No | let
| No | boolean
| false
| Set to `true` to display the skeleton state |
| title | No | let
| No | string
| "Clear filter"
| Set the title for the close button in a filterable tag |
-| icon | No | let
| No | typeof import("svelte").SvelteComponent
| undefined
| Specify the icon to render |
+| icon | No | let
| No | any
| undefined
| Specify the icon to render |
| id | No | let
| No | string
| "ccs-" + Math.random().toString(36)
| Set an id for the filterable tag |
### Slots
@@ -4575,7 +4583,7 @@ None.
| align | No | let
| No | "start" | "center" | "end"
| "center"
| Set the alignment of the tooltip relative to the icon |
| direction | No | let
| No | "top" | "right" | "bottom" | "left"
| "bottom"
| Set the direction of the tooltip relative to the button |
| hideIcon | No | let
| No | boolean
| false
| Set to `true` to hide the tooltip icon |
-| icon | No | let
| No | typeof import("svelte").SvelteComponent
| undefined
| Specify the icon to render for the tooltip button.let
| No | any
| undefined
| Specify the icon to render for the tooltip button.let
| No | string
| ""
| Specify the ARIA label for the tooltip button |
| iconName | No | let
| No | string
| ""
| Specify the icon name attribute |
| tabindex | No | let
| No | string
| "0"
| Set the button tabindex |
@@ -4658,7 +4666,7 @@ None.
| :---------- | :------- | :--------------- | :------- | --------------------------------------------------------------- | ------------------------------------------------ | ------------------------------------------------------------------------ |
| ref | No | let
| Yes | null | HTMLButtonElement
| null
| Obtain a reference to the button HTML element |
| tooltipText | No | let
| No | string
| ""
| Specify the tooltip text.let
| No | typeof import("svelte").SvelteComponent
| undefined
| Specify the icon to render |
+| icon | No | let
| No | any
| undefined
| Specify the icon to render |
| disabled | No | let
| No | boolean
| false
| Set to `true` to disable the tooltip icon |
| align | No | let
| No | "start" | "center" | "end"
| "center"
| Set the alignment of the tooltip relative to the icon |
| direction | No | let
| No | "top" | "right" | "bottom" | "left"
| "bottom"
| Set the direction of the tooltip relative to the icon |
@@ -4691,7 +4699,7 @@ export type TreeNodeId = string | number;
export interface TreeNode {
id: TreeNodeId;
text: any;
- icon?: typeof import("svelte").SvelteComponentlet
| Yes | ReadonlyArray
| []
| Set the node ids to be expanded |
-| selectedIds | No | let
| Yes | ReadonlyArray
| []
| Set the node ids to be selected |
-| activeId | No | let
| Yes | TreeNodeId
| ""
| Set the current active node idlet
| Yes | Array
| []
| Provide an array of nodes to render |
-| size | No | let
| No | "default" | "compact"
| "default"
| Specify the TreeView size |
-| labelText | No | let
| No | string
| ""
| Specify the label text |
-| hideLabel | No | let
| No | boolean
| false
| Set to `true` to visually hide the label text |
-| expandAll | No | function
| No | () => void
| () => { expandedIds = [...nodeIds]; }
| Programmatically expand all nodes |
-| collapseAll | No | function
| No | () => void
| () => { expandedIds = []; }
| Programmatically collapse all nodes |
-| expandNodes | No | function
| No | (filterId?: (node: TreeNode) => boolean) => void
| () => { expandedIds = nodes .filter( (node) => filterNode(node) || node.nodes?.some((child) => filterNode(child) && child.nodes), ) .map((node) => node.id); }
| Programmatically expand a subset of nodes.function
| No | (filterId?: (node: TreeNode) => boolean) => void
| () => { expandedIds = nodes .filter((node) => expandedIds.includes(node.id) && !filterNode(node)) .map((node) => node.id); }
| Programmatically collapse a subset of nodes.function
| No | (id: TreeNodeId) => void
| () => { for (const child of nodes) { const nodes = findNodeById(child, id); if (nodes) { const ids = nodes.map((node) => node.id); const nodeIds = new Set(ids); expandNodes((node) => nodeIds.has(node.id)); const lastId = ids[ids.length - 1]; activeId = lastId; selectedIds = [lastId]; tick().then(() => { ref?.querySelector(\`[id="${lastId}"]\`)?.focus(); }); // Break out of the loop if the node is found. break; } } }
| Programmatically show a node by `id`.let
| Yes | ReadonlyArray
| []
| Set the node ids to be expanded |
+| selectedIds | No | let
| Yes | ReadonlyArray
| []
| Set the node ids to be selected |
+| activeId | No | let
| Yes | TreeNodeId
| ""
| Set the current active node idlet
| No | Array
| []
| Provide an array of nodes to render |
+| size | No | let
| No | "default" | "compact"
| "default"
| Specify the TreeView size |
+| labelText | No | let
| No | string
| ""
| Specify the label text |
+| hideLabel | No | let
| No | boolean
| false
| Set to `true` to visually hide the label text |
+| expandAll | No | function
| No | () => void
| () => { expandedIds = [...nodeIds]; }
| Programmatically expand all nodes |
+| collapseAll | No | function
| No | () => void
| () => { expandedIds = []; }
| Programmatically collapse all nodes |
+| expandNodes | No | function
| No | (filterId?: (node: TreeNode) => boolean) => void
| () => { expandedIds = flattenedNodes .filter( (node) => filterNode(node) || node.nodes?.some((child) => filterNode(child) && child.nodes), ) .map((node) => node.id); }
| Programmatically expand a subset of nodes.function
| No | (filterId?: (node: TreeNode) => boolean) => void
| () => { expandedIds = flattenedNodes .filter((node) => expandedIds.includes(node.id) && !filterNode(node)) .map((node) => node.id); }
| Programmatically collapse a subset of nodes.function
| No | (id: TreeNodeId) => void
| () => { for (const child of nodes) { const nodes = findNodeById(child, id); if (nodes) { const ids = nodes.map((node) => node.id); const nodeIds = new Set(ids); expandNodes((node) => nodeIds.has(node.id)); const lastId = ids[ids.length - 1]; activeId = lastId; selectedIds = [lastId]; tick().then(() => { ref?.querySelector(\`[id="${lastId}"]\`)?.focus(); }); break; } } }
| Programmatically show a node by `id`.{label}
", - "slot_props": "{ props: { class: \"bx--progress-label\" } }" + "slot_props": "{\n props: {\n class: \"bx--progress-label\";\n };\n}" } ], "events": [ - { "type": "forwarded", "name": "click", "element": "button" }, - { "type": "forwarded", "name": "mouseover", "element": "button" }, - { "type": "forwarded", "name": "mouseenter", "element": "button" }, - { "type": "forwarded", "name": "mouseleave", "element": "button" }, - { "type": "forwarded", "name": "keydown", "element": "button" } + { + "type": "forwarded", + "name": "click", + "element": "button" + }, + { + "type": "forwarded", + "name": "mouseover", + "element": "button" + }, + { + "type": "forwarded", + "name": "mouseenter", + "element": "button" + }, + { + "type": "forwarded", + "name": "mouseleave", + "element": "button" + }, + { + "type": "forwarded", + "name": "keydown", + "element": "button" + } ], "typedefs": [], "generics": null, - "rest_props": { "type": "Element", "name": "li" } + "rest_props": { + "type": "Element", + "name": "li" + } }, { "moduleName": "RadioButton", @@ -9591,10 +11417,29 @@ "slot_props": "{}" } ], - "events": [{ "type": "forwarded", "name": "change", "element": "input" }], + "events": [ + { + "type": "forwarded", + "name": "focus", + "element": "input" + }, + { + "type": "forwarded", + "name": "blur", + "element": "input" + }, + { + "type": "forwarded", + "name": "change", + "element": "input" + } + ], "typedefs": [], "generics": null, - "rest_props": { "type": "Element", "name": "div" } + "rest_props": { + "type": "Element", + "name": "div" + } }, { "moduleName": "RadioButtonGroup", @@ -9707,7 +11552,11 @@ ], "moduleExports": [], "slots": [ - { "name": "__default__", "default": true, "slot_props": "{}" }, + { + "name": "__default__", + "default": true, + "slot_props": "{}" + }, { "name": "legendText", "default": false, @@ -9716,15 +11565,38 @@ } ], "events": [ - { "type": "dispatched", "name": "change", "detail": "string | number" }, - { "type": "forwarded", "name": "click", "element": "div" }, - { "type": "forwarded", "name": "mouseover", "element": "div" }, - { "type": "forwarded", "name": "mouseenter", "element": "div" }, - { "type": "forwarded", "name": "mouseleave", "element": "div" } + { + "type": "dispatched", + "name": "change", + "detail": "string | number" + }, + { + "type": "forwarded", + "name": "click", + "element": "div" + }, + { + "type": "forwarded", + "name": "mouseover", + "element": "div" + }, + { + "type": "forwarded", + "name": "mouseenter", + "element": "div" + }, + { + "type": "forwarded", + "name": "mouseleave", + "element": "div" + } ], "typedefs": [], "generics": null, - "rest_props": { "type": "Element", "name": "div" } + "rest_props": { + "type": "Element", + "name": "div" + } }, { "moduleName": "RadioButtonSkeleton", @@ -9733,14 +11605,33 @@ "moduleExports": [], "slots": [], "events": [ - { "type": "forwarded", "name": "click", "element": "div" }, - { "type": "forwarded", "name": "mouseover", "element": "div" }, - { "type": "forwarded", "name": "mouseenter", "element": "div" }, - { "type": "forwarded", "name": "mouseleave", "element": "div" } + { + "type": "forwarded", + "name": "click", + "element": "div" + }, + { + "type": "forwarded", + "name": "mouseover", + "element": "div" + }, + { + "type": "forwarded", + "name": "mouseenter", + "element": "div" + }, + { + "type": "forwarded", + "name": "mouseleave", + "element": "div" + } ], "typedefs": [], "generics": null, - "rest_props": { "type": "Element", "name": "div" } + "rest_props": { + "type": "Element", + "name": "div" + } }, { "moduleName": "RadioTile", @@ -9855,18 +11746,51 @@ } ], "moduleExports": [], - "slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }], + "slots": [ + { + "name": "__default__", + "default": true, + "slot_props": "{}" + } + ], "events": [ - { "type": "forwarded", "name": "change", "element": "input" }, - { "type": "forwarded", "name": "keydown", "element": "input" }, - { "type": "forwarded", "name": "click", "element": "label" }, - { "type": "forwarded", "name": "mouseover", "element": "label" }, - { "type": "forwarded", "name": "mouseenter", "element": "label" }, - { "type": "forwarded", "name": "mouseleave", "element": "label" } + { + "type": "forwarded", + "name": "change", + "element": "input" + }, + { + "type": "forwarded", + "name": "keydown", + "element": "input" + }, + { + "type": "forwarded", + "name": "click", + "element": "label" + }, + { + "type": "forwarded", + "name": "mouseover", + "element": "label" + }, + { + "type": "forwarded", + "name": "mouseenter", + "element": "label" + }, + { + "type": "forwarded", + "name": "mouseleave", + "element": "label" + } ], "typedefs": [], "generics": null, - "rest_props": { "type": "Element", "name": "label" } + "rest_props": { + "type": "Element", + "name": "label" + } }, { "moduleName": "RecursiveList", @@ -9904,11 +11828,14 @@ { "type": "{ text?: string; href?: string; html?: string; }", "name": "RecursiveListNode", - "ts": "interface RecursiveListNode { text?: string; href?: string; html?: string; }" + "ts": "interface RecursiveListNode {\n text?: string;\n href?: string;\n html?: string;\n}\n" } ], "generics": null, - "rest_props": { "type": "Element", "name": "ul | ol" } + "rest_props": { + "type": "Element", + "name": "ul | ol" + } }, { "moduleName": "Row", @@ -10004,13 +11931,16 @@ { "name": "__default__", "default": true, - "slot_props": "{ props: { class: string; [key: string]: any; } }" + "slot_props": "{\n props: {\n class: string;\n [key: string]: any;\n };\n}" } ], "events": [], "typedefs": [], "generics": null, - "rest_props": { "type": "Element", "name": "div" } + "rest_props": { + "type": "Element", + "name": "div" + } }, { "moduleName": "Search", @@ -10176,7 +12106,7 @@ "name": "icon", "kind": "let", "description": "Specify the icon to render.\nDefaults to `{typeMap[type]}
- {:else if type.startsWith("(")}
- {type}
+ {prop.value}
$1
")}.
{/each}
- {:else}
- No typedefs.
{/if}No slots.
{/if} @@ -173,7 +237,7 @@event.detail
type{event.detail}
+ 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.
@@ -27,6 +34,10 @@ components: ["Accordion", "AccordionItem", "AccordionSkeleton"]
## Left-aligned chevron
+The chevron icon can be aligned to the left side of the accordion item by setting
+the `align` prop to "start". This provides an alternative visual style while
+maintaining the same functionality.
+
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.
@@ -42,6 +53,9 @@ components: ["Accordion", "AccordionItem", "AccordionSkeleton"]
## Custom title slot
+Customize the title content by using the `title` slot instead of the `title` prop.
+This allows for more complex title layouts with multiple elements.
+
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.
@@ -84,12 +101,18 @@ components: ["Accordion", "AccordionItem", "AccordionSkeleton"]
## Programmatic example
-This example demonstrates how a list of items can be programmatically expanded and collapsed.
+This example demonstrates how to programmatically control the accordion items using
+the `bind:open` directive. Expand and collapse items based on user
+interactions or application state.
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.
@@ -105,6 +128,10 @@ This example demonstrates how a list of items can be programmatically expanded a
## Small size
+For more compact layouts, set the `size` prop to "sm" to display the accordion in a
+smaller size. This is useful when space is limited or when the accordion is used as
+a secondary UI element.
+
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.
@@ -120,6 +147,9 @@ This example demonstrates how a list of items can be programmatically expanded a
## Disabled
+Set the `disabled` prop on the `Accordion` component to disable all items at once.
+This prevents users from expanding or collapsing any items in the accordion.
+
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.
@@ -135,6 +165,10 @@ This example demonstrates how a list of items can be programmatically expanded a
## Disabled (item)
+Individual accordion items can be disabled by setting the `disabled` prop on
+specific `AccordionItem` components. This allows for more granular control over
+which items are interactive.
+
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.
@@ -150,25 +184,45 @@ This example demonstrates how a list of items can be programmatically expanded a
## Skeleton
+The skeleton state provides a loading placeholder for the accordion. It displays a
+simplified version of the component while content is being loaded.
+