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: regenerate component docs [ci skip]

Browse source
This commit is contained in:
Eric Liu 2020-11-19 06:21:24 -08:00
commit 998757691b
5 changed files with 33 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

19
COMPONENT_INDEX.md
View file

@ -1347,15 +1347,16 @@ None.
### Props
| Prop name | Kind | Reactive | Type | Default value | Description |
| :---------------- | :--------------- | :------- | :----------------------------------------- | ------------------ | ------------------------------------------------------------------------------------------------------------------------------- |
| ref | <code>let</code> | Yes | <code>null &#124; HTMLAnchorElement</code> | <code>null</code> | Obtain a reference to the HTML anchor element |
| isSideNavOpen | <code>let</code> | Yes | <code>boolean</code> | <code>false</code> | Set to `true` to open the side nav |
| expandedByDefault | <code>let</code> | No | <code>boolean</code> | <code>true</code> | Set to `false` to hide the side nav by default |
| uiShellAriaLabel | <code>let</code> | No | <code>string</code> | -- | Specify the ARIA label for the header |
| href | <code>let</code> | No | <code>string</code> | -- | Specify the `href` attribute |
| company | <code>let</code> | No | <code>string</code> | -- | Specify the company name |
| platformName | <code>let</code> | No | <code>string</code> | <code>""</code> | Specify the platform name<br />Alternatively, use the named slot "platform" (e.g. &lt;span slot="platform"&gt;...&lt;/span&gt;) |
| Prop name | Kind | Reactive | Type | Default value | Description |
| :---------------------- | :--------------- | :------- | :----------------------------------------- | ------------------ | ------------------------------------------------------------------------------------------------------------------------------- |
| ref | <code>let</code> | Yes | <code>null &#124; HTMLAnchorElement</code> | <code>null</code> | Obtain a reference to the HTML anchor element |
| isSideNavOpen | <code>let</code> | Yes | <code>boolean</code> | <code>false</code> | Set to `true` to open the side nav |
| expandedByDefault | <code>let</code> | No | <code>boolean</code> | <code>true</code> | Set to `false` to hide the side nav by default |
| uiShellAriaLabel | <code>let</code> | No | <code>string</code> | -- | Specify the ARIA label for the header |
| href | <code>let</code> | No | <code>string</code> | -- | Specify the `href` attribute |
| company | <code>let</code> | No | <code>string</code> | -- | Specify the company name |
| platformName | <code>let</code> | No | <code>string</code> | <code>""</code> | Specify the platform name<br />Alternatively, use the named slot "platform" (e.g. &lt;span slot="platform"&gt;...&lt;/span&gt;) |
| persistentHamburgerMenu | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` to persist the hamburger menu |
### Slots

10
docs/src/COMPONENT_API.json
View file

@ -9507,6 +9507,16 @@
"constant": false,
"reactive": false
},
{
"name": "persistentHamburgerMenu",
"kind": "let",
"description": "Set to `true` to persist the hamburger menu",
"type": "boolean",
"value": "false",
"isFunction": false,
"constant": false,
"reactive": false
},
{
"name": "ref",
"kind": "let",

10
docs/src/components/ComponentApi.svelte
View file

@ -63,9 +63,9 @@
</style>
<p style="margin-bottom: var(--cds-layout-02)">
View component
<Link href="{source}" target="_blank">
source code
Component source code:
<Link size="lg" href="{source}" target="_blank">
{component.filePath}
<Launch16 />
</Link>
</p>
@ -138,7 +138,9 @@
<StructuredListCell>
{#if prop.description}
{#each prop.description.split('\n') as line}
<div class="description">{@html line.replace(/`(.*?)`/g, '<code>$1</code>')}.</div>
<div class="description">
{@html line.replace(/`(.*?)`/g, '<code>$1</code>')}.
</div>
{/each}
{:else}
<div class="description">No description available.</div>

2
docs/svelte.config.js
View file

@ -243,7 +243,7 @@ module.exports = {
<a class="bx--link" href="#dispatched-events">Dispatched events</a>
</li>
<li class="bx--list__item">
<a class="bx--link" href="#rest-props">$$restProps</a>
<a class="bx--link" href="#rest-props">restProps</a>
</li>
</ul>
</li>

6
types/UIShell/GlobalHeader/Header.d.ts vendored
View file

@ -35,6 +35,12 @@ export interface HeaderProps extends svelte.JSX.HTMLAttributes<HTMLElementTagNam
*/
platformName?: string;
/**
* Set to `true` to persist the hamburger menu
* @default false
*/
persistentHamburgerMenu?: boolean;
/**
* Obtain a reference to the HTML anchor element
* @default null