mirror of
https://github.com/carbon-design-system/carbon-components-svelte.git
synced 2025-09-15 10:21:05 +00:00
feat(types): use the SvelteComponentTyped interface in the TypeScript definitions (#515)
This commit is contained in:
parent
4e4234f83d
commit
bcd28de86e
161 changed files with 6379 additions and 6362 deletions
20
types/UIShell/GlobalHeader/Header.d.ts
vendored
20
types/UIShell/GlobalHeader/Header.d.ts
vendored
|
@ -1,6 +1,8 @@
|
|||
/// <reference types="svelte" />
|
||||
import { SvelteComponentTyped } from "svelte";
|
||||
|
||||
export interface HeaderProps extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["a"]> {
|
||||
export interface HeaderProps
|
||||
extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["a"]> {
|
||||
/**
|
||||
* Set to `false` to hide the side nav by default
|
||||
* @default true
|
||||
|
@ -48,14 +50,8 @@ export interface HeaderProps extends svelte.JSX.HTMLAttributes<HTMLElementTagNam
|
|||
ref?: null | HTMLAnchorElement;
|
||||
}
|
||||
|
||||
export default class Header {
|
||||
$$prop_def: HeaderProps;
|
||||
$$slot_def: {
|
||||
default: {};
|
||||
platform: {};
|
||||
["skip-to-content"]: {};
|
||||
};
|
||||
|
||||
$on(eventname: "click", cb: (event: WindowEventMap["click"]) => void): () => void;
|
||||
$on(eventname: string, cb: (event: Event) => void): () => void;
|
||||
}
|
||||
export default class Header extends SvelteComponentTyped<
|
||||
HeaderProps,
|
||||
{ click: WindowEventMap["click"] },
|
||||
{ default: {}; platform: {}; ["skip-to-content"]: {} }
|
||||
> {}
|
||||
|
|
20
types/UIShell/GlobalHeader/HeaderAction.d.ts
vendored
20
types/UIShell/GlobalHeader/HeaderAction.d.ts
vendored
|
@ -1,4 +1,5 @@
|
|||
/// <reference types="svelte" />
|
||||
import { SvelteComponentTyped } from "svelte";
|
||||
|
||||
export interface HeaderActionSlideTransition {
|
||||
delay?: number;
|
||||
|
@ -6,7 +7,8 @@ export interface HeaderActionSlideTransition {
|
|||
easing?: (t: number) => number;
|
||||
}
|
||||
|
||||
export interface HeaderActionProps extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["button"]> {
|
||||
export interface HeaderActionProps
|
||||
extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["button"]> {
|
||||
/**
|
||||
* Set to `true` to open the panel
|
||||
* @default false
|
||||
|
@ -38,14 +40,8 @@ export interface HeaderActionProps extends svelte.JSX.HTMLAttributes<HTMLElement
|
|||
transition?: false | HeaderActionSlideTransition;
|
||||
}
|
||||
|
||||
export default class HeaderAction {
|
||||
$$prop_def: HeaderActionProps;
|
||||
$$slot_def: {
|
||||
default: {};
|
||||
text: {};
|
||||
};
|
||||
|
||||
$on(eventname: "click", cb: (event: WindowEventMap["click"]) => void): () => void;
|
||||
$on(eventname: "close", cb: (event: CustomEvent<any>) => void): () => void;
|
||||
$on(eventname: string, cb: (event: Event) => void): () => void;
|
||||
}
|
||||
export default class HeaderAction extends SvelteComponentTyped<
|
||||
HeaderActionProps,
|
||||
{ click: WindowEventMap["click"]; close: CustomEvent<any> },
|
||||
{ default: {}; text: {} }
|
||||
> {}
|
||||
|
|
15
types/UIShell/GlobalHeader/HeaderActionLink.d.ts
vendored
15
types/UIShell/GlobalHeader/HeaderActionLink.d.ts
vendored
|
@ -1,6 +1,8 @@
|
|||
/// <reference types="svelte" />
|
||||
import { SvelteComponentTyped } from "svelte";
|
||||
|
||||
export interface HeaderActionLinkProps extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["a"]> {
|
||||
export interface HeaderActionLinkProps
|
||||
extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["a"]> {
|
||||
/**
|
||||
* Set to `true` to use the active state
|
||||
* @default false
|
||||
|
@ -24,9 +26,8 @@ export interface HeaderActionLinkProps extends svelte.JSX.HTMLAttributes<HTMLEle
|
|||
ref?: null | HTMLAnchorElement;
|
||||
}
|
||||
|
||||
export default class HeaderActionLink {
|
||||
$$prop_def: HeaderActionLinkProps;
|
||||
$$slot_def: {};
|
||||
|
||||
$on(eventname: string, cb: (event: Event) => void): () => void;
|
||||
}
|
||||
export default class HeaderActionLink extends SvelteComponentTyped<
|
||||
HeaderActionLinkProps,
|
||||
{},
|
||||
{}
|
||||
> {}
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
/// <reference types="svelte" />
|
||||
import { SvelteComponentTyped } from "svelte";
|
||||
|
||||
export interface HeaderActionSearchProps {
|
||||
/**
|
||||
|
@ -8,12 +9,12 @@ export interface HeaderActionSearchProps {
|
|||
searchIsActive?: boolean;
|
||||
}
|
||||
|
||||
export default class HeaderActionSearch {
|
||||
$$prop_def: HeaderActionSearchProps;
|
||||
$$slot_def: {};
|
||||
|
||||
$on(eventname: "inputSearch", cb: (event: CustomEvent<{ action: "search"; textInput: string }>) => void): () => void;
|
||||
$on(eventname: "focusInputSearch", cb: (event: CustomEvent<any>) => void): () => void;
|
||||
$on(eventname: "focusOutInputSearch", cb: (event: CustomEvent<any>) => void): () => void;
|
||||
$on(eventname: string, cb: (event: Event) => void): () => void;
|
||||
}
|
||||
export default class HeaderActionSearch extends SvelteComponentTyped<
|
||||
HeaderActionSearchProps,
|
||||
{
|
||||
inputSearch: CustomEvent<{ action: "search"; textInput: string }>;
|
||||
focusInputSearch: CustomEvent<any>;
|
||||
focusOutInputSearch: CustomEvent<any>;
|
||||
},
|
||||
{}
|
||||
> {}
|
||||
|
|
17
types/UIShell/GlobalHeader/HeaderNav.d.ts
vendored
17
types/UIShell/GlobalHeader/HeaderNav.d.ts
vendored
|
@ -1,17 +1,16 @@
|
|||
/// <reference types="svelte" />
|
||||
import { SvelteComponentTyped } from "svelte";
|
||||
|
||||
export interface HeaderNavProps extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["nav"]> {
|
||||
export interface HeaderNavProps
|
||||
extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["nav"]> {
|
||||
/**
|
||||
* Specify the ARIA label for the nav
|
||||
*/
|
||||
ariaLabel?: string;
|
||||
}
|
||||
|
||||
export default class HeaderNav {
|
||||
$$prop_def: HeaderNavProps;
|
||||
$$slot_def: {
|
||||
default: {};
|
||||
};
|
||||
|
||||
$on(eventname: string, cb: (event: Event) => void): () => void;
|
||||
}
|
||||
export default class HeaderNav extends SvelteComponentTyped<
|
||||
HeaderNavProps,
|
||||
{},
|
||||
{ default: {} }
|
||||
> {}
|
||||
|
|
32
types/UIShell/GlobalHeader/HeaderNavItem.d.ts
vendored
32
types/UIShell/GlobalHeader/HeaderNavItem.d.ts
vendored
|
@ -1,6 +1,8 @@
|
|||
/// <reference types="svelte" />
|
||||
import { SvelteComponentTyped } from "svelte";
|
||||
|
||||
export interface HeaderNavItemProps extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["a"]> {
|
||||
export interface HeaderNavItemProps
|
||||
extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["a"]> {
|
||||
/**
|
||||
* Specify the `href` attribute
|
||||
*/
|
||||
|
@ -18,17 +20,17 @@ export interface HeaderNavItemProps extends svelte.JSX.HTMLAttributes<HTMLElemen
|
|||
ref?: null | HTMLAnchorElement;
|
||||
}
|
||||
|
||||
export default class HeaderNavItem {
|
||||
$$prop_def: HeaderNavItemProps;
|
||||
$$slot_def: {};
|
||||
|
||||
$on(eventname: "click", cb: (event: WindowEventMap["click"]) => void): () => void;
|
||||
$on(eventname: "mouseover", cb: (event: WindowEventMap["mouseover"]) => void): () => void;
|
||||
$on(eventname: "mouseenter", cb: (event: WindowEventMap["mouseenter"]) => void): () => void;
|
||||
$on(eventname: "mouseleave", cb: (event: WindowEventMap["mouseleave"]) => void): () => void;
|
||||
$on(eventname: "keyup", cb: (event: WindowEventMap["keyup"]) => void): () => void;
|
||||
$on(eventname: "keydown", cb: (event: WindowEventMap["keydown"]) => void): () => void;
|
||||
$on(eventname: "focus", cb: (event: WindowEventMap["focus"]) => void): () => void;
|
||||
$on(eventname: "blur", cb: (event: WindowEventMap["blur"]) => void): () => void;
|
||||
$on(eventname: string, cb: (event: Event) => void): () => void;
|
||||
}
|
||||
export default class HeaderNavItem extends SvelteComponentTyped<
|
||||
HeaderNavItemProps,
|
||||
{
|
||||
click: WindowEventMap["click"];
|
||||
mouseover: WindowEventMap["mouseover"];
|
||||
mouseenter: WindowEventMap["mouseenter"];
|
||||
mouseleave: WindowEventMap["mouseleave"];
|
||||
keyup: WindowEventMap["keyup"];
|
||||
keydown: WindowEventMap["keydown"];
|
||||
focus: WindowEventMap["focus"];
|
||||
blur: WindowEventMap["blur"];
|
||||
},
|
||||
{}
|
||||
> {}
|
||||
|
|
34
types/UIShell/GlobalHeader/HeaderNavMenu.d.ts
vendored
34
types/UIShell/GlobalHeader/HeaderNavMenu.d.ts
vendored
|
@ -1,6 +1,8 @@
|
|||
/// <reference types="svelte" />
|
||||
import { SvelteComponentTyped } from "svelte";
|
||||
|
||||
export interface HeaderNavMenuProps extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["a"]> {
|
||||
export interface HeaderNavMenuProps
|
||||
extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["a"]> {
|
||||
/**
|
||||
* Set to `true` to toggle the expanded state
|
||||
* @default false
|
||||
|
@ -31,19 +33,17 @@ export interface HeaderNavMenuProps extends svelte.JSX.HTMLAttributes<HTMLElemen
|
|||
iconDescription?: string;
|
||||
}
|
||||
|
||||
export default class HeaderNavMenu {
|
||||
$$prop_def: HeaderNavMenuProps;
|
||||
$$slot_def: {
|
||||
default: {};
|
||||
};
|
||||
|
||||
$on(eventname: "keydown", cb: (event: WindowEventMap["keydown"]) => void): () => void;
|
||||
$on(eventname: "click", cb: (event: WindowEventMap["click"]) => void): () => void;
|
||||
$on(eventname: "mouseover", cb: (event: WindowEventMap["mouseover"]) => void): () => void;
|
||||
$on(eventname: "mouseenter", cb: (event: WindowEventMap["mouseenter"]) => void): () => void;
|
||||
$on(eventname: "mouseleave", cb: (event: WindowEventMap["mouseleave"]) => void): () => void;
|
||||
$on(eventname: "keyup", cb: (event: WindowEventMap["keyup"]) => void): () => void;
|
||||
$on(eventname: "focus", cb: (event: WindowEventMap["focus"]) => void): () => void;
|
||||
$on(eventname: "blur", cb: (event: WindowEventMap["blur"]) => void): () => void;
|
||||
$on(eventname: string, cb: (event: Event) => void): () => void;
|
||||
}
|
||||
export default class HeaderNavMenu extends SvelteComponentTyped<
|
||||
HeaderNavMenuProps,
|
||||
{
|
||||
keydown: WindowEventMap["keydown"];
|
||||
click: WindowEventMap["click"];
|
||||
mouseover: WindowEventMap["mouseover"];
|
||||
mouseenter: WindowEventMap["mouseenter"];
|
||||
mouseleave: WindowEventMap["mouseleave"];
|
||||
keyup: WindowEventMap["keyup"];
|
||||
focus: WindowEventMap["focus"];
|
||||
blur: WindowEventMap["blur"];
|
||||
},
|
||||
{ default: {} }
|
||||
> {}
|
||||
|
|
|
@ -1,12 +1,10 @@
|
|||
/// <reference types="svelte" />
|
||||
import { SvelteComponentTyped } from "svelte";
|
||||
|
||||
export interface HeaderPanelDividerProps {}
|
||||
|
||||
export default class HeaderPanelDivider {
|
||||
$$prop_def: HeaderPanelDividerProps;
|
||||
$$slot_def: {
|
||||
default: {};
|
||||
};
|
||||
|
||||
$on(eventname: string, cb: (event: Event) => void): () => void;
|
||||
}
|
||||
export default class HeaderPanelDivider extends SvelteComponentTyped<
|
||||
HeaderPanelDividerProps,
|
||||
{},
|
||||
{ default: {} }
|
||||
> {}
|
||||
|
|
18
types/UIShell/GlobalHeader/HeaderPanelLink.d.ts
vendored
18
types/UIShell/GlobalHeader/HeaderPanelLink.d.ts
vendored
|
@ -1,6 +1,8 @@
|
|||
/// <reference types="svelte" />
|
||||
import { SvelteComponentTyped } from "svelte";
|
||||
|
||||
export interface HeaderPanelLinkProps extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["a"]> {
|
||||
export interface HeaderPanelLinkProps
|
||||
extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["a"]> {
|
||||
/**
|
||||
* Specify the `href` attribute
|
||||
*/
|
||||
|
@ -13,12 +15,8 @@ export interface HeaderPanelLinkProps extends svelte.JSX.HTMLAttributes<HTMLElem
|
|||
ref?: null | HTMLAnchorElement;
|
||||
}
|
||||
|
||||
export default class HeaderPanelLink {
|
||||
$$prop_def: HeaderPanelLinkProps;
|
||||
$$slot_def: {
|
||||
default: {};
|
||||
};
|
||||
|
||||
$on(eventname: "click", cb: (event: WindowEventMap["click"]) => void): () => void;
|
||||
$on(eventname: string, cb: (event: Event) => void): () => void;
|
||||
}
|
||||
export default class HeaderPanelLink extends SvelteComponentTyped<
|
||||
HeaderPanelLinkProps,
|
||||
{ click: WindowEventMap["click"] },
|
||||
{ default: {} }
|
||||
> {}
|
||||
|
|
14
types/UIShell/GlobalHeader/HeaderPanelLinks.d.ts
vendored
14
types/UIShell/GlobalHeader/HeaderPanelLinks.d.ts
vendored
|
@ -1,12 +1,10 @@
|
|||
/// <reference types="svelte" />
|
||||
import { SvelteComponentTyped } from "svelte";
|
||||
|
||||
export interface HeaderPanelLinksProps {}
|
||||
|
||||
export default class HeaderPanelLinks {
|
||||
$$prop_def: HeaderPanelLinksProps;
|
||||
$$slot_def: {
|
||||
default: {};
|
||||
};
|
||||
|
||||
$on(eventname: string, cb: (event: Event) => void): () => void;
|
||||
}
|
||||
export default class HeaderPanelLinks extends SvelteComponentTyped<
|
||||
HeaderPanelLinksProps,
|
||||
{},
|
||||
{ default: {} }
|
||||
> {}
|
||||
|
|
14
types/UIShell/GlobalHeader/HeaderUtilities.d.ts
vendored
14
types/UIShell/GlobalHeader/HeaderUtilities.d.ts
vendored
|
@ -1,12 +1,10 @@
|
|||
/// <reference types="svelte" />
|
||||
import { SvelteComponentTyped } from "svelte";
|
||||
|
||||
export interface HeaderUtilitiesProps {}
|
||||
|
||||
export default class HeaderUtilities {
|
||||
$$prop_def: HeaderUtilitiesProps;
|
||||
$$slot_def: {
|
||||
default: {};
|
||||
};
|
||||
|
||||
$on(eventname: string, cb: (event: Event) => void): () => void;
|
||||
}
|
||||
export default class HeaderUtilities extends SvelteComponentTyped<
|
||||
HeaderUtilitiesProps,
|
||||
{},
|
||||
{ default: {} }
|
||||
> {}
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue