mcp/carbon-components-svelte
1
0
Fork 0
mirror of https://github.com/carbon-design-system/carbon-components-svelte.git synced 2025-09-14 18:01:06 +00:00
Code Issues Projects Releases Packages Wiki Activity

chore: re-run npm run build:docs (#2051)

Browse source
This commit is contained in:
Eric Liu 2024-11-12 10:27:38 -08:00 • committed by GitHub
commit 5f887f59e8
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
6 changed files with 82 additions and 83 deletions
Download patch file Download diff file Expand all files Collapse all files

108
COMPONENT_INDEX.md
View file

@ -862,12 +862,12 @@ None.
### Slots ### Slots
| Slot name | Default | Props | Fallback | | Slot name | Default | Props | Fallback |
| :----------- | :------ | :---- | :---------------------------------------------------- | | :----------- | :------ | :---- | :-------------------------------------------------- |
| -- | Yes | -- | -- | | -- | Yes | -- | -- |
| icon | No | -- | <code>&lt;svelte:component this="{icon}" /&gt;</code> | | icon | No | -- | <code>&lt;svelte:component this={icon} /&gt;</code> |
| labelText | No | -- | <code>{labelText}</code> | | labelText | No | -- | <code>{labelText}</code> |
| shortcutText | No | -- | <code>{shortcutText}</code> | | shortcutText | No | -- | <code>{shortcutText}</code> |
### Events ### Events
@ -1627,12 +1627,12 @@ None.
### Slots ### Slots
| Slot name | Default | Props | Fallback | | Slot name | Default | Props | Fallback |
| :-------- | :------ | :---- | :--------------------------------------------------------------------------------------------------- | | :-------- | :------ | :---- | :------------------------------------------------------------------------------------------------- |
| -- | Yes | -- | -- | | -- | Yes | -- | -- |
| closeIcon | No | -- | <code>&lt;svelte:component this="{closeIcon}" size="{20}" /&gt;</code> | | closeIcon | No | -- | <code>&lt;svelte:component this={closeIcon} size={20} /&gt;</code> |
| icon | No | -- | <code>&lt;svelte:component this="{icon}" size="{20}" /&gt;</code> | | icon | No | -- | <code>&lt;svelte:component this={icon} size={20} /&gt;</code> |
| text | No | -- | <code>{#if text}&lt;span class:bx--header\_\_action-text="{true}"&gt;{text}&lt;/span&gt;{/if}</code> | | text | No | -- | <code>{#if text}&lt;span class:bx--header\_\_action-text={true}&gt;{text}&lt;/span&gt;{/if}</code> |
### Events ### Events
@ -1655,9 +1655,9 @@ None.
### Slots ### Slots
| Slot name | Default | Props | Fallback | | Slot name | Default | Props | Fallback |
| :-------- | :------ | :---- | :---------------------------------------------------------------- | | :-------- | :------ | :---- | :------------------------------------------------------------ |
| icon | No | -- | <code>&lt;svelte:component this="{icon}" size="{20}" /&gt;</code> | | icon | No | -- | <code>&lt;svelte:component this={icon} size={20} /&gt;</code> |
### Events ### Events
@ -1838,9 +1838,9 @@ export interface HeaderSearchResult {
### Slots ### Slots
| Slot name | Default | Props | Fallback | | Slot name | Default | Props | Fallback |
| :-------- | :------ | :---------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | :-------- | :------ | :---------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| -- | Yes | <code>{ result: HeaderSearchResult; index: number } </code> | <code>{result.text}<br /> {#if result.description}&lt;span<br /> class:bx--header-search-menu-description="{true}"<br /> &gt;– {result.description}&lt;/span<br /> &gt;{/if}</code> | | -- | Yes | <code>{ result: HeaderSearchResult; index: number } </code> | <code>{result.text}<br /> {#if result.description}&lt;span<br /> class:bx--header-search-menu-description={true}<br /> &gt;– {result.description}&lt;/span<br /> &gt;{/if}</code> |
### Events ### Events
@ -1978,10 +1978,10 @@ None.
### Slots ### Slots
| Slot name | Default | Props | Fallback | | Slot name | Default | Props | Fallback |
| :-------- | :------ | :---- | :---------------------------------------------------- | | :-------- | :------ | :---- | :-------------------------------------------------- |
| -- | Yes | -- | -- | | -- | Yes | -- | -- |
| icon | No | -- | <code>&lt;svelte:component this="{icon}" /&gt;</code> | | icon | No | -- | <code>&lt;svelte:component this={icon} /&gt;</code> |
### Events ### Events
@ -2628,10 +2628,10 @@ None.
### Slots ### Slots
| Slot name | Default | Props | Fallback | | Slot name | Default | Props | Fallback |
| :-------- | :------ | :---- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | :-------- | :------ | :---- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| -- | Yes | -- | -- | | -- | Yes | -- | -- |
| menu | No | -- | <code>&lt;svelte:component<br /> this="{icon}"<br /> aria-label="{iconDescription}"<br /> title="{iconDescription}"<br /> class="bx--overflow-menu\_\_icon {iconClass}"<br /> /&gt;</code> | | menu | No | -- | <code>&lt;svelte:component<br /> this={icon}<br /> aria-label={iconDescription}<br /> title={iconDescription}<br /> class="bx--overflow-menu\_\_icon {iconClass}"<br /> /&gt;</code> |
### Events ### Events
@ -2662,9 +2662,9 @@ None.
### Slots ### Slots
| Slot name | Default | Props | Fallback | | Slot name | Default | Props | Fallback |
| :-------- | :------ | :---- | :------------------------------------------------------------------------------------------------------------------ | | :-------- | :------ | :---- | :---------------------------------------------------------------------------------------------------------------- |
| -- | Yes | -- | <code>&lt;div class:bx--overflow-menu-options\_\_option-content="{true}"&gt;<br /> {text}<br /> &lt;/div&gt;</code> | | -- | Yes | -- | <code>&lt;div class:bx--overflow-menu-options\_\_option-content={true}&gt;<br /> {text}<br /> &lt;/div&gt;</code> |
### Events ### Events
@ -2922,9 +2922,9 @@ None.
### Slots ### Slots
| Slot name | Default | Props | Fallback | | Slot name | Default | Props | Fallback |
| :-------- | :------ | :------------------------------------------------------- | :------------------------------------------------------------------------ | | :-------- | :------ | :------------------------------------------------------- | :---------------------------------------------------------------------- |
| -- | Yes | <code>{ props: { class: 'bx--progress-label' } } </code> | <code>&lt;p class:bx--progress-label="{true}"&gt;{label}&lt;/p&gt;</code> | | -- | Yes | <code>{ props: { class: "bx--progress-label" } } </code> | <code>&lt;p class:bx--progress-label={true}&gt;{label}&lt;/p&gt;</code> |
### Events ### Events
@ -3377,10 +3377,10 @@ None.
### Slots ### Slots
| Slot name | Default | Props | Fallback | | Slot name | Default | Props | Fallback |
| :-------- | :------ | :---- | :---------------------------------------------------- | | :-------- | :------ | :---- | :-------------------------------------------------- |
| -- | Yes | -- | <code>{text}</code> | | -- | Yes | -- | <code>{text}</code> |
| icon | No | -- | <code>&lt;svelte:component this="{icon}" /&gt;</code> | | icon | No | -- | <code>&lt;svelte:component this={icon} /&gt;</code> |
### Events ### Events
@ -3401,10 +3401,10 @@ None.
### Slots ### Slots
| Slot name | Default | Props | Fallback | | Slot name | Default | Props | Fallback |
| :-------- | :------ | :---- | :---------------------------------------------------- | | :-------- | :------ | :---- | :-------------------------------------------------- |
| -- | Yes | -- | -- | | -- | Yes | -- | -- |
| icon | No | -- | <code>&lt;svelte:component this="{icon}" /&gt;</code> | | icon | No | -- | <code>&lt;svelte:component this={icon} /&gt;</code> |
### Events ### Events
@ -4016,10 +4016,10 @@ None.
### Slots ### Slots
| Slot name | Default | Props | Fallback | | Slot name | Default | Props | Fallback |
| :-------- | :------ | :----------------------------------------------------- | :---------------------------------------------------- | | :-------- | :------ | :----------------------------------------------------- | :-------------------------------------------------- |
| -- | Yes | <code>{ props: { class: 'bx--tag\_\_label' } } </code> | -- | | -- | Yes | <code>{ props: { class: "bx--tag\_\_label" } } </code> | -- |
| icon | No | -- | <code>&lt;svelte:component this="{icon}" /&gt;</code> | | icon | No | -- | <code>&lt;svelte:component this={icon} /&gt;</code> |
### Events ### Events
@ -4585,11 +4585,11 @@ None.
### Slots ### Slots
| Slot name | Default | Props | Fallback | | Slot name | Default | Props | Fallback |
| :---------- | :------ | :---- | :---------------------------------------------------------------------- | | :---------- | :------ | :---- | :------------------------------------------------------------------ |
| -- | Yes | -- | -- | | -- | Yes | -- | -- |
| icon | No | -- | <code>&lt;svelte:component this="{icon}" name="{iconName}" /&gt;</code> | | icon | No | -- | <code>&lt;svelte:component this={icon} name={iconName} /&gt;</code> |
| triggerText | No | -- | <code>{triggerText}</code> | | triggerText | No | -- | <code>{triggerText}</code> |
### Events ### Events
@ -4666,10 +4666,10 @@ None.
### Slots ### Slots
| Slot name | Default | Props | Fallback | | Slot name | Default | Props | Fallback |
| :---------- | :------ | :---- | :---------------------------------------------------- | | :---------- | :------ | :---- | :-------------------------------------------------- |
| -- | Yes | -- | <code>&lt;svelte:component this="{icon}" /&gt;</code> | | -- | Yes | -- | <code>&lt;svelte:component this={icon} /&gt;</code> |
| tooltipText | No | -- | <code>{tooltipText}</code> | | tooltipText | No | -- | <code>{tooltipText}</code> |
### Events ### Events
@ -4710,7 +4710,7 @@ export interface TreeNode {
| hideLabel | No | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` to visually hide the label text | | hideLabel | No | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` to visually hide the label text |
| expandAll | No | <code>function</code> | No | <code>() => void</code> | <code>() => { expandedIds = [...nodeIds]; }</code> | Programmatically expand all nodes | | expandAll | No | <code>function</code> | No | <code>() => void</code> | <code>() => { expandedIds = [...nodeIds]; }</code> | Programmatically expand all nodes |
| collapseAll | No | <code>function</code> | No | <code>() => void</code> | <code>() => { expandedIds = []; }</code> | Programmatically collapse all nodes | | collapseAll | No | <code>function</code> | No | <code>() => void</code> | <code>() => { expandedIds = []; }</code> | Programmatically collapse all nodes |
| expandNodes | No | <code>function</code> | No | <code>(filterId?: (node: TreeNode) => boolean) => void</code> | <code>() => { expandedIds = nodes .filter( (node) => filterNode(node) &#124;&#124; node.nodes?.some((child) => filterNode(child) && child.nodes) ) .map((node) => node.id); }</code> | Programmatically expand a subset of nodes.<br />Expands all nodes if no argument is provided | | expandNodes | No | <code>function</code> | No | <code>(filterId?: (node: TreeNode) => boolean) => void</code> | <code>() => { expandedIds = nodes .filter( (node) => filterNode(node) &#124;&#124; node.nodes?.some((child) => filterNode(child) && child.nodes), ) .map((node) => node.id); }</code> | Programmatically expand a subset of nodes.<br />Expands all nodes if no argument is provided |
| collapseNodes | No | <code>function</code> | No | <code>(filterId?: (node: TreeNode) => boolean) => void</code> | <code>() => { expandedIds = nodes .filter((node) => expandedIds.includes(node.id) && !filterNode(node)) .map((node) => node.id); }</code> | Programmatically collapse a subset of nodes.<br />Collapses all nodes if no argument is provided | | collapseNodes | No | <code>function</code> | No | <code>(filterId?: (node: TreeNode) => boolean) => void</code> | <code>() => { expandedIds = nodes .filter((node) => expandedIds.includes(node.id) && !filterNode(node)) .map((node) => node.id); }</code> | Programmatically collapse a subset of nodes.<br />Collapses all nodes if no argument is provided |
| showNode | No | <code>function</code> | No | <code>(id: TreeNodeId) => void</code> | <code>() => { 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; } } }</code> | Programmatically show a node by `id`.<br />The matching node will be expanded, selected, and focused | | showNode | No | <code>function</code> | No | <code>(id: TreeNodeId) => void</code> | <code>() => { 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; } } }</code> | Programmatically show a node by `id`.<br />The matching node will be expanded, selected, and focused |

36
docs/src/COMPONENT_API.json
View file

@ -2237,7 +2237,7 @@
{ {
"name": "icon", "name": "icon",
"default": false, "default": false,
"fallback": "<svelte:component this=\"{icon}\" />", "fallback": "<svelte:component this={icon} />",
"slot_props": "{}" "slot_props": "{}"
}, },
{ {
@ -5030,19 +5030,19 @@
{ {
"name": "closeIcon", "name": "closeIcon",
"default": false, "default": false,
"fallback": "<svelte:component this=\"{closeIcon}\" size=\"{20}\" />", "fallback": "<svelte:component this={closeIcon} size={20} />",
"slot_props": "{}" "slot_props": "{}"
}, },
{ {
"name": "icon", "name": "icon",
"default": false, "default": false,
"fallback": "<svelte:component this=\"{icon}\" size=\"{20}\" />", "fallback": "<svelte:component this={icon} size={20} />",
"slot_props": "{}" "slot_props": "{}"
}, },
{ {
"name": "text", "name": "text",
"default": false, "default": false,
"fallback": "{#if text}<span class:bx--header__action-text=\"{true}\">{text}</span>{/if}", "fallback": "{#if text}<span class:bx--header__action-text={true}>{text}</span>{/if}",
"slot_props": "{}" "slot_props": "{}"
} }
], ],
@ -5111,7 +5111,7 @@
{ {
"name": "icon", "name": "icon",
"default": false, "default": false,
"fallback": "<svelte:component this=\"{icon}\" size=\"{20}\" />", "fallback": "<svelte:component this={icon} size={20} />",
"slot_props": "{}" "slot_props": "{}"
} }
], ],
@ -5449,7 +5449,7 @@
{ {
"name": "__default__", "name": "__default__",
"default": true, "default": true,
"fallback": "{result.text}\n {#if result.description}<span\n class:bx--header-search-menu-description=\"{true}\"\n >– {result.description}</span\n >{/if}", "fallback": "{result.text}\n {#if result.description}<span\n class:bx--header-search-menu-description={true}\n >– {result.description}</span\n >{/if}",
"slot_props": "{ result: HeaderSearchResult; index: number }" "slot_props": "{ result: HeaderSearchResult; index: number }"
} }
], ],
@ -5903,7 +5903,7 @@
{ {
"name": "icon", "name": "icon",
"default": false, "default": false,
"fallback": "<svelte:component this=\"{icon}\" />", "fallback": "<svelte:component this={icon} />",
"slot_props": "{}" "slot_props": "{}"
} }
], ],
@ -8216,7 +8216,7 @@
{ {
"name": "menu", "name": "menu",
"default": false, "default": false,
"fallback": "<svelte:component\n this=\"{icon}\"\n aria-label=\"{iconDescription}\"\n title=\"{iconDescription}\"\n class=\"bx--overflow-menu__icon {iconClass}\"\n />", "fallback": "<svelte:component\n this={icon}\n aria-label={iconDescription}\n title={iconDescription}\n class=\"bx--overflow-menu__icon {iconClass}\"\n />",
"slot_props": "{}" "slot_props": "{}"
} }
], ],
@ -8354,7 +8354,7 @@
{ {
"name": "__default__", "name": "__default__",
"default": true, "default": true,
"fallback": "<div class:bx--overflow-menu-options__option-content=\"{true}\">\n {text}\n </div>", "fallback": "<div class:bx--overflow-menu-options__option-content={true}>\n {text}\n </div>",
"slot_props": "{}" "slot_props": "{}"
} }
], ],
@ -9443,8 +9443,8 @@
{ {
"name": "__default__", "name": "__default__",
"default": true, "default": true,
"fallback": "<p class:bx--progress-label=\"{true}\">{label}</p>", "fallback": "<p class:bx--progress-label={true}>{label}</p>",
"slot_props": "{ props: { class: 'bx--progress-label' } }" "slot_props": "{ props: { class: \"bx--progress-label\" } }"
} }
], ],
"events": [ "events": [
@ -10965,7 +10965,7 @@
{ {
"name": "icon", "name": "icon",
"default": false, "default": false,
"fallback": "<svelte:component this=\"{icon}\" />", "fallback": "<svelte:component this={icon} />",
"slot_props": "{}" "slot_props": "{}"
} }
], ],
@ -11031,7 +11031,7 @@
{ {
"name": "icon", "name": "icon",
"default": false, "default": false,
"fallback": "<svelte:component this=\"{icon}\" />", "fallback": "<svelte:component this={icon} />",
"slot_props": "{}" "slot_props": "{}"
} }
], ],
@ -12547,12 +12547,12 @@
{ {
"name": "__default__", "name": "__default__",
"default": true, "default": true,
"slot_props": "{ props: { class: 'bx--tag__label' } }" "slot_props": "{ props: { class: \"bx--tag__label\" } }"
}, },
{ {
"name": "icon", "name": "icon",
"default": false, "default": false,
"fallback": "<svelte:component this=\"{icon}\" />", "fallback": "<svelte:component this={icon} />",
"slot_props": "{}" "slot_props": "{}"
} }
], ],
@ -14440,7 +14440,7 @@
{ {
"name": "icon", "name": "icon",
"default": false, "default": false,
"fallback": "<svelte:component this=\"{icon}\" name=\"{iconName}\" />", "fallback": "<svelte:component this={icon} name={iconName} />",
"slot_props": "{}" "slot_props": "{}"
}, },
{ {
@ -14676,7 +14676,7 @@
{ {
"name": "__default__", "name": "__default__",
"default": true, "default": true,
"fallback": "<svelte:component this=\"{icon}\" />", "fallback": "<svelte:component this={icon} />",
"slot_props": "{}" "slot_props": "{}"
}, },
{ {
@ -14814,7 +14814,7 @@
"kind": "function", "kind": "function",
"description": "Programmatically expand a subset of nodes.\nExpands all nodes if no argument is provided", "description": "Programmatically expand a subset of nodes.\nExpands all nodes if no argument is provided",
"type": "(filterId?: (node: TreeNode) => boolean) => void", "type": "(filterId?: (node: TreeNode) => boolean) => void",
"value": "() => { expandedIds = nodes .filter( (node) => filterNode(node) || node.nodes?.some((child) => filterNode(child) && child.nodes) ) .map((node) => node.id); }", "value": "() => { expandedIds = nodes .filter( (node) => filterNode(node) || node.nodes?.some((child) => filterNode(child) && child.nodes), ) .map((node) => node.id); }",
"isFunction": true, "isFunction": true,
"isFunctionDeclaration": true, "isFunctionDeclaration": true,
"isRequired": false, "isRequired": false,

2
types/Breakpoint/breakpointObserver.d.ts vendored
View file

@ -9,7 +9,7 @@ export function breakpointObserver(): {
subscribe: ( subscribe: (
this: void, this: void,
run: Subscriber<any>, run: Subscriber<any>,
invalidate?: (value?: any) => void invalidate?: (value?: any) => void,
) => Unsubscriber; ) => Unsubscriber;
/** /**
* Returns a store readable store that returns whether the current * Returns a store readable store that returns whether the current

1
types/Breakpoint/index.d.ts vendored
View file

@ -2,4 +2,3 @@
export { default as Breakpoint } from "./Breakpoint.svelte"; export { default as Breakpoint } from "./Breakpoint.svelte";
export { breakpointObserver } from "./breakpointObserver"; export { breakpointObserver } from "./breakpointObserver";
export { breakpoints } from "./breakpoints"; export { breakpoints } from "./breakpoints";

16
types/DataTable/DataTableTypes.d.ts vendored
View file

@ -2,17 +2,17 @@ type PathDepth = [never, 0, 1, 2, ...0[]];
type Join<K, P> = K extends string | number type Join<K, P> = K extends string | number
? P extends string | number ? P extends string | number
? `${K}${"" extends P ? "" : "."}${P}` ? `${K}${"" extends P ? "" : "."}${P}`
: never : never
: never; : never;
// For performance, the maximum traversal depth is 10. // For performance, the maximum traversal depth is 10.
export type PropertyPath<T, D extends number = 10> = [D] extends [never] export type PropertyPath<T, D extends number = 10> = [D] extends [never]
? never ? never
: T extends object : T extends object
? { ? {
[K in keyof T]-?: K extends string | number [K in keyof T]-?: K extends string | number
? `${K}` | Join<K, PropertyPath<T[K], PathDepth[D]>> ? `${K}` | Join<K, PropertyPath<T[K], PathDepth[D]>>
: never; : never;
}[keyof T] }[keyof T]
: ""; : "";

2
types/Truncate/truncate.d.ts vendored
View file

@ -4,7 +4,7 @@ interface TruncateOptions {
export function TruncateAction( export function TruncateAction(
node: HTMLElement, node: HTMLElement,
options?: TruncateOptions options?: TruncateOptions,
): { ): {
update: (options?: TruncateOptions) => void; update: (options?: TruncateOptions) => void;
}; };