@carbon/ibm-products 2.1.1 → 2.1.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (153) hide show
  1. package/css/index-full-carbon.css +586 -191
  2. package/css/index-full-carbon.css.map +1 -1
  3. package/css/index-full-carbon.min.css +3 -3
  4. package/css/index-full-carbon.min.css.map +1 -1
  5. package/css/index-without-carbon-released-only.css +157 -1
  6. package/css/index-without-carbon-released-only.css.map +1 -1
  7. package/css/index-without-carbon-released-only.min.css +2 -2
  8. package/css/index-without-carbon-released-only.min.css.map +1 -1
  9. package/css/index-without-carbon.css +344 -20
  10. package/css/index-without-carbon.css.map +1 -1
  11. package/css/index-without-carbon.min.css +3 -3
  12. package/css/index-without-carbon.min.css.map +1 -1
  13. package/css/index.css +248 -95
  14. package/css/index.css.map +1 -1
  15. package/css/index.min.css +3 -3
  16. package/css/index.min.css.map +1 -1
  17. package/es/components/APIKeyModal/APIKeyModal.docs-page.js +26 -0
  18. package/es/components/AboutModal/AboutModal.docs-page.js +21 -0
  19. package/es/components/AboutModal/AboutModal.js +1 -1
  20. package/es/components/BreadcrumbWithOverflow/BreadcrumbWithOverflow.js +3 -0
  21. package/es/components/Cascade/Cascade.docs-page.js +22 -0
  22. package/es/components/Cascade/Cascade.js +11 -1
  23. package/es/components/CreateFullPage/CreateFullPage.docs-page.js +39 -0
  24. package/es/components/CreateFullPage/CreateFullPage.js +13 -0
  25. package/es/components/CreateModal/CreateModal.docs-page.js +24 -0
  26. package/es/components/CreateModal/CreateModal.js +7 -0
  27. package/es/components/CreateSidePanel/CreateSidePanel.docs-page.js +18 -0
  28. package/es/components/CreateSidePanel/CreateSidePanel.js +1 -1
  29. package/es/components/CreateTearsheet/CreateTearsheet.docs-page.js +29 -0
  30. package/es/components/DataSpreadsheet/DataSpreadsheet.js +3 -3
  31. package/es/components/Datagrid/Datagrid/DatagridContent.js +1 -1
  32. package/es/components/Datagrid/Datagrid/DatagridSelectAllWithToggle.js +3 -3
  33. package/es/components/Datagrid/Datagrid/DatagridToolbar.js +3 -2
  34. package/es/components/Datagrid/Datagrid/addons/CustomizeColumns/TearsheetWrapper.js +1 -1
  35. package/es/components/Datagrid/Datagrid/addons/Filtering/FilterFlyout.js +5 -11
  36. package/es/components/Datagrid/Datagrid/addons/InlineEdit/InlineEditCell/InlineEditCell.js +12 -10
  37. package/es/components/Datagrid/Datagrid/addons/InlineEdit/handleGridKeyPress.js +2 -2
  38. package/es/components/Datagrid/utils/DatagridActions.js +6 -14
  39. package/es/components/EditFullPage/EditFullPage.docs-page.js +39 -0
  40. package/es/components/EditFullPage/EditFullPage.js +2 -1
  41. package/es/components/EditSidePanel/EditSidePanel.js +1 -1
  42. package/es/components/EditTearsheet/EditTearsheet.docs-page.js +25 -0
  43. package/es/components/EditTearsheet/EditTearsheet.js +4 -0
  44. package/es/components/EditTearsheetNarrow/EditTearsheetNarrow.js +1 -1
  45. package/es/components/EditUpdateCards/EditUpdateCards.js +3 -2
  46. package/es/components/EmptyStates/EmptyState.js +4 -0
  47. package/es/components/EmptyStates/ErrorEmptyState/ErrorEmptyState.js +4 -0
  48. package/es/components/EmptyStates/NoDataEmptyState/NoDataEmptyState.js +4 -0
  49. package/es/components/EmptyStates/NoTagsEmptyState/NoTagsEmptyState.js +4 -0
  50. package/es/components/EmptyStates/NotFoundEmptyState/NotFoundEmptyState.js +4 -0
  51. package/es/components/EmptyStates/NotificationsEmptyState/NotificationsEmptyState.js +4 -0
  52. package/es/components/EmptyStates/UnauthorizedEmptyState/UnauthorizedEmptyState.js +4 -0
  53. package/es/components/ExampleComponent/ExampleComponent.docs-page.js +22 -0
  54. package/es/components/ExportModal/ExportModal.js +4 -0
  55. package/es/components/HTTPErrors/HTTPError403/HTTPError403.js +6 -0
  56. package/es/components/HTTPErrors/HTTPError404/HTTPError404.js +6 -0
  57. package/es/components/HTTPErrors/HTTPErrorOther/HTTPErrorOther.js +6 -0
  58. package/es/components/ImportModal/ImportModal.docs-page.js +18 -0
  59. package/es/components/ImportModal/ImportModal.js +13 -6
  60. package/es/components/MultiAddSelect/MultiAddSelect.docs-page.js +17 -0
  61. package/es/components/MultiAddSelect/MultiAddSelect.js +4 -0
  62. package/es/components/NotificationsPanel/preview-components/UnreadNotificationBell.js +2 -17
  63. package/es/components/PageHeader/PageHeaderUtils.js +2 -2
  64. package/es/components/RemoveModal/RemoveModal.docs-page.js +18 -0
  65. package/es/components/RemoveModal/RemoveModal.js +6 -0
  66. package/es/components/SingleAddSelect/SingleAddSelect.docs-page.js +15 -0
  67. package/es/components/SingleAddSelect/SingleAddSelect.js +4 -0
  68. package/es/components/StatusIcon/StatusIcon.docs-page.js +17 -0
  69. package/es/components/StatusIcon/StatusIcon.js +10 -0
  70. package/es/components/Tearsheet/TearsheetShell.js +11 -6
  71. package/es/components/Toolbar/Toolbar.docs-page.js +14 -0
  72. package/es/components/UserProfileImage/UserProfileImage.docs-page.js +17 -0
  73. package/es/components/UserProfileImage/UserProfileImage.js +1 -1
  74. package/es/components/WebTerminal/WebTerminal.docs-page.js +52 -0
  75. package/es/components/WebTerminal/WebTerminal.js +4 -0
  76. package/es/global/js/hooks/useCreateComponentStepChange.js +16 -15
  77. package/es/global/js/utils/StoryDocsPage.js +218 -0
  78. package/es/global/js/utils/story-helper.js +108 -6
  79. package/lib/components/APIKeyModal/APIKeyModal.docs-page.js +37 -0
  80. package/lib/components/AboutModal/AboutModal.docs-page.js +32 -0
  81. package/lib/components/AboutModal/AboutModal.js +1 -1
  82. package/lib/components/BreadcrumbWithOverflow/BreadcrumbWithOverflow.js +3 -0
  83. package/lib/components/Cascade/Cascade.docs-page.js +33 -0
  84. package/lib/components/Cascade/Cascade.js +11 -1
  85. package/lib/components/CreateFullPage/CreateFullPage.docs-page.js +50 -0
  86. package/lib/components/CreateFullPage/CreateFullPage.js +13 -0
  87. package/lib/components/CreateModal/CreateModal.docs-page.js +35 -0
  88. package/lib/components/CreateModal/CreateModal.js +7 -0
  89. package/lib/components/CreateSidePanel/CreateSidePanel.docs-page.js +29 -0
  90. package/lib/components/CreateSidePanel/CreateSidePanel.js +1 -1
  91. package/lib/components/CreateTearsheet/CreateTearsheet.docs-page.js +40 -0
  92. package/lib/components/DataSpreadsheet/DataSpreadsheet.js +3 -3
  93. package/lib/components/Datagrid/Datagrid/DatagridContent.js +1 -1
  94. package/lib/components/Datagrid/Datagrid/DatagridSelectAllWithToggle.js +3 -3
  95. package/lib/components/Datagrid/Datagrid/DatagridToolbar.js +3 -2
  96. package/lib/components/Datagrid/Datagrid/addons/CustomizeColumns/TearsheetWrapper.js +1 -1
  97. package/lib/components/Datagrid/Datagrid/addons/Filtering/FilterFlyout.js +4 -10
  98. package/lib/components/Datagrid/Datagrid/addons/InlineEdit/InlineEditCell/InlineEditCell.js +12 -10
  99. package/lib/components/Datagrid/Datagrid/addons/InlineEdit/handleGridKeyPress.js +2 -2
  100. package/lib/components/Datagrid/utils/DatagridActions.js +5 -13
  101. package/lib/components/EditFullPage/EditFullPage.docs-page.js +50 -0
  102. package/lib/components/EditFullPage/EditFullPage.js +2 -1
  103. package/lib/components/EditSidePanel/EditSidePanel.js +1 -1
  104. package/lib/components/EditTearsheet/EditTearsheet.docs-page.js +36 -0
  105. package/lib/components/EditTearsheet/EditTearsheet.js +4 -0
  106. package/lib/components/EditTearsheetNarrow/EditTearsheetNarrow.js +1 -1
  107. package/lib/components/EditUpdateCards/EditUpdateCards.js +3 -2
  108. package/lib/components/EmptyStates/EmptyState.js +4 -0
  109. package/lib/components/EmptyStates/ErrorEmptyState/ErrorEmptyState.js +4 -0
  110. package/lib/components/EmptyStates/NoDataEmptyState/NoDataEmptyState.js +4 -0
  111. package/lib/components/EmptyStates/NoTagsEmptyState/NoTagsEmptyState.js +4 -0
  112. package/lib/components/EmptyStates/NotFoundEmptyState/NotFoundEmptyState.js +4 -0
  113. package/lib/components/EmptyStates/NotificationsEmptyState/NotificationsEmptyState.js +4 -0
  114. package/lib/components/EmptyStates/UnauthorizedEmptyState/UnauthorizedEmptyState.js +4 -0
  115. package/lib/components/ExampleComponent/ExampleComponent.docs-page.js +33 -0
  116. package/lib/components/ExportModal/ExportModal.js +4 -0
  117. package/lib/components/HTTPErrors/HTTPError403/HTTPError403.js +6 -0
  118. package/lib/components/HTTPErrors/HTTPError404/HTTPError404.js +6 -0
  119. package/lib/components/HTTPErrors/HTTPErrorOther/HTTPErrorOther.js +6 -0
  120. package/lib/components/ImportModal/ImportModal.docs-page.js +26 -0
  121. package/lib/components/ImportModal/ImportModal.js +13 -6
  122. package/lib/components/MultiAddSelect/MultiAddSelect.docs-page.js +25 -0
  123. package/lib/components/MultiAddSelect/MultiAddSelect.js +4 -0
  124. package/lib/components/NotificationsPanel/preview-components/UnreadNotificationBell.js +2 -17
  125. package/lib/components/PageHeader/PageHeaderUtils.js +2 -2
  126. package/lib/components/RemoveModal/RemoveModal.docs-page.js +26 -0
  127. package/lib/components/RemoveModal/RemoveModal.js +6 -0
  128. package/lib/components/SingleAddSelect/SingleAddSelect.docs-page.js +23 -0
  129. package/lib/components/SingleAddSelect/SingleAddSelect.js +4 -0
  130. package/lib/components/StatusIcon/StatusIcon.docs-page.js +28 -0
  131. package/lib/components/StatusIcon/StatusIcon.js +10 -0
  132. package/lib/components/Tearsheet/TearsheetShell.js +11 -6
  133. package/lib/components/Toolbar/Toolbar.docs-page.js +25 -0
  134. package/lib/components/UserProfileImage/UserProfileImage.docs-page.js +28 -0
  135. package/lib/components/UserProfileImage/UserProfileImage.js +1 -1
  136. package/lib/components/WebTerminal/WebTerminal.docs-page.js +63 -0
  137. package/lib/components/WebTerminal/WebTerminal.js +4 -0
  138. package/lib/global/js/hooks/useCreateComponentStepChange.js +16 -15
  139. package/lib/global/js/utils/StoryDocsPage.js +225 -0
  140. package/lib/global/js/utils/story-helper.js +115 -7
  141. package/package.json +10 -10
  142. package/scss/components/Cascade/_storybook-styles.scss +3 -2
  143. package/scss/components/DataSpreadsheet/_storybook-styles.scss +6 -0
  144. package/scss/components/Datagrid/_storybook-styles.scss +8 -2
  145. package/scss/components/Datagrid/styles/_datagrid.scss +14 -0
  146. package/scss/components/Datagrid/styles/addons/_FilterFlyout.scss +7 -0
  147. package/scss/components/Datagrid/styles/addons/_FilterPanel.scss +4 -0
  148. package/scss/components/NotificationsPanel/_storybook-styles.scss +10 -2
  149. package/scss/components/PageHeader/_storybook-styles.scss +24 -14
  150. package/scss/components/Tearsheet/_tearsheet.scss +7 -1
  151. package/scss/components/WebTerminal/_storybook-styles.scss +11 -1
  152. package/scss/global/styles/_display-box.scss +1 -0
  153. package/scss/components/HTTPErrors/_storybook-styles.scss +0 -6
@@ -0,0 +1,24 @@
1
+ import React from 'react';
2
+ import { StoryDocsPage } from '../../global/js/utils/StoryDocsPage';
3
+ import * as stories from './CreateModal.stories';
4
+ var DocsPage = function DocsPage() {
5
+ return /*#__PURE__*/React.createElement(StoryDocsPage, {
6
+ altGuidelinesHref: "https://pages.github.ibm.com/cdai-design/pal/patterns/creation-flows/usage#modal",
7
+ blocks: [{
8
+ story: stories.Default
9
+ }, {
10
+ title: 'Form validation',
11
+ description: "All forms, including that within the `CreateModal` should follow C&CS guidelines\nfor form validation.\n\nThis includes the following:\n\n- The `Submit` button in the modal should be disabled, until all required inputs\n are filled in and valid\n- All required inputs should _only_ throw an invalid error _after_ the element\n loses focus\n- All optional form fields should have an `(optional)` text at the end of the\n input `labelText`. Optional should always be in parentheses\n\nYou can find more information on how to validate your form fields in\n[Carbon's Form usage page](https://www.carbondesignsystem.com/components/form/usage)."
12
+ }, {
13
+ title: 'Overriding Carbon theme',
14
+ description: "The design recommendation is to use a dark theme for the CreateModal if the\napplication is currently using a light theme, and vice versa. The theme applied\nto the CreateModal can easily be customized as follows:\n\nIn SCSS:",
15
+ source: {
16
+ language: 'css',
17
+ code: " .#{$pkg-prefix}--create-modal {\n @include carbon--theme(\n $theme: $carbon--theme--g90\n );\n }"
18
+ }
19
+ }, {
20
+ description: "Alternatively, the required Carbon theme can be set as above in a custom CSS\nclass which is then applied to the CreateModal using the `className` prop."
21
+ }]
22
+ });
23
+ };
24
+ export default DocsPage;
@@ -30,6 +30,13 @@ var isValidChildren = function isValidChildren() {
30
30
  return;
31
31
  };
32
32
  };
33
+
34
+ /**
35
+ * The `CreateModal` component provides a way for a user to quickly generate a new
36
+ resource. It is triggered by a user’s action, appears on top of the main page
37
+ content, and is persistent until dismissed. The purpose of this modal should be
38
+ immediately apparent to the user, with a clear and obvious path to completion.
39
+ */
33
40
  export var CreateModal = /*#__PURE__*/React.forwardRef(function (_ref2, ref) {
34
41
  var className = _ref2.className,
35
42
  children = _ref2.children,
@@ -0,0 +1,18 @@
1
+ import React from 'react';
2
+ import { StoryDocsPage } from '../../global/js/utils/StoryDocsPage';
3
+ import * as stories from './CreateSidePanel.stories';
4
+ var DocsPage = function DocsPage() {
5
+ return /*#__PURE__*/React.createElement(StoryDocsPage, {
6
+ altGuidelinesHref: [{
7
+ href: 'https://pages.github.ibm.com/cdai-design/pal/patterns/creation-flows/usage#side-panel',
8
+ label: 'Carbon create flows side panel usage guidelines'
9
+ }],
10
+ blocks: [{
11
+ story: stories.Default
12
+ }, {
13
+ title: 'Form validation',
14
+ description: "All forms, including that within the `CreateSidePanel` should follow C&CS\nguidelines for form validation.\n\nThis includes the following:\n\n- The `Submit` button in the side panel should be disabled, until all required\n inputs are filled in and valid\n- All required inputs should _only_ throw an invalid error _after_ the element\n loses focus\n- All optional form fields should have an `(optional)` text at the end of the\n input `labelText`. Optional should always be in parentheses\n\nYou can find more information on how to validate your form fields in\n[Carbon's Form usage page](https://www.carbondesignsystem.com/components/form/usage)."
15
+ }]
16
+ });
17
+ };
18
+ export default DocsPage;
@@ -31,7 +31,7 @@ var componentName = 'CreateSidePanel';
31
31
  // NOTE: the component SCSS is not imported here: it is rolled up separately.
32
32
 
33
33
  /**
34
- * This is an example component to show relevant conventions and usage.
34
+ * Use with medium complexity creations if the user needs page context. On-page content can be seen and interacted with.
35
35
  */
36
36
  export var CreateSidePanel = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
37
37
  var className = _ref.className,
@@ -0,0 +1,29 @@
1
+ import React from 'react';
2
+ import { StoryDocsPage } from '../../global/js/utils/StoryDocsPage';
3
+ import * as stories from './CreateTearsheet.stories';
4
+ var DocsPage = function DocsPage() {
5
+ return /*#__PURE__*/React.createElement(StoryDocsPage, {
6
+ altGuidelinesHref: "https://pages.github.ibm.com/cdai-design/pal/patterns/creation-flows/usage#wide-tearsheet",
7
+ blocks: [{
8
+ story: stories.multiStepTearsheet,
9
+ description: "This is used when you have one section per step. This can be created by passing\nin the overall `<CreateTearsheet />` component and the `<CreateTearsheetStep />`\ncomponent with form items as children:",
10
+ source: {
11
+ code: " <CreateTearsheet {...props}>\n <CreateTearsheetStep\n title=\"Required title\"\n subtitle=\"Optional subtitle\"\n description=\"Optional description\"\n onNext={() => {'Optional function'}}\n disableSubmit={}\n >\n <TextInput\n id=\"test-1\"\n invalidText=\"A valid value is required\"\n labelText=\"Topic name\"\n placeholder=\"Enter topic name\"\n />\n </CreateTearsheetStep>\n </CreateTearsheet>"
12
+ }
13
+ }, {
14
+ title: 'Using custom components',
15
+ description: "It is possible to use custom components that return `CreateTearsheetStep`s in\norder to help reduce the amount of logic in the component that contains the main\n`CreateTearsheet`. _It is required that each child of the `CreateTearsheet`\neither be a custom step or a `CreateTearsheetStep`_. An example of this could\nlook like the following:",
16
+ source: {
17
+ code: "const CreateStepCustom = ({ subtitle, ...rest }) => {\n return (\n <CreateTearsheetStep\n {...rest}\n subtitle={subtitle}\n title=\"Step 1\"\n onNext={() => console.log('optional validation check')}\n onMount={() => console.log('optional onMount fn')}\n disableSubmit={false}\n >\n step content here\n </CreateTearsheetStep>\n );\n};\n\nconst CreateComponent = () => {\n return (\n <CreateTearsheet {...createTearsheetProps}>\n <CreateStepCustom subtitle=\"Custom step subtitle\" />\n <CreateTearsheetStep\n title=\"Topic name\"\n fieldsetLegendText=\"Topic information\"\n disableSubmit={!value}\n subtitle=\"This is the unique name used to recognize your topic\"\n description=\"It will also be used by your producers and consumers as part of the\n connection information, so make it something easy to recognize.\"\n >\n Content for second step\n </CreateTearsheetStep>\n </CreateTearsheet>\n );\n};"
18
+ }
19
+ }, {
20
+ title: 'Using dynamic steps',
21
+ description: "The use of dynamic steps can be utilized in a scenario when the user makes a\ncertain selection on one step that effects which steps will follow it, this is\ncontrolled via the `includeStep` prop. See abbreviated example below:",
22
+ code: "import { useState } from 'react';\n\nconst CreateFlow = () => {\n const [shouldIncludeAdditionalStep, setShouldIncludeAdditionalStep] =\n useState(false);\n return (\n <CreateTearsheet {...createTearsheetProps}>\n <CreateTearsheetStep {...step1Props}>\n Step 1 content\n <Checkbox\n labelText={`Include additional step`}\n id=\"include-additional-step-checkbox\"\n onChange={(value) => setShouldIncludeAdditionalStep(value)}\n checked={shouldIncludeAdditionalStep}\n />\n </CreateTearsheetStep>\n <CreateTearsheetStep\n {...step2Props}\n includeStep={shouldIncludeAdditionalStep}\n >\n Dynamic step content\n </CreateTearsheetStep>\n <CreateTearsheetStep {...step3Props}>\n Final step content\n </CreateTearsheetStep>\n </CreateTearsheet>\n );\n};"
23
+ }, {
24
+ title: 'Class names',
25
+ description: "Additionally, to get the preferred styling when including your own children as\nsections, you can utilize the below included class names.\n\n| Class name | Element | Features |\n| ----------------------------------------------------- | ----------- | ---------------------------------------------------------- |\n| `#{$pkg-prefix}--create-tearsheet__step--title` | title | `productive-heading-04` & `margin-bottom` of `$spacing-05` |\n| `#{$pkg-prefix}--create-tearsheet__step--subtitle` | subtitle | `productive-heading-01` & `margin-bottom` of `$spacing-03` |\n| `#{$pkg-prefix}--create-tearsheet__step--description` | description | `body-long-01` & `margin-bottom` of `$spacing-06` |\n| `#{$pkg-prefix}--create-tearsheet__step--fieldset` | fieldset | `margin-bottom` of `$spacing-05` to all children elements |\n| `#{$pkg-prefix}--create-tearsheet__section--divider` | divider | Includes a `1px` divider line inside the `main` content |\n"
26
+ }]
27
+ });
28
+ };
29
+ export default DocsPage;
@@ -667,9 +667,6 @@ export var DataSpreadsheet = /*#__PURE__*/React.forwardRef(function (_ref, ref)
667
667
  defaultColumn: defaultColumn,
668
668
  cellEditorValue: cellEditorValue
669
669
  });
670
- var handleActiveCellMouseEnter = useCallback(function () {
671
- handleActiveCellMouseEnterCallback(selectionAreas, clickAndHoldActive);
672
- }, [clickAndHoldActive, selectionAreas, handleActiveCellMouseEnterCallback]);
673
670
 
674
671
  // Only update if there are cell selection areas
675
672
  // Find point object that matches currentMatcher and remove the second point
@@ -702,6 +699,9 @@ export var DataSpreadsheet = /*#__PURE__*/React.forwardRef(function (_ref, ref)
702
699
  });
703
700
  }
704
701
  }, [spreadsheetRef, currentMatcher]);
702
+ var handleActiveCellMouseEnter = useCallback(function () {
703
+ handleActiveCellMouseEnterCallback(selectionAreas, clickAndHoldActive);
704
+ }, [clickAndHoldActive, selectionAreas, handleActiveCellMouseEnterCallback]);
705
705
  return /*#__PURE__*/React.createElement("div", _extends({}, rest, getTableProps(), getDevtoolsProps(componentName), {
706
706
  className: cx(blockClass, className, "".concat(blockClass, "--interactive-cell-element"), (_cx = {}, _defineProperty(_cx, "".concat(blockClass, "__container-has-focus"), containerHasFocus), _defineProperty(_cx, "".concat(blockClass, "__").concat(theme), theme === 'dark'), _cx)),
707
707
  ref: spreadsheetRef,
@@ -82,7 +82,7 @@ export var DatagridContent = function DatagridContent(_ref) {
82
82
  return /*#__PURE__*/React.createElement(Table, _extends({}, getTableProps(), {
83
83
  className: cx(withVirtualScroll ? '' : "".concat(blockClass, "__table-simple"), "".concat(blockClass, "__vertical-align-").concat(verticalAlign), _defineProperty({}, "".concat(blockClass, "__variable-row-height"), variableRowHeight), _defineProperty({}, "".concat(blockClass, "__table-with-inline-edit"), withInlineEdit), _defineProperty({}, "".concat(blockClass, "__table-grid-active"), gridActive), (_getTableProps = getTableProps()) === null || _getTableProps === void 0 ? void 0 : _getTableProps.className),
84
84
  role: withInlineEdit && 'grid',
85
- tabIndex: withInlineEdit && 0,
85
+ tabIndex: withInlineEdit ? 0 : -1,
86
86
  onKeyDown: withInlineEdit ? function (event) {
87
87
  return handleGridKeyPress({
88
88
  event: event,
@@ -35,6 +35,9 @@ var SelectAllWithToggle = function SelectAllWithToggle(_ref) {
35
35
  allRowsLabel = _ref$allRowsLabel === void 0 ? 'Select all' : _ref$allRowsLabel,
36
36
  columns = _ref.columns,
37
37
  withStickyColumn = _ref.withStickyColumn;
38
+ var _ref2 = selectAllToggle || {},
39
+ onSelectAllRows = _ref2.onSelectAllRows,
40
+ labels = _ref2.labels;
38
41
  var _useState = useState(SELECT_ALL_PAGE_ROWS),
39
42
  _useState2 = _slicedToArray(_useState, 2),
40
43
  selectAllMode = _useState2[0],
@@ -57,9 +60,6 @@ var SelectAllWithToggle = function SelectAllWithToggle(_ref) {
57
60
  return window.removeEventListener('resize', updateSize);
58
61
  };
59
62
  }, []);
60
- var _ref2 = selectAllToggle || {},
61
- onSelectAllRows = _ref2.onSelectAllRows,
62
- labels = _ref2.labels;
63
63
  if (labels) {
64
64
  allPageRowsLabel = labels.allPageRows || allPageRowsLabel;
65
65
  allRowsLabel = labels.allRows || allRowsLabel;
@@ -16,6 +16,7 @@ import { pkg, carbon } from '../../../settings';
16
16
  import cx from 'classnames';
17
17
  var blockClass = "".concat(pkg.prefix, "--datagrid");
18
18
  var DatagridBatchActionsToolbar = function DatagridBatchActionsToolbar(datagridState, width, ref) {
19
+ var _Object$keys;
19
20
  var _useState = useState(false),
20
21
  _useState2 = _slicedToArray(_useState, 2),
21
22
  displayAllInMenu = _useState2[0],
@@ -28,11 +29,11 @@ var DatagridBatchActionsToolbar = function DatagridBatchActionsToolbar(datagridS
28
29
  _useState6 = _slicedToArray(_useState5, 2),
29
30
  receivedInitialWidth = _useState6[0],
30
31
  setReceivedInitialWidth = _useState6[1];
31
- var selectedFlatRows = datagridState.selectedFlatRows,
32
+ var selectedRowIds = datagridState.state.selectedRowIds,
32
33
  toggleAllRowsSelected = datagridState.toggleAllRowsSelected,
33
34
  toolbarBatchActions = datagridState.toolbarBatchActions,
34
35
  setGlobalFilter = datagridState.setGlobalFilter;
35
- var totalSelected = selectedFlatRows && selectedFlatRows.length;
36
+ var totalSelected = (_Object$keys = Object.keys(selectedRowIds || {})) === null || _Object$keys === void 0 ? void 0 : _Object$keys.length;
36
37
 
37
38
  // Get initial width of batch actions container,
38
39
  // used to measure when all items are put inside
@@ -20,7 +20,7 @@ var TearsheetWrapper = function TearsheetWrapper(_ref) {
20
20
  rest = _objectWithoutProperties(_instance$customizeCo, _excluded);
21
21
  return /*#__PURE__*/React.createElement(CustomizeColumnsTearsheet, _extends({}, rest, labels, {
22
22
  isOpen: isTearsheetOpen,
23
- isTableSortable: instance === null || instance === void 0 ? void 0 : instance.isTableSortable,
23
+ isTableSortable: (instance === null || instance === void 0 ? void 0 : instance.isTableSortable) || false,
24
24
  setIsTearsheetOpen: setIsTearsheetOpen,
25
25
  columnDefinitions: instance.allColumns,
26
26
  originalColumnDefinitions: instance.columns,
@@ -9,7 +9,7 @@ import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
9
9
  */
10
10
 
11
11
  import { Filter } from '@carbon/react/icons';
12
- import { Button, usePrefix } from '@carbon/react';
12
+ import { IconButton, usePrefix } from '@carbon/react';
13
13
  import cx from 'classnames';
14
14
  import PropTypes from 'prop-types';
15
15
  import React, { useRef, useState, useEffect } from 'react';
@@ -153,20 +153,14 @@ var FilterFlyout = function FilterFlyout(_ref) {
153
153
  }, [reactTableFiltersState, lastAppliedFilters]);
154
154
  return /*#__PURE__*/React.createElement("div", {
155
155
  className: "".concat(componentClass, "__container")
156
- }, /*#__PURE__*/React.createElement(Button, {
156
+ }, /*#__PURE__*/React.createElement(IconButton, {
157
+ label: flyoutIconDescription,
157
158
  kind: "ghost",
158
- hasIconOnly: true,
159
- tooltipPosition: "bottom",
160
- renderIcon: function renderIcon() {
161
- return /*#__PURE__*/React.createElement(Filter, {
162
- size: 16
163
- });
164
- },
165
- iconDescription: flyoutIconDescription,
159
+ align: "bottom",
166
160
  onClick: open ? closeFlyout : openFlyout,
167
161
  className: cx("".concat(componentClass, "__trigger"), _defineProperty({}, "".concat(componentClass, "__trigger--open"), open)),
168
162
  disabled: data.length === 0
169
- }), /*#__PURE__*/React.createElement("div", {
163
+ }, /*#__PURE__*/React.createElement(Filter, null)), /*#__PURE__*/React.createElement("div", {
170
164
  ref: filterFlyoutRef,
171
165
  className: cx(componentClass, (_cx2 = {}, _defineProperty(_cx2, "".concat(componentClass, "--open"), open), _defineProperty(_cx2, "".concat(componentClass, "--batch"), showActionSet), _defineProperty(_cx2, "".concat(componentClass, "--instant"), !showActionSet), _cx2))
172
166
  }, /*#__PURE__*/React.createElement("div", {
@@ -5,7 +5,7 @@ import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
5
5
  function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
6
6
  function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
7
7
  /**
8
- * Copyright IBM Corp. 2022, 2022
8
+ * Copyright IBM Corp. 2022, 2023
9
9
  *
10
10
  * This source code is licensed under the Apache-2.0 license found in the
11
11
  * LICENSE file in the root directory of this source tree.
@@ -31,7 +31,8 @@ export var InlineEditCell = function InlineEditCell(_ref) {
31
31
  placeholder = _ref$placeholder === void 0 ? '' : _ref$placeholder,
32
32
  tabIndex = _ref.tabIndex,
33
33
  value = _ref.value,
34
- nonEditCell = _ref.nonEditCell,
34
+ _ref$nonEditCell = _ref.nonEditCell,
35
+ nonEditCell = _ref$nonEditCell === void 0 ? false : _ref$nonEditCell,
35
36
  totalInlineEditColumns = _ref.totalInlineEditColumns,
36
37
  type = _ref.type;
37
38
  var columnId = cell.column.id;
@@ -72,6 +73,9 @@ export var InlineEditCell = function InlineEditCell(_ref) {
72
73
  var dropdownRef = useRef();
73
74
  var datePickerRef = useRef();
74
75
  var outerButtonElement = useRef();
76
+ var rowSize = instance.rowSize,
77
+ onDataUpdate = instance.onDataUpdate;
78
+ var saveCellData;
75
79
  useEffect(function () {
76
80
  setInitialValue(value);
77
81
  var columnId = cell.column.id;
@@ -145,8 +149,6 @@ export var InlineEditCell = function InlineEditCell(_ref) {
145
149
  }, 1);
146
150
  }
147
151
  };
148
- var rowSize = instance.rowSize,
149
- onDataUpdate = instance.onDataUpdate;
150
152
 
151
153
  // Auto focus text input when entering edit mode
152
154
  useEffect(function () {
@@ -160,14 +162,9 @@ export var InlineEditCell = function InlineEditCell(_ref) {
160
162
  }
161
163
  }, [inEditMode, type]);
162
164
 
163
- // Initialize cellValue from value prop
164
- useEffect(function () {
165
- setCellValue(value);
166
- }, [value]);
167
-
168
165
  // Saves the new cell data, onDataUpdate is a required function to be
169
166
  // passed to useDatagrid when using useInlineEdit
170
- var saveCellData = useCallback(function (newValue) {
167
+ saveCellData = useCallback(function (newValue) {
171
168
  var columnId = cell.column.id;
172
169
  var rowIndex = cell.row.index;
173
170
  onDataUpdate(function (prev) {
@@ -179,6 +176,11 @@ export var InlineEditCell = function InlineEditCell(_ref) {
179
176
  });
180
177
  });
181
178
  }, [cell, onDataUpdate]);
179
+
180
+ // Initialize cellValue from value prop
181
+ useEffect(function () {
182
+ setCellValue(value);
183
+ }, [value]);
182
184
  var sendFocusBackToGrid = function sendFocusBackToGrid() {
183
185
  // Allows the onKeyDown listener to go back to the entire grid area
184
186
  var inlineEditArea = document.querySelector("#".concat(instance.tableId, " .").concat(blockClass, "__table-with-inline-edit"));
@@ -2,7 +2,7 @@ import _defineProperty from "@babel/runtime/helpers/defineProperty";
2
2
  function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
3
3
  function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
4
4
  /**
5
- * Copyright IBM Corp. 2022, 2022
5
+ * Copyright IBM Corp. 2022, 2023
6
6
  *
7
7
  * This source code is licensed under the Apache-2.0 license found in the
8
8
  * LICENSE file in the root directory of this source tree.
@@ -86,7 +86,7 @@ export var handleGridKeyPress = function handleGridKeyPress(_ref) {
86
86
  if (['End', 'Home', 'ArrowLeft', 'ArrowUp', 'ArrowRight', 'ArrowDown'].indexOf(key) > -1 && !isEditing && keysPressedList.length < 2) {
87
87
  event.preventDefault();
88
88
  }
89
- var isDisabledCell = !!focusedCell.getAttribute('data-disabled');
89
+ var isDisabledCell = focusedCell.getAttribute('data-disabled') === 'false' ? false : true;
90
90
  var sharedUpdateParams = {
91
91
  oldId: activeCellId,
92
92
  instance: instance
@@ -1,5 +1,4 @@
1
1
  import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
2
- import _extends from "@babel/runtime/helpers/extends";
3
2
  /**
4
3
  * Copyright IBM Corp. 2020, 2022
5
4
  *
@@ -8,7 +7,7 @@ import _extends from "@babel/runtime/helpers/extends";
8
7
  */
9
8
 
10
9
  import React, { useLayoutEffect, useState, useContext } from 'react';
11
- import { TableToolbarContent, TableToolbarSearch, Button, OverflowMenu, OverflowMenuItem, ComposedModal, ModalBody, ModalHeader, ModalFooter, Dropdown } from '@carbon/react';
10
+ import { TableToolbarContent, TableToolbarSearch, Button, IconButton, OverflowMenu, OverflowMenuItem, ComposedModal, ModalBody, ModalHeader, ModalFooter, Dropdown } from '@carbon/react';
12
11
  import { Download, Add, Restart, ChevronDown, Filter } from '@carbon/react/icons';
13
12
  import { action } from '@storybook/addon-actions';
14
13
  import { pkg } from '../../../settings';
@@ -45,25 +44,18 @@ export var DatagridActions = function DatagridActions(datagridState) {
45
44
  return (filterProps === null || filterProps === void 0 ? void 0 : filterProps.variation) === 'flyout' && /*#__PURE__*/React.createElement(FilterFlyout, getFilterFlyoutProps());
46
45
  };
47
46
  var renderFilterPanelButton = function renderFilterPanelButton() {
48
- return (filterProps === null || filterProps === void 0 ? void 0 : filterProps.variation) === 'panel' && /*#__PURE__*/React.createElement(Button, {
47
+ return (filterProps === null || filterProps === void 0 ? void 0 : filterProps.variation) === 'panel' && /*#__PURE__*/React.createElement(IconButton, {
49
48
  kind: "ghost",
50
- hasIconOnly: true,
51
- tooltipPosition: "bottom",
52
- renderIcon: function renderIcon(props) {
53
- return /*#__PURE__*/React.createElement(Filter, _extends({
54
- size: 16
55
- }, props));
56
- },
57
- iconDescription: filterProps.panelIconDescription,
49
+ align: "bottom",
50
+ label: filterProps.panelIconDescription,
58
51
  className: "".concat(blockClass, "-filter-panel-open-button"),
59
52
  onClick: function onClick() {
60
53
  return setPanelOpen(function (open) {
61
54
  return !open;
62
55
  });
63
56
  },
64
- disabled: data.length === 0,
65
- tooltipAlignment: "start"
66
- });
57
+ disabled: data.length === 0
58
+ }, /*#__PURE__*/React.createElement(Filter, null));
67
59
  };
68
60
  var _useState = useState(false),
69
61
  _useState2 = _slicedToArray(_useState, 2),
@@ -0,0 +1,39 @@
1
+ import React from 'react';
2
+ import { StoryDocsPage } from '../../global/js/utils/StoryDocsPage';
3
+ import * as stories from './EditFullPage.stories';
4
+ var DocsPage = function DocsPage() {
5
+ return /*#__PURE__*/React.createElement(StoryDocsPage, {
6
+ altGuidelinesHref: "https://pages.github.ibm.com/cdai-design/pal/patterns/edit/usage#full-page-edit",
7
+ blocks: [{
8
+ description: "There are **2** components that make up a Create Full Page component, which can\nbe used in unison to create the desired look, or flow. Please note, to utilize\nthe Create Full Page component, you'll need to have a minimum of two steps. If\nyou are looking for a one step creation flow, consider Create Tearsheet, Create\nSide Panel, or Create Modal."
9
+ }, {
10
+ story: stories.editFullPage,
11
+ description: "This is used when you have one section per step. This can be created by passing\nin the overall `<CreateFullPage />` component and the `<CreateFullPageStep />`\ncomponent with form items as children:",
12
+ source: {
13
+ code: "<CreateFullPage {...props}>\n <CreateFullPageStep\n title=\"Required title\"\n subtitle=\"Optional subtitle\"\n description=\"Optional description\"\n onNext={() => {'Optional function'}}\n >\n <Row>\n <Column xlg={5} lg={5} md={4} sm={4}>\n <TextInput\n id=\"test-1\"\n invalidText=\"A valid value is required\"\n labelText=\"Topic name\"\n placeholder=\"Enter topic name\"\n />\n </Column>\n </Row>\n </CreateFullPageStep>\n </CreateFullPage>"
14
+ }
15
+ }, {
16
+ story: stories.editFullPageWithSections,
17
+ description: "This is used when you have several sections per step. This can be created by\npassing in the overall `<CreateFullPage />` component and the\n`<CreateFullPageStep />` component for the first `section`. All additional\n`sections` must be passed in as children, as shown below:",
18
+ source: {
19
+ code: "<CreateFullPageStep\n title=\"Required title\"\n subtitle=\"Optional subtitle\"\n description=\"Optional description\"\n onNext={() => {'Optional function'}}\n >\n <Row>\n <Column xlg={5} lg={5} md={4} sm={4}>\n <fieldset className={`#{$pkg-prefix}--create-full-page__step-fieldset`}>\n <TextInput\n id=\"test-1\"\n invalidText=\"A valid value is required\"\n labelText=\"Topic name\"\n placeholder=\"Enter topic name\"\n />\n </fieldset>\n </Column>\n </Row>\n <span className={`#{$pkg-prefix}--create-full-page__section-divider`} />\n <h5 className={`#{$pkg-prefix}--create-full-page__step-title`}>Required title</h5>\n <h6 className={`#{$pkg-prefix}--create-full-page__step-subtitle`}>\n Optional subtitle\n </h6>\n <p className={`#{$pkg-prefix}--create-full-page__step-description`}>\n Optional description\n </p>\n <Row>\n <Column xlg={5} lg={5} md={4} sm={4}>\n <fieldset className={`#{$pkg-prefix}--create-full-page__step-fieldset`}>\n <TextInput\n id=\"test-2\"\n invalidText=\"A valid value is required\"\n labelText=\"Topic name\"\n placeholder=\"Enter topic name\"\n />\n </fieldset>\n </Column>\n </Row>\n</CreateFullPageStep>"
20
+ }
21
+ }, {
22
+ title: 'Using custom components',
23
+ description: "It is possible to use custom components that return `CreateFullPageStep`s in\norder to help reduce the amount of logic in the component that contains the main\n`CreateFullPage`. _It is required that each child of the `CreateFullPage` either\nbe a custom step or a `CreateFullPageStep`_. An example of this could look like\nthe following:",
24
+ source: {
25
+ code: "const CreateStepCustom = ({ subtitle, ...rest }) => {\n return (\n <CreateFullPageStep\n {...rest}\n subtitle={subtitle}\n title=\"Step 1\"\n onNext={() => console.log('optional validation check')}\n onMount={() => console.log('optional onMount fn')}\n disableSubmit={false}\n >\n step content here\n </CreateFullPageStep>\n );\n};\n\nconst CreateComponent = () => {\n return (\n <CreateFullPage {...createFullPageProps}>\n <CreateStepCustom subtitle=\"Custom step subtitle\" />\n <CreateFullPageStep\n title=\"Topic name\"\n fieldsetLegendText=\"Topic information\"\n disableSubmit={!value}\n subtitle=\"This is the unique name used to recognize your topic\"\n description=\"It will also be used by your producers and consumers as part of the\n connection information, so make it something easy to recognize.\"\n >\n Content for second step\n </CreateFullPageStep>\n </CreateFullPage>\n );\n};"
26
+ }
27
+ }, {
28
+ title: 'Using dynamic steps',
29
+ description: "The use of dynamic steps can be utilized in a scenario when the user makes a\ncertain selection on one step that effects which steps will follow it, this is\ncontrolled via the `includeStep` prop. See abbreviated example below:",
30
+ source: {
31
+ code: "import { useState } from 'react';\n\nconst CreateFlow = () => {\n const [shouldIncludeAdditionalStep, setShouldIncludeAdditionalStep] =\n useState(false);\n return (\n <CreateFullPage {...createFullPageProps}>\n <CreateFullPageStep {...step1Props}>\n Step 1 content\n <Checkbox\n labelText={`Include additional step`}\n id=\"include-additional-step-checkbox\"\n onChange={(value) => setShouldIncludeAdditionalStep(value)}\n checked={shouldIncludeAdditionalStep}\n />\n </CreateFullPageStep>\n <CreateFullPageStep\n {...step2Props}\n includeStep={shouldIncludeAdditionalStep}\n >\n Dynamic step content\n </CreateFullPageStep>\n <CreateFullPageStep {...step3Props}>\n Final step content\n </CreateFullPageStep>\n </CreateFullPage>\n );\n};"
32
+ }
33
+ }, {
34
+ title: 'Class names',
35
+ description: "Additionally, to get the preferred styling when including your own children as\nsections, you can utilize the below included class names.\n\n| Class name | Element | Features |\n| ---------------------------------------------------- | ----------- | ---------------------------------------------------------- |\n| `#{$pkg-prefix}--create-full-page__step-title` | title | `productive-heading-04` & `margin-bottom` of `$spacing-05` |\n| `#{$pkg-prefix}--create-full-page__step-subtitle` | subtitle | `productive-heading-01` & `margin-bottom` of `$spacing-03` |\n| `#{$pkg-prefix}--create-full-page__step-description` | description | `body-long-01` & `margin-bottom` of `$spacing-06` |\n| `#{$pkg-prefix}--create-full-page__step-fieldset` | fieldset | `margin-bottom` of `$spacing-05` to all children elements |\n| `#{$pkg-prefix}--create-full-page__section-divider` | divider | Includes a `1px` divider line inside the `main` content |\n"
36
+ }]
37
+ });
38
+ };
39
+ export default DocsPage;
@@ -41,7 +41,8 @@ var componentName = 'EditFullPage';
41
41
  // };
42
42
 
43
43
  /**
44
- * TODO: A description of the component.
44
+ * Use when settings on a page need to always be shown in edit mode, or when the context of the page is needed to make several changes.
45
+ * See usage guidance for further details.
45
46
  */
46
47
  export var EditFullPage = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
47
48
  var children = _ref.children,
@@ -38,7 +38,7 @@ var defaults = {
38
38
  };
39
39
 
40
40
  /**
41
- * TODO: A description of the component.
41
+ * Use with medium complexity edits if the user needs page context.
42
42
  */
43
43
  export var EditSidePanel = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
44
44
  var children = _ref.children,
@@ -0,0 +1,25 @@
1
+ import React from 'react';
2
+ import { StoryDocsPage } from '../../global/js/utils/StoryDocsPage';
3
+ import * as stories from './EditTearsheet.stories';
4
+ var DocsPage = function DocsPage() {
5
+ return /*#__PURE__*/React.createElement(StoryDocsPage, {
6
+ altGuidelinesHref: "https://pages.github.ibm.com/cdai-design/pal/patterns/edit/usage#tearsheet-edit",
7
+ blocks: [{
8
+ story: stories.multiFormEditTearsheet,
9
+ description: "This is used when you have one section per step. This can be created by passing\nin the overall `<EditTearsheet />` component and the `<EditTearsheetForm />`\ncomponent with form items as children:",
10
+ source: {
11
+ code: "<EditTearsheet {...props}>\n <EditTearsheetForm\n title=\"Required title\"\n subtitle=\"Optional subtitle\"\n description=\"Optional description\"\n onNext={() => {\n 'Optional function';\n }}\n >\n <TextInput\n id=\"test-1\"\n invalidText=\"A valid value is required\"\n labelText=\"Topic name\"\n placeholder=\"Enter topic name\"\n />\n </EditTearsheetForm>\n</EditTearsheet>"
12
+ }
13
+ }, {
14
+ title: 'Using custom components',
15
+ description: "It is possible to use custom components that return `EditTearsheetForms` in\norder to help reduce the amount of logic in the component that contains the main\n`EditTearsheet`. _It is required that each child of the `EditTearsheet` either\nbe a custom step or a `EditTearsheetForm`_. An example of this could look like\nthe following:",
16
+ source: {
17
+ code: "const CreateFormCustom = ({ subtitle, ...rest }) => {\n return (\n <EditTearsheetForm {...rest} subtitle={subtitle} title=\"Form 1\">\n form content here\n </EditTearsheetForm>\n );\n};\n\nconst CreateComponent = () => {\n return (\n <EditTearsheet {...EditTearsheetProps}>\n <CreateFormCustom subtitle=\"Custom form subtitle\" />\n <EditTearsheetForm\n title=\"Topic name\"\n fieldsetLegendText=\"Topic information\"\n subtitle=\"This is the unique name used to recognize your topic\"\n description=\"It will also be used by your producers and consumers as part of the\n connection information, so make it something easy to recognize.\"\n >\n Content for second form\n </EditTearsheetForm>\n </EditTearsheet>\n );\n};"
18
+ }
19
+ }, {
20
+ title: "Class names",
21
+ description: "Additionally, to get the preferred styling when including your own children as\nsections, you can utilize the below included class names.\n\n| Class name | Element | Features |\n| ----------------------------------------------------- | ----------- | ---------------------------------------------------------- |\n| `#{$pkg-prefix}--create-tearsheet__form--title` | title | `productive-heading-04` & `margin-bottom` of `$spacing-05` |\n| `#{$pkg-prefix}--create-tearsheet__form--subtitle` | subtitle | `productive-heading-01` & `margin-bottom` of `$spacing-03` |\n| `#{$pkg-prefix}--create-tearsheet__form--description` | description | `body-long-01` & `margin-bottom` of `$spacing-06` |\n| `#{$pkg-prefix}--create-tearsheet__form--fieldset` | fieldset | `margin-bottom` of `$spacing-05` to all children elements |\n"
22
+ }]
23
+ });
24
+ };
25
+ export default DocsPage;
@@ -33,6 +33,10 @@ var defaults = {
33
33
  verticalPosition: 'normal',
34
34
  influencerWidth: 'narrow'
35
35
  };
36
+
37
+ /**
38
+ * Use Tearsheet with medium to complex edits. See usage guidance for further information.
39
+ */
36
40
  export var EditTearsheet = /*#__PURE__*/forwardRef(function (_ref, ref) {
37
41
  var cancelButtonText = _ref.cancelButtonText,
38
42
  children = _ref.children,
@@ -41,7 +41,7 @@ var componentName = 'EditTearsheetNarrow';
41
41
  // };
42
42
 
43
43
  /**
44
- * TODO: A description of the component.
44
+ * Use a narrow tearsheet as an alternative to a modal when there is scrolling. See usage guidance for further information.
45
45
  */
46
46
  export var EditTearsheetNarrow = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
47
47
  var children = _ref.children,
@@ -44,9 +44,10 @@ var componentName = 'EditUpdateCards';
44
44
  // };
45
45
 
46
46
  /**
47
- * TODO: A description of the component.
47
+ Editable cards allow a user to view, modify, and save the content contained within the card.
48
+ These cards are generally used in instances where a user needs to make changes to a resource instances
49
+ (ex. configuration details), account plan, etc. Editable cards allow a user to edit something within context.
48
50
  */
49
-
50
51
  export var EditUpdateCards = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
51
52
  var actionIcons = _ref.actionIcons,
52
53
  actionsPlacement = _ref.actionsPlacement,
@@ -32,6 +32,10 @@ export var defaults = {
32
32
  position: 'top',
33
33
  size: 'lg'
34
34
  };
35
+
36
+ /**
37
+ * The `EmptyState` component follows the Carbon guidelines for empty states with some added specifications around illustration usage. For additional usage guidelines and documentation please refer to the links above.
38
+ */
35
39
  export var EmptyState = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
36
40
  var action = _ref.action,
37
41
  className = _ref.className,
@@ -27,6 +27,10 @@ import { defaults } from '../EmptyState';
27
27
  // The block part of our conventional BEM class names (blockClass__E--M).
28
28
  var blockClass = "".concat(pkg.prefix, "--empty-state");
29
29
  var componentName = 'ErrorEmptyState';
30
+
31
+ /**
32
+ * The `EmptyState` component follows the Carbon guidelines for empty states with some added specifications around illustration usage. For additional usage guidelines and documentation please refer to the links above.
33
+ */
30
34
  export var ErrorEmptyState = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
31
35
  var action = _ref.action,
32
36
  className = _ref.className,
@@ -27,6 +27,10 @@ import { defaults } from '../EmptyState';
27
27
  // The block part of our conventional BEM class names (blockClass__E--M).
28
28
  var blockClass = "".concat(pkg.prefix, "--empty-state");
29
29
  var componentName = 'NoDataEmptyState';
30
+
31
+ /**
32
+ * The `EmptyState` component follows the Carbon guidelines for empty states with some added specifications around illustration usage. For additional usage guidelines and documentation please refer to the links above.
33
+ */
30
34
  export var NoDataEmptyState = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
31
35
  var action = _ref.action,
32
36
  className = _ref.className,
@@ -27,6 +27,10 @@ import { defaults } from '../EmptyState';
27
27
  // The block part of our conventional BEM class names (blockClass__E--M).
28
28
  var blockClass = "".concat(pkg.prefix, "--empty-state");
29
29
  var componentName = 'NoTagsEmptyState';
30
+
31
+ /**
32
+ * The `EmptyState` component follows the Carbon guidelines for empty states with some added specifications around illustration usage. For additional usage guidelines and documentation please refer to the links above.
33
+ */
30
34
  export var NoTagsEmptyState = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
31
35
  var action = _ref.action,
32
36
  className = _ref.className,
@@ -27,6 +27,10 @@ import { defaults } from '../EmptyState';
27
27
  // The block part of our conventional BEM class names (blockClass__E--M).
28
28
  var blockClass = "".concat(pkg.prefix, "--empty-state");
29
29
  var componentName = 'NotFoundEmptyState';
30
+
31
+ /**
32
+ * The `EmptyState` component follows the Carbon guidelines for empty states with some added specifications around illustration usage. For additional usage guidelines and documentation please refer to the links above.
33
+ */
30
34
  export var NotFoundEmptyState = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
31
35
  var action = _ref.action,
32
36
  className = _ref.className,
@@ -27,6 +27,10 @@ import { defaults } from '../EmptyState';
27
27
  // The block part of our conventional BEM class names (blockClass__E--M).
28
28
  var blockClass = "".concat(pkg.prefix, "--empty-state");
29
29
  var componentName = 'NotificationsEmptyState';
30
+
31
+ /**
32
+ * The `EmptyState` component follows the Carbon guidelines for empty states with some added specifications around illustration usage. For additional usage guidelines and documentation please refer to the links above.
33
+ */
30
34
  export var NotificationsEmptyState = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
31
35
  var action = _ref.action,
32
36
  className = _ref.className,
@@ -27,6 +27,10 @@ import { defaults } from '../EmptyState';
27
27
  // The block part of our conventional BEM class names (blockClass__E--M).
28
28
  var blockClass = "".concat(pkg.prefix, "--empty-state");
29
29
  var componentName = 'UnauthorizedEmptyState';
30
+
31
+ /**
32
+ * The `EmptyState` component follows the Carbon guidelines for empty states with some added specifications around illustration usage. For additional usage guidelines and documentation please refer to the links above.
33
+ */
30
34
  export var UnauthorizedEmptyState = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
31
35
  var action = _ref.action,
32
36
  className = _ref.className,
@@ -0,0 +1,22 @@
1
+ /**
2
+ * Copyright IBM Corp. 2023, 2023
3
+ *
4
+ * This source code is licensed under the Apache-2.0 license found in the
5
+ * LICENSE file in the root directory of this source tree.
6
+ */
7
+ import React from 'react';
8
+ import { StoryDocsPage } from '../../global/js/utils/StoryDocsPage';
9
+ import * as stories from './ExampleComponent.stories';
10
+
11
+ /**
12
+ * OPTIONAL: required only to customize default docs page
13
+ */
14
+ var DocsPage = function DocsPage() {
15
+ return /*#__PURE__*/React.createElement(StoryDocsPage, {
16
+ blocks: [{
17
+ description: 'Here it is in use.',
18
+ story: stories.exampleComponent
19
+ }]
20
+ });
21
+ };
22
+ export default DocsPage;
@@ -28,6 +28,10 @@ var defaults = {
28
28
  preformattedExtensions: Object.freeze([]),
29
29
  validExtensions: Object.freeze([])
30
30
  };
31
+
32
+ /**
33
+ * Modal dialog version of the export pattern
34
+ */
31
35
  export var ExportModal = /*#__PURE__*/forwardRef(function (_ref, ref) {
32
36
  var body = _ref.body,
33
37
  className = _ref.className,