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

View file

@ -1,61 +1,63 @@
/// <reference types="svelte" />
export interface ExpandableTileProps extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["div"]> {
/**
* Set to `true` to expand the tile
* @default false
*/
expanded?: boolean;
/**
* Set to `true` to enable the light variant
* @default false
*/
light?: boolean;
/**
* Specify the max height of the tile (number of pixels)
* @default 0
*/
tileMaxHeight?: number;
/**
* Specify the padding of the tile (number of pixels)
* @default 0
*/
tilePadding?: number;
/**
* Specify the icon text of the collapsed tile
* @default "Interact to expand Tile"
*/
tileCollapsedIconText?: string;
/**
* Specify the icon text of the expanded tile
* @default "Interact to collapse Tile"
*/
tileExpandedIconText?: string;
/**
* Specify the tabindex
* @default "0"
*/
tabindex?: string;
/**
* Set an id for the top-level div element
* @default "ccs-" + Math.random().toString(36)
*/
id?: string;
/**
* Obtain a reference to the top-level element
* @default null
*/
ref?: null | HTMLDivElement;
}
export default class ExpandableTile {
$$prop_def: svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["div"]> & {
/**
* Set to `true` to expand the tile
* @default false
*/
expanded?: boolean;
/**
* Set to `true` to enable the light variant
* @default false
*/
light?: boolean;
/**
* Specify the max height of the tile (number of pixels)
* @default 0
*/
tileMaxHeight?: number;
/**
* Specify the padding of the tile (number of pixels)
* @default 0
*/
tilePadding?: number;
/**
* Specify the icon text of the collapsed tile
* @default "Interact to expand Tile"
*/
tileCollapsedIconText?: string;
/**
* Specify the icon text of the expanded tile
* @default "Interact to collapse Tile"
*/
tileExpandedIconText?: string;
/**
* Specify the tabindex
* @default "0"
*/
tabindex?: string;
/**
* Set an id for the top-level div element
*/
id?: string;
/**
* Obtain a reference to the top-level element
* @default null
*/
ref?: null | HTMLDivElement;
};
$$prop_def: ExpandableTileProps;
$$slot_def: {
above: {};
below: {};