Skip to content

Commit 5b1b498

Browse files
Clean up for release
Build Server commit: Update release notes, commit inline icons (if needed), site component documentation (if needed). Remove patch.md or minor.md
1 parent d13eec8 commit 5b1b498

File tree

3 files changed

+68
-77
lines changed

3 files changed

+68
-77
lines changed

components/component-docs.json

Lines changed: 41 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3248,10 +3248,19 @@
32483248
},
32493249
"items": {
32503250
"type": {
3251-
"name": "array"
3251+
"name": "arrayOf",
3252+
"value": {
3253+
"name": "shape",
3254+
"value": {
3255+
"id": {
3256+
"name": "string",
3257+
"required": true
3258+
}
3259+
}
3260+
}
32523261
},
32533262
"required": true,
3254-
"description": "The collection of items to render in the table."
3263+
"description": "The collection of items to render in the table. This is an array of objects with each object having keys that correspond with the `property` prop of each `DataTableColumn`."
32553264
},
32563265
"noRowHover": {
32573266
"type": {
@@ -3260,12 +3269,12 @@
32603269
"required": false,
32613270
"description": "A variant which removes hover style on rows"
32623271
},
3263-
"onChange": {
3272+
"onRowChange": {
32643273
"type": {
32653274
"name": "func"
32663275
},
32673276
"required": false,
3268-
"description": "This function fires when the selection of rows changes."
3277+
"description": "This function fires when the selection of rows changes. This component passes in `event, { selection }` to the function. `selection` is an array of objects from the `items` prop.\n\nThis used to be `onChange` which is deprecated now, so that the parameters can be consistent with other components. `onChange` passed in the selection first and the event wtihout a data object."
32693278
},
32703279
"onSort": {
32713280
"type": {
@@ -3279,7 +3288,7 @@
32793288
"name": "array"
32803289
},
32813290
"required": false,
3282-
"description": "The selected rows.",
3291+
"description": "An array of objects of selected rows. See `items` prop for shape of objects.",
32833292
"defaultValue": {
32843293
"value": "[]",
32853294
"computed": false
@@ -4447,11 +4456,19 @@
44474456
"spinner": {
44484457
"name": "string",
44494458
"required": false
4459+
},
4460+
"fieldLevelHelpButton": {
4461+
"name": "string",
4462+
"required": false
44504463
}
44514464
}
44524465
},
44534466
"required": false,
4454-
"description": "**Assistive text for accessibility**\n* `label`: Visually hidden label but read out loud by screen readers.\n* `spinner`: Text for loading spinner icon."
4467+
"description": "**Assistive text for accessibility**\n* `label`: Visually hidden label but read out loud by screen readers.\n* `spinner`: Text for loading spinner icon.\n* `fieldLevelHelpButton`: The field level help button, by default an 'info' icon.",
4468+
"defaultValue": {
4469+
"value": "{\n fieldLevelHelpButton: 'Help',\n}",
4470+
"computed": false
4471+
}
44554472
},
44564473
"children": {
44574474
"type": {
@@ -4574,7 +4591,15 @@
45744591
},
45754592
"inlineHelpText": {
45764593
"type": {
4577-
"name": "string"
4594+
"name": "union",
4595+
"value": [
4596+
{
4597+
"name": "node"
4598+
},
4599+
{
4600+
"name": "string"
4601+
}
4602+
]
45784603
},
45794604
"required": false,
45804605
"description": "Displays help text under the input."
@@ -12088,7 +12113,15 @@
1208812113
"required": true
1208912114
},
1209012115
"label": {
12091-
"name": "string",
12116+
"name": "union",
12117+
"value": [
12118+
{
12119+
"name": "node"
12120+
},
12121+
{
12122+
"name": "string"
12123+
}
12124+
],
1209212125
"required": true
1209312126
},
1209412127
"type": {

package-lock.json

Lines changed: 27 additions & 27 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

patch.md

Lines changed: 0 additions & 42 deletions
This file was deleted.

0 commit comments

Comments
 (0)