@carbon/ibm-products 2.1.2 → 2.1.3

package/es/components/CreateModal/CreateModal.js

@@ -30,6 +30,13 @@ var isValidChildren = function isValidChildren() {
     return;
   };
 };
+
+/**
+ * The `CreateModal` component provides a way for a user to quickly generate a new
+resource. It is triggered by a user’s action, appears on top of the main page
+content, and is persistent until dismissed. The purpose of this modal should be
+immediately apparent to the user, with a clear and obvious path to completion.
+ */
 export var CreateModal = /*#__PURE__*/React.forwardRef(function (_ref2, ref) {
   var className = _ref2.className,
     children = _ref2.children,

package/es/components/CreateSidePanel/CreateSidePanel.docs-page.js

@@ -0,0 +1,18 @@
+import React from 'react';
+import { StoryDocsPage } from '../../global/js/utils/StoryDocsPage';
+import * as stories from './CreateSidePanel.stories';
+var DocsPage = function DocsPage() {
+  return /*#__PURE__*/React.createElement(StoryDocsPage, {
+    altGuidelinesHref: [{
+      href: 'https://pages.github.ibm.com/cdai-design/pal/patterns/creation-flows/usage#side-panel',
+      label: 'Carbon create flows side panel usage guidelines'
+    }],
+    blocks: [{
+      story: stories.Default
+    }, {
+      title: 'Form validation',
+      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)."
+    }]
+  });
+};
+export default DocsPage;

package/es/components/CreateSidePanel/CreateSidePanel.js

@@ -31,7 +31,7 @@ var componentName = 'CreateSidePanel';
 // NOTE: the component SCSS is not imported here: it is rolled up separately.
 
 /**
- * This is an example component to show relevant conventions and usage.
+ * Use with medium complexity creations if the user needs page context. On-page content can be seen and interacted with.
  */
 export var CreateSidePanel = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
   var className = _ref.className,

package/es/components/CreateTearsheet/CreateTearsheet.docs-page.js

@@ -0,0 +1,29 @@
+import React from 'react';
+import { StoryDocsPage } from '../../global/js/utils/StoryDocsPage';
+import * as stories from './CreateTearsheet.stories';
+var DocsPage = function DocsPage() {
+  return /*#__PURE__*/React.createElement(StoryDocsPage, {
+    altGuidelinesHref: "https://pages.github.ibm.com/cdai-design/pal/patterns/creation-flows/usage#wide-tearsheet",
+    blocks: [{
+      story: stories.multiStepTearsheet,
+      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:",
+      source: {
+        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>"
+      }
+    }, {
+      title: 'Using custom components',
+      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:",
+      source: {
+        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};"
+      }
+    }, {
+      title: 'Using dynamic steps',
+      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:",
+      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};"
+    }, {
+      title: 'Class names',
+      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"
+    }]
+  });
+};
+export default DocsPage;

package/es/components/Datagrid/Datagrid/DatagridSelectAllWithToggle.js

@@ -35,6 +35,9 @@ var SelectAllWithToggle = function SelectAllWithToggle(_ref) {
     allRowsLabel = _ref$allRowsLabel === void 0 ? 'Select all' : _ref$allRowsLabel,
     columns = _ref.columns,
     withStickyColumn = _ref.withStickyColumn;
+  var _ref2 = selectAllToggle || {},
+    onSelectAllRows = _ref2.onSelectAllRows,
+    labels = _ref2.labels;
   var _useState = useState(SELECT_ALL_PAGE_ROWS),
     _useState2 = _slicedToArray(_useState, 2),
     selectAllMode = _useState2[0],
@@ -57,9 +60,6 @@ var SelectAllWithToggle = function SelectAllWithToggle(_ref) {
       return window.removeEventListener('resize', updateSize);
     };
   }, []);
-  var _ref2 = selectAllToggle || {},
-    onSelectAllRows = _ref2.onSelectAllRows,
-    labels = _ref2.labels;
   if (labels) {
     allPageRowsLabel = labels.allPageRows || allPageRowsLabel;
     allRowsLabel = labels.allRows || allRowsLabel;

package/es/components/Datagrid/Datagrid/DatagridToolbar.js

@@ -16,6 +16,7 @@ import { pkg, carbon } from '../../../settings';
 import cx from 'classnames';
 var blockClass = "".concat(pkg.prefix, "--datagrid");
 var DatagridBatchActionsToolbar = function DatagridBatchActionsToolbar(datagridState, width, ref) {
+  var _Object$keys;
   var _useState = useState(false),
     _useState2 = _slicedToArray(_useState, 2),
     displayAllInMenu = _useState2[0],
@@ -28,11 +29,11 @@ var DatagridBatchActionsToolbar = function DatagridBatchActionsToolbar(datagridS
     _useState6 = _slicedToArray(_useState5, 2),
     receivedInitialWidth = _useState6[0],
     setReceivedInitialWidth = _useState6[1];
-  var selectedFlatRows = datagridState.selectedFlatRows,
+  var selectedRowIds = datagridState.state.selectedRowIds,
     toggleAllRowsSelected = datagridState.toggleAllRowsSelected,
     toolbarBatchActions = datagridState.toolbarBatchActions,
     setGlobalFilter = datagridState.setGlobalFilter;
-  var totalSelected = selectedFlatRows && selectedFlatRows.length;
+  var totalSelected = (_Object$keys = Object.keys(selectedRowIds || {})) === null || _Object$keys === void 0 ? void 0 : _Object$keys.length;
 
   // Get initial width of batch actions container,
   // used to measure when all items are put inside

package/es/components/Datagrid/Datagrid/addons/InlineEdit/InlineEditCell/InlineEditCell.js

@@ -5,7 +5,7 @@ import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
 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; }
 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; }
 /**
- * Copyright IBM Corp. 2022, 2022
+ * Copyright IBM Corp. 2022, 2023
  *
  * This source code is licensed under the Apache-2.0 license found in the
  * LICENSE file in the root directory of this source tree.
@@ -31,7 +31,8 @@ export var InlineEditCell = function InlineEditCell(_ref) {
     placeholder = _ref$placeholder === void 0 ? '' : _ref$placeholder,
     tabIndex = _ref.tabIndex,
     value = _ref.value,
-    nonEditCell = _ref.nonEditCell,
+    _ref$nonEditCell = _ref.nonEditCell,
+    nonEditCell = _ref$nonEditCell === void 0 ? false : _ref$nonEditCell,
     totalInlineEditColumns = _ref.totalInlineEditColumns,
     type = _ref.type;
   var columnId = cell.column.id;
@@ -74,21 +75,7 @@ export var InlineEditCell = function InlineEditCell(_ref) {
   var outerButtonElement = useRef();
   var rowSize = instance.rowSize,
     onDataUpdate = instance.onDataUpdate;
-
-  // Saves the new cell data, onDataUpdate is a required function to be
-  // passed to useDatagrid when using useInlineEdit
-  var saveCellData = useCallback(function (newValue) {
-    var columnId = cell.column.id;
-    var rowIndex = cell.row.index;
-    onDataUpdate(function (prev) {
-      return prev.map(function (row, index) {
-        if (index === rowIndex) {
-          return _objectSpread(_objectSpread({}, prev[rowIndex]), {}, _defineProperty({}, columnId, newValue));
-        }
-        return row;
-      });
-    });
-  }, [cell, onDataUpdate]);
+  var saveCellData;
   useEffect(function () {
     setInitialValue(value);
     var columnId = cell.column.id;
@@ -175,6 +162,21 @@ export var InlineEditCell = function InlineEditCell(_ref) {
     }
   }, [inEditMode, type]);
 
+  // Saves the new cell data, onDataUpdate is a required function to be
+  // passed to useDatagrid when using useInlineEdit
+  saveCellData = useCallback(function (newValue) {
+    var columnId = cell.column.id;
+    var rowIndex = cell.row.index;
+    onDataUpdate(function (prev) {
+      return prev.map(function (row, index) {
+        if (index === rowIndex) {
+          return _objectSpread(_objectSpread({}, prev[rowIndex]), {}, _defineProperty({}, columnId, newValue));
+        }
+        return row;
+      });
+    });
+  }, [cell, onDataUpdate]);
+
   // Initialize cellValue from value prop
   useEffect(function () {
     setCellValue(value);

package/es/components/Datagrid/Datagrid/addons/InlineEdit/handleGridKeyPress.js

@@ -2,7 +2,7 @@ import _defineProperty from "@babel/runtime/helpers/defineProperty";
 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; }
 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; }
 /**
- * Copyright IBM Corp. 2022, 2022
+ * Copyright IBM Corp. 2022, 2023
  *
  * This source code is licensed under the Apache-2.0 license found in the
  * LICENSE file in the root directory of this source tree.
@@ -86,7 +86,7 @@ export var handleGridKeyPress = function handleGridKeyPress(_ref) {
   if (['End', 'Home', 'ArrowLeft', 'ArrowUp', 'ArrowRight', 'ArrowDown'].indexOf(key) > -1 && !isEditing && keysPressedList.length < 2) {
     event.preventDefault();
   }
-  var isDisabledCell = !!focusedCell.getAttribute('data-disabled');
+  var isDisabledCell = focusedCell.getAttribute('data-disabled') === 'false' ? false : true;
   var sharedUpdateParams = {
     oldId: activeCellId,
     instance: instance

package/es/components/EditFullPage/EditFullPage.docs-page.js

@@ -0,0 +1,39 @@
+import React from 'react';
+import { StoryDocsPage } from '../../global/js/utils/StoryDocsPage';
+import * as stories from './EditFullPage.stories';
+var DocsPage = function DocsPage() {
+  return /*#__PURE__*/React.createElement(StoryDocsPage, {
+    altGuidelinesHref: "https://pages.github.ibm.com/cdai-design/pal/patterns/edit/usage#full-page-edit",
+    blocks: [{
+      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."
+    }, {
+      story: stories.editFullPage,
+      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:",
+      source: {
+        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>"
+      }
+    }, {
+      story: stories.editFullPageWithSections,
+      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:",
+      source: {
+        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>"
+      }
+    }, {
+      title: 'Using custom components',
+      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:",
+      source: {
+        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};"
+      }
+    }, {
+      title: 'Using dynamic steps',
+      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:",
+      source: {
+        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};"
+      }
+    }, {
+      title: 'Class names',
+      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"
+    }]
+  });
+};
+export default DocsPage;

package/es/components/EditFullPage/EditFullPage.js

@@ -41,7 +41,8 @@ var componentName = 'EditFullPage';
 // };
 
 /**
- * TODO: A description of the component.
+ * 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.
+ * See usage guidance for further details.
  */
 export var EditFullPage = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
   var children = _ref.children,

package/es/components/EditSidePanel/EditSidePanel.js

@@ -38,7 +38,7 @@ var defaults = {
 };
 
 /**
- * TODO: A description of the component.
+ * Use with medium complexity edits if the user needs page context.
  */
 export var EditSidePanel = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
   var children = _ref.children,

package/es/components/EditTearsheet/EditTearsheet.docs-page.js

@@ -0,0 +1,25 @@
+import React from 'react';
+import { StoryDocsPage } from '../../global/js/utils/StoryDocsPage';
+import * as stories from './EditTearsheet.stories';
+var DocsPage = function DocsPage() {
+  return /*#__PURE__*/React.createElement(StoryDocsPage, {
+    altGuidelinesHref: "https://pages.github.ibm.com/cdai-design/pal/patterns/edit/usage#tearsheet-edit",
+    blocks: [{
+      story: stories.multiFormEditTearsheet,
+      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:",
+      source: {
+        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>"
+      }
+    }, {
+      title: 'Using custom components',
+      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:",
+      source: {
+        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};"
+      }
+    }, {
+      title: "Class names",
+      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"
+    }]
+  });
+};
+export default DocsPage;

package/es/components/EditTearsheet/EditTearsheet.js

@@ -33,6 +33,10 @@ var defaults = {
   verticalPosition: 'normal',
   influencerWidth: 'narrow'
 };
+
+/**
+ * Use Tearsheet with medium to complex edits. See usage guidance for further information.
+ */
 export var EditTearsheet = /*#__PURE__*/forwardRef(function (_ref, ref) {
   var cancelButtonText = _ref.cancelButtonText,
     children = _ref.children,

package/es/components/EditTearsheetNarrow/EditTearsheetNarrow.js

@@ -41,7 +41,7 @@ var componentName = 'EditTearsheetNarrow';
 // };
 
 /**
- * TODO: A description of the component.
+ * Use a narrow tearsheet as an alternative to a modal when there is scrolling. See usage guidance for further information.
  */
 export var EditTearsheetNarrow = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
   var children = _ref.children,

package/es/components/EditUpdateCards/EditUpdateCards.js

@@ -44,9 +44,10 @@ var componentName = 'EditUpdateCards';
 // };
 
 /**
- * TODO: A description of the component.
+ Editable cards allow a user to view, modify, and save the content contained within the card.
+ These cards are generally used in instances where a user needs to make changes to a resource instances
+ (ex. configuration details), account plan, etc. Editable cards allow a user to edit something within context.
  */
-
 export var EditUpdateCards = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
   var actionIcons = _ref.actionIcons,
     actionsPlacement = _ref.actionsPlacement,

package/es/components/EmptyStates/EmptyState.js

@@ -32,6 +32,10 @@ export var defaults = {
   position: 'top',
   size: 'lg'
 };
+
+/**
+ * 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.
+ */
 export var EmptyState = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
   var action = _ref.action,
     className = _ref.className,

package/es/components/EmptyStates/ErrorEmptyState/ErrorEmptyState.js

@@ -27,6 +27,10 @@ import { defaults } from '../EmptyState';
 // The block part of our conventional BEM class names (blockClass__E--M).
 var blockClass = "".concat(pkg.prefix, "--empty-state");
 var componentName = 'ErrorEmptyState';
+
+/**
+ * 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.
+ */
 export var ErrorEmptyState = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
   var action = _ref.action,
     className = _ref.className,

package/es/components/EmptyStates/NoDataEmptyState/NoDataEmptyState.js

@@ -27,6 +27,10 @@ import { defaults } from '../EmptyState';
 // The block part of our conventional BEM class names (blockClass__E--M).
 var blockClass = "".concat(pkg.prefix, "--empty-state");
 var componentName = 'NoDataEmptyState';
+
+/**
+ * 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.
+ */
 export var NoDataEmptyState = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
   var action = _ref.action,
     className = _ref.className,

package/es/components/EmptyStates/NoTagsEmptyState/NoTagsEmptyState.js

@@ -27,6 +27,10 @@ import { defaults } from '../EmptyState';
 // The block part of our conventional BEM class names (blockClass__E--M).
 var blockClass = "".concat(pkg.prefix, "--empty-state");
 var componentName = 'NoTagsEmptyState';
+
+/**
+ * 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.
+ */
 export var NoTagsEmptyState = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
   var action = _ref.action,
     className = _ref.className,

package/es/components/EmptyStates/NotFoundEmptyState/NotFoundEmptyState.js

@@ -27,6 +27,10 @@ import { defaults } from '../EmptyState';
 // The block part of our conventional BEM class names (blockClass__E--M).
 var blockClass = "".concat(pkg.prefix, "--empty-state");
 var componentName = 'NotFoundEmptyState';
+
+/**
+ * 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.
+ */
 export var NotFoundEmptyState = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
   var action = _ref.action,
     className = _ref.className,

package/es/components/EmptyStates/NotificationsEmptyState/NotificationsEmptyState.js

@@ -27,6 +27,10 @@ import { defaults } from '../EmptyState';
 // The block part of our conventional BEM class names (blockClass__E--M).
 var blockClass = "".concat(pkg.prefix, "--empty-state");
 var componentName = 'NotificationsEmptyState';
+
+/**
+ * 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.
+ */
 export var NotificationsEmptyState = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
   var action = _ref.action,
     className = _ref.className,

package/es/components/EmptyStates/UnauthorizedEmptyState/UnauthorizedEmptyState.js

@@ -27,6 +27,10 @@ import { defaults } from '../EmptyState';
 // The block part of our conventional BEM class names (blockClass__E--M).
 var blockClass = "".concat(pkg.prefix, "--empty-state");
 var componentName = 'UnauthorizedEmptyState';
+
+/**
+ * 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.
+ */
 export var UnauthorizedEmptyState = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
   var action = _ref.action,
     className = _ref.className,

package/es/components/ExampleComponent/ExampleComponent.docs-page.js

@@ -0,0 +1,22 @@
+/**
+ * Copyright IBM Corp. 2023, 2023
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import React from 'react';
+import { StoryDocsPage } from '../../global/js/utils/StoryDocsPage';
+import * as stories from './ExampleComponent.stories';
+
+/**
+ * OPTIONAL: required only to customize default docs page
+ */
+var DocsPage = function DocsPage() {
+  return /*#__PURE__*/React.createElement(StoryDocsPage, {
+    blocks: [{
+      description: 'Here it is in use.',
+      story: stories.exampleComponent
+    }]
+  });
+};
+export default DocsPage;

package/es/components/ExportModal/ExportModal.js

@@ -28,6 +28,10 @@ var defaults = {
   preformattedExtensions: Object.freeze([]),
   validExtensions: Object.freeze([])
 };
+
+/**
+ * Modal dialog version of the export pattern
+ */
 export var ExportModal = /*#__PURE__*/forwardRef(function (_ref, ref) {
   var body = _ref.body,
     className = _ref.className,

package/es/components/HTTPErrors/HTTPError403/HTTPError403.js

@@ -22,6 +22,12 @@ import { pkg } from '../../../settings';
 // The block part of our conventional BEM class names (blockClass__E--M).
 var blockClass = "".concat(pkg.prefix, "--http-errors");
 var componentName = 'HTTPError403';
+
+/**
+ * HTTP errors are used in an attempt to access something that isn’t available or
+the user doesn’t have permission for. This HTTPError component is generic so you
+can use it when you receive an error code that isn't provided.
+ */
 export var HTTPError403 = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
   var className = _ref.className,
     description = _ref.description,

package/es/components/HTTPErrors/HTTPError404/HTTPError404.js

@@ -22,6 +22,12 @@ import { pkg } from '../../../settings';
 // The block part of our conventional BEM class names (blockClass__E--M).
 var blockClass = "".concat(pkg.prefix, "--http-errors");
 var componentName = 'HTTPError404';
+
+/**
+ * HTTP errors are used in an attempt to access something that isn’t available or
+the user doesn’t have permission for. This HTTPError component is generic so you
+can use it when you receive an error code that isn't provided.
+ */
 export var HTTPError404 = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
   var className = _ref.className,
     description = _ref.description,

package/es/components/HTTPErrors/HTTPErrorOther/HTTPErrorOther.js

@@ -22,6 +22,12 @@ import { pkg } from '../../../settings';
 // The block part of our conventional BEM class names (blockClass__E--M).
 var blockClass = "".concat(pkg.prefix, "--http-errors");
 var componentName = 'HTTPErrorOther';
+
+/**
+ * HTTP errors are used in an attempt to access something that isn’t available or
+the user doesn’t have permission for. This HTTPError component is generic so you
+can use it when you receive an error code that isn't provided.
+ */
 export var HTTPErrorOther = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
   var className = _ref.className,
     description = _ref.description,

package/es/components/ImportModal/ImportModal.docs-page.js

@@ -0,0 +1,18 @@
+import React from 'react';
+import { StoryDocsPage } from '../../global/js/utils/StoryDocsPage';
+import { useOf } from '@storybook/blocks';
+import { storyDocsGuidelines } from '../../global/js/utils/story-helper';
+var DocsPage = function DocsPage() {
+  var _useOf = useOf('meta', ['meta']),
+    csfFile = _useOf.csfFile;
+  return /*#__PURE__*/React.createElement(StoryDocsPage, {
+    altGuidelinesHref: [storyDocsGuidelines(csfFile), {
+      href: 'https://www.carbondesignsystem.com/components/modal/usage',
+      label: 'Carbon Modal usage guidelines'
+    }, {
+      href: 'https://react.carbondesignsystem.com/?path=/docs/modal--default',
+      label: 'Carbon Modal documentation'
+    }]
+  });
+};
+export default DocsPage;

package/es/components/MultiAddSelect/MultiAddSelect.docs-page.js

@@ -0,0 +1,17 @@
+import React from 'react';
+import { StoryDocsPage } from '../../global/js/utils/StoryDocsPage';
+var DocsPage = function DocsPage() {
+  return /*#__PURE__*/React.createElement(StoryDocsPage, {
+    altGuidelinesHref: "https://pages.github.ibm.com/cdai-design/pal/patterns/add-and-select/usage",
+    blocks: [{
+      title: 'Structuring items',
+      description: "The `items` object has a lot of customization potential and can greatly effect\nthe way the component is displayed and how you interact with it.\n\nLet's walk through an example.",
+      source: {
+        code: "items: {\n  modifiers: { // adds a modifier dropdown inside the items\n    label: PropTypes.string, // label for the dropdown\n    options: PropTypes.array, // list of options / values for the dropdown\n  },\n  sortBy: ['title'], // designates which properties should be used to sort the column when using a hierarchy\n  entries: [ // the actual list of items / entries\n    {\n      id: '1', // required unique id for the entry\n      value: '1', // required value of the entry\n      title: 'item 1', // required title to display\n      subtitle: 'item 1 subtitle', // subtitle to display\n      children: { // designates if entry has children. if the children prop is found a hierarchy list will be used\n        sortBy: ['title', 'size'],\n        filterBy: 'fileType', // designates which property should be used to filter the column of items\n        entries: [\n          {\n            id: '1-1',\n            value: 'file1.pdf',\n            title: 'file1.pdf',\n            fileType: 'pdf',\n            size: '100',\n            icon: Document16, // designates if an icon should be displayed. While similar to avatar icon, both have different displays.\n            tag: 'business',\n            avatar: { // designates if an avatar should be displayed\n              alt: 'alt text',\n              icon: <Icon />,\n              src: 'avatar.png',\n            },\n          },\n        ],\n      },\n    },\n  ],\n}"
+      }
+    }, {
+      description: "The properties that have been commented on like `id`, `value`, and `icon` have\nspecific use within the component and are generally required. Other properties\nlike `fileType` and `size` do not and will simply show up as details in the\nsidebar when selected."
+    }]
+  });
+};
+export default DocsPage;

package/es/components/MultiAddSelect/MultiAddSelect.js

@@ -12,6 +12,10 @@ import { AddSelect } from '../AddSelect';
 import { getDevtoolsProps } from '../../global/js/utils/devtools';
 import { pkg } from '../../settings';
 var componentName = 'MultiAddSelect';
+
+/**
+ * Used to add or select multiple or more items from larger lists or hierarchies.
+ */
 export var MultiAddSelect = /*#__PURE__*/forwardRef(function (props, ref) {
   return /*#__PURE__*/React.createElement(AddSelect, _extends({}, props, {
     multi: true,

package/es/components/RemoveModal/RemoveModal.docs-page.js

@@ -0,0 +1,18 @@
+import React from 'react';
+import { StoryDocsPage } from '../../global/js/utils/StoryDocsPage';
+import { useOf } from '@storybook/blocks';
+import { storyDocsGuidelines } from '../../global/js/utils/story-helper';
+var DocsPage = function DocsPage() {
+  var _useOf = useOf('meta', ['meta']),
+    csfFile = _useOf.csfFile;
+  return /*#__PURE__*/React.createElement(StoryDocsPage, {
+    altGuidelinesHref: [storyDocsGuidelines(csfFile), {
+      href: 'https://www.carbondesignsystem.com/components/modal/usage',
+      label: 'Carbon Modal usage guidelines'
+    }, {
+      href: 'https://react.carbondesignsystem.com/?path=/docs/modal--default',
+      label: 'Carbon Modal documentation'
+    }]
+  });
+};
+export default DocsPage;

package/es/components/RemoveModal/RemoveModal.js

@@ -21,6 +21,12 @@ import uuidv4 from '../../global/js/utils/uuidv4';
 import { pkg } from '../../settings';
 import { usePreviousValue } from '../../global/js/hooks';
 var componentName = 'RemoveModal';
+
+/**
+The `RemoveModal` covers what is known as high impact and medium impact deleting.
+Enabling `textConfirmation` enables what would be considered the high impact state of the modal.
+For additional information on differentiating between delete / remove and low / medium / high impact please refer to the usage guidelines.
+ */
 export var RemoveModal = /*#__PURE__*/forwardRef(function (_ref, ref) {
   var body = _ref.body,
     className = _ref.className,

package/es/components/SingleAddSelect/SingleAddSelect.docs-page.js

@@ -0,0 +1,15 @@
+import React from 'react';
+import { StoryDocsPage } from '../../global/js/utils/StoryDocsPage';
+var DocsPage = function DocsPage() {
+  return /*#__PURE__*/React.createElement(StoryDocsPage, {
+    altGuidelinesHref: "https://pages.github.ibm.com/cdai-design/pal/patterns/add-and-select/usage",
+    blocks: [{
+      title: 'Structuring items',
+      description: "The `items` object has a lot of customization potential and can greatly effect\nthe way the component is displayed and how you interact with it..\n\nLet's walk through an example.",
+      source: {
+        code: "items: {\n  entries: [ // the actual list of items / entries\n    {\n      id: '1', // required unique id for the entry\n      value: '1', // required value of the entry\n      title: 'item 1', // required title to display\n      subtitle: 'item 1 subtitle', // subtitle to display\n      children: { // designates if entry has children. if the children prop is found a hierarchy list will be used\n        entries: [\n          {\n            id: '1-1',\n            value: 'file1.pdf',\n            title: 'file1.pdf',\n          },\n        ],\n      },\n    },\n  ],\n}"
+      }
+    }]
+  });
+};
+export default DocsPage;