refactor(types): shorten ref, id JSDocs, use CarbonIcon type, export component props

This commit is contained in:
Eric Liu 2020-11-06 11:30:46 -08:00
commit 75d4b4cf03
219 changed files with 5168 additions and 5259 deletions

78
types/Tabs/Tab.d.ts vendored
View file

@ -1,44 +1,46 @@
/// <reference types="svelte" />
export interface TabProps extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["li"]> {
/**
* Specify the tab label
* Alternatively, use the default slot (e.g. <Tab><span>Label</span></Tab>)
* @default ""
*/
label?: string;
/**
* Specify the href attribute
* @default "#"
*/
href?: string;
/**
* Set to `true` to disable the tab
* @default false
*/
disabled?: boolean;
/**
* Specify the tabindex
* @default "0"
*/
tabindex?: string;
/**
* Set an id for the top-level element
* @default "ccs-" + Math.random().toString(36)
*/
id?: string;
/**
* Obtain a reference to the anchor HTML element
* @default null
*/
ref?: null | HTMLAnchorElement;
}
export default class Tab {
$$prop_def: svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["li"]> & {
/**
* Specify the tab label
* Alternatively, use the default slot (e.g. <Tab><span>Label</span></Tab>)
* @default ""
*/
label?: string;
/**
* Specify the href attribute
* @default "#"
*/
href?: string;
/**
* Set to `true` to disable the tab
* @default false
*/
disabled?: boolean;
/**
* Specify the tabindex
* @default "0"
*/
tabindex?: string;
/**
* Set an id for the top-level element
*/
id?: string;
/**
* Obtain a reference to the anchor HTML element
* @default null
*/
ref?: null | HTMLAnchorElement;
};
$$prop_def: TabProps;
$$slot_def: {
default: {};
};

View file

@ -1,13 +1,15 @@
/// <reference types="svelte" />
export default class TabContent {
$$prop_def: svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["div"]> & {
/**
* Set an id for the top-level element
*/
id?: string;
};
export interface TabContentProps extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["div"]> {
/**
* Set an id for the top-level element
* @default "ccs-" + Math.random().toString(36)
*/
id?: string;
}
export default class TabContent {
$$prop_def: TabContentProps;
$$slot_def: {
default: {};
};

53
types/Tabs/Tabs.d.ts vendored
View file

@ -1,32 +1,33 @@
/// <reference types="svelte" />
export interface TabsProps extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["div"]> {
/**
* Specify the selected tab index
* @default 0
*/
selected?: number;
/**
* Specify the type of tabs
* @default "default"
*/
type?: "default" | "container";
/**
* Specify the ARIA label for the chevron icon
* @default "Show menu options"
*/
iconDescription?: string;
/**
* Specify the tab trigger href attribute
* @default "#"
*/
triggerHref?: string;
}
export default class Tabs {
$$prop_def: svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["div"]> & {
/**
* Specify the selected tab index
* @default 0
*/
selected?: number;
/**
* Specify the type of tabs
* @default "default"
*/
type?: "default" | "container";
/**
* Specify the ARIA label for the chevron icon
* @default "Show menu options"
*/
iconDescription?: string;
/**
* Specify the tab trigger href attribute
* @default "#"
*/
triggerHref?: string;
};
$$prop_def: TabsProps;
$$slot_def: {
default: {};
content: {};

View file

@ -1,14 +1,15 @@
/// <reference types="svelte" />
export default class TabsSkeleton {
$$prop_def: svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["div"]> & {
/**
* Specify the number of tabs to render
* @default 4
*/
count?: number;
};
export interface TabsSkeletonProps extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["div"]> {
/**
* Specify the number of tabs to render
* @default 4
*/
count?: number;
}
export default class TabsSkeleton {
$$prop_def: TabsSkeletonProps;
$$slot_def: {};
$on(eventname: "click", cb: (event: WindowEventMap["click"]) => void): () => void;