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

Fixing missing changes in docs and the layout

Browse source
This commit is contained in:
Davi Seidel Brandão 2024-01-02 18:02:31 -03:00
commit 48b63b9246
5 changed files with 9 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

4
COMPONENT_INDEX.md
View file

@ -1609,7 +1609,7 @@ None.
| Prop name | Required | Kind | Reactive | Type | Default value | Description | | Prop name | Required | Kind | Reactive | Type | Default value | Description |
| :------------------------- | :------- | :--------------- | :------- | ----------------------------------------------------------------- | ------------------------------ | ---------------------------------------------------------------------------------------------------------------- | | :------------------------- | :------- | :--------------- | :------- | ----------------------------------------------------------------- | ------------------------------ | ---------------------------------------------------------------------------------------------------------------- |
| ref | No | <code>let</code> | Yes | <code>null &#124; HTMLButtonElement</code> | <code>null</code> | Obtain a reference to the button HTML element | | ref | No | <code>let</code> | Yes | <code>null &#124; HTMLButtonElement</code> | <code>null</code> | Obtain a reference to the button HTML element |
| isOpen | No | <code>let</code> | Yes | <code>boolean</code> | <code>false</code> | Set to `true` to open the panel | | open | No | <code>let</code> | Yes | <code>boolean</code> | <code>false</code> | Set to `true` to open the panel |
| icon | No | <code>let</code> | No | <code>typeof import("svelte").SvelteComponent<any></code> | <code>undefined</code> | Specify the icon to render when the action panel is closed.<br />Defaults to `&lt;Switcher size={20} /&gt;` | | icon | No | <code>let</code> | No | <code>typeof import("svelte").SvelteComponent<any></code> | <code>undefined</code> | Specify the icon to render when the action panel is closed.<br />Defaults to `&lt;Switcher size={20} /&gt;` |
| closeIcon | No | <code>let</code> | No | <code>typeof import("svelte").SvelteComponent<any></code> | <code>undefined</code> | Specify the icon to render when the action panel is open.<br />Defaults to `&lt;Close size={20} /&gt;` | | closeIcon | No | <code>let</code> | No | <code>typeof import("svelte").SvelteComponent<any></code> | <code>undefined</code> | Specify the icon to render when the action panel is open.<br />Defaults to `&lt;Close size={20} /&gt;` |
| text | No | <code>let</code> | No | <code>string</code> | <code>undefined</code> | Specify the text.<br />Alternatively, use the named slot "text" (e.g., `&lt;div slot="text"&gt;...&lt;/div&gt;`) | | text | No | <code>let</code> | No | <code>string</code> | <code>undefined</code> | Specify the text.<br />Alternatively, use the named slot "text" (e.g., `&lt;div slot="text"&gt;...&lt;/div&gt;`) |
@ -3306,7 +3306,7 @@ None.
| Prop name | Required | Kind | Reactive | Type | Default value | Description | | Prop name | Required | Kind | Reactive | Type | Default value | Description |
| :------------------ | :------- | :--------------- | :------- | -------------------- | ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | :------------------ | :------- | :--------------- | :------- | -------------------- | ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| isOpen | No | <code>let</code> | Yes | <code>boolean</code> | <code>false</code> | Set to `true` to toggle the expanded state | | open | No | <code>let</code> | Yes | <code>boolean</code> | <code>false</code> | Set to `true` to toggle the expanded state |
| fixed | No | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` to use the fixed variant | | fixed | No | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` to use the fixed variant |
| rail | No | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` to use the rail variant | | rail | No | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` to use the rail variant |
| ariaLabel | No | <code>let</code> | No | <code>string</code> | <code>undefined</code> | Specify the ARIA label for the nav | | ariaLabel | No | <code>let</code> | No | <code>string</code> | <code>undefined</code> | Specify the ARIA label for the nav |

4
docs/src/COMPONENT_API.json
View file

@ -4893,7 +4893,7 @@
"filePath": "src/UIShell/HeaderAction.svelte", "filePath": "src/UIShell/HeaderAction.svelte",
"props": [ "props": [
{ {
"name": "isOpen", "name": "open",
"kind": "let", "kind": "let",
"description": "Set to `true` to open the panel", "description": "Set to `true` to open the panel",
"type": "boolean", "type": "boolean",
@ -10723,7 +10723,7 @@
"reactive": false "reactive": false
}, },
{ {
"name": "isOpen", "name": "open",
"kind": "let", "kind": "let",
"description": "Set to `true` to toggle the expanded state", "description": "Set to `true` to toggle the expanded state",
"type": "boolean", "type": "boolean",

6
docs/src/pages/_layout.svelte
View file

@ -46,7 +46,7 @@
let active = false; let active = false;
$: results = miniSearch.search(value).slice(0, 10); $: results = miniSearch.search(value).slice(0, 10);
let isOpen = false; let open = false;
let isSideNavOpen = true; let isSideNavOpen = true;
let innerWidth = 2048; let innerWidth = 2048;
@ -118,7 +118,7 @@
href="https://github.com/carbon-design-system/carbon-components-svelte" href="https://github.com/carbon-design-system/carbon-components-svelte"
target="_blank" target="_blank"
/> />
<HeaderAction transition="{false}" bind:isOpen> <HeaderAction transition="{false}" bind:open>
<HeaderPanelLinks> <HeaderPanelLinks>
<HeaderPanelDivider>Carbon Svelte portfolio</HeaderPanelDivider> <HeaderPanelDivider>Carbon Svelte portfolio</HeaderPanelDivider>
<HeaderPanelLink <HeaderPanelLink
@ -153,7 +153,7 @@
</HeaderUtilities> </HeaderUtilities>
</Header> </Header>
<SideNav bind:isOpen="{isSideNavOpen}"> <SideNav bind:open="{isSideNavOpen}">
<SideNavItems> <SideNavItems>
{#each components.children.filter((child) => !deprecated.includes(child.title)) as child (child.path)} {#each components.children.filter((child) => !deprecated.includes(child.title)) as child (child.path)}
<SideNavMenuItem <SideNavMenuItem

2
types/UIShell/HeaderAction.svelte.d.ts vendored
View file

@ -8,7 +8,7 @@ export interface HeaderActionProps extends RestProps {
* Set to `true` to open the panel * Set to `true` to open the panel
* @default false * @default false
*/ */
isOpen?: boolean; open?: boolean;
/** /**
* Specify the icon to render when the action panel is closed. * Specify the icon to render when the action panel is closed.

2
types/UIShell/SideNav.svelte.d.ts vendored
View file

@ -26,7 +26,7 @@ export interface SideNavProps extends RestProps {
* Set to `true` to toggle the expanded state * Set to `true` to toggle the expanded state
* @default false * @default false
*/ */
isOpen?: boolean; open?: boolean;
/** /**
* The window width (px) at which the SideNav is expanded and the hamburger menu is hidden. * The window width (px) at which the SideNav is expanded and the hamburger menu is hidden.