diff --git a/COMPONENT_INDEX.md b/COMPONENT_INDEX.md index 14d8d4b3..1e200b7c 100644 --- a/COMPONENT_INDEX.md +++ b/COMPONENT_INDEX.md @@ -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 | let | Yes | null | HTMLAnchorElement | HTMLButtonElement | null | Obtain a reference to the HTML element | -| hasIconOnly | let | Yes | boolean | false | Set to `true` for the icon-only variant | | kind | let | No | "primary" | "secondary" | "tertiary" | "ghost" | "danger" | "danger-tertiary" | "danger-ghost" | "primary" | Specify the kind of button | | size | let | No | "default" | "field" | "small" | "lg" | "xl" | "default" | Specify the size of button | | expressive | let | No | boolean | false | Set to `true` to use Carbon's expressive typesetting | | isSelected | let | No | boolean | false | Set to `true` to enable the selected state for an icon-only, ghost button | | icon | let | No | typeof import("svelte").SvelteComponent | undefined | Specify the icon to render | | iconDescription | let | No | string | undefined | Specify the ARIA label for the button icon | -| tooltipAlignment | let | No | "start" | "center" | "end" | "center" | Set the alignment of the tooltip relative to the icon
`hasIconOnly` must be set to `true` | +| tooltipAlignment | let | No | "start" | "center" | "end" | "center" | Set the alignment of the tooltip relative to the icon.
Only applies to icon-only buttons | | tooltipPosition | let | No | "top" | "right" | "bottom" | "left" | "bottom" | Set the position of the tooltip relative to the icon | | as | let | No | boolean | false | Set to `true` to render a custom HTML element
Props are destructured as `props` in the default slot (e.g., <Button let:props><div {...props}>...</div></Button>) | | skeleton | let | No | boolean | false | Set to `true` to display the skeleton state | @@ -438,7 +431,6 @@ None. | :-------- | :--------------- | :------- | :--------------------------------------------------------------------------- | ---------------------- | ------------------------------------ | | href | let | No | string | undefined | Set the `href` to use an anchor link | | size | let | No | "default" | "field" | "small" | "lg" | "xl" | "default" | Specify the size of button skeleton | -| small | let | No | boolean | false | -- | ### Slots @@ -761,7 +753,6 @@ None. | Prop name | Kind | Reactive | Type | Default value | Description | | :------------ | :--------------- | :------- | :---------------------------- | ---------------------- | ----------------------------------------- | | selectedIndex | let | Yes | number | 0 | Set the selected index of the switch item | -| light | let | No | boolean | false | Set to `true` to enable the light variant | | size | let | No | "sm" | "xl" | undefined | 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 | let | Yes | boolean | false | Set to `true` to focus the search | - -### Slots - -None. - -### Events - -| Event name | Type | Detail | -| :------------------ | :--------- | :---------------------------------------------------- | -| inputSearch | dispatched | { action: "search"; textInput: string; } | -| focusInputSearch | dispatched | -- | -| focusOutInputSearch | dispatched | -- | - ## `HeaderGlobalAction` ### Props @@ -1686,9 +1657,7 @@ None. ### Props -| Prop name | Kind | Reactive | Type | Default value | Description | -| :-------- | :--------------- | :------- | :------------------ | ---------------------- | ---------------------------------- | -| ariaLabel | let | No | string | undefined | 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 | let | No | typeof import("svelte").SvelteComponent | undefined | Specify the icon to render | -| skeleton | let | No | boolean | false | Set to `true` to display the skeleton state | - -### Slots - -None. - -### Events - -| Event name | Type | Detail | -| :--------- | :-------- | :----- | -| click | forwarded | -- | -| mouseover | forwarded | -- | -| mouseenter | forwarded | -- | -| mouseleave | forwarded | -- | - -## `IconSkeleton` - -### Props - -| Prop name | Kind | Reactive | Type | Default value | Description | -| :-------- | :--------------- | :------- | :------------------ | --------------- | ------------------------ | -| size | let | No | number | 16 | Set the size of the icon | - -### Slots - -None. - -### Events - -| Event name | Type | Detail | -| :--------- | :-------- | :----- | -| click | forwarded | -- | -| mouseover | forwarded | -- | -| mouseenter | forwarded | -- | -| mouseleave | forwarded | -- | - ## `ImageLoader` ### Props @@ -2516,27 +2442,6 @@ None. None. -## `NotificationTextDetails` - -### Props - -| Prop name | Kind | Reactive | Type | Default value | Description | -| :--------------- | :--------------- | :------- | :----------------------------------- | ---------------------- | ---------------------------- | -| notificationType | let | No | "toast" | "inline" | "toast" | Set the type of notification | -| title | let | No | string | "Title" | Specify the title text | -| subtitle | let | No | string | "" | Specify the subtitle text | -| caption | let | No | string | "Caption" | Specify the caption text | - -### Slots - -| Slot name | Default | Props | Fallback | -| :-------- | :------ | :---- | :------- | -| -- | Yes | -- | -- | - -### Events - -None. - ## `NumberInput` ### Types @@ -2557,7 +2462,6 @@ export type NumberInputTranslationId = "increment" | "decrement"; | min | let | No | number | undefined | Specify the minimum value | | light | let | No | boolean | false | Set to `true` to enable the light variant | | readonly | let | No | boolean | false | Set to `true` for the input to be read-only | -| mobile | let | No | boolean | false | Set to `true` to enable the mobile variant | | allowEmpty | let | No | boolean | false | Set to `true` to allow for an empty value | | disabled | let | No | boolean | false | Set to `true` to disable the input | | hideSteppers | let | No | boolean | false | Set to `true` to hide the input stepper buttons | @@ -3155,7 +3059,6 @@ None. | ref | let | Yes | null | HTMLInputElement | null | Obtain a reference to the input HTML element | | expanded | let | Yes | boolean | false | Set to `true to expand the search input | | value | let | Yes | any | "" | Specify the value of the search input | -| small | let | No | boolean | false | -- | | size | let | No | "sm" | "lg" | "xl" | "xl" | Specify the size of the search input | | searchClass | let | No | string | "" | Specify the class name passed to the outer div element | | skeleton | let | No | boolean | false | Set to `true` to display the skeleton state | @@ -3198,10 +3101,9 @@ None. ### Props -| Prop name | Kind | Reactive | Type | Default value | Description | -| :-------- | :--------------- | :------- | :---------------------------------------- | ------------------ | ------------------------------------ | -| small | let | No | boolean | false | -- | -| size | let | No | "sm" | "lg" | "xl" | "xl" | Specify the size of the search input | +| Prop name | Kind | Reactive | Type | Default value | Description | +| :-------- | :--------------- | :------- | :---------------------------------------- | ----------------- | ------------------------------------ | +| size | let | No | "sm" | "lg" | "xl" | "xl" | Specify the size of the search input | ### Slots @@ -3608,7 +3510,6 @@ None. | Prop name | Kind | Reactive | Type | Default value | Description | | :-------- | :--------------- | :------- | :------------------- | ---------------------- | ---------------------------------------------- | | selected | let | Yes | string | undefined | Specify the selected structured list row value | -| border | let | No | boolean | false | Set to `true` to use the bordered variant | | condensed | let | No | boolean | false | Set to `true` to use the condensed variant | | flush | let | No | boolean | false | Set to `true` to flush the list | | selection | let | No | boolean | false | Set to `true` to use the selection variant | @@ -3842,14 +3743,13 @@ None. ### Props -| Prop name | Kind | Reactive | Type | Default value | Description | -| :--------------- | :--------------- | :------- | :------------------------------------------------------------------ | ---------------------- | --------------------------------------- | -| size | let | No | "compact" | "short" | "medium" | "tall" | undefined | Set the size of the table | -| zebra | let | No | boolean | false | Set to `true` to use zebra styles | -| useStaticWidth | let | No | boolean | false | Set to `true` to use static width | -| shouldShowBorder | let | No | boolean | false | Set to `true` for the bordered variant | -| sortable | let | No | boolean | false | Set to `true` for the sortable variant | -| stickyHeader | let | No | boolean | false | Set to `true` to enable a sticky header | +| Prop name | Kind | Reactive | Type | Default value | Description | +| :------------- | :--------------- | :------- | :------------------------------------------------------------------ | ---------------------- | --------------------------------------- | +| size | let | No | "compact" | "short" | "medium" | "tall" | undefined | Set the size of the table | +| zebra | let | No | boolean | false | Set to `true` to use zebra styles | +| useStaticWidth | let | No | boolean | false | Set to `true` to use static width | +| sortable | let | No | boolean | false | Set to `true` for the sortable variant | +| stickyHeader | let | No | boolean | false | Set to `true` to enable a sticky header | ### Slots @@ -4354,7 +4254,6 @@ export type CarbonTheme = "white" | "g10" | "g80" | "g90" | "g100"; | disabled | let | No | boolean | false | Set to `true` to disable the select | | iconDescription | let | No | string | "Open list of options" | Specify the ARIA label for the chevron icon | | labelText | let | No | string | "" | Specify the label text | -| hideLabel | let | No | boolean | true | -- | | id | let | No | string | "ccs-" + Math.random().toString(36) | Set an id for the select element | | name | let | No | string | undefined | 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 | let | Yes | boolean | false | Set to `true` to toggle the checkbox input | -| disabled | let | No | boolean | false | Set to `true` to disable checkbox input | -| labelA | let | No | string | "Off" | Specify the label for the untoggled state | -| labelB | let | No | string | "On" | Specify the label for the toggled state | -| labelText | let | No | string | "" | Specify the label text | -| id | let | No | string | "ccs-" + Math.random().toString(36) | Set an id for the input element | -| name | let | No | string | undefined | 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 | let | No | string | "" | Specify the label text | -| id | let | No | string | "ccs-" + Math.random().toString(36) | Set an id for the input element | - -### Slots - -None. - -### Events - -| Event name | Type | Detail | -| :--------- | :-------- | :----- | -| click | forwarded | -- | -| mouseover | forwarded | -- | -| mouseenter | forwarded | -- | -| mouseleave | forwarded | -- | - ## `Toolbar` ### Props diff --git a/docs/src/COMPONENT_API.json b/docs/src/COMPONENT_API.json index eb7625f3..ec7acb9d 100644 --- a/docs/src/COMPONENT_API.json +++ b/docs/src/COMPONENT_API.json @@ -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`` 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`` instead." - }, { "moduleName": "Toolbar", "filePath": "src/DataTable/Toolbar.svelte", diff --git a/preprocess/api.json b/preprocess/api.json index faf1f11c..a4519681 100644 --- a/preprocess/api.json +++ b/preprocess/api.json @@ -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" }, diff --git a/types/Button/Button.svelte.d.ts b/types/Button/Button.svelte.d.ts index 8af7d6ff..e50c7111 100644 --- a/types/Button/Button.svelte.d.ts +++ b/types/Button/Button.svelte.d.ts @@ -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"; diff --git a/types/Button/ButtonSkeleton.svelte.d.ts b/types/Button/ButtonSkeleton.svelte.d.ts index 301f0ec1..162d6102 100644 --- a/types/Button/ButtonSkeleton.svelte.d.ts +++ b/types/Button/ButtonSkeleton.svelte.d.ts @@ -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< diff --git a/types/ContentSwitcher/ContentSwitcher.svelte.d.ts b/types/ContentSwitcher/ContentSwitcher.svelte.d.ts index 5115c345..a75f5723 100644 --- a/types/ContentSwitcher/ContentSwitcher.svelte.d.ts +++ b/types/ContentSwitcher/ContentSwitcher.svelte.d.ts @@ -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 diff --git a/types/DataTable/Table.svelte.d.ts b/types/DataTable/Table.svelte.d.ts index 0c2a302d..f3731dc4 100644 --- a/types/DataTable/Table.svelte.d.ts +++ b/types/DataTable/Table.svelte.d.ts @@ -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 diff --git a/types/NumberInput/NumberInput.svelte.d.ts b/types/NumberInput/NumberInput.svelte.d.ts index f7813f13..cfe55699 100644 --- a/types/NumberInput/NumberInput.svelte.d.ts +++ b/types/NumberInput/NumberInput.svelte.d.ts @@ -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 diff --git a/types/Search/Search.svelte.d.ts b/types/Search/Search.svelte.d.ts index 44b5b19c..f02628a9 100644 --- a/types/Search/Search.svelte.d.ts +++ b/types/Search/Search.svelte.d.ts @@ -8,11 +8,6 @@ export interface SearchProps { */ value?: any; - /** - * @default false - */ - small?: boolean; - /** * Specify the size of the search input * @default "xl" diff --git a/types/Search/SearchSkeleton.svelte.d.ts b/types/Search/SearchSkeleton.svelte.d.ts index eaeb4ec5..9076275b 100644 --- a/types/Search/SearchSkeleton.svelte.d.ts +++ b/types/Search/SearchSkeleton.svelte.d.ts @@ -3,11 +3,6 @@ import { SvelteComponentTyped } from "svelte"; export interface SearchSkeletonProps extends svelte.JSX.HTMLAttributes { - /** - * @default false - */ - small?: boolean; - /** * Specify the size of the search input * @default "xl" diff --git a/types/StructuredList/StructuredList.svelte.d.ts b/types/StructuredList/StructuredList.svelte.d.ts index 98593117..40dd5247 100644 --- a/types/StructuredList/StructuredList.svelte.d.ts +++ b/types/StructuredList/StructuredList.svelte.d.ts @@ -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 diff --git a/types/TimePicker/TimePickerSelect.svelte.d.ts b/types/TimePicker/TimePickerSelect.svelte.d.ts index 7d4607d6..f4391c23 100644 --- a/types/TimePicker/TimePickerSelect.svelte.d.ts +++ b/types/TimePicker/TimePickerSelect.svelte.d.ts @@ -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) diff --git a/types/UIShell/GlobalHeader/HeaderNav.svelte.d.ts b/types/UIShell/GlobalHeader/HeaderNav.svelte.d.ts index 20bbd3df..ee6ec604 100644 --- a/types/UIShell/GlobalHeader/HeaderNav.svelte.d.ts +++ b/types/UIShell/GlobalHeader/HeaderNav.svelte.d.ts @@ -2,13 +2,7 @@ import { SvelteComponentTyped } from "svelte"; export interface HeaderNavProps - extends svelte.JSX.HTMLAttributes { - /** - * Specify the ARIA label for the nav - * @default undefined - */ - ariaLabel?: string; -} + extends svelte.JSX.HTMLAttributes {} export default class HeaderNav extends SvelteComponentTyped< HeaderNavProps, diff --git a/types/index.d.ts b/types/index.d.ts index 2958b98a..3b361412 100644 --- a/types/index.d.ts +++ b/types/index.d.ts @@ -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";