mirror of
https://github.com/carbon-design-system/carbon-components-svelte.git
synced 2025-09-14 18:01:06 +00:00
chore(types): fix formatting of prop comments in Header, SideNav
This commit is contained in:
Eric Liu
parent
2715ed9c38
commit
7885e124b4
6 changed files with 51 additions and 51 deletions
|
|
@ -1568,19 +1568,19 @@ None.
|
||||||
|
|
||||||
### Props
|
### Props
|
||||||
|
|
||||||
| 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 | HTMLAnchorElement</code> | <code>null</code> | Obtain a reference to the HTML anchor element |
|
| ref | No | <code>let</code> | Yes | <code>null | HTMLAnchorElement</code> | <code>null</code> | Obtain a reference to the HTML anchor element |
|
||||||
| isSideNavOpen | No | <code>let</code> | Yes | <code>boolean</code> | <code>false</code> | Set to `true` to open the side nav |
|
| isSideNavOpen | No | <code>let</code> | Yes | <code>boolean</code> | <code>false</code> | Set to `true` to open the side nav |
|
||||||
| expandedByDefault | No | <code>let</code> | No | <code>boolean</code> | <code>true</code> | Set to `false` to hide the side nav by default |
|
| expandedByDefault | No | <code>let</code> | No | <code>boolean</code> | <code>true</code> | Set to `false` to hide the side nav by default |
|
||||||
| uiShellAriaLabel | No | <code>let</code> | No | <code>string</code> | <code>undefined</code> | Specify the ARIA label for the header |
|
| uiShellAriaLabel | No | <code>let</code> | No | <code>string</code> | <code>undefined</code> | Specify the ARIA label for the header |
|
||||||
| href | No | <code>let</code> | No | <code>string</code> | <code>undefined</code> | Specify the `href` attribute |
|
| href | No | <code>let</code> | No | <code>string</code> | <code>undefined</code> | Specify the `href` attribute |
|
||||||
| company | No | <code>let</code> | No | <code>string</code> | <code>undefined</code> | Specify the company name. <br />Alternatively, use the named slot "company" (e.g., `<span slot="company">...</span>`) |
|
| company | No | <code>let</code> | No | <code>string</code> | <code>undefined</code> | Specify the company name. <br />Alternatively, use the named slot "company" (e.g., `<span slot="company">...</span>`) |
|
||||||
| platformName | No | <code>let</code> | No | <code>string</code> | <code>""</code> | Specify the platform name<br />Alternatively, use the named slot "platform" (e.g., <span slot="platform">...</span>) |
|
| platformName | No | <code>let</code> | No | <code>string</code> | <code>""</code> | Specify the platform name.<br />Alternatively, use the named slot "platform" (e.g., `<span slot="platform">...</span>`) |
|
||||||
| persistentHamburgerMenu | No | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` to persist the hamburger menu |
|
| persistentHamburgerMenu | No | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` to persist the hamburger menu |
|
||||||
| expansionBreakpoint | No | <code>let</code> | No | <code>number</code> | <code>1056</code> | The window width (px) at which the SideNav is expanded and the hamburger menu is hidden<br />1056 represents the "large" breakpoint in pixels from the Carbon Design System:<br />small: 320<br />medium: 672<br />large: 1056<br />x-large: 1312<br />max: 1584 |
|
| expansionBreakpoint | No | <code>let</code> | No | <code>number</code> | <code>1056</code> | The window width (px) at which the SideNav is expanded and the hamburger menu is hidden.<br />1056 represents the "large" breakpoint in pixels from the Carbon Design System:<br />- small: 320<br />- medium: 672<br />- large: 1056<br />- x-large: 1312<br />- max: 1584 |
|
||||||
| iconMenu | No | <code>let</code> | No | <code>typeof import("svelte").SvelteComponent</code> | <code>undefined</code> | Specify the icon to render for the closed state.<br />Defaults to `<Menu size={20} />` |
|
| iconMenu | No | <code>let</code> | No | <code>typeof import("svelte").SvelteComponent</code> | <code>undefined</code> | Specify the icon to render for the closed state.<br />Defaults to `<Menu size={20} />` |
|
||||||
| iconClose | No | <code>let</code> | No | <code>typeof import("svelte").SvelteComponent</code> | <code>undefined</code> | Specify the icon to render for the opened state.<br />Defaults to `<Close size={20} />` |
|
| iconClose | No | <code>let</code> | No | <code>typeof import("svelte").SvelteComponent</code> | <code>undefined</code> | Specify the icon to render for the opened state.<br />Defaults to `<Close size={20} />` |
|
||||||
|
|
||||||
### Slots
|
### Slots
|
||||||
|
|
||||||
|
|
@ -3293,13 +3293,13 @@ None.
|
||||||
|
|
||||||
### Props
|
### Props
|
||||||
|
|
||||||
| 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 |
|
| isOpen | 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 |
|
||||||
| expansionBreakpoint | No | <code>let</code> | No | <code>number</code> | <code>1056</code> | The window width (px) at which the SideNav is expanded and the hamburger menu is hidden<br />1056 represents the "large" breakpoint in pixels from the Carbon Design System:<br />small: 320<br />medium: 672<br />large: 1056<br />x-large: 1312<br />max: 1584 |
|
| expansionBreakpoint | No | <code>let</code> | No | <code>number</code> | <code>1056</code> | The window width (px) at which the SideNav is expanded and the hamburger menu is hidden.<br />1056 represents the "large" breakpoint in pixels from the Carbon Design System:<br />- small: 320<br />- medium: 672<br />- large: 1056<br />- x-large: 1312<br />- max: 1584 |
|
||||||
|
|
||||||
### Slots
|
### Slots
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -4762,7 +4762,7 @@
|
||||||
{
|
{
|
||||||
"name": "platformName",
|
"name": "platformName",
|
||||||
"kind": "let",
|
"kind": "let",
|
||||||
"description": "Specify the platform name\nAlternatively, use the named slot \"platform\" (e.g., <span slot=\"platform\">...</span>)",
|
"description": "Specify the platform name.\nAlternatively, use the named slot \"platform\" (e.g., `<span slot=\"platform\">...</span>`)",
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"value": "\"\"",
|
"value": "\"\"",
|
||||||
"isFunction": false,
|
"isFunction": false,
|
||||||
|
|
@ -4786,7 +4786,7 @@
|
||||||
{
|
{
|
||||||
"name": "expansionBreakpoint",
|
"name": "expansionBreakpoint",
|
||||||
"kind": "let",
|
"kind": "let",
|
||||||
"description": "The window width (px) at which the SideNav is expanded and the hamburger menu is hidden\n1056 represents the \"large\" breakpoint in pixels from the Carbon Design System:\nsmall: 320\nmedium: 672\nlarge: 1056\nx-large: 1312\nmax: 1584",
|
"description": "The window width (px) at which the SideNav is expanded and the hamburger menu is hidden.\n1056 represents the \"large\" breakpoint in pixels from the Carbon Design System:\n- small: 320\n- medium: 672\n- large: 1056\n- x-large: 1312\n- max: 1584",
|
||||||
"type": "number",
|
"type": "number",
|
||||||
"value": "1056",
|
"value": "1056",
|
||||||
"isFunction": false,
|
"isFunction": false,
|
||||||
|
|
@ -10658,7 +10658,7 @@
|
||||||
{
|
{
|
||||||
"name": "expansionBreakpoint",
|
"name": "expansionBreakpoint",
|
||||||
"kind": "let",
|
"kind": "let",
|
||||||
"description": "The window width (px) at which the SideNav is expanded and the hamburger menu is hidden\n1056 represents the \"large\" breakpoint in pixels from the Carbon Design System:\nsmall: 320\nmedium: 672\nlarge: 1056\nx-large: 1312\nmax: 1584",
|
"description": "The window width (px) at which the SideNav is expanded and the hamburger menu is hidden.\n1056 represents the \"large\" breakpoint in pixels from the Carbon Design System:\n- small: 320\n- medium: 672\n- large: 1056\n- x-large: 1312\n- max: 1584",
|
||||||
"type": "number",
|
"type": "number",
|
||||||
"value": "1056",
|
"value": "1056",
|
||||||
"isFunction": false,
|
"isFunction": false,
|
||||||
|
|
|
||||||
|
|
@ -25,8 +25,8 @@
|
||||||
export let company = undefined;
|
export let company = undefined;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Specify the platform name
|
* Specify the platform name.
|
||||||
* Alternatively, use the named slot "platform" (e.g., <span slot="platform">...</span>)
|
* Alternatively, use the named slot "platform" (e.g., `<span slot="platform">...</span>`)
|
||||||
*/
|
*/
|
||||||
export let platformName = "";
|
export let platformName = "";
|
||||||
|
|
||||||
|
|
@ -34,13 +34,13 @@
|
||||||
export let persistentHamburgerMenu = false;
|
export let persistentHamburgerMenu = false;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* 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.
|
||||||
* 1056 represents the "large" breakpoint in pixels from the Carbon Design System:
|
* 1056 represents the "large" breakpoint in pixels from the Carbon Design System:
|
||||||
* small: 320
|
* - small: 320
|
||||||
* medium: 672
|
* - medium: 672
|
||||||
* large: 1056
|
* - large: 1056
|
||||||
* x-large: 1312
|
* - x-large: 1312
|
||||||
* max: 1584
|
* - max: 1584
|
||||||
*/
|
*/
|
||||||
export let expansionBreakpoint = 1056;
|
export let expansionBreakpoint = 1056;
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -21,13 +21,13 @@
|
||||||
export let isOpen = false;
|
export let isOpen = false;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* 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.
|
||||||
* 1056 represents the "large" breakpoint in pixels from the Carbon Design System:
|
* 1056 represents the "large" breakpoint in pixels from the Carbon Design System:
|
||||||
* small: 320
|
* - small: 320
|
||||||
* medium: 672
|
* - medium: 672
|
||||||
* large: 1056
|
* - large: 1056
|
||||||
* x-large: 1312
|
* - x-large: 1312
|
||||||
* max: 1584
|
* - max: 1584
|
||||||
*/
|
*/
|
||||||
export let expansionBreakpoint = 1056;
|
export let expansionBreakpoint = 1056;
|
||||||
|
|
||||||
|
|
|
||||||
16
types/UIShell/Header.svelte.d.ts
vendored
16
types/UIShell/Header.svelte.d.ts
vendored
|
|
@ -35,8 +35,8 @@ export interface HeaderProps
|
||||||
company?: string;
|
company?: string;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Specify the platform name
|
* Specify the platform name.
|
||||||
* Alternatively, use the named slot "platform" (e.g., <span slot="platform">...</span>)
|
* Alternatively, use the named slot "platform" (e.g., `<span slot="platform">...</span>`)
|
||||||
* @default ""
|
* @default ""
|
||||||
*/
|
*/
|
||||||
platformName?: string;
|
platformName?: string;
|
||||||
|
|
@ -48,13 +48,13 @@ export interface HeaderProps
|
||||||
persistentHamburgerMenu?: boolean;
|
persistentHamburgerMenu?: 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.
|
||||||
* 1056 represents the "large" breakpoint in pixels from the Carbon Design System:
|
* 1056 represents the "large" breakpoint in pixels from the Carbon Design System:
|
||||||
* small: 320
|
* - small: 320
|
||||||
* medium: 672
|
* - medium: 672
|
||||||
* large: 1056
|
* - large: 1056
|
||||||
* x-large: 1312
|
* - x-large: 1312
|
||||||
* max: 1584
|
* - max: 1584
|
||||||
* @default 1056
|
* @default 1056
|
||||||
*/
|
*/
|
||||||
expansionBreakpoint?: number;
|
expansionBreakpoint?: number;
|
||||||
|
|
|
||||||
12
types/UIShell/SideNav.svelte.d.ts
vendored
12
types/UIShell/SideNav.svelte.d.ts
vendored
|
|
@ -28,13 +28,13 @@ export interface SideNavProps
|
||||||
isOpen?: boolean;
|
isOpen?: 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.
|
||||||
* 1056 represents the "large" breakpoint in pixels from the Carbon Design System:
|
* 1056 represents the "large" breakpoint in pixels from the Carbon Design System:
|
||||||
* small: 320
|
* - small: 320
|
||||||
* medium: 672
|
* - medium: 672
|
||||||
* large: 1056
|
* - large: 1056
|
||||||
* x-large: 1312
|
* - x-large: 1312
|
||||||
* max: 1584
|
* - max: 1584
|
||||||
* @default 1056
|
* @default 1056
|
||||||
*/
|
*/
|
||||||
expansionBreakpoint?: number;
|
expansionBreakpoint?: number;
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue