mcp/carbon-components-svelte
1
0
Fork 0
mirror of https://github.com/carbon-design-system/carbon-components-svelte.git synced 2025-09-15 02:11:05 +00:00
Code Issues Projects Releases Packages Wiki Activity

feat(data-table): update JSDocs to use generics

Browse source
This commit is contained in:
Eric Liu 2024-04-20 14:58:52 -07:00
commit 94262c17a4
1 changed files with 20 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

38
src/DataTable/DataTable.svelte
View file

@ -1,39 +1,41 @@
<script> <script>
/** /**
* @typedef {string} DataTableKey * @generics {Row extends DataTableRow = DataTableRow} Row
* @template {DataTableRow} Row
* @typedef {Exclude<keyof Row, "id">} DataTableKey<Row=DataTableRow>
* @typedef {any} DataTableValue * @typedef {any} DataTableValue
* @typedef {{ key: DataTableKey; empty: boolean; display?: (item: DataTableValue, row: DataTableRow) => DataTableValue; sort?: false | ((a: DataTableValue, b: DataTableValue) => number); columnMenu?: boolean; width?: string; minWidth?: string; }} DataTableEmptyHeader * @typedef {{ key: DataTableKey<Row>; empty: boolean; display?: (item: DataTableValue, row: Row) => DataTableValue; sort?: false | ((a: DataTableValue, b: DataTableValue) => number); columnMenu?: boolean; width?: string; minWidth?: string; }} DataTableEmptyHeader<Row=DataTableRow>
* @typedef {{ key: DataTableKey; value: DataTableValue; display?: (item: DataTableValue, row: DataTableRow) => DataTableValue; sort?: false | ((a: DataTableValue, b: DataTableValue) => number); columnMenu?: boolean; width?: string; minWidth?: string; }} DataTableNonEmptyHeader * @typedef {{ key: DataTableKey<Row>; value: DataTableValue; display?: (item: DataTableValue, row: Row) => DataTableValue; sort?: false | ((a: DataTableValue, b: DataTableValue) => number); columnMenu?: boolean; width?: string; minWidth?: string; }} DataTableNonEmptyHeader<Row=DataTableRow>
* @typedef {DataTableNonEmptyHeader | DataTableEmptyHeader} DataTableHeader * @typedef {DataTableNonEmptyHeader<Row> | DataTableEmptyHeader<Row>} DataTableHeader<Row=DataTableRow>
* @typedef {{ id: any; [key: string]: DataTableValue; }} DataTableRow * @typedef {{ id: any; [key: string]: DataTableValue; }} DataTableRow
* @typedef {any} DataTableRowId * @typedef {any} DataTableRowId
* @typedef {{ key: DataTableKey; value: DataTableValue; display?: (item: DataTableValue, row: DataTableRow) => DataTableValue; }} DataTableCell * @typedef {{ key: DataTableKey<Row>; value: DataTableValue; display?: (item: DataTableValue, row: DataTableRow) => DataTableValue; }} DataTableCell<Row=DataTableRow>
* @slot {{ row: DataTableRow; }} expanded-row * @slot {{ row: Row; }} expanded-row
* @slot {{ header: DataTableNonEmptyHeader; }} cell-header * @slot {{ header: DataTableNonEmptyHeader; }} cell-header
* @slot {{ row: DataTableRow; cell: DataTableCell; rowIndex: number; cellIndex: number; }} cell * @slot {{ row: Row; cell: DataTableCell<Row>; rowIndex: number; cellIndex: number; }} cell
* @event {{ header?: DataTableHeader; row?: DataTableRow; cell?: DataTableCell; }} click * @event {{ header?: DataTableHeader<Row>; row?: Row; cell?: DataTableCell<Row>; }} click
* @event {{ expanded: boolean; }} click:header--expand * @event {{ expanded: boolean; }} click:header--expand
* @event {{ header: DataTableHeader; sortDirection?: "ascending" | "descending" | "none" }} click:header * @event {{ header: DataTableHeader<Row>; sortDirection?: "ascending" | "descending" | "none" }} click:header
* @event {{ indeterminate: boolean; selected: boolean; }} click:header--select * @event {{ indeterminate: boolean; selected: boolean; }} click:header--select
* @event {DataTableRow} click:row * @event {Row} click:row
* @event {DataTableRow} mouseenter:row * @event {Row} mouseenter:row
* @event {DataTableRow} mouseleave:row * @event {Row} mouseleave:row
* @event {{ expanded: boolean; row: DataTableRow; }} click:row--expand * @event {{ expanded: boolean; row: Row; }} click:row--expand
* @event {{ selected: boolean; row: DataTableRow; }} click:row--select * @event {{ selected: boolean; row: Row; }} click:row--select
* @event {DataTableCell} click:cell * @event {DataTableCell<Row>} click:cell
* @restProps {div} * @restProps {div}
*/ */
/** /**
* Specify the data table headers * Specify the data table headers
* @type {ReadonlyArray<DataTableHeader>} * @type {ReadonlyArray<DataTableHeader<Row>>}
*/ */
export let headers = []; export let headers = [];
/** /**
* Specify the rows the data table should render * Specify the rows the data table should render
* keys defined in `headers` are used for the row ids * keys defined in `headers` are used for the row ids
* @type {ReadonlyArray<DataTableRow>} * @type {ReadonlyArray<Row>}
*/ */
export let rows = []; export let rows = [];
@ -57,7 +59,7 @@
/** /**
* Specify the header key to sort by * Specify the header key to sort by
* @type {DataTableKey} * @type {DataTableKey<Row>}
*/ */
export let sortKey = null; export let sortKey = null;