carbon-components-svelte/types/DataTable/DataTableSkeleton.svelte.d.ts
Eric Liu 0d78c30b9d
fix(types): include @default annotations for props that are undefined by default (#1020)
* chore(deps-dev): upgrade sveld to v0.12.1

* Run "yarn build:lib"

* Re-run "yarn build:lib"
2022-01-20 19:29:06 -08:00

62 lines
1.3 KiB
TypeScript

/// <reference types="svelte" />
import { SvelteComponentTyped } from "svelte";
import { DataTableHeader } from "./DataTable.svelte";
export interface DataTableSkeletonProps
extends DataTableHeader,
svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["div"]> {
/**
* Specify the number of columns
* Superseded by `headers` if `headers` is a non-empty array
* @default 5
*/
columns?: number;
/**
* Specify the number of rows
* @default 5
*/
rows?: number;
/**
* Set the size of the data table
* @default undefined
*/
size?: "compact" | "short" | "tall";
/**
* Set to `true` to apply zebra styles to the datatable rows
* @default false
*/
zebra?: boolean;
/**
* Set to `false` to hide the header
* @default true
*/
showHeader?: boolean;
/**
* Set the column headers
* Supersedes `columns` if value is a non-empty array
* @default []
*/
headers?: string[] | Partial<DataTableHeader>[];
/**
* Set to `false` to hide the toolbar
* @default true
*/
showToolbar?: boolean;
}
export default class DataTableSkeleton extends SvelteComponentTyped<
DataTableSkeletonProps,
{
click: WindowEventMap["click"];
mouseover: WindowEventMap["mouseover"];
mouseenter: WindowEventMap["mouseenter"];
mouseleave: WindowEventMap["mouseleave"];
},
{}
> {}