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

Improve Jsdoc formatting in typedef

Browse source
This commit is contained in:
Janos Lengyel 2023-07-13 14:33:31 +02:00
commit fc7d712673
1 changed files with 15 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

30
types/UIShell/Header.svelte.d.ts vendored
View file

@ -28,15 +28,15 @@ export interface HeaderProps
href?: string;
/**
* Specify the company name
* Alternatively, use the named slot "company" (e.g., <span slot="company">...</span>)
* Specify the company name.
* Alternatively, use the named slot "company" (e.g., `<span slot="company">...</span>`)
* @default undefined
*/
company?: string;
/**
* Specify the platform name
* Alternatively, use the named slot "platform" (e.g., <span slot="platform">...</span>)
* Specify the platform name.
* Alternatively, use the named slot "platform" (e.g., `<span slot="platform">...</span>`)
* @default ""
*/
platformName?: string;
@ -48,13 +48,13 @@ export interface HeaderProps
persistentHamburgerMenu?: boolean;
/**
* 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:
* small: 320
* medium: 672
* large: 1056
* x-large: 1312
* max: 1584
* 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:
* small: 320
* medium: 672
* large: 1056
* x-large: 1312
* max: 1584
* @default 1056
*/
expansionBreakpoint?: number;
@ -66,15 +66,15 @@ export interface HeaderProps
ref?: null | HTMLAnchorElement;
/**
* Specify the icon to render for the closed state.
* Defaults to `<Menu size={20} />`
* Specify the icon to render for the closed state.
* Defaults to `<Menu size={20} />`
* @default undefined
*/
iconMenu?: typeof import("svelte").SvelteComponent;
/**
* Specify the icon to render for the opened state.
* Defaults to `<Close size={20} />`
* Specify the icon to render for the opened state.
* Defaults to `<Close size={20} />`
* @default undefined
*/
iconClose?: typeof import("svelte").SvelteComponent;