mcp/carbon-components-svelte
1
0
Fork 0
mirror of https://github.com/carbon-design-system/carbon-components-svelte.git synced 2025-09-20 12:23:02 +00:00
Code Issues Projects Releases Packages Wiki Activity

Run "yarn build:api & yarn build:docs"

Browse source
This commit is contained in:
Eric Liu 2022-03-20 08:19:27 -07:00
commit eaa1603d42
14 changed files with 19 additions and 654 deletions
Download patch file Download diff file Expand all files Collapse all files

180
COMPONENT_INDEX.md
View file

@ -1,6 +1,6 @@
# Component Index
> 171 components exported from carbon-components-svelte@0.62.1.
> 165 components exported from carbon-components-svelte@0.62.1.
## Components
@ -54,7 +54,6 @@
- [`Header`](#header)
- [`HeaderAction`](#headeraction)
- [`HeaderActionLink`](#headeractionlink)
- [`HeaderActionSearch`](#headeractionsearch)
- [`HeaderGlobalAction`](#headerglobalaction)
- [`HeaderNav`](#headernav)
- [`HeaderNavItem`](#headernavitem)
@ -64,8 +63,6 @@
- [`HeaderPanelLinks`](#headerpanellinks)
- [`HeaderSearch`](#headersearch)
- [`HeaderUtilities`](#headerutilities)
- [`Icon`](#icon)
- [`IconSkeleton`](#iconskeleton)
- [`ImageLoader`](#imageloader)
- [`InlineLoading`](#inlineloading)
- [`InlineNotification`](#inlinenotification)
@ -87,7 +84,6 @@
- [`NotificationActionButton`](#notificationactionbutton)
- [`NotificationButton`](#notificationbutton)
- [`NotificationIcon`](#notificationicon)
- [`NotificationTextDetails`](#notificationtextdetails)
- [`NumberInput`](#numberinput)
- [`NumberInputSkeleton`](#numberinputskeleton)
- [`OrderedList`](#orderedlist)
@ -160,8 +156,6 @@
- [`ToastNotification`](#toastnotification)
- [`Toggle`](#toggle)
- [`ToggleSkeleton`](#toggleskeleton)
- [`ToggleSmall`](#togglesmall)
- [`ToggleSmallSkeleton`](#togglesmallskeleton)
- [`Toolbar`](#toolbar)
- [`ToolbarBatchActions`](#toolbarbatchactions)
- [`ToolbarContent`](#toolbarcontent)
@ -381,14 +375,13 @@ export type BreakpointValue = 320 | 672 | 1056 | 1312 | 1584;
| Prop name | Kind | Reactive | Type | Default value | Description |
| :--------------- | :--------------- | :------- | :---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ref | <code>let</code> | Yes | <code>null &#124; HTMLAnchorElement &#124; HTMLButtonElement</code> | <code>null</code> | Obtain a reference to the HTML element |
| hasIconOnly | <code>let</code> | Yes | <code>boolean</code> | <code>false</code> | Set to `true` for the icon-only variant |
| kind | <code>let</code> | No | <code>"primary" &#124; "secondary" &#124; "tertiary" &#124; "ghost" &#124; "danger" &#124; "danger-tertiary" &#124; "danger-ghost"</code> | <code>"primary"</code> | Specify the kind of button |
| size | <code>let</code> | No | <code>"default" &#124; "field" &#124; "small" &#124; "lg" &#124; "xl"</code> | <code>"default"</code> | Specify the size of button |
| expressive | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` to use Carbon's expressive typesetting |
| isSelected | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` to enable the selected state for an icon-only, ghost button |
| icon | <code>let</code> | No | <code>typeof import("svelte").SvelteComponent</code> | <code>undefined</code> | Specify the icon to render |
| iconDescription | <code>let</code> | No | <code>string</code> | <code>undefined</code> | Specify the ARIA label for the button icon |
| tooltipAlignment | <code>let</code> | No | <code>"start" &#124; "center" &#124; "end"</code> | <code>"center"</code> | Set the alignment of the tooltip relative to the icon<br />`hasIconOnly` must be set to `true` |
| tooltipAlignment | <code>let</code> | No | <code>"start" &#124; "center" &#124; "end"</code> | <code>"center"</code> | Set the alignment of the tooltip relative to the icon.<br />Only applies to icon-only buttons |
| tooltipPosition | <code>let</code> | No | <code>"top" &#124; "right" &#124; "bottom" &#124; "left"</code> | <code>"bottom"</code> | Set the position of the tooltip relative to the icon |
| as | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` to render a custom HTML element<br />Props are destructured as `props` in the default slot (e.g., &lt;Button let:props&gt;&lt;div {...props}&gt;...&lt;/div&gt;&lt;/Button&gt;) |
| skeleton | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` to display the skeleton state |
@ -438,7 +431,6 @@ None.
| :-------- | :--------------- | :------- | :--------------------------------------------------------------------------- | ---------------------- | ------------------------------------ |
| href | <code>let</code> | No | <code>string</code> | <code>undefined</code> | Set the `href` to use an anchor link |
| size | <code>let</code> | No | <code>"default" &#124; "field" &#124; "small" &#124; "lg" &#124; "xl"</code> | <code>"default"</code> | Specify the size of button skeleton |
| small | <code>let</code> | No | <code>boolean</code> | <code>false</code> | -- |
### Slots
@ -761,7 +753,6 @@ None.
| Prop name | Kind | Reactive | Type | Default value | Description |
| :------------ | :--------------- | :------- | :---------------------------- | ---------------------- | ----------------------------------------- |
| selectedIndex | <code>let</code> | Yes | <code>number</code> | <code>0</code> | Set the selected index of the switch item |
| light | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` to enable the light variant |
| size | <code>let</code> | No | <code>"sm" &#124; "xl"</code> | <code>undefined</code> | Specify the size of the content switcher |
### Slots
@ -1640,26 +1631,6 @@ None.
None.
## `HeaderActionSearch`
### Props
| Prop name | Kind | Reactive | Type | Default value | Description |
| :------------- | :--------------- | :------- | :------------------- | ------------------ | --------------------------------- |
| searchIsActive | <code>let</code> | Yes | <code>boolean</code> | <code>false</code> | Set to `true` to focus the search |
### Slots
None.
### Events
| Event name | Type | Detail |
| :------------------ | :--------- | :---------------------------------------------------- |
| inputSearch | dispatched | <code>{ action: "search"; textInput: string; }</code> |
| focusInputSearch | dispatched | -- |
| focusOutInputSearch | dispatched | -- |
## `HeaderGlobalAction`
### Props
@ -1686,9 +1657,7 @@ None.
### Props
| Prop name | Kind | Reactive | Type | Default value | Description |
| :-------- | :--------------- | :------- | :------------------ | ---------------------- | ---------------------------------- |
| ariaLabel | <code>let</code> | No | <code>string</code> | <code>undefined</code> | Specify the ARIA label for the nav |
None.
### Slots
@ -1869,49 +1838,6 @@ None.
None.
## `Icon`
### Props
| Prop name | Kind | Reactive | Type | Default value | Description |
| :-------- | :--------------- | :------- | :--------------------------------------------------- | ---------------------- | ------------------------------------------- |
| render | <code>let</code> | No | <code>typeof import("svelte").SvelteComponent</code> | <code>undefined</code> | Specify the icon to render |
| skeleton | <code>let</code> | No | <code>boolean</code> | <code>false</code> | 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 | <code>let</code> | No | <code>number</code> | <code>16</code> | Set the size of the icon |
### Slots
None.
### Events
| Event name | Type | Detail |
| :--------- | :-------- | :----- |
| click | forwarded | -- |
| mouseover | forwarded | -- |
| mouseenter | forwarded | -- |
| mouseleave | forwarded | -- |
## `ImageLoader`
### Props
@ -2516,27 +2442,6 @@ None.
None.
## `NotificationTextDetails`
### Props
| Prop name | Kind | Reactive | Type | Default value | Description |
| :--------------- | :--------------- | :------- | :----------------------------------- | ---------------------- | ---------------------------- |
| notificationType | <code>let</code> | No | <code>"toast" &#124; "inline"</code> | <code>"toast"</code> | Set the type of notification |
| title | <code>let</code> | No | <code>string</code> | <code>"Title"</code> | Specify the title text |
| subtitle | <code>let</code> | No | <code>string</code> | <code>""</code> | Specify the subtitle text |
| caption | <code>let</code> | No | <code>string</code> | <code>"Caption"</code> | Specify the caption text |
### Slots
| Slot name | Default | Props | Fallback |
| :-------- | :------ | :---- | :------- |
| -- | Yes | -- | -- |
### Events
None.
## `NumberInput`
### Types
@ -2557,7 +2462,6 @@ export type NumberInputTranslationId = "increment" | "decrement";
| min | <code>let</code> | No | <code>number</code> | <code>undefined</code> | Specify the minimum value |
| light | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` to enable the light variant |
| readonly | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` for the input to be read-only |
| mobile | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` to enable the mobile variant |
| allowEmpty | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` to allow for an empty value |
| disabled | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` to disable the input |
| hideSteppers | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` to hide the input stepper buttons |
@ -3155,7 +3059,6 @@ None.
| ref | <code>let</code> | Yes | <code>null &#124; HTMLInputElement</code> | <code>null</code> | Obtain a reference to the input HTML element |
| expanded | <code>let</code> | Yes | <code>boolean</code> | <code>false</code> | Set to `true to expand the search input |
| value | <code>let</code> | Yes | <code>any</code> | <code>""</code> | Specify the value of the search input |
| small | <code>let</code> | No | <code>boolean</code> | <code>false</code> | -- |
| size | <code>let</code> | No | <code>"sm" &#124; "lg" &#124; "xl"</code> | <code>"xl"</code> | Specify the size of the search input |
| searchClass | <code>let</code> | No | <code>string</code> | <code>""</code> | Specify the class name passed to the outer div element |
| skeleton | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` to display the skeleton state |
@ -3198,10 +3101,9 @@ None.
### Props
| Prop name | Kind | Reactive | Type | Default value | Description |
| :-------- | :--------------- | :------- | :---------------------------------------- | ------------------ | ------------------------------------ |
| small | <code>let</code> | No | <code>boolean</code> | <code>false</code> | -- |
| size | <code>let</code> | No | <code>"sm" &#124; "lg" &#124; "xl"</code> | <code>"xl"</code> | Specify the size of the search input |
| Prop name | Kind | Reactive | Type | Default value | Description |
| :-------- | :--------------- | :------- | :---------------------------------------- | ----------------- | ------------------------------------ |
| size | <code>let</code> | No | <code>"sm" &#124; "lg" &#124; "xl"</code> | <code>"xl"</code> | Specify the size of the search input |
### Slots
@ -3608,7 +3510,6 @@ None.
| Prop name | Kind | Reactive | Type | Default value | Description |
| :-------- | :--------------- | :------- | :------------------- | ---------------------- | ---------------------------------------------- |
| selected | <code>let</code> | Yes | <code>string</code> | <code>undefined</code> | Specify the selected structured list row value |
| border | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` to use the bordered variant |
| condensed | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` to use the condensed variant |
| flush | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` to flush the list |
| selection | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` to use the selection variant |
@ -3842,14 +3743,13 @@ None.
### Props
| Prop name | Kind | Reactive | Type | Default value | Description |
| :--------------- | :--------------- | :------- | :------------------------------------------------------------------ | ---------------------- | --------------------------------------- |
| size | <code>let</code> | No | <code>"compact" &#124; "short" &#124; "medium" &#124; "tall"</code> | <code>undefined</code> | Set the size of the table |
| zebra | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` to use zebra styles |
| useStaticWidth | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` to use static width |
| shouldShowBorder | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` for the bordered variant |
| sortable | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` for the sortable variant |
| stickyHeader | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` to enable a sticky header |
| Prop name | Kind | Reactive | Type | Default value | Description |
| :------------- | :--------------- | :------- | :------------------------------------------------------------------ | ---------------------- | --------------------------------------- |
| size | <code>let</code> | No | <code>"compact" &#124; "short" &#124; "medium" &#124; "tall"</code> | <code>undefined</code> | Set the size of the table |
| zebra | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` to use zebra styles |
| useStaticWidth | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` to use static width |
| sortable | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` for the sortable variant |
| stickyHeader | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` to enable a sticky header |
### Slots
@ -4354,7 +4254,6 @@ export type CarbonTheme = "white" | "g10" | "g80" | "g90" | "g100";
| disabled | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` to disable the select |
| iconDescription | <code>let</code> | No | <code>string</code> | <code>"Open list of options"</code> | Specify the ARIA label for the chevron icon |
| labelText | <code>let</code> | No | <code>string</code> | <code>""</code> | Specify the label text |
| hideLabel | <code>let</code> | No | <code>boolean</code> | <code>true</code> | -- |
| id | <code>let</code> | No | <code>string</code> | <code>"ccs-" + Math.random().toString(36)</code> | Set an id for the select element |
| name | <code>let</code> | No | <code>string</code> | <code>undefined</code> | Specify a name attribute for the select element |
@ -4471,59 +4370,6 @@ export type CarbonTheme = "white" | "g10" | "g80" | "g90" | "g100";
| mouseenter | forwarded | -- |
| mouseleave | forwarded | -- |
## `ToggleSmall`
### Props
| Prop name | Kind | Reactive | Type | Default value | Description |
| :-------- | :--------------- | :------- | :------------------- | ------------------------------------------------ | ----------------------------------------------- |
| toggled | <code>let</code> | Yes | <code>boolean</code> | <code>false</code> | Set to `true` to toggle the checkbox input |
| disabled | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` to disable checkbox input |
| labelA | <code>let</code> | No | <code>string</code> | <code>"Off"</code> | Specify the label for the untoggled state |
| labelB | <code>let</code> | No | <code>string</code> | <code>"On"</code> | Specify the label for the toggled state |
| labelText | <code>let</code> | No | <code>string</code> | <code>""</code> | Specify the label text |
| id | <code>let</code> | No | <code>string</code> | <code>"ccs-" + Math.random().toString(36)</code> | Set an id for the input element |
| name | <code>let</code> | No | <code>string</code> | <code>undefined</code> | Specify a name attribute for the checkbox input |
### Slots
None.
### Events
| Event name | Type | Detail |
| :--------- | :-------- | :----- |
| click | forwarded | -- |
| mouseover | forwarded | -- |
| mouseenter | forwarded | -- |
| mouseleave | forwarded | -- |
| change | forwarded | -- |
| keyup | forwarded | -- |
| focus | forwarded | -- |
| blur | forwarded | -- |
## `ToggleSmallSkeleton`
### Props
| Prop name | Kind | Reactive | Type | Default value | Description |
| :-------- | :--------------- | :------- | :------------------ | ------------------------------------------------ | ------------------------------- |
| labelText | <code>let</code> | No | <code>string</code> | <code>""</code> | Specify the label text |
| id | <code>let</code> | No | <code>string</code> | <code>"ccs-" + Math.random().toString(36)</code> | Set an id for the input element |
### Slots
None.
### Events
| Event name | Type | Detail |
| :--------- | :-------- | :----- |
| click | forwarded | -- |
| mouseover | forwarded | -- |
| mouseenter | forwarded | -- |
| mouseleave | forwarded | -- |
## `Toolbar`
### Props

407
docs/src/COMPONENT_API.json
View file

@ -1,5 +1,5 @@
{
"total": 171,
"total": 165,
"components": [
{
"moduleName": "Accordion",
@ -472,17 +472,6 @@
"constant": false,
"reactive": false
},
{
"name": "hasIconOnly",
"kind": "let",
"description": "Set to `true` for the icon-only variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"isFunctionDeclaration": false,
"constant": false,
"reactive": true
},
{
"name": "icon",
"kind": "let",
@ -506,7 +495,7 @@
{
"name": "tooltipAlignment",
"kind": "let",
"description": "Set the alignment of the tooltip relative to the icon\n`hasIconOnly` must be set to `true`",
"description": "Set the alignment of the tooltip relative to the icon.\nOnly applies to icon-only buttons",
"type": "\"start\" | \"center\" | \"end\"",
"value": "\"center\"",
"isFunction": false,
@ -681,16 +670,6 @@
"isFunctionDeclaration": false,
"constant": false,
"reactive": false
},
{
"name": "small",
"kind": "let",
"type": "boolean",
"value": "false",
"isFunction": false,
"isFunctionDeclaration": false,
"constant": false,
"reactive": false
}
],
"moduleExports": [],
@ -1813,17 +1792,6 @@
"constant": false,
"reactive": true
},
{
"name": "light",
"kind": "let",
"description": "Set to `true` to enable the light variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"isFunctionDeclaration": false,
"constant": false,
"reactive": false
},
{
"name": "size",
"kind": "let",
@ -4659,36 +4627,6 @@
"typedefs": [],
"rest_props": { "type": "Element", "name": "a" }
},
{
"moduleName": "HeaderActionSearch",
"filePath": "src/UIShell/GlobalHeader/HeaderActionSearch.svelte",
"props": [
{
"name": "searchIsActive",
"kind": "let",
"description": "Set to `true` to focus the search",
"type": "boolean",
"value": "false",
"isFunction": false,
"isFunctionDeclaration": false,
"constant": false,
"reactive": true
}
],
"moduleExports": [],
"slots": [],
"events": [
{
"type": "dispatched",
"name": "inputSearch",
"detail": "{ action: \"search\"; textInput: string; }"
},
{ "type": "dispatched", "name": "focusInputSearch" },
{ "type": "dispatched", "name": "focusOutInputSearch" }
],
"typedefs": [],
"componentComment": "\n@deprecated\nThis component is deprecated. Use `HeaderSearch` instead."
},
{
"moduleName": "HeaderGlobalAction",
"filePath": "src/UIShell/HeaderGlobalAction.svelte",
@ -4742,18 +4680,7 @@
{
"moduleName": "HeaderNav",
"filePath": "src/UIShell/GlobalHeader/HeaderNav.svelte",
"props": [
{
"name": "ariaLabel",
"kind": "let",
"description": "Specify the ARIA label for the nav",
"type": "string",
"isFunction": false,
"isFunctionDeclaration": false,
"constant": false,
"reactive": false
}
],
"props": [],
"moduleExports": [],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [],
@ -5037,80 +4964,6 @@
"events": [],
"typedefs": []
},
{
"moduleName": "Icon",
"filePath": "src/Icon/Icon.svelte",
"props": [
{
"name": "render",
"kind": "let",
"description": "Specify the icon to render",
"type": "typeof import(\"svelte\").SvelteComponent",
"isFunction": false,
"isFunctionDeclaration": false,
"constant": false,
"reactive": false
},
{
"name": "skeleton",
"kind": "let",
"description": "Set to `true` to display the skeleton state",
"type": "boolean",
"value": "false",
"isFunction": false,
"isFunctionDeclaration": false,
"constant": false,
"reactive": false
}
],
"moduleExports": [],
"slots": [],
"events": [
{ "type": "forwarded", "name": "click", "element": "IconSkeleton" },
{ "type": "forwarded", "name": "mouseover", "element": "IconSkeleton" },
{
"type": "forwarded",
"name": "mouseenter",
"element": "IconSkeleton"
},
{ "type": "forwarded", "name": "mouseleave", "element": "IconSkeleton" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "svg" },
"extends": {
"interface": "IconSkeletonProps",
"import": "\"./IconSkeleton.svelte\""
},
"componentComment": "\n@deprecated This component is deprecated.\nUse icons from \"carbon-icons-svelte\" instead."
},
{
"moduleName": "IconSkeleton",
"filePath": "src/Icon/IconSkeleton.svelte",
"props": [
{
"name": "size",
"kind": "let",
"description": "Set the size of the icon",
"type": "number",
"value": "16",
"isFunction": false,
"isFunctionDeclaration": false,
"constant": false,
"reactive": false
}
],
"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" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" },
"componentComment": "\n@deprecated This component is deprecated."
},
{
"moduleName": "ImageLoader",
"filePath": "src/ImageLoader/ImageLoader.svelte",
@ -7073,61 +6926,6 @@
"events": [],
"typedefs": []
},
{
"moduleName": "NotificationTextDetails",
"filePath": "src/Notification/NotificationTextDetails.svelte",
"props": [
{
"name": "notificationType",
"kind": "let",
"description": "Set the type of notification",
"type": "\"toast\" | \"inline\"",
"value": "\"toast\"",
"isFunction": false,
"isFunctionDeclaration": false,
"constant": false,
"reactive": false
},
{
"name": "title",
"kind": "let",
"description": "Specify the title text",
"type": "string",
"value": "\"Title\"",
"isFunction": false,
"isFunctionDeclaration": false,
"constant": false,
"reactive": false
},
{
"name": "subtitle",
"kind": "let",
"description": "Specify the subtitle text",
"type": "string",
"value": "\"\"",
"isFunction": false,
"isFunctionDeclaration": false,
"constant": false,
"reactive": false
},
{
"name": "caption",
"kind": "let",
"description": "Specify the caption text",
"type": "string",
"value": "\"Caption\"",
"isFunction": false,
"isFunctionDeclaration": false,
"constant": false,
"reactive": false
}
],
"moduleExports": [],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [],
"typedefs": [],
"componentComment": "\n@deprecated This component is deprecated."
},
{
"moduleName": "NumberInput",
"filePath": "src/NumberInput/NumberInput.svelte",
@ -7206,17 +7004,6 @@
"constant": false,
"reactive": false
},
{
"name": "mobile",
"kind": "let",
"description": "Set to `true` to enable the mobile variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"isFunctionDeclaration": false,
"constant": false,
"reactive": false
},
{
"name": "allowEmpty",
"kind": "let",
@ -9250,16 +9037,6 @@
"constant": false,
"reactive": true
},
{
"name": "small",
"kind": "let",
"type": "boolean",
"value": "false",
"isFunction": false,
"isFunctionDeclaration": false,
"constant": false,
"reactive": false
},
{
"name": "size",
"kind": "let",
@ -9468,16 +9245,6 @@
"moduleName": "SearchSkeleton",
"filePath": "src/Search/SearchSkeleton.svelte",
"props": [
{
"name": "small",
"kind": "let",
"type": "boolean",
"value": "false",
"isFunction": false,
"isFunctionDeclaration": false,
"constant": false,
"reactive": false
},
{
"name": "size",
"kind": "let",
@ -10602,17 +10369,6 @@
"constant": false,
"reactive": true
},
{
"name": "border",
"kind": "let",
"description": "Set to `true` to use the bordered variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"isFunctionDeclaration": false,
"constant": false,
"reactive": false
},
{
"name": "condensed",
"kind": "let",
@ -11118,17 +10874,6 @@
"constant": false,
"reactive": false
},
{
"name": "shouldShowBorder",
"kind": "let",
"description": "Set to `true` for the bordered variant",
"type": "boolean",
"value": "false",
"isFunction": false,
"isFunctionDeclaration": false,
"constant": false,
"reactive": false
},
{
"name": "sortable",
"kind": "let",
@ -12495,16 +12240,6 @@
"constant": false,
"reactive": false
},
{
"name": "hideLabel",
"kind": "let",
"type": "boolean",
"value": "true",
"isFunction": false,
"isFunctionDeclaration": false,
"constant": false,
"reactive": false
},
{
"name": "id",
"kind": "let",
@ -12884,142 +12619,6 @@
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
},
{
"moduleName": "ToggleSmall",
"filePath": "src/ToggleSmall/ToggleSmall.svelte",
"props": [
{
"name": "toggled",
"kind": "let",
"description": "Set to `true` to toggle the checkbox input",
"type": "boolean",
"value": "false",
"isFunction": false,
"isFunctionDeclaration": false,
"constant": false,
"reactive": true
},
{
"name": "disabled",
"kind": "let",
"description": "Set to `true` to disable checkbox input",
"type": "boolean",
"value": "false",
"isFunction": false,
"isFunctionDeclaration": false,
"constant": false,
"reactive": false
},
{
"name": "labelA",
"kind": "let",
"description": "Specify the label for the untoggled state",
"type": "string",
"value": "\"Off\"",
"isFunction": false,
"isFunctionDeclaration": false,
"constant": false,
"reactive": false
},
{
"name": "labelB",
"kind": "let",
"description": "Specify the label for the toggled state",
"type": "string",
"value": "\"On\"",
"isFunction": false,
"isFunctionDeclaration": false,
"constant": false,
"reactive": false
},
{
"name": "labelText",
"kind": "let",
"description": "Specify the label text",
"type": "string",
"value": "\"\"",
"isFunction": false,
"isFunctionDeclaration": false,
"constant": false,
"reactive": false
},
{
"name": "id",
"kind": "let",
"description": "Set an id for the input element",
"type": "string",
"value": "\"ccs-\" + Math.random().toString(36)",
"isFunction": false,
"isFunctionDeclaration": false,
"constant": false,
"reactive": false
},
{
"name": "name",
"kind": "let",
"description": "Specify a name attribute for the checkbox input",
"type": "string",
"isFunction": false,
"isFunctionDeclaration": false,
"constant": false,
"reactive": false
}
],
"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": "change", "element": "input" },
{ "type": "forwarded", "name": "keyup", "element": "input" },
{ "type": "forwarded", "name": "focus", "element": "input" },
{ "type": "forwarded", "name": "blur", "element": "input" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" },
"componentComment": "\n@deprecated This component is deprecated.\nUse`<Toggle size=\"sm\" />` instead."
},
{
"moduleName": "ToggleSmallSkeleton",
"filePath": "src/ToggleSmall/ToggleSmallSkeleton.svelte",
"props": [
{
"name": "labelText",
"kind": "let",
"description": "Specify the label text",
"type": "string",
"value": "\"\"",
"isFunction": false,
"isFunctionDeclaration": false,
"constant": false,
"reactive": false
},
{
"name": "id",
"kind": "let",
"description": "Set an id for the input element",
"type": "string",
"value": "\"ccs-\" + Math.random().toString(36)",
"isFunction": false,
"isFunctionDeclaration": false,
"constant": false,
"reactive": false
}
],
"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" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" },
"componentComment": "\n@deprecated This component is deprecated.\nUse`<ToggleSkeleton size=\"sm\" />` instead."
},
{
"moduleName": "Toolbar",
"filePath": "src/DataTable/Toolbar.svelte",

18
preprocess/api.json
View file

@ -190,12 +190,6 @@
"Row": {
"path": "carbon-components-svelte/src/Grid/Row.svelte"
},
"Icon": {
"path": "carbon-components-svelte/src/Icon/Icon.svelte"
},
"IconSkeleton": {
"path": "carbon-components-svelte/src/Icon/IconSkeleton.svelte"
},
"Add16": {
"path": "carbon-components-svelte/src/icons/Add16.svelte"
},
@ -376,9 +370,6 @@
"NotificationIcon": {
"path": "carbon-components-svelte/src/Notification/NotificationIcon.svelte"
},
"NotificationTextDetails": {
"path": "carbon-components-svelte/src/Notification/NotificationTextDetails.svelte"
},
"ToastNotification": {
"path": "carbon-components-svelte/src/Notification/ToastNotification.svelte"
},
@ -559,12 +550,6 @@
"ToggleSkeleton": {
"path": "carbon-components-svelte/src/Toggle/ToggleSkeleton.svelte"
},
"ToggleSmall": {
"path": "carbon-components-svelte/src/ToggleSmall/ToggleSmall.svelte"
},
"ToggleSmallSkeleton": {
"path": "carbon-components-svelte/src/ToggleSmall/ToggleSmallSkeleton.svelte"
},
"Tooltip": {
"path": "carbon-components-svelte/src/Tooltip/Tooltip.svelte"
},
@ -601,9 +586,6 @@
"HeaderActionLink": {
"path": "carbon-components-svelte/src/UIShell/GlobalHeader/HeaderActionLink.svelte"
},
"HeaderActionSearch": {
"path": "carbon-components-svelte/src/UIShell/GlobalHeader/HeaderActionSearch.svelte"
},
"HeaderNav": {
"path": "carbon-components-svelte/src/UIShell/GlobalHeader/HeaderNav.svelte"
},

10
types/Button/Button.svelte.d.ts vendored
View file

@ -38,12 +38,6 @@ export interface ButtonProps
*/
isSelected?: boolean;
/**
* Set to `true` for the icon-only variant
* @default false
*/
hasIconOnly?: boolean;
/**
* Specify the icon to render
* @default undefined
@ -57,8 +51,8 @@ export interface ButtonProps
iconDescription?: string;
/**
* Set the alignment of the tooltip relative to the icon
* `hasIconOnly` must be set to `true`
* Set the alignment of the tooltip relative to the icon.
* Only applies to icon-only buttons
* @default "center"
*/
tooltipAlignment?: "start" | "center" | "end";

5
types/Button/ButtonSkeleton.svelte.d.ts vendored
View file

@ -14,11 +14,6 @@ export interface ButtonSkeletonProps
* @default "default"
*/
size?: "default" | "field" | "small" | "lg" | "xl";
/**
* @default false
*/
small?: boolean;
}
export default class ButtonSkeleton extends SvelteComponentTyped<

6
types/ContentSwitcher/ContentSwitcher.svelte.d.ts vendored
View file

@ -9,12 +9,6 @@ export interface ContentSwitcherProps
*/
selectedIndex?: number;
/**
* Set to `true` to enable the light variant
* @default false
*/
light?: boolean;
/**
* Specify the size of the content switcher
* @default undefined

6
types/DataTable/Table.svelte.d.ts vendored
View file

@ -21,12 +21,6 @@ export interface TableProps
*/
useStaticWidth?: boolean;
/**
* Set to `true` for the bordered variant
* @default false
*/
shouldShowBorder?: boolean;
/**
* Set to `true` for the sortable variant
* @default false

6
types/NumberInput/NumberInput.svelte.d.ts vendored
View file

@ -48,12 +48,6 @@ export interface NumberInputProps
*/
readonly?: boolean;
/**
* Set to `true` to enable the mobile variant
* @default false
*/
mobile?: boolean;
/**
* Set to `true` to allow for an empty value
* @default false

5
types/Search/Search.svelte.d.ts vendored
View file

@ -8,11 +8,6 @@ export interface SearchProps {
*/
value?: any;
/**
* @default false
*/
small?: boolean;
/**
* Specify the size of the search input
* @default "xl"

5
types/Search/SearchSkeleton.svelte.d.ts vendored
View file

@ -3,11 +3,6 @@ import { SvelteComponentTyped } from "svelte";
export interface SearchSkeletonProps
extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["div"]> {
/**
* @default false
*/
small?: boolean;
/**
* Specify the size of the search input
* @default "xl"

6
types/StructuredList/StructuredList.svelte.d.ts vendored
View file

@ -9,12 +9,6 @@ export interface StructuredListProps
*/
selected?: string;
/**
* Set to `true` to use the bordered variant
* @default false
*/
border?: boolean;
/**
* Set to `true` to use the condensed variant
* @default false

5
types/TimePicker/TimePickerSelect.svelte.d.ts vendored
View file

@ -27,11 +27,6 @@ export interface TimePickerSelectProps
*/
labelText?: string;
/**
* @default true
*/
hideLabel?: boolean;
/**
* Set an id for the select element
* @default "ccs-" + Math.random().toString(36)

8
types/UIShell/GlobalHeader/HeaderNav.svelte.d.ts vendored
View file

@ -2,13 +2,7 @@
import { SvelteComponentTyped } from "svelte";
export interface HeaderNavProps
extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["nav"]> {
/**
* Specify the ARIA label for the nav
* @default undefined
*/
ariaLabel?: string;
}
extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["nav"]> {}
export default class HeaderNav extends SvelteComponentTyped<
HeaderNavProps,

6
types/index.d.ts vendored
View file

@ -60,8 +60,6 @@ export { default as FormLabel } from "./FormLabel/FormLabel.svelte";
export { default as Grid } from "./Grid/Grid.svelte";
export { default as Row } from "./Grid/Row.svelte";
export { default as Column } from "./Grid/Column.svelte";
export { default as Icon } from "./Icon/Icon.svelte";
export { default as IconSkeleton } from "./Icon/IconSkeleton.svelte";
export { default as ImageLoader } from "./ImageLoader/ImageLoader.svelte";
export { default as InlineLoading } from "./InlineLoading/InlineLoading.svelte";
export { default as Link } from "./Link/Link.svelte";
@ -82,7 +80,6 @@ export { default as InlineNotification } from "./Notification/InlineNotification
export { default as NotificationActionButton } from "./Notification/NotificationActionButton.svelte";
export { default as NotificationButton } from "./Notification/NotificationButton.svelte";
export { default as NotificationIcon } from "./Notification/NotificationIcon.svelte";
export { default as NotificationTextDetails } from "./Notification/NotificationTextDetails.svelte";
export { default as NumberInput } from "./NumberInput/NumberInput.svelte";
export { default as NumberInputSkeleton } from "./NumberInput/NumberInputSkeleton.svelte";
export { default as OrderedList } from "./OrderedList/OrderedList.svelte";
@ -139,8 +136,6 @@ export { default as TimePicker } from "./TimePicker/TimePicker.svelte";
export { default as TimePickerSelect } from "./TimePicker/TimePickerSelect.svelte";
export { default as Toggle } from "./Toggle/Toggle.svelte";
export { default as ToggleSkeleton } from "./Toggle/ToggleSkeleton.svelte";
export { default as ToggleSmall } from "./ToggleSmall/ToggleSmall.svelte";
export { default as ToggleSmallSkeleton } from "./ToggleSmall/ToggleSmallSkeleton.svelte";
export { default as Tooltip } from "./Tooltip/Tooltip.svelte";
export { default as TooltipFooter } from "./Tooltip/TooltipFooter.svelte";
export { default as TooltipDefinition } from "./TooltipDefinition/TooltipDefinition.svelte";
@ -150,7 +145,6 @@ export { default as Truncate } from "./Truncate/Truncate.svelte";
export { default as Header } from "./UIShell/GlobalHeader/Header.svelte";
export { default as HeaderAction } from "./UIShell/GlobalHeader/HeaderAction.svelte";
export { default as HeaderActionLink } from "./UIShell/GlobalHeader/HeaderActionLink.svelte";
export { default as HeaderActionSearch } from "./UIShell/GlobalHeader/HeaderActionSearch.svelte";
export { default as HeaderNav } from "./UIShell/GlobalHeader/HeaderNav.svelte";
export { default as HeaderNavItem } from "./UIShell/GlobalHeader/HeaderNavItem.svelte";
export { default as HeaderNavMenu } from "./UIShell/GlobalHeader/HeaderNavMenu.svelte";