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 SelectableTileProps extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["label"]> {
/**
* Set to `true` to select the tile
* @default false
*/
selected?: boolean;
/**
* Set to `true` to enable the light variant
* @default false
*/
light?: boolean;
/**
* Specify the title of the selectable tile
* @default "title"
*/
title?: string;
/**
* Specify the value of the selectable tile
* @default "value"
*/
value?: string;
/**
* Specify the tabindex
* @default "0"
*/
tabindex?: string;
/**
* Specify the ARIA label for the selectable tile checkmark icon
* @default "Tile checkmark"
*/
iconDescription?: string;
/**
* Set an id for the input element
* @default "ccs-" + Math.random().toString(36)
*/
id?: string;
/**
* Specify a name attribute for the input
* @default ""
*/
name?: string;
/**
* Obtain a reference to the input HTML element
* @default null
*/
ref?: null | HTMLInputElement;
}
export default class SelectableTile {
$$prop_def: svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["label"]> & {
/**
* Set to `true` to select the tile
* @default false
*/
selected?: boolean;
/**
* Set to `true` to enable the light variant
* @default false
*/
light?: boolean;
/**
* Specify the title of the selectable tile
* @default "title"
*/
title?: string;
/**
* Specify the value of the selectable tile
* @default "value"
*/
value?: string;
/**
* Specify the tabindex
* @default "0"
*/
tabindex?: string;
/**
* Specify the ARIA label for the selectable tile checkmark icon
* @default "Tile checkmark"
*/
iconDescription?: string;
/**
* Set an id for the input element
*/
id?: string;
/**
* Specify a name attribute for the input
* @default ""
*/
name?: string;
/**
* Obtain a reference to the input HTML element
* @default null
*/
ref?: null | HTMLInputElement;
};
$$prop_def: SelectableTileProps;
$$slot_def: {
default: {};
};