breaking(types): type arrays as read-only (#1335)

Closes #1259

* breaking(types): type arrays as read-only

* Run "yarn build:docs"

* test: assert read-only arrays
This commit is contained in:
metonym 2022-06-05 13:25:43 -07:00 committed by GitHub
commit 260bf4e040
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
34 changed files with 257 additions and 192 deletions

View file

@ -46,14 +46,14 @@ export interface DataTableProps
* Specify the data table headers
* @default []
*/
headers?: DataTableHeader[];
headers?: ReadonlyArray<DataTableHeader>;
/**
* Specify the rows the data table should render
* keys defined in `headers` are used for the row ids
* @default []
*/
rows?: DataTableRow[];
rows?: ReadonlyArray<DataTableRow>;
/**
* Set the size of the data table
@ -102,13 +102,13 @@ export interface DataTableProps
* Specify the row ids to be expanded
* @default []
*/
expandedRowIds?: DataTableRowId[];
expandedRowIds?: ReadonlyArray<DataTableRowId>;
/**
* Specify the ids for rows that should not be expandable
* @default []
*/
nonExpandableRowIds?: DataTableRowId[];
nonExpandableRowIds?: ReadonlyArray<DataTableRowId>;
/**
* Set to `true` for the radio selection variant
@ -133,13 +133,13 @@ export interface DataTableProps
* Specify the row ids to be selected
* @default []
*/
selectedRowIds?: DataTableRowId[];
selectedRowIds?: ReadonlyArray<DataTableRowId>;
/**
* Specify the ids of rows that should not be selectable
* @default []
*/
nonSelectableRowIds?: DataTableRowId[];
nonSelectableRowIds?: ReadonlyArray<DataTableRowId>;
/**
* Set to `true` to enable a sticky header

View file

@ -41,7 +41,7 @@ export interface DataTableSkeletonProps
* Supersedes `columns` if value is a non-empty array
* @default []
*/
headers?: string[] | Partial<DataTableHeader>[];
headers?: ReadonlyArray<string | Partial<DataTableHeader>>;
/**
* Set to `false` to hide the toolbar