refactor: update/fix JSDoc props

This commit is contained in:
Eric Liu 2020-11-04 06:04:25 -08:00
commit d38e6d8be6
204 changed files with 992 additions and 2359 deletions

View file

@ -69,11 +69,11 @@ export default class Checkbox {
$$slot_def: {};
$on(eventname: "check", cb: (event: CustomEvent<boolean>) => 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: "change", cb: (event: WindowEventMap["change"]) => void): () => void;
$on(eventname: "check", cb: (event: CustomEvent<any>) => void): () => void;
$on(eventname: string, cb: (event: Event) => void): () => void;
}

View file

@ -119,11 +119,14 @@ export default class ComboBox {
$$slot_def: {};
$on(
eventname: "select",
cb: (event: CustomEvent<{ selectedId: string; selectedIndex: number; selectedItem: ComboBoxItem }>) => 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: "clear", cb: (event: WindowEventMap["clear"]) => void): () => void;
$on(eventname: "scroll", cb: (event: WindowEventMap["scroll"]) => void): () => void;
$on(eventname: "select", cb: (event: CustomEvent<any>) => void): () => void;
$on(eventname: string, cb: (event: Event) => void): () => void;
}

View file

@ -41,7 +41,7 @@ export default class ComposedModal {
* Obtain a reference to the top-level HTML element
* @default null
*/
ref?: null | HTMLElement;
ref?: null | HTMLDivElement;
};
$$slot_def: {

View file

@ -24,10 +24,10 @@ export default class ContentSwitcher {
default: {};
};
$on(eventname: "change", cb: (event: CustomEvent<number>) => 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: "change", cb: (event: CustomEvent<any>) => void): () => void;
$on(eventname: string, cb: (event: Event) => void): () => void;
}

View file

@ -1,13 +1,15 @@
/// <reference types="svelte" />
type Headers = {
interface Header {
key: string;
value: string;
display?: (item) => string;
sort?: (a, b) => number;
empty?: boolean;
columnMenu?: boolean;
}[];
}
type Headers = Header[];
export default class DataTable {
$$prop_def: {
@ -106,17 +108,24 @@ export default class DataTable {
$$slot_def: {
default: {};
cell: { row: any; cell: any };
["expanded-row"]: { row: any };
["expanded-row"]: { row: Object };
["cell-header"]: { header: Header };
cell: { row: Object; cell: Object };
};
$on(eventname: "click:header--expand", cb: (event: CustomEvent<any>) => void): () => void;
$on(eventname: "click", cb: (event: CustomEvent<any>) => void): () => void;
$on(eventname: "click:header", cb: (event: CustomEvent<any>) => void): () => void;
$on(eventname: "click:row", cb: (event: CustomEvent<any>) => void): () => void;
$on(eventname: "mouseenter:row", cb: (event: CustomEvent<any>) => void): () => void;
$on(eventname: "mouseleave:row", cb: (event: CustomEvent<any>) => void): () => void;
$on(eventname: "click:row--expand", cb: (event: CustomEvent<any>) => void): () => void;
$on(eventname: "click:cell", cb: (event: CustomEvent<any>) => void): () => void;
$on(
eventname: "click",
cb: (event: CustomEvent<{ header?: Header; row?: Object; cell?: Object }>) => void
): () => void;
$on(eventname: "click:header--expand", cb: (event: CustomEvent<{ expanded: boolean }>) => void): () => void;
$on(
eventname: "click:header",
cb: (event: CustomEvent<{ header: Header; sortDirection: "ascending" | "descending" | "none" }>) => void
): () => void;
$on(eventname: "click:row", cb: (event: CustomEvent<Object>) => void): () => void;
$on(eventname: "mouseenter:row", cb: (event: CustomEvent<Object>) => void): () => void;
$on(eventname: "mouseleave:row", cb: (event: CustomEvent<Object>) => void): () => void;
$on(eventname: "click:row--expand", cb: (event: CustomEvent<{ expanded: boolean; row: Object }>) => void): () => void;
$on(eventname: "click:cell", cb: (event: CustomEvent<Object>) => void): () => void;
$on(eventname: string, cb: (event: Event) => void): () => void;
}

View file

@ -116,6 +116,9 @@ export default class Dropdown {
$$slot_def: {};
$on(eventname: "select", cb: (event: CustomEvent<any>) => void): () => void;
$on(
eventname: "select",
cb: (event: CustomEvent<{ selectedId: DropdownItemId; selectedIndex: number; selectedItem: DropdownItem }>) => void
): () => void;
$on(eventname: string, cb: (event: Event) => void): () => void;
}

View file

@ -1,5 +1,7 @@
/// <reference types="svelte" />
type Files = string[];
export default class FileUploader {
$$prop_def: svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["div"]> & {
/**
@ -12,13 +14,13 @@ export default class FileUploader {
* Specify the accepted file types
* @default []
*/
accept?: string[];
accept?: Files;
/**
* Obtain the uploaded file names
* @default []
*/
files?: string[];
files?: Files;
/**
* Set to `true` to allow multiple files
@ -31,7 +33,7 @@ export default class FileUploader {
* @constant
* @default () => { files = []; }
*/
clearFiles?: () => any;
clearFiles?: () => void;
/**
* Specify the label description
@ -72,13 +74,13 @@ export default class FileUploader {
$$slot_def: {};
$on(eventname: "add", cb: (event: CustomEvent<Files>) => void): () => void;
$on(eventname: "remove", cb: (event: CustomEvent<Files>) => 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: "change", cb: (event: WindowEventMap["change"]) => void): () => void;
$on(eventname: "keydown", cb: (event: WindowEventMap["keydown"]) => void): () => void;
$on(eventname: "add", cb: (event: CustomEvent<any>) => void): () => void;
$on(eventname: "remove", cb: (event: CustomEvent<any>) => void): () => void;
$on(eventname: string, cb: (event: Event) => void): () => void;
}

View file

@ -1,12 +1,14 @@
/// <reference types="svelte" />
type Files = string[];
export default class FileUploaderButton {
$$prop_def: svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["input"]> & {
/**
* Specify the accepted file types
* @default []
*/
accept?: string[];
accept?: Files;
/**
* Set to `true` to allow multiple files

View file

@ -8,7 +8,7 @@ export default class FileUploaderDropContainer {
* Specify the accepted file types
* @default []
*/
accept?: string[];
accept?: Files;
/**
* Set to `true` to allow multiple files
@ -67,12 +67,12 @@ export default class FileUploaderDropContainer {
$$slot_def: {};
$on(eventname: "add", cb: (event: CustomEvent<Files>) => void): () => void;
$on(eventname: "dragover", cb: (event: WindowEventMap["dragover"]) => void): () => void;
$on(eventname: "dragleave", cb: (event: WindowEventMap["dragleave"]) => void): () => void;
$on(eventname: "drop", cb: (event: WindowEventMap["drop"]) => void): () => void;
$on(eventname: "keydown", cb: (event: WindowEventMap["keydown"]) => void): () => void;
$on(eventname: "change", cb: (event: WindowEventMap["change"]) => void): () => void;
$on(eventname: "click", cb: (event: WindowEventMap["click"]) => void): () => void;
$on(eventname: "add", cb: (event: CustomEvent<any>) => void): () => void;
$on(eventname: string, cb: (event: Event) => void): () => void;
}

View file

@ -46,9 +46,9 @@ export default class FileUploaderItem {
$$slot_def: {};
$on(eventname: "delete", cb: (event: CustomEvent<string>) => 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: "delete", cb: (event: CustomEvent<any>) => void): () => void;
$on(eventname: string, cb: (event: Event) => void): () => void;
}

View file

@ -68,7 +68,7 @@ export default class Column {
};
$$slot_def: {
default: { props: undefined };
default: { props?: { class: string } };
};
$on(eventname: string, cb: (event: Event) => void): () => void;

View file

@ -47,7 +47,7 @@ export default class Grid {
};
$$slot_def: {
default: { props: undefined };
default: { props?: { class: string } };
};
$on(eventname: string, cb: (event: Event) => void): () => void;

2
types/Grid/Row.d.ts vendored
View file

@ -41,7 +41,7 @@ export default class Row {
};
$$slot_def: {
default: { props: undefined };
default: { props?: { class: string } };
};
$on(eventname: string, cb: (event: Event) => void): () => void;

View file

@ -44,7 +44,7 @@ export default class ListBoxField {
* Obtain a reference to the top-level HTML element
* @default null
*/
ref?: null | HTMLElement;
ref?: null | HTMLDivElement;
};
$$slot_def: {

View file

@ -8,7 +8,7 @@ export default class ListBoxMenu {
id?: string;
/**
* Obtain a reference to the input HTML element
* Obtain a reference to the HTML element
* @default null
*/
ref?: null | HTMLDivElement;

View file

@ -109,7 +109,7 @@ export default class Modal {
* Obtain a reference to the top-level HTML element
* @default null
*/
ref?: null | HTMLElement;
ref?: null | HTMLDivElement;
};
$$slot_def: {

View file

@ -15,7 +15,7 @@ export default class RadioButton {
checked?: boolean;
/**
* Set to `true` to disable the radio button
* et to `true` to disable the radio button
* @default false
*/
disabled?: boolean;

View file

@ -5,7 +5,7 @@ export default class Select {
/**
* Specify the selected item value
*/
selected?: string;
selected?: undefined;
/**
* Set the size of the select input

View file

@ -50,10 +50,10 @@ export default class ExpandableTile {
id?: string;
/**
* Obtain a reference to the input HTML element
* Obtain a reference to the top-level element
* @default null
*/
ref?: null | HTMLElement;
ref?: null | HTMLDivElement;
};
$$slot_def: {

View file

@ -11,8 +11,8 @@ export default class HeaderActionSearch {
$$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: "inputSearch", cb: (event: CustomEvent<any>) => void): () => void;
$on(eventname: string, cb: (event: Event) => void): () => void;
}

42
types/index.d.ts vendored
View file

@ -3,14 +3,14 @@ export { default as AccordionSkeleton } from "./Accordion/AccordionSkeleton";
export { default as Accordion } from "./Accordion/Accordion";
export { default as AccordionItem } from "./Accordion/AccordionItem";
export { default as AspectRatio } from "./AspectRatio/AspectRatio";
export { default as BreadcrumbSkeleton } from "./Breadcrumb/Breadcrumb.Skeleton";
export { default as BreadcrumbSkeleton } from "./Breadcrumb/BreadcrumbSkeleton";
export { default as Breadcrumb } from "./Breadcrumb/Breadcrumb";
export { default as Link } from "./Link/Link";
export { default as BreadcrumbItem } from "./Breadcrumb/BreadcrumbItem";
export { default as ButtonSkeleton } from "./Button/Button.Skeleton";
export { default as ButtonSkeleton } from "./Button/ButtonSkeleton";
export { default as Button } from "./Button/Button";
export { default as ButtonSet } from "./Button/ButtonSet";
export { default as CheckboxSkeleton } from "./Checkbox/Checkbox.Skeleton";
export { default as CheckboxSkeleton } from "./Checkbox/CheckboxSkeleton";
export { default as Checkbox } from "./Checkbox/Checkbox";
export { default as ContentSwitcher } from "./ContentSwitcher/ContentSwitcher";
export { default as Switch } from "./ContentSwitcher/Switch";
@ -27,10 +27,10 @@ export { default as ComposedModal } from "./ComposedModal/ComposedModal";
export { default as ModalHeader } from "./ComposedModal/ModalHeader";
export { default as ModalBody } from "./ComposedModal/ModalBody";
export { default as ModalFooter } from "./ComposedModal/ModalFooter";
export { default as CodeSnippetSkeleton } from "./CodeSnippet/CodeSnippet.Skeleton";
export { default as CodeSnippetSkeleton } from "./CodeSnippet/CodeSnippetSkeleton";
export { default as CodeSnippet } from "./CodeSnippet/CodeSnippet";
export { default as RadioButton } from "./RadioButton/RadioButton";
export { default as RadioButtonSkeleton } from "./RadioButton/RadioButton.Skeleton";
export { default as RadioButtonSkeleton } from "./RadioButton/RadioButtonSkeleton";
export { default as Table } from "./DataTable/Table";
export { default as TableBody } from "./DataTable/TableBody";
export { default as TableCell } from "./DataTable/TableCell";
@ -41,7 +41,7 @@ export { default as TableRow } from "./DataTable/TableRow";
export { default as DataTable } from "./DataTable/DataTable";
export { default as Toolbar } from "./DataTable/Toolbar";
export { default as ToolbarContent } from "./DataTable/ToolbarContent";
export { default as SearchSkeleton } from "./Search/Search.Skeleton";
export { default as SearchSkeleton } from "./Search/SearchSkeleton";
export { default as Search } from "./Search/Search";
export { default as ToolbarSearch } from "./DataTable/ToolbarSearch";
export { default as ToolbarBatchActions } from "./DataTable/ToolbarBatchActions";
@ -52,16 +52,16 @@ export { default as ToolbarMenuItem } from "./DataTable/ToolbarMenuItem";
export { default as DataTableSkeleton } from "./DataTableSkeleton/DataTableSkeleton";
export { default as DatePicker } from "./DatePicker/DatePicker";
export { default as DatePickerInput } from "./DatePicker/DatePickerInput";
export { default as DatePickerSkeleton } from "./DatePicker/DatePicker.Skeleton";
export { default as DatePickerSkeleton } from "./DatePicker/DatePickerSkeleton";
export { default as Dropdown } from "./Dropdown/Dropdown";
export { default as DropdownSkeleton } from "./Dropdown/Dropdown.Skeleton";
export { default as DropdownSkeleton } from "./Dropdown/DropdownSkeleton";
export { default as Loading } from "./Loading/Loading";
export { default as Filename } from "./FileUploader/Filename";
export { default as FileUploaderButton } from "./FileUploader/FileUploaderButton";
export { default as FileUploader } from "./FileUploader/FileUploader";
export { default as FileUploaderItem } from "./FileUploader/FileUploaderItem";
export { default as FileUploaderDropContainer } from "./FileUploader/FileUploaderDropContainer";
export { default as FileUploaderSkeleton } from "./FileUploader/FileUploader.Skeleton";
export { default as FileUploaderSkeleton } from "./FileUploader/FileUploaderSkeleton";
export { default as Form } from "./Form/Form";
export { default as FluidForm } from "./FluidForm/FluidForm";
export { default as FormGroup } from "./FormGroup/FormGroup";
@ -70,7 +70,7 @@ export { default as FormLabel } from "./FormLabel/FormLabel";
export { default as Grid } from "./Grid/Grid";
export { default as Row } from "./Grid/Row";
export { default as Column } from "./Grid/Column";
export { default as IconSkeleton } from "./Icon/Icon.Skeleton";
export { default as IconSkeleton } from "./Icon/IconSkeleton";
export { default as Icon } from "./Icon/Icon";
export { default as InlineLoading } from "./InlineLoading/InlineLoading";
export { default as ListItem } from "./ListItem/ListItem";
@ -83,24 +83,24 @@ export { default as ToastNotification } from "./Notification/ToastNotification";
export { default as InlineNotification } from "./Notification/InlineNotification";
export { default as NotificationActionButton } from "./Notification/NotificationActionButton";
export { default as NumberInput } from "./NumberInput/NumberInput";
export { default as NumberInputSkeleton } from "./NumberInput/NumberInput.Skeleton";
export { default as NumberInputSkeleton } from "./NumberInput/NumberInputSkeleton";
export { default as OrderedList } from "./OrderedList/OrderedList";
export { default as Select } from "./Select/Select";
export { default as SelectSkeleton } from "./Select/Select.Skeleton";
export { default as SelectSkeleton } from "./Select/SelectSkeleton";
export { default as SelectItem } from "./Select/SelectItem";
export { default as SelectItemGroup } from "./Select/SelectItemGroup";
export { default as Pagination } from "./Pagination/Pagination";
export { default as PaginationSkeleton } from "./Pagination/Pagination.Skeleton";
export { default as PaginationSkeleton } from "./Pagination/PaginationSkeleton";
export { default as PaginationNav } from "./PaginationNav/PaginationNav";
export { default as ProgressIndicator } from "./ProgressIndicator/ProgressIndicator";
export { default as ProgressIndicatorSkeleton } from "./ProgressIndicator/ProgressIndicator.Skeleton";
export { default as ProgressIndicatorSkeleton } from "./ProgressIndicator/ProgressIndicatorSkeleton";
export { default as ProgressStep } from "./ProgressIndicator/ProgressStep";
export { default as RadioButtonGroup } from "./RadioButtonGroup/RadioButtonGroup";
export { default as SkeletonPlaceholder } from "./SkeletonPlaceholder/SkeletonPlaceholder";
export { default as Slider } from "./Slider/Slider";
export { default as SliderSkeleton } from "./Slider/Slider.Skeleton";
export { default as SliderSkeleton } from "./Slider/SliderSkeleton";
export { default as StructuredList } from "./StructuredList/StructuredList";
export { default as StructuredListSkeleton } from "./StructuredList/StructuredList.Skeleton";
export { default as StructuredListSkeleton } from "./StructuredList/StructuredListSkeleton";
export { default as StructuredListBody } from "./StructuredList/StructuredListBody";
export { default as StructuredListHead } from "./StructuredList/StructuredListHead";
export { default as StructuredListCell } from "./StructuredList/StructuredListCell";
@ -110,12 +110,12 @@ export { default as Tabs } from "./Tabs/Tabs";
export { default as Tab } from "./Tabs/Tab";
export { default as TabContent } from "./Tabs/TabContent";
export { default as TabsSkeleton } from "./Tabs/TabsSkeleton";
export { default as TagSkeleton } from "./Tag/Tag.Skeleton";
export { default as TagSkeleton } from "./Tag/TagSkeleton";
export { default as Tag } from "./Tag/Tag";
export { default as TextArea } from "./TextArea/TextArea";
export { default as TextAreaSkeleton } from "./TextArea/TextArea.Skeleton";
export { default as TextAreaSkeleton } from "./TextArea/TextAreaSkeleton";
export { default as TextInput } from "./TextInput/TextInput";
export { default as TextInputSkeleton } from "./TextInput/TextInput.Skeleton";
export { default as TextInputSkeleton } from "./TextInput/TextInputSkeleton";
export { default as PasswordInput } from "./TextInput/PasswordInput";
export { default as Tile } from "./Tile/Tile";
export { default as ClickableTile } from "./Tile/ClickableTile";
@ -126,9 +126,9 @@ export { default as TileGroup } from "./Tile/TileGroup";
export { default as TimePicker } from "./TimePicker/TimePicker";
export { default as TimePickerSelect } from "./TimePicker/TimePickerSelect";
export { default as Toggle } from "./Toggle/Toggle";
export { default as ToggleSkeleton } from "./Toggle/Toggle.Skeleton";
export { default as ToggleSkeleton } from "./Toggle/ToggleSkeleton";
export { default as ToggleSmall } from "./ToggleSmall/ToggleSmall";
export { default as ToggleSmallSkeleton } from "./ToggleSmall/ToggleSmall.Skeleton";
export { default as ToggleSmallSkeleton } from "./ToggleSmall/ToggleSmallSkeleton";
export { default as Tooltip } from "./Tooltip/Tooltip";
export { default as TooltipDefinition } from "./TooltipDefinition/TooltipDefinition";
export { default as TooltipIcon } from "./TooltipIcon/TooltipIcon";