@kaizen/components 1.68.7 → 1.68.9

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.
Files changed (136) hide show
  1. package/codemods/README.md +2 -1
  2. package/dist/cjs/__overlays__/Tooltip/v3/Tooltip.cjs +1 -1
  3. package/dist/esm/Calendar/CalendarPopover/CalendarPopover.mjs +1 -1
  4. package/dist/esm/EmptyState/EmptyState.mjs +1 -1
  5. package/dist/esm/Filter/FilterMultiSelect/subcomponents/ListBox/ListBox.mjs +1 -1
  6. package/dist/esm/MultiSelect/subcomponents/Popover/Popover.mjs +1 -1
  7. package/dist/esm/RichTextEditor/RichTextEditor/RichTextEditor.mjs +1 -1
  8. package/dist/esm/RichTextEditor/RichTextEditor/schema.mjs +1 -1
  9. package/dist/esm/RichTextEditor/utils/schema/nodes.mjs +1 -1
  10. package/dist/esm/TimeField/TimeField.mjs +1 -1
  11. package/dist/esm/__overlays__/Tooltip/v1/Tooltip.mjs +1 -1
  12. package/dist/esm/__overlays__/Tooltip/v3/Tooltip.mjs +1 -1
  13. package/dist/styles.css +50 -50
  14. package/dist/types/__overlays__/Tooltip/v3/Tooltip.d.ts +1 -1
  15. package/package.json +30 -30
  16. package/src/Avatar/_docs/Avatar.mdx +3 -4
  17. package/src/AvatarGroup/_docs/AvatarGroup.mdx +3 -3
  18. package/src/Badge/_docs/Badge.mdx +3 -3
  19. package/src/Brand/_docs/Brand.mdx +3 -4
  20. package/src/BrandMoment/_docs/BrandMoment.mdx +3 -3
  21. package/src/ButtonGroup/_docs/ButtonGroup.mdx +3 -3
  22. package/src/Calendar/CalendarRange/_docs/CalendarRange.mdx +3 -3
  23. package/src/Calendar/CalendarSingle/_docs/CalendarSingle.mdx +3 -3
  24. package/src/Card/_docs/Card.mdx +5 -4
  25. package/src/Checkbox/Checkbox/_docs/Checkbox.mdx +4 -5
  26. package/src/Checkbox/CheckboxField/_docs/CheckboxField.mdx +5 -3
  27. package/src/Checkbox/CheckboxGroup/_docs/CheckboxGroup.mdx +4 -3
  28. package/src/Collapsible/Collapsible/_docs/Collapsible.mdx +3 -3
  29. package/src/Collapsible/CollapsibleGroup/_docs/CollapsibleGroup.mdx +8 -7
  30. package/src/Collapsible/ExpertAdviceCollapsible/_docs/ExpertAdviceCollapsible.mdx +3 -3
  31. package/src/Container/_docs/Container.mdx +6 -4
  32. package/src/Content/_docs/Content.mdx +6 -4
  33. package/src/DatePicker/_docs/DatePicker.mdx +3 -3
  34. package/src/DateRangePicker/_docs/DateRangePicker.mdx +3 -4
  35. package/src/Divider/_docs/Divider.mdx +3 -3
  36. package/src/EmptyState/_docs/EmptyState.mdx +3 -3
  37. package/src/ErrorPage/_docs/ErrorPage.mdx +3 -3
  38. package/src/FieldGroup/_docs/FieldGroup.mdx +6 -4
  39. package/src/FieldMessage/_docs/FieldMessage.mdx +3 -4
  40. package/src/Filter/Filter/_docs/Filter.mdx +13 -14
  41. package/src/Filter/FilterBar/_docs/FilterBar.mdx +49 -48
  42. package/src/Filter/FilterButton/_docs/filter-buttons.mdx +5 -5
  43. package/src/Filter/FilterDatePicker/_docs/FilterDatePicker.mdx +8 -3
  44. package/src/Filter/FilterDateRangePicker/_docs/FilterDateRangePicker.mdx +9 -3
  45. package/src/Filter/FilterMultiSelect/_docs/FilterMultiSelect.mdx +90 -39
  46. package/src/Filter/FilterMultiSelect/subcomponents/MultiSelectOption/MultiSelectOption.spec.tsx +1 -0
  47. package/src/Filter/FilterSelect/_docs/FilterSelect.mdx +4 -4
  48. package/src/GuidanceBlock/_docs/GuidanceBlock.mdx +3 -3
  49. package/src/Heading/_docs/Heading.mdx +4 -4
  50. package/src/Icon/_docs/Icon.mdx +5 -7
  51. package/src/Illustration/Scene/BrandMomentCaptureIntro/_docs/BrandMomentCaptureIntro.mdx +10 -3
  52. package/src/Illustration/Scene/_docs/Scene.mdx +5 -8
  53. package/src/Illustration/Spot/_docs/Spot.mdx +4 -4
  54. package/src/Input/Input/_docs/Input.mdx +8 -4
  55. package/src/Input/InputRange/_docs/InputRange.mdx +3 -3
  56. package/src/Input/InputSearch/_docs/InputSearch.mdx +4 -3
  57. package/src/KaizenProvider/_docs/KaizenProvider.mdx +9 -9
  58. package/src/KaizenProvider/_docs/internationalization-in-kaizen.mdx +10 -11
  59. package/src/Label/_docs/Label.mdx +9 -3
  60. package/src/LabelledMessage/_docs/LabelledMessage.mdx +3 -3
  61. package/src/LikertScaleLegacy/_docs/LikertScaleLegacy.mdx +3 -3
  62. package/src/Loading/LoadingGraphic/_docs/LoadingGraphic.mdx +5 -5
  63. package/src/Loading/LoadingHeading/_docs/LoadingHeading.mdx +3 -3
  64. package/src/Loading/LoadingInput/_docs/LoadingInput.mdx +3 -3
  65. package/src/Loading/LoadingParagraph/_docs/LoadingParagraph.mdx +3 -3
  66. package/src/Loading/LoadingSpinner/_docs/LoadingSpinner.mdx +3 -4
  67. package/src/Modal/ConfirmationModal/_docs/ConfirmationModal.mdx +3 -3
  68. package/src/Modal/ContextModal/_docs/ContextModal.mdx +6 -3
  69. package/src/Modal/GenericModal/_docs/GenericModal.mdx +5 -4
  70. package/src/Modal/InputEditModal/_docs/InputEditModal.mdx +3 -4
  71. package/src/MultiSelect/_docs/MultiSelect.mdx +3 -4
  72. package/src/Notification/GlobalNotification/_docs/GlobalNotification.mdx +3 -3
  73. package/src/Notification/InlineNotification/_docs/InlineNotification.mdx +3 -4
  74. package/src/Notification/ToastNotification/_docs/ToastNotification.mdx +3 -3
  75. package/src/Pagination/_docs/Pagination.mdx +3 -3
  76. package/src/Pagination/subcomponents/DirectionalLink/_docs/DirectionalLink.mdx +3 -3
  77. package/src/Pagination/subcomponents/PaginationLink/_docs/PaginationLink.mdx +3 -3
  78. package/src/Popover/_docs/Popover.mdx +12 -10
  79. package/src/ProgressBar/_docs/ProgressBar.mdx +3 -4
  80. package/src/Radio/Radio/_docs/Radio.mdx +4 -4
  81. package/src/Radio/RadioField/_docs/RadioField.mdx +3 -3
  82. package/src/Radio/RadioGroup/_docs/RadioGroup.mdx +3 -3
  83. package/src/RichTextEditor/EditableRichTextContent/_docs/EditableRichTextContent.mdx +7 -10
  84. package/src/RichTextEditor/RichTextContent/_docs/RichTextContent.mdx +3 -5
  85. package/src/RichTextEditor/RichTextEditor/_docs/RichTextEditor.mdx +7 -9
  86. package/src/RichTextEditor/RichTextEditor/subcomponents/ToggleIconButton/_docs/ToggleIconButton.mdx +3 -3
  87. package/src/RichTextEditor/RichTextEditor/subcomponents/Toolbar/_docs/Toolbar.mdx +3 -3
  88. package/src/SearchField/_docs/SearchField.mdx +3 -3
  89. package/src/Select/_docs/Select.mdx +7 -3
  90. package/src/Skirt/_docs/Skirt.mdx +4 -4
  91. package/src/Slider/_docs/Slider.mdx +3 -3
  92. package/src/SplitButton/_docs/SplitButton.mdx +4 -3
  93. package/src/Table/_docs/Table.mdx +19 -6
  94. package/src/Tabs/_docs/Tabs.mdx +4 -7
  95. package/src/Tag/_docs/Tag.mdx +16 -5
  96. package/src/Text/_docs/Text.mdx +3 -3
  97. package/src/TextArea/_docs/TextArea.mdx +5 -4
  98. package/src/TextAreaField/_docs/TextAreaField.mdx +9 -4
  99. package/src/TextField/_docs/TextField.mdx +9 -4
  100. package/src/Tile/InformationTile/_docs/InformationTile.mdx +5 -4
  101. package/src/Tile/MultiActionTile/_docs/MultiActionTile.mdx +5 -3
  102. package/src/Tile/TileGrid/_docs/TileGrid.mdx +3 -3
  103. package/src/TimeField/_docs/TimeField.mdx +3 -3
  104. package/src/TitleBlockZen/_docs/TitleBlockZen.mdx +5 -3
  105. package/src/ToggleSwitch/ToggleSwitch/_docs/ToggleSwitch.mdx +3 -3
  106. package/src/ToggleSwitch/ToggleSwitchField/_docs/ToggleSwitchField.mdx +3 -3
  107. package/src/VisuallyHidden/_docs/VisuallyHidden.mdx +6 -4
  108. package/src/Well/_docs/Well.mdx +5 -5
  109. package/src/Workflow/_docs/ProgressStepper.mdx +3 -3
  110. package/src/Workflow/_docs/Workflow.mdx +25 -19
  111. package/src/Workflow/_docs/WorkflowFooter.mdx +3 -3
  112. package/src/Workflow/_docs/WorkflowHeader.mdx +3 -3
  113. package/src/__actions__/Button/v1/Button/_docs/Button.mdx +4 -4
  114. package/src/__actions__/Button/v1/IconButton/_docs/IconButton.mdx +3 -3
  115. package/src/__actions__/Button/v2/Button/_docs/Button.mdx +4 -4
  116. package/src/__actions__/Button/v2/IconButton/_docs/IconButton.mdx +3 -3
  117. package/src/__actions__/Button/v3/_docs/Button--api-specification.mdx +49 -17
  118. package/src/__actions__/Button/v3/_docs/Button--usage-guidelines.mdx +8 -6
  119. package/src/__actions__/Menu/v1/_docs/Menu.mdx +3 -4
  120. package/src/__actions__/Menu/v2/_docs/Menu.mdx +8 -4
  121. package/src/__actions__/Menu/v3/_docs/ApiSpecification.mdx +35 -24
  122. package/src/__actions__/Menu/v3/_docs/Menu.mdx +52 -39
  123. package/src/__future__/Icon/_docs/Icon--api-specification.mdx +17 -10
  124. package/src/__future__/Icon/_docs/Icon--usage-guidelines.mdx +5 -4
  125. package/src/__future__/Select/_docs/Select.mdx +9 -5
  126. package/src/__future__/Tabs/_docs/Tabs--api-specification.mdx +4 -8
  127. package/src/__future__/Tabs/_docs/Tabs--migration-guide.mdx +11 -4
  128. package/src/__future__/Tag/RemovableTag/_docs/RemovableTag.mdx +4 -6
  129. package/src/__future__/Tag/Tag/_docs/Tag-migration-guide.mdx +12 -20
  130. package/src/__future__/Tag/Tag/_docs/Tag.mdx +3 -4
  131. package/src/__overlays__/Focusable/v3/_docs/ApiSpecification.mdx +14 -13
  132. package/src/__overlays__/Tooltip/v1/_docs/Tooltip.mdx +5 -7
  133. package/src/__overlays__/Tooltip/v2/_docs/Tooltip.mdx +5 -6
  134. package/src/__overlays__/Tooltip/v3/Tooltip.tsx +3 -2
  135. package/src/__overlays__/Tooltip/v3/_docs/ApiSpecification.mdx +50 -46
  136. package/src/__overlays__/Tooltip/v3/_docs/Tooltip.mdx +63 -48
@@ -1,7 +1,7 @@
1
- import { Canvas, Controls , Meta, Unstyled } from "@storybook/blocks"
2
- import { InlineNotification } from "~components/Notification"
3
- import { ResourceLinks, KAIOInstallation } from "~storybook/components"
4
- import * as TagStories from "./Tag.stories"
1
+ import { Canvas, Controls, Meta, Unstyled } from '@storybook/blocks'
2
+ import { InlineNotification } from '~components/Notification'
3
+ import { ResourceLinks, KAIOInstallation } from '~storybook/components'
4
+ import * as TagStories from './Tag.stories'
5
5
 
6
6
  <Meta of={TagStories} />
7
7
 
@@ -17,7 +17,7 @@ import * as TagStories from "./Tag.stories"
17
17
  <Unstyled>
18
18
  <InlineNotification type="cautionary" persistent>
19
19
  {`This version of the Tag will soon be deprecated and will be removed in the next major release.
20
- Import Tag from "@kaizen/components/future" for the latest version and veiw our migration guide in the Future folder` }
20
+ Import Tag from "@kaizen/components/future" for the latest version and veiw our migration guide in the Future folder`}
21
21
  </InlineNotification>
22
22
  </Unstyled>
23
23
 
@@ -33,48 +33,59 @@ Tags help users quickly recognize important information about items that organiz
33
33
  ## API
34
34
 
35
35
  ### Variants
36
+
36
37
  We have 3 different sets of combinations for various uses.
37
38
 
38
39
  #### Status
40
+
39
41
  Use status tags to show the status of surveys, reports, action plans, and performance feedback.
40
42
 
41
43
  <Canvas of={TagStories.Status} />
42
44
 
43
45
  #### Validation
46
+
44
47
  Use validation tags for indicating the validation state such as the Cautionary style for cautioning users that the item has a validation warning that could be addressed.
45
48
 
46
49
  <Canvas of={TagStories.Validation} />
47
50
 
48
51
  #### Sentiments
52
+
49
53
  Use sentiment tags only for sentiment or other employee feedback data.
50
54
 
51
55
  <Canvas of={TagStories.Sentiments} />
52
56
 
53
57
  ### Sizes
58
+
54
59
  **Note:** Icons and Avatars are not supported in `small` sizes.
55
60
 
56
61
  <Canvas of={TagStories.Sizes} />
57
62
 
58
63
  ### Avatar
64
+
59
65
  An Avatar can be added in two ways, either by importing the `<Avatar />` component and passing it in, or you can use the Avatar's props.
60
66
 
61
67
  **Note:** Avatar are not supported in `small` sizes.
62
68
 
63
69
  #### Import Avatar
70
+
64
71
  <Canvas of={TagStories.ProfileWithAvatarImport} />
65
72
 
66
73
  #### Avatar props
74
+
67
75
  <Canvas of={TagStories.ProfileWithAvatarProps} />
68
76
 
69
77
  ### Dismissable
78
+
70
79
  <Canvas of={TagStories.Dismissible} />
71
80
 
72
81
  ### TruncateWidth
82
+
73
83
  A pixel width which sets a limit for when the text starts to truncate.
74
84
 
75
85
  <Canvas of={TagStories.Truncate} />
76
86
 
77
87
  ### Inline
88
+
78
89
  Removes the default right-hand margin.
79
90
 
80
91
  <Canvas of={TagStories.Inline} />
@@ -1,6 +1,6 @@
1
- import { Canvas, Controls, Meta } from "@storybook/blocks"
2
- import { ResourceLinks, KAIOInstallation } from "~storybook/components"
3
- import * as TextStories from "./Text.stories"
1
+ import { Canvas, Controls, Meta } from '@storybook/blocks'
2
+ import { ResourceLinks, KAIOInstallation } from '~storybook/components'
3
+ import * as TextStories from './Text.stories'
4
4
 
5
5
  <Meta of={TextStories} />
6
6
 
@@ -1,7 +1,7 @@
1
- import { Canvas, Controls, Meta } from "@storybook/blocks"
2
- import { ResourceLinks, KAIOInstallation } from "~storybook/components"
3
- import { LinkTo } from "~storybook/components/LinkTo"
4
- import * as TextAreaStories from "./TextArea.stories"
1
+ import { Canvas, Controls, Meta } from '@storybook/blocks'
2
+ import { ResourceLinks, KAIOInstallation } from '~storybook/components'
3
+ import { LinkTo } from '~storybook/components/LinkTo'
4
+ import * as TextAreaStories from './TextArea.stories'
5
5
 
6
6
  <Meta of={TextAreaStories} />
7
7
 
@@ -37,6 +37,7 @@ You can use our <LinkTo pageId="components-label">Label</LinkTo> component
37
37
  ```
38
38
 
39
39
  ### Connecting a custom element
40
+
40
41
  For linking text that isn't in a `Label` you can use `aria-labelledBy`
41
42
 
42
43
  ```
@@ -1,6 +1,6 @@
1
- import { Canvas, Controls, Meta } from "@storybook/blocks"
2
- import { ResourceLinks, KAIOInstallation } from "~storybook/components"
3
- import * as TextAreaFieldStories from "./TextAreaField.stories"
1
+ import { Canvas, Controls, Meta } from '@storybook/blocks'
2
+ import { ResourceLinks, KAIOInstallation } from '~storybook/components'
3
+ import * as TextAreaFieldStories from './TextAreaField.stories'
4
4
 
5
5
  <Meta of={TextAreaFieldStories} />
6
6
 
@@ -25,18 +25,23 @@ A text area includes a label and a longer area you can type multiple lines of te
25
25
  ## API
26
26
 
27
27
  ### Variant
28
+
28
29
  <Canvas of={TextAreaFieldStories.Variant} />
29
30
 
30
31
  ### Autogrow
31
- Autogrow expands the textarea as the user's typing exceeds the minimum height of the text area.
32
+
33
+ Autogrow expands the textarea as the user's typing exceeds the minimum height of the text area.
32
34
 
33
35
  <Canvas of={TextAreaFieldStories.Autogrow} />
34
36
 
35
37
  ### Description
38
+
36
39
  <Canvas of={TextAreaFieldStories.Description} />
37
40
 
38
41
  ### Validation
42
+
39
43
  <Canvas of={TextAreaFieldStories.Validation} />
40
44
 
41
45
  ### Reversed
46
+
42
47
  <Canvas of={TextAreaFieldStories.Reversed} />
@@ -1,7 +1,7 @@
1
- import { Canvas, Controls, Meta } from "@storybook/blocks"
2
- import { ResourceLinks, KAIOInstallation } from "~storybook/components"
3
- import { LinkTo } from "~storybook/components/LinkTo"
4
- import * as TextFieldStories from "./TextField.stories"
1
+ import { Canvas, Controls, Meta } from '@storybook/blocks'
2
+ import { ResourceLinks, KAIOInstallation } from '~storybook/components'
3
+ import { LinkTo } from '~storybook/components/LinkTo'
4
+ import * as TextFieldStories from './TextField.stories'
5
5
 
6
6
  <Meta of={TextFieldStories} />
7
7
 
@@ -28,16 +28,21 @@ Composed of <LinkTo pageId="components-label">Label</LinkTo>, <LinkTo pageId="co
28
28
  ## API
29
29
 
30
30
  ### Types
31
+
31
32
  <Canvas of={TextFieldStories.Types} />
32
33
 
33
34
  ### Description
35
+
34
36
  <Canvas of={TextFieldStories.Description} />
35
37
 
36
38
  ### Icon
39
+
37
40
  <Canvas of={TextFieldStories.IconStory} />
38
41
 
39
42
  ### Validation
43
+
40
44
  <Canvas of={TextFieldStories.Validation} />
41
45
 
42
46
  ### Reversed
47
+
43
48
  <Canvas of={TextFieldStories.Reversed} />
@@ -1,6 +1,6 @@
1
- import { Canvas, Controls, Meta } from "@storybook/blocks"
2
- import { ResourceLinks, KAIOInstallation } from "~storybook/components"
3
- import * as InformationTileStories from "./InformationTile.stories"
1
+ import { Canvas, Controls, Meta } from '@storybook/blocks'
2
+ import { ResourceLinks, KAIOInstallation } from '~storybook/components'
3
+ import * as InformationTileStories from './InformationTile.stories'
4
4
 
5
5
  <Meta of={InformationTileStories} />
6
6
 
@@ -29,8 +29,9 @@ A visually interesting item in a list consisting of a card, visual, title, metad
29
29
  <Canvas of={InformationTileStories.Variants} />
30
30
 
31
31
  ### Information
32
- <Canvas of={InformationTileStories.Information} />
33
32
 
33
+ <Canvas of={InformationTileStories.Information} />
34
34
 
35
35
  ### Information Button Label
36
+
36
37
  <Canvas of={InformationTileStories.TileWithCustomInfoLabel} />
@@ -1,6 +1,6 @@
1
- import { Canvas, Controls, Meta } from "@storybook/blocks"
2
- import { ResourceLinks, KAIOInstallation } from "~storybook/components"
3
- import * as MultiActionTileStories from "./MultiActionTile.stories"
1
+ import { Canvas, Controls, Meta } from '@storybook/blocks'
2
+ import { ResourceLinks, KAIOInstallation } from '~storybook/components'
3
+ import * as MultiActionTileStories from './MultiActionTile.stories'
4
4
 
5
5
  <Meta of={MultiActionTileStories} />
6
6
 
@@ -29,7 +29,9 @@ A visually interesting item in a list consisting of a card, visual, title, metad
29
29
  <Canvas of={MultiActionTileStories.Variants} />
30
30
 
31
31
  ### Secondary Action
32
+
32
33
  <Canvas of={MultiActionTileStories.SecondaryAction} />
33
34
 
34
35
  ### Information
36
+
35
37
  <Canvas of={MultiActionTileStories.Information} />
@@ -1,6 +1,6 @@
1
- import { Canvas, Controls, Meta } from "@storybook/blocks"
2
- import { ResourceLinks, KAIOInstallation } from "~storybook/components"
3
- import * as TileGridStories from "./TileGrid.stories"
1
+ import { Canvas, Controls, Meta } from '@storybook/blocks'
2
+ import { ResourceLinks, KAIOInstallation } from '~storybook/components'
3
+ import * as TileGridStories from './TileGrid.stories'
4
4
 
5
5
  <Meta of={TileGridStories} />
6
6
 
@@ -1,6 +1,6 @@
1
- import { Canvas, Controls, Meta } from "@storybook/blocks"
2
- import { ResourceLinks, KAIOInstallation } from "~storybook/components"
3
- import * as TimeFieldStories from "./TimeField.stories"
1
+ import { Canvas, Controls, Meta } from '@storybook/blocks'
2
+ import { ResourceLinks, KAIOInstallation } from '~storybook/components'
3
+ import * as TimeFieldStories from './TimeField.stories'
4
4
 
5
5
  <Meta of={TimeFieldStories} />
6
6
 
@@ -1,6 +1,6 @@
1
- import { Canvas, Meta } from "@storybook/blocks"
2
- import { ResourceLinks, KAIOInstallation } from "~storybook/components"
3
- import * as TitleBlockZenStories from "./TitleBlockZen.stories"
1
+ import { Canvas, Meta } from '@storybook/blocks'
2
+ import { ResourceLinks, KAIOInstallation } from '~storybook/components'
3
+ import * as TitleBlockZenStories from './TitleBlockZen.stories'
4
4
 
5
5
  <Meta of={TitleBlockZenStories} />
6
6
 
@@ -48,6 +48,7 @@ in the dropdown menu when you click it. (`MenuItemProps` is a type imported from
48
48
  ## secondaryActions & secondaryOverflowMenuItems
49
49
 
50
50
  Secondary Actions sit below the Primary Actions, and consist of
51
+
51
52
  - actions/links (just a button),
52
53
  - menus (a menu button), and
53
54
  - the overflow menu (a menu button with a "meatballs" icon).
@@ -70,5 +71,6 @@ Each object can be a MenuGroup (see code snippet for `primaryAction` above) or a
70
71
  ```
71
72
  type SecondaryActionsProps = Array<MenuGroup | TitleBlockButtonProps>;
72
73
  ```
74
+
73
75
  The order of elements in the array will determine the visual order on the page, so
74
76
  please be aware of the intended order mentioned above.
@@ -1,6 +1,6 @@
1
- import { Canvas, Controls, DocsStory, Meta } from "@storybook/blocks"
2
- import { ResourceLinks, KAIOInstallation, LinkTo } from "~storybook/components"
3
- import * as ToggleSwitchStories from "./ToggleSwitch.stories"
1
+ import { Canvas, Controls, DocsStory, Meta } from '@storybook/blocks'
2
+ import { ResourceLinks, KAIOInstallation, LinkTo } from '~storybook/components'
3
+ import * as ToggleSwitchStories from './ToggleSwitch.stories'
4
4
 
5
5
  <Meta of={ToggleSwitchStories} />
6
6
 
@@ -1,6 +1,6 @@
1
- import { Canvas, Controls, DocsStory, Meta } from "@storybook/blocks"
2
- import { ResourceLinks, KAIOInstallation } from "~storybook/components"
3
- import * as ToggleSwitchFieldStories from "./ToggleSwitchField.stories"
1
+ import { Canvas, Controls, DocsStory, Meta } from '@storybook/blocks'
2
+ import { ResourceLinks, KAIOInstallation } from '~storybook/components'
3
+ import * as ToggleSwitchFieldStories from './ToggleSwitchField.stories'
4
4
 
5
5
  <Meta of={ToggleSwitchFieldStories} />
6
6
 
@@ -1,6 +1,6 @@
1
- import { Canvas, Controls, Meta } from "@storybook/blocks"
2
- import { ResourceLinks, KAIOInstallation } from "~storybook/components"
3
- import * as VisuallyHiddenStories from "./VisuallyHidden.stories"
1
+ import { Canvas, Controls, Meta } from '@storybook/blocks'
2
+ import { ResourceLinks, KAIOInstallation } from '~storybook/components'
3
+ import * as VisuallyHiddenStories from './VisuallyHidden.stories'
4
4
 
5
5
  <Meta of={VisuallyHiddenStories} />
6
6
 
@@ -31,5 +31,7 @@ Visual users can see the name of the survey to the left of the link, but screen
31
31
  The context can be added like so:
32
32
 
33
33
  ```jsx
34
- <a href="/path">View report<VisuallyHidden> for Camper Check-in 2023</VisuallyHidden></a>
34
+ <a href="/path">
35
+ View report<VisuallyHidden> for Camper Check-in 2023</VisuallyHidden>
36
+ </a>
35
37
  ```
@@ -1,6 +1,6 @@
1
- import { Canvas, Controls, Meta } from "@storybook/blocks"
2
- import { ResourceLinks, KAIOInstallation } from "~storybook/components"
3
- import * as WellStories from "./Well.stories"
1
+ import { Canvas, Controls, Meta } from '@storybook/blocks'
2
+ import { ResourceLinks, KAIOInstallation } from '~storybook/components'
3
+ import * as WellStories from './Well.stories'
4
4
 
5
5
  <Meta of={WellStories} />
6
6
 
@@ -32,10 +32,10 @@ All `variant`s have a corresponding `color` value, with some minor update to ens
32
32
 
33
33
  <Canvas of={WellStories.Colors} />
34
34
 
35
-
36
35
  ### Border Styles
36
+
37
37
  <Canvas of={WellStories.BorderStyles} />
38
38
 
39
39
  ### No Margin
40
- <Canvas of={WellStories.NoMargin} />
41
40
 
41
+ <Canvas of={WellStories.NoMargin} />
@@ -1,6 +1,6 @@
1
- import { Canvas, Controls, DocsStory, Meta } from "@storybook/blocks"
2
- import { Installation, ResourceLinks } from "~storybook/components"
3
- import * as ProgressStepperStories from "./ProgressStepper.stories"
1
+ import { Canvas, Controls, DocsStory, Meta } from '@storybook/blocks'
2
+ import { Installation, ResourceLinks } from '~storybook/components'
3
+ import * as ProgressStepperStories from './ProgressStepper.stories'
4
4
 
5
5
  <Meta of={ProgressStepperStories} />
6
6
 
@@ -1,8 +1,8 @@
1
- import { ArgTypes, Canvas, Meta } from "@storybook/blocks"
2
- import { Installation, ResourceLinks } from "~storybook/components"
3
- import * as Workflow from "./Workflow.stories"
4
- import * as WorkflowFooter from "./WorkflowFooter.stories"
5
- import * as WorkflowHeader from "./WorkflowHeader.stories"
1
+ import { ArgTypes, Canvas, Meta } from '@storybook/blocks'
2
+ import { Installation, ResourceLinks } from '~storybook/components'
3
+ import * as Workflow from './Workflow.stories'
4
+ import * as WorkflowFooter from './WorkflowFooter.stories'
5
+ import * as WorkflowHeader from './WorkflowHeader.stories'
6
6
 
7
7
  <Meta of={Workflow} />
8
8
 
@@ -30,14 +30,15 @@ To ensure at readability at 400% zoom (See WCAG's [Reflow criteria](https://www.
30
30
 
31
31
  ## Header actions
32
32
 
33
- The `headerActions` prop takes array of JSX elements that will render in the top right of the `Header` component.
33
+ The `headerActions` prop takes array of JSX elements that will render in the top right of the `Header` component.
34
34
 
35
35
  While the number of JSX elements is not limited, is important to consider the real estate in the `Header` and how larger strings or components may be rendered on smaller screen sizes.
36
36
 
37
37
  <Canvas
38
38
  layout="fullscreen"
39
39
  of={WorkflowHeader.MultipleActions}
40
- source={{code: `<Workflow
40
+ source={{
41
+ code: `<Workflow
41
42
  headerActions={[
42
43
  <Button
43
44
  key="would-use-uui-1"
@@ -57,10 +58,10 @@ While the number of JSX elements is not limited, is important to consider the re
57
58
  {...otherProps}
58
59
  >
59
60
  <MockContent />
60
- </Workflow>`}}
61
+ </Workflow>`,
62
+ }}
61
63
  />
62
64
 
63
-
64
65
  ## Handling a Workflow exit
65
66
 
66
67
  A common pattern identified is a Workflow Exit button. An implementation of this component should be passed to the `headerActions` an array to handle a user leaving a Workflow. We've provided an example below that combines a Kaizen `Button` with the `ConfirmationModal` component.
@@ -68,7 +69,8 @@ A common pattern identified is a Workflow Exit button. An implementation of this
68
69
  <Canvas
69
70
  layout="fullscreen"
70
71
  of={WorkflowHeader.Playground}
71
- source={{code: `
72
+ source={{
73
+ code: `
72
74
  const [showModal, setShowModal] = useState<boolean>(false)
73
75
  ...
74
76
  return (
@@ -97,7 +99,7 @@ A common pattern identified is a Workflow Exit button. An implementation of this
97
99
  </div>
98
100
  </ConfirmationModal>
99
101
  </>
100
- )`
102
+ )`,
101
103
  }}
102
104
  />
103
105
 
@@ -108,7 +110,8 @@ The Footer tracks the progress of the form by using finding the index of the `cu
108
110
  <Canvas
109
111
  layout="fullscreen"
110
112
  of={WorkflowFooter.FirstStep}
111
- source={{code: `<Workflow
113
+ source={{
114
+ code: `<Workflow
112
115
  currentStepId="settings-step"
113
116
  steps={[
114
117
  { label: "Settings", id: "settings-step" },
@@ -120,24 +123,26 @@ The Footer tracks the progress of the form by using finding the index of the `cu
120
123
  {...otherProps}
121
124
  >
122
125
  <MockContent />
123
- </Workflow>`}}
126
+ </Workflow>`,
127
+ }}
124
128
  />
125
129
 
126
130
  The Footer is agnostic to the JSX elements that are used in the `previousAction` and `nextAction`. While we recommend using the Kaizen Button, a button-like component can be used in its place to satisfy project-specific requirements.
127
131
 
128
-
129
132
  To hide, disable or change the appearance of the Footer buttons you can leverage the props available for the `@kaizen/button` or pass in undefined to not render the component.
130
133
 
131
134
  <Canvas
132
135
  layout="fullscreen"
133
136
  of={WorkflowFooter.LastStep}
134
- source={{code: `<Workflow
137
+ source={{
138
+ code: `<Workflow
135
139
  nextAction={<Button disabled label="Finish" primary />}
136
140
  previousAction={<Button label="Back" />}
137
141
  {...otherProps}
138
142
  >
139
143
  <MockContent />
140
- </Workflow>`}}
144
+ </Workflow>`,
145
+ }}
141
146
  />
142
147
 
143
148
  In Instances where users are returning to a completed workflow you can pass the `isComplete` prop to set the indicators to their "complete" status. This will also be reflected in their Aria title.
@@ -145,12 +150,14 @@ In Instances where users are returning to a completed workflow you can pass the
145
150
  <Canvas
146
151
  layout="fullscreen"
147
152
  of={WorkflowFooter.AllStepsComplete}
148
- source={{code: `<Workflow
153
+ source={{
154
+ code: `<Workflow
149
155
  isComplete
150
156
  {...otherProps}
151
157
  >
152
158
  <MockContent />
153
- </Workflow>`}}
159
+ </Workflow>`,
160
+ }}
154
161
  />
155
162
 
156
163
  ## Composable Worflow
@@ -159,7 +166,6 @@ While we do not advise this path, a composable Workflow may be created if requir
159
166
 
160
167
  <Canvas layout="fullscreen" of={Workflow.ComposableWorkflow} />
161
168
 
162
-
163
169
  ## Worflow API at a glance
164
170
 
165
171
  <ArgTypes of={Workflow.Playground} />
@@ -1,6 +1,6 @@
1
- import { Canvas, Controls, DocsStory, Meta } from "@storybook/blocks"
2
- import { Installation, ResourceLinks } from "~storybook/components"
3
- import * as WorkflowFooterStories from "./WorkflowFooter.stories"
1
+ import { Canvas, Controls, DocsStory, Meta } from '@storybook/blocks'
2
+ import { Installation, ResourceLinks } from '~storybook/components'
3
+ import * as WorkflowFooterStories from './WorkflowFooter.stories'
4
4
 
5
5
  <Meta of={WorkflowFooterStories} />
6
6
 
@@ -1,6 +1,6 @@
1
- import { Canvas, Controls, DocsStory, Meta } from "@storybook/blocks"
2
- import { Installation, ResourceLinks } from "~storybook/components"
3
- import * as WorkflowHeaderStories from "./WorkflowHeader.stories"
1
+ import { Canvas, Controls, DocsStory, Meta } from '@storybook/blocks'
2
+ import { Installation, ResourceLinks } from '~storybook/components'
3
+ import * as WorkflowHeaderStories from './WorkflowHeader.stories'
4
4
 
5
5
  <Meta of={WorkflowHeaderStories} />
6
6
 
@@ -1,6 +1,6 @@
1
- import { Canvas, Controls, Meta } from "@storybook/blocks"
2
- import { ResourceLinks, KAIOInstallation, LinkTo } from "~storybook/components"
3
- import * as ButtonStories from "./Button.stories"
1
+ import { Canvas, Controls, Meta } from '@storybook/blocks'
2
+ import { ResourceLinks, KAIOInstallation, LinkTo } from '~storybook/components'
3
+ import * as ButtonStories from './Button.stories'
4
4
 
5
5
  <Meta of={ButtonStories} />
6
6
 
@@ -13,7 +13,6 @@ import * as ButtonStories from "./Button.stories"
13
13
 
14
14
  />
15
15
 
16
-
17
16
  <KAIOInstallation exportNames="Button" family="actions" version="1" />
18
17
 
19
18
  ## Overview
@@ -79,6 +78,7 @@ Alternatively use the `workingLabelHidden` prop to hide the button label all tog
79
78
  <Canvas of={ButtonStories.Working} />
80
79
 
81
80
  ### Controlling the working state
81
+
82
82
  Here is an example of controlling whether the button is 'working' or not, using state.
83
83
 
84
84
  <Canvas of={ButtonStories.ResolveWorking} />
@@ -1,6 +1,6 @@
1
- import { Canvas, Controls, Meta } from "@storybook/blocks"
2
- import { ResourceLinks, KAIOInstallation, LinkTo } from "~storybook/components"
3
- import * as IconButtonStories from "./IconButton.stories"
1
+ import { Canvas, Controls, Meta } from '@storybook/blocks'
2
+ import { ResourceLinks, KAIOInstallation, LinkTo } from '~storybook/components'
3
+ import * as IconButtonStories from './IconButton.stories'
4
4
 
5
5
  <Meta of={IconButtonStories} />
6
6
 
@@ -1,6 +1,6 @@
1
- import { Canvas, Controls, Meta } from "@storybook/blocks"
2
- import { ResourceLinks, KAIOInstallation, LinkTo } from "~storybook/components"
3
- import * as ButtonStories from "./Button.stories"
1
+ import { Canvas, Controls, Meta } from '@storybook/blocks'
2
+ import { ResourceLinks, KAIOInstallation, LinkTo } from '~storybook/components'
3
+ import * as ButtonStories from './Button.stories'
4
4
 
5
5
  <Meta of={ButtonStories} />
6
6
 
@@ -13,7 +13,6 @@ import * as ButtonStories from "./Button.stories"
13
13
 
14
14
  />
15
15
 
16
-
17
16
  <KAIOInstallation exportNames="Button" family="actions" version="2" />
18
17
 
19
18
  ## Overview
@@ -79,6 +78,7 @@ Alternatively use the `workingLabelHidden` prop to hide the button label all tog
79
78
  <Canvas of={ButtonStories.Working} />
80
79
 
81
80
  ### Controlling the working state
81
+
82
82
  Here is an example of controlling whether the button is 'working' or not, using state.
83
83
 
84
84
  <Canvas of={ButtonStories.ResolveWorking} />
@@ -1,6 +1,6 @@
1
- import { Canvas, Controls, Meta } from "@storybook/blocks"
2
- import { ResourceLinks, KAIOInstallation, LinkTo } from "~storybook/components"
3
- import * as IconButtonStories from "./IconButton.stories"
1
+ import { Canvas, Controls, Meta } from '@storybook/blocks'
2
+ import { ResourceLinks, KAIOInstallation, LinkTo } from '~storybook/components'
3
+ import * as IconButtonStories from './IconButton.stories'
4
4
 
5
5
  <Meta of={IconButtonStories} />
6
6