@cloudscape-design/board-components 3.0.96 → 3.0.98
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/internal/api-docs/components/board-item.js +1 -1
- package/internal/api-docs/components/board.js +23 -8
- package/internal/api-docs/components/index.js +3 -3
- package/internal/api-docs/components/items-palette.js +20 -5
- package/internal/environment.js +1 -1
- package/internal/environment.json +1 -1
- package/internal/manifest.json +1 -1
- package/package.json +1 -1
|
@@ -61,7 +61,7 @@ module.exports = {
|
|
|
61
61
|
]
|
|
62
62
|
},
|
|
63
63
|
"optional": false,
|
|
64
|
-
"description": "An object containing all the necessary localized strings required by the component.\nARIA labels:\n* `dragHandleAriaLabel` (string) - the ARIA label for the drag handle.\n* `dragHandleAriaDescription` (string, optional) - the ARIA description for the drag handle.\n* `resizeHandleAriaLabel` (string) - the ARIA label for the resize handle.\n* `resizeHandleAriaDescription` (string, optional) - the ARIA description for the resize handle
|
|
64
|
+
"description": "An object containing all the necessary localized strings required by the component.\n\nARIA labels:\n* `dragHandleAriaLabel` (string) - the ARIA label for the drag handle.\n* `dragHandleAriaDescription` (string, optional) - the ARIA description for the drag handle.\n* `resizeHandleAriaLabel` (string) - the ARIA label for the resize handle.\n* `resizeHandleAriaDescription` (string, optional) - the ARIA description for the resize handle."
|
|
65
65
|
}
|
|
66
66
|
],
|
|
67
67
|
"events": []
|
|
@@ -4,7 +4,7 @@ module.exports = {
|
|
|
4
4
|
"regions": [
|
|
5
5
|
{
|
|
6
6
|
"name": "empty",
|
|
7
|
-
"description": "Rendered when the `items` array is empty.\nWhen items are loading the slot can be used to render the loading indicator
|
|
7
|
+
"description": "Rendered when the `items` array is empty.\n\nWhen items are loading the slot can be used to render the loading indicator.",
|
|
8
8
|
"isDefault": false
|
|
9
9
|
}
|
|
10
10
|
],
|
|
@@ -14,7 +14,7 @@ module.exports = {
|
|
|
14
14
|
"name": "i18nStrings",
|
|
15
15
|
"type": "BoardProps.I18nStrings<D>",
|
|
16
16
|
"inlineType": {
|
|
17
|
-
"name": "BoardProps.I18nStrings",
|
|
17
|
+
"name": "BoardProps.I18nStrings<D>",
|
|
18
18
|
"type": "object",
|
|
19
19
|
"properties": [
|
|
20
20
|
{
|
|
@@ -70,29 +70,44 @@ module.exports = {
|
|
|
70
70
|
]
|
|
71
71
|
},
|
|
72
72
|
"optional": false,
|
|
73
|
-
"description": "An object containing all the necessary localized strings required by the component.\nLive announcements:\n* `liveAnnouncementDndStarted(BoardProps.DndOperationType): string` - the function to create a live announcement string to indicate start of DnD (\"reorder\", \"resize\" or \"insert\").\n* `liveAnnouncementDndItemReordered(BoardProps.DndReorderState<D>): string` - the function to create a live announcement string to indicate when DnD reorder is performed.\n* `liveAnnouncementDndItemResized(BoardProps.DndResizeState<D>): string` - the function to create a live announcement string to indicate when DnD resize is performed.\n* `liveAnnouncementDndItemInserted(BoardProps.DndInsertState<D>): string` - the function to create a live announcement string to indicate when DnD insert is performed.\n* `liveAnnouncementDndDiscarded(BoardProps.DndOperationType): string` - the function to create a live announcement string to indicate commit of DnD (\"reorder\", \"resize\" or \"insert\").\n* `liveAnnouncementDndCommitted(BoardProps.DndOperationType): string` - the function to create a live announcement string to indicate discard of DnD (\"reorder\", \"resize\" or \"insert\").\n* `liveAnnouncementItemRemoved(BoardProps.OperationStateRemove<D>): string` - the function to create a live announcement string to indicate when item is removed
|
|
73
|
+
"description": "An object containing all the necessary localized strings required by the component.\n\nLive announcements:\n* `liveAnnouncementDndStarted(BoardProps.DndOperationType): string` - the function to create a live announcement string to indicate start of DnD (\"reorder\", \"resize\" or \"insert\").\n* `liveAnnouncementDndItemReordered(BoardProps.DndReorderState<D>): string` - the function to create a live announcement string to indicate when DnD reorder is performed.\n* `liveAnnouncementDndItemResized(BoardProps.DndResizeState<D>): string` - the function to create a live announcement string to indicate when DnD resize is performed.\n* `liveAnnouncementDndItemInserted(BoardProps.DndInsertState<D>): string` - the function to create a live announcement string to indicate when DnD insert is performed.\n* `liveAnnouncementDndDiscarded(BoardProps.DndOperationType): string` - the function to create a live announcement string to indicate commit of DnD (\"reorder\", \"resize\" or \"insert\").\n* `liveAnnouncementDndCommitted(BoardProps.DndOperationType): string` - the function to create a live announcement string to indicate discard of DnD (\"reorder\", \"resize\" or \"insert\").\n* `liveAnnouncementItemRemoved(BoardProps.OperationStateRemove<D>): string` - the function to create a live announcement string to indicate when item is removed."
|
|
74
74
|
},
|
|
75
75
|
{
|
|
76
76
|
"name": "items",
|
|
77
77
|
"type": "ReadonlyArray<BoardProps.Item<D>>",
|
|
78
78
|
"optional": false,
|
|
79
|
-
"description": "Specifies the items displayed in the board. Each item includes its position on the board and\noptional data. The content of an item is controlled by the `renderItem` property.\nThe BoardProps.Item includes:\n* `id` (string) - the unique item identifier. The IDs of any two items in a page must be different.\n* `definition.minRowSpan` (number, optional) - the minimal number of rows the item is allowed to take. It can't be less than two. Defaults to two.\n* `definition.minColumnSpan` (number, optional) - the minimal number of columns the item is allowed to take. It can't be less than one. Defaults to one.\n* `definition.defaultRowSpan` (number, optional) - the number or rows the item will take when inserted to the board. It can't be less than `definition.minRowSpan`.\n* `definition.defaultColumnSpan` (number, optional) - the number or columns the item will take when inserted in the board. It can't be less than `definition.minColumnSpan`.\n* `columnOffset` (mapping, optional) - the item's offset from the first column (per layout) starting from zero. The value is updated by `onItemsChange` after an update is committed.\n* `rowSpan` (number, optional) - the item's vertical size starting from two. The value is updated by `onItemsChange` after an update is committed.\n* `columnSpan` (number, optional) - the item's horizontal size starting from one. The value is updated by `onItemsChange` after an update is committed.\n* `data` (D) - optional item data which can include the specific configurations of an item, such as its title
|
|
79
|
+
"description": "Specifies the items displayed in the board. Each item includes its position on the board and\noptional data. The content of an item is controlled by the `renderItem` property.\n\nThe BoardProps.Item includes:\n* `id` (string) - the unique item identifier. The IDs of any two items in a page must be different.\n* `definition.minRowSpan` (number, optional) - the minimal number of rows the item is allowed to take. It can't be less than two. Defaults to two.\n* `definition.minColumnSpan` (number, optional) - the minimal number of columns the item is allowed to take. It can't be less than one. Defaults to one.\n* `definition.defaultRowSpan` (number, optional) - the number or rows the item will take when inserted to the board. It can't be less than `definition.minRowSpan`.\n* `definition.defaultColumnSpan` (number, optional) - the number or columns the item will take when inserted in the board. It can't be less than `definition.minColumnSpan`.\n* `columnOffset` (mapping, optional) - the item's offset from the first column (per layout) starting from zero. The value is updated by `onItemsChange` after an update is committed.\n* `rowSpan` (number, optional) - the item's vertical size starting from two. The value is updated by `onItemsChange` after an update is committed.\n* `columnSpan` (number, optional) - the item's horizontal size starting from one. The value is updated by `onItemsChange` after an update is committed.\n* `data` (D) - optional item data which can include the specific configurations of an item, such as its title."
|
|
80
80
|
},
|
|
81
81
|
{
|
|
82
82
|
"name": "renderItem",
|
|
83
|
-
"type": "(item: BoardProps.Item<D>, actions: BoardProps.ItemActions) => Element",
|
|
83
|
+
"type": "(item: BoardProps.Item<D>, actions: BoardProps.ItemActions) => JSX.Element",
|
|
84
|
+
"inlineType": {
|
|
85
|
+
"name": "(item: BoardProps.Item<D>, actions: BoardProps.ItemActions) => JSX.Element",
|
|
86
|
+
"type": "function",
|
|
87
|
+
"returnType": "JSX.Element",
|
|
88
|
+
"parameters": [
|
|
89
|
+
{
|
|
90
|
+
"name": "item",
|
|
91
|
+
"type": "BoardProps.Item<D>"
|
|
92
|
+
},
|
|
93
|
+
{
|
|
94
|
+
"name": "actions",
|
|
95
|
+
"type": "BoardProps.ItemActions"
|
|
96
|
+
}
|
|
97
|
+
]
|
|
98
|
+
},
|
|
84
99
|
"optional": false,
|
|
85
|
-
"description": "Specifies a function to render content for board items. The return value must include board item component.\nThe function takes the item and its associated actions (BoardProps.ItemActions) that include:\n* `removeItem(): void` - the callback to issue the item's removal. Once issued, the `onItemsChange` will fire to update the state
|
|
100
|
+
"description": "Specifies a function to render content for board items. The return value must include board item component.\n\nThe function takes the item and its associated actions (BoardProps.ItemActions) that include:\n* `removeItem(): void` - the callback to issue the item's removal. Once issued, the `onItemsChange` will fire to update the state."
|
|
86
101
|
}
|
|
87
102
|
],
|
|
88
103
|
"events": [
|
|
89
104
|
{
|
|
90
105
|
"name": "onItemsChange",
|
|
91
|
-
"description": "Called when a user modifies the size or position of board items.\nThe change detail has the following properties:\n\n* `items`: (readonly Item<D>[]) - the updated items array.\n* `addedItem`: (Item<D>, optional) - the item that was added as part of the update, if applicable.\n* `removedItem`: (Item<D>, optional) - the item that was removed as part of the update, if applicable.\n* `resizedItem`: (Item<D>, optional) - the item that was resized as part of the update, if applicable.\n* `movedItem`: (Item<D>, optional) - the item that was moved as part of the update, if applicable
|
|
106
|
+
"description": "Called when a user modifies the size or position of board items.\n\nThe change detail has the following properties:\n\n* `items`: (readonly Item<D>[]) - the updated items array.\n* `addedItem`: (Item<D>, optional) - the item that was added as part of the update, if applicable.\n* `removedItem`: (Item<D>, optional) - the item that was removed as part of the update, if applicable.\n* `resizedItem`: (Item<D>, optional) - the item that was resized as part of the update, if applicable.\n* `movedItem`: (Item<D>, optional) - the item that was moved as part of the update, if applicable.",
|
|
92
107
|
"cancelable": false,
|
|
93
108
|
"detailType": "BoardProps.ItemsChangeDetail<D>",
|
|
94
109
|
"detailInlineType": {
|
|
95
|
-
"name": "BoardProps.ItemsChangeDetail",
|
|
110
|
+
"name": "BoardProps.ItemsChangeDetail<D>",
|
|
96
111
|
"type": "object",
|
|
97
112
|
"properties": [
|
|
98
113
|
{
|
|
@@ -8,7 +8,7 @@ module.exports = {
|
|
|
8
8
|
"name": "i18nStrings",
|
|
9
9
|
"type": "ItemsPaletteProps.I18nStrings<D>",
|
|
10
10
|
"inlineType": {
|
|
11
|
-
"name": "ItemsPaletteProps.I18nStrings",
|
|
11
|
+
"name": "ItemsPaletteProps.I18nStrings<D>",
|
|
12
12
|
"type": "object",
|
|
13
13
|
"properties": [
|
|
14
14
|
{
|
|
@@ -39,19 +39,34 @@ module.exports = {
|
|
|
39
39
|
]
|
|
40
40
|
},
|
|
41
41
|
"optional": false,
|
|
42
|
-
"description": "An object containing all the necessary localized strings required by the component.\nLive announcements:\n* `liveAnnouncementDndStarted` (string) - live announcement string to indicate start of DnD.\n* `liveAnnouncementDndDiscarded` (string) - live announcement string to indicate discard of DnD
|
|
42
|
+
"description": "An object containing all the necessary localized strings required by the component.\n\nLive announcements:\n* `liveAnnouncementDndStarted` (string) - live announcement string to indicate start of DnD.\n* `liveAnnouncementDndDiscarded` (string) - live announcement string to indicate discard of DnD."
|
|
43
43
|
},
|
|
44
44
|
{
|
|
45
45
|
"name": "items",
|
|
46
46
|
"type": "ReadonlyArray<ItemsPaletteProps.Item<D>>",
|
|
47
47
|
"optional": false,
|
|
48
|
-
"description": "Specifies the items displayed in the palette. The content of each item is controlled by the `renderItem` property.\nThe ItemsPaletteProps.Item includes:\n* `id` (string) - the unique item identifier. The IDs of any two items in a page must be different.\n* `definition.minRowSpan` (number, optional) - the minimal number of rows the item is allowed to take. It can't be less than two. Defaults to two.\n* `definition.minColumnSpan` (number, optional) - the minimal number of columns the item is allowed to take (in a 4 column layout). It can't be less than one. Defaults to one.\n* `definition.defaultRowSpan` (number) - the number or rows the item will take when inserted to the board. It can't be less than `definition.minRowSpan`.\n* `definition.defaultColumnSpan` (number) - the number or columns the item will take (in a 4 column layout) when inserted to the board. It can't be less than `definition.minColumnSpan`.\n* `data` (D) - optional item data which can include the specific configurations of an item, such as its title
|
|
48
|
+
"description": "Specifies the items displayed in the palette. The content of each item is controlled by the `renderItem` property.\n\nThe ItemsPaletteProps.Item includes:\n* `id` (string) - the unique item identifier. The IDs of any two items in a page must be different.\n* `definition.minRowSpan` (number, optional) - the minimal number of rows the item is allowed to take. It can't be less than two. Defaults to two.\n* `definition.minColumnSpan` (number, optional) - the minimal number of columns the item is allowed to take (in a 4 column layout). It can't be less than one. Defaults to one.\n* `definition.defaultRowSpan` (number) - the number or rows the item will take when inserted to the board. It can't be less than `definition.minRowSpan`.\n* `definition.defaultColumnSpan` (number) - the number or columns the item will take (in a 4 column layout) when inserted to the board. It can't be less than `definition.minColumnSpan`.\n* `data` (D) - optional item data which can include the specific configurations of an item, such as its title."
|
|
49
49
|
},
|
|
50
50
|
{
|
|
51
51
|
"name": "renderItem",
|
|
52
|
-
"type": "(item: ItemsPaletteProps.Item<D>, context: ItemsPaletteProps.ItemContext) => Element",
|
|
52
|
+
"type": "(item: ItemsPaletteProps.Item<D>, context: ItemsPaletteProps.ItemContext) => JSX.Element",
|
|
53
|
+
"inlineType": {
|
|
54
|
+
"name": "(item: ItemsPaletteProps.Item<D>, context: ItemsPaletteProps.ItemContext) => JSX.Element",
|
|
55
|
+
"type": "function",
|
|
56
|
+
"returnType": "JSX.Element",
|
|
57
|
+
"parameters": [
|
|
58
|
+
{
|
|
59
|
+
"name": "item",
|
|
60
|
+
"type": "ItemsPaletteProps.Item<D>"
|
|
61
|
+
},
|
|
62
|
+
{
|
|
63
|
+
"name": "context",
|
|
64
|
+
"type": "ItemsPaletteProps.ItemContext"
|
|
65
|
+
}
|
|
66
|
+
]
|
|
67
|
+
},
|
|
53
68
|
"optional": false,
|
|
54
|
-
"description": "Specifies a function to render content for a palette item. The return value must include board item component.\nThe function takes the item and its associated context (ItemsPaletteProps.ItemContext) that include:\n* `showPreview` (boolean) - a flag that indicates if the item's content needs to be rendered in preview mode
|
|
69
|
+
"description": "Specifies a function to render content for a palette item. The return value must include board item component.\n\nThe function takes the item and its associated context (ItemsPaletteProps.ItemContext) that include:\n* `showPreview` (boolean) - a flag that indicates if the item's content needs to be rendered in preview mode."
|
|
55
70
|
}
|
|
56
71
|
],
|
|
57
72
|
"events": []
|
package/internal/environment.js
CHANGED
package/internal/manifest.json
CHANGED