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

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

Browse source 
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
Download patch file Download diff file Expand all files Collapse all files

88
docs/src/COMPONENT_API.json
View file

@ -754,7 +754,7 @@
"name": "group",
"kind": "let",
"description": "Specify the bound group",
"type": "any[]",
"type": "ReadonlyArray<any>",
"isFunction": false,
"isFunctionDeclaration": false,
"isRequired": false,
@ -1460,7 +1460,7 @@
"name": "items",
"kind": "let",
"description": "Set the combobox items",
"type": "ComboBoxItem[]",
"type": "ReadonlyArray<ComboBoxItem>",
"value": "[]",
"isFunction": false,
"isFunctionDeclaration": false,
@ -1961,7 +1961,7 @@
"name": "target",
"kind": "let",
"description": "Specify an element or list of elements to trigger the context menu.\nIf no element is specified, the context menu applies to the entire window",
"type": "null | HTMLElement | HTMLElement[]",
"type": "null | ReadonlyArray<null | HTMLElement>",
"value": "null",
"isFunction": false,
"isFunctionDeclaration": false,
@ -2045,7 +2045,7 @@
{
"name": "selectedIds",
"kind": "let",
"type": "string[]",
"type": "ReadonlyArray<string>",
"value": "[]",
"isFunction": false,
"isFunctionDeclaration": false,
@ -2342,7 +2342,7 @@
"name": "headers",
"kind": "let",
"description": "Specify the data table headers",
"type": "DataTableHeader[]",
"type": "ReadonlyArray<DataTableHeader>",
"value": "[]",
"isFunction": false,
"isFunctionDeclaration": false,
@ -2354,7 +2354,7 @@
"name": "rows",
"kind": "let",
"description": "Specify the rows the data table should render\nkeys defined in `headers` are used for the row ids",
"type": "DataTableRow[]",
"type": "ReadonlyArray<DataTableRow>",
"value": "[]",
"isFunction": false,
"isFunctionDeclaration": false,
@ -2449,7 +2449,7 @@
"name": "expandedRowIds",
"kind": "let",
"description": "Specify the row ids to be expanded",
"type": "DataTableRowId[]",
"type": "ReadonlyArray<DataTableRowId>",
"value": "[]",
"isFunction": false,
"isFunctionDeclaration": false,
@ -2461,7 +2461,7 @@
"name": "nonExpandableRowIds",
"kind": "let",
"description": "Specify the ids for rows that should not be expandable",
"type": "DataTableRowId[]",
"type": "ReadonlyArray<DataTableRowId>",
"value": "[]",
"isFunction": false,
"isFunctionDeclaration": false,
@ -2509,7 +2509,7 @@
"name": "selectedRowIds",
"kind": "let",
"description": "Specify the row ids to be selected",
"type": "DataTableRowId[]",
"type": "ReadonlyArray<DataTableRowId>",
"value": "[]",
"isFunction": false,
"isFunctionDeclaration": false,
@ -2521,7 +2521,7 @@
"name": "nonSelectableRowIds",
"kind": "let",
"description": "Specify the ids of rows that should not be selectable",
"type": "DataTableRowId[]",
"type": "ReadonlyArray<DataTableRowId>",
"value": "[]",
"isFunction": false,
"isFunctionDeclaration": false,
@ -2760,7 +2760,7 @@
"name": "headers",
"kind": "let",
"description": "Set the column headers\nSupersedes `columns` if value is a non-empty array",
"type": "string[] | Partial<DataTableHeader>[]",
"type": "ReadonlyArray<string | Partial<DataTableHeader>>",
"value": "[]",
"isFunction": false,
"isFunctionDeclaration": false,
@ -3223,7 +3223,7 @@
"name": "items",
"kind": "let",
"description": "Set the dropdown items",
"type": "DropdownItem[]",
"type": "ReadonlyArray<DropdownItem>",
"value": "[]",
"isFunction": false,
"isFunctionDeclaration": false,
@ -3714,7 +3714,7 @@
"name": "accept",
"kind": "let",
"description": "Specify the accepted file types",
"type": "string[]",
"type": "ReadonlyArray<string>",
"value": "[]",
"isFunction": false,
"isFunctionDeclaration": false,
@ -3726,7 +3726,7 @@
"name": "files",
"kind": "let",
"description": "Obtain a reference to the uploaded files",
"type": "File[]",
"type": "ReadonlyArray<File>",
"value": "[]",
"isFunction": false,
"isFunctionDeclaration": false,
@ -3834,9 +3834,21 @@
"moduleExports": [],
"slots": [],
"events": [
{ "type": "dispatched", "name": "add", "detail": "File[]" },
{ "type": "dispatched", "name": "remove", "detail": "File[]" },
{ "type": "dispatched", "name": "change", "detail": "File[]" },
{
"type": "dispatched",
"name": "add",
"detail": "ReadonlyArray<File>"
},
{
"type": "dispatched",
"name": "remove",
"detail": "ReadonlyArray<File>"
},
{
"type": "dispatched",
"name": "change",
"detail": "ReadonlyArray<File>"
},
{ "type": "forwarded", "name": "click", "element": "div" },
{ "type": "forwarded", "name": "mouseover", "element": "div" },
{ "type": "forwarded", "name": "mouseenter", "element": "div" },
@ -3854,7 +3866,7 @@
"name": "accept",
"kind": "let",
"description": "Specify the accepted file types",
"type": "string[]",
"type": "ReadonlyArray<string>",
"value": "[]",
"isFunction": false,
"isFunctionDeclaration": false,
@ -3866,7 +3878,7 @@
"name": "files",
"kind": "let",
"description": "Obtain a reference to the uploaded files",
"type": "File[]",
"type": "ReadonlyArray<File>",
"value": "[]",
"isFunction": false,
"isFunctionDeclaration": false,
@ -4005,7 +4017,11 @@
}
],
"events": [
{ "type": "dispatched", "name": "change", "detail": "File[]" },
{
"type": "dispatched",
"name": "change",
"detail": "ReadonlyArray<File>"
},
{ "type": "forwarded", "name": "keydown", "element": "label" },
{ "type": "forwarded", "name": "click", "element": "input" }
],
@ -4020,7 +4036,7 @@
"name": "accept",
"kind": "let",
"description": "Specify the accepted file types",
"type": "string[]",
"type": "ReadonlyArray<string>",
"value": "[]",
"isFunction": false,
"isFunctionDeclaration": false,
@ -4032,7 +4048,7 @@
"name": "files",
"kind": "let",
"description": "Obtain a reference to the uploaded files",
"type": "File[]",
"type": "ReadonlyArray<File>",
"value": "[]",
"isFunction": false,
"isFunctionDeclaration": false,
@ -4055,8 +4071,8 @@
{
"name": "validateFiles",
"kind": "let",
"description": "Override the default behavior of validating uploaded files\nThe default behavior does not validate files",
"type": "(files: File[]) => File[]",
"description": "Override the default behavior of validating uploaded files.\nBy default, files are not validated",
"type": "(files: ReadonlyArray<File>) => ReadonlyArray<File>",
"value": "(files) => files",
"isFunction": true,
"isFunctionDeclaration": false,
@ -4159,8 +4175,16 @@
}
],
"events": [
{ "type": "dispatched", "name": "add", "detail": "File[]" },
{ "type": "dispatched", "name": "change", "detail": "File[]" },
{
"type": "dispatched",
"name": "add",
"detail": "ReadonlyArray<File>"
},
{
"type": "dispatched",
"name": "change",
"detail": "ReadonlyArray<File>"
},
{ "type": "forwarded", "name": "dragover", "element": "div" },
{ "type": "forwarded", "name": "dragleave", "element": "div" },
{ "type": "forwarded", "name": "drop", "element": "div" },
@ -5245,7 +5269,7 @@
"name": "results",
"kind": "let",
"description": "Render a list of search results",
"type": "HeaderSearchResult[]",
"type": "ReadonlyArray<HeaderSearchResult>",
"value": "[]",
"isFunction": false,
"isFunctionDeclaration": false,
@ -6861,7 +6885,7 @@
"name": "items",
"kind": "let",
"description": "Set the multiselect items",
"type": "MultiSelectItem[]",
"type": "ReadonlyArray<MultiSelectItem>",
"value": "[]",
"isFunction": false,
"isFunctionDeclaration": false,
@ -6897,7 +6921,7 @@
"name": "selectedIds",
"kind": "let",
"description": "Set the selected ids",
"type": "MultiSelectItemId[]",
"type": "ReadonlyArray<MultiSelectItemId>",
"value": "[]",
"isFunction": false,
"isFunctionDeclaration": false,
@ -8283,7 +8307,7 @@
"name": "pageSizes",
"kind": "let",
"description": "Specify the available page sizes",
"type": "number[]",
"type": "ReadonlyArray<number>",
"value": "[10]",
"isFunction": false,
"isFunctionDeclaration": false,
@ -14210,7 +14234,7 @@
"name": "selectedIds",
"kind": "let",
"description": "Set the node ids to be selected",
"type": "TreeNodeId[]",
"type": "ReadonlyArray<TreeNodeId>",
"value": "[]",
"isFunction": false,
"isFunctionDeclaration": false,
@ -14222,7 +14246,7 @@
"name": "expandedIds",
"kind": "let",
"description": "Set the node ids to be expanded",
"type": "TreeNodeId[]",
"type": "ReadonlyArray<TreeNodeId>",
"value": "[]",
"isFunction": false,
"isFunctionDeclaration": false,