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

fix(types): include @default annotations for props that are undefined by default (#1020)

Browse source 
* chore(deps-dev): upgrade sveld to v0.12.1

* Run "yarn build:lib"

* Re-run "yarn build:lib"
This commit is contained in:
Eric Liu 2022-01-20 19:29:06 -08:00 • committed by GitHub
commit 0d78c30b9d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
64 changed files with 373 additions and 260 deletions
Download patch file Download diff file Expand all files Collapse all files

5
types/UIShell/GlobalHeader/Header.svelte.d.ts vendored
View file

@ -17,16 +17,19 @@ export interface HeaderProps
/**
* Specify the ARIA label for the header
* @default undefined
*/
uiShellAriaLabel?: string;
/**
* Specify the `href` attribute
* @default undefined
*/
href?: string;
/**
* Specify the company name
* @default undefined
*/
company?: string;
@ -64,12 +67,14 @@ export interface HeaderProps
/**
* Specify the icon to render for the closed state
* Defaults to `Menu20`
* @default undefined
*/
iconMenu?: typeof import("svelte").SvelteComponent;
/**
* Specify the icon to render for the opened state
* Defaults to `Close20`
* @default undefined
*/
iconClose?: typeof import("svelte").SvelteComponent;
}

3
types/UIShell/GlobalHeader/HeaderAction.svelte.d.ts vendored
View file

@ -17,17 +17,20 @@ export interface HeaderActionProps
/**
* Specify the icon to render
* @default undefined
*/
icon?: typeof import("svelte").SvelteComponent;
/**
* Specify the icon to render when the action panel is open
* @default undefined
*/
closeIcon?: typeof import("svelte").SvelteComponent;
/**
* Specify the text
* Alternatively, use the named slot "text" (e.g., <div slot="text">...</div>)
* @default undefined
*/
text?: string;

2
types/UIShell/GlobalHeader/HeaderActionLink.svelte.d.ts vendored
View file

@ -11,11 +11,13 @@ export interface HeaderActionLinkProps
/**
* Specify the `href` attribute
* @default undefined
*/
href?: string;
/**
* Specify the icon to render
* @default undefined
*/
icon?: typeof import("svelte").SvelteComponent;

1
types/UIShell/GlobalHeader/HeaderNav.svelte.d.ts vendored
View file

@ -5,6 +5,7 @@ export interface HeaderNavProps
extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["nav"]> {
/**
* Specify the ARIA label for the nav
* @default undefined
*/
ariaLabel?: string;
}

2
types/UIShell/GlobalHeader/HeaderNavItem.svelte.d.ts vendored
View file

@ -5,11 +5,13 @@ export interface HeaderNavItemProps
extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["a"]> {
/**
* Specify the `href` attribute
* @default undefined
*/
href?: string;
/**
* Specify the text
* @default undefined
*/
text?: string;

1
types/UIShell/GlobalHeader/HeaderNavMenu.svelte.d.ts vendored
View file

@ -17,6 +17,7 @@ export interface HeaderNavMenuProps
/**
* Specify the text
* @default undefined
*/
text?: string;

1
types/UIShell/GlobalHeader/HeaderPanelLink.svelte.d.ts vendored
View file

@ -5,6 +5,7 @@ export interface HeaderPanelLinkProps
extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["a"]> {
/**
* Specify the `href` attribute
* @default undefined
*/
href?: string;

1
types/UIShell/HeaderGlobalAction.svelte.d.ts vendored
View file

@ -11,6 +11,7 @@ export interface HeaderGlobalActionProps
/**
* Specify the icon to render
* @default undefined
*/
icon?: typeof import("svelte").SvelteComponent;

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

@ -17,6 +17,7 @@ export interface SideNavProps
/**
* Specify the ARIA label for the nav
* @default undefined
*/
ariaLabel?: string;

3
types/UIShell/SideNav/SideNavLink.svelte.d.ts vendored
View file

@ -11,16 +11,19 @@ export interface SideNavLinkProps
/**
* Specify the `href` attribute
* @default undefined
*/
href?: string;
/**
* Specify the text
* @default undefined
*/
text?: string;
/**
* Specify the icon to render
* @default undefined
*/
icon?: typeof import("svelte").SvelteComponent;

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

@ -11,11 +11,13 @@ export interface SideNavMenuProps
/**
* Specify the text
* @default undefined
*/
text?: string;
/**
* Specify the icon to render
* @default undefined
*/
icon?: typeof import("svelte").SvelteComponent;

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

@ -11,11 +11,13 @@ export interface SideNavMenuItemProps
/**
* Specify the `href` attribute
* @default undefined
*/
href?: string;
/**
* Specify the item text
* @default undefined
*/
text?: string;