@carbon/ibm-products 2.1.1 → 2.1.3

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/ImportModal/ImportModal.js

@@ -179,6 +179,13 @@ export var ImportModal = /*#__PURE__*/forwardRef(function (_ref, ref) {
   var inputHandler = function inputHandler(evt) {
     setImportUrl(evt.target.value);
   };
+  var onCloseHandler = function onCloseHandler() {
+    setFiles([]);
+    setImportUrl('');
+    if (onClose) {
+      onClose();
+    }
+  };
   var numberOfFiles = files.length;
   var numberOfValidFiles = files.filter(function (f) {
     return !f.invalid;
@@ -190,13 +197,13 @@ export var ImportModal = /*#__PURE__*/forwardRef(function (_ref, ref) {
   var blockClass = "".concat(pkg.prefix, "--import-modal");
   return /*#__PURE__*/React.createElement(ComposedModal, _extends({}, rest, _objectSpread({
     open: open,
-    ref: ref,
-    onClose: onClose
+    ref: ref
   }, getDevtoolsProps(componentName)), {
     "aria-label": title,
     className: cx(blockClass, className),
     size: "sm",
-    preventCloseOnClickOutside: true
+    preventCloseOnClickOutside: true,
+    onClose: onCloseHandler
   }), /*#__PURE__*/React.createElement(ModalHeader, {
     className: "".concat(blockClass, "__header"),
     title: title
@@ -259,7 +266,7 @@ export var ImportModal = /*#__PURE__*/forwardRef(function (_ref, ref) {
   }, /*#__PURE__*/React.createElement(Button, {
     type: "button",
     kind: "secondary",
-    onClick: onClose
+    onClick: onCloseHandler
   }, secondaryButtonText), /*#__PURE__*/React.createElement(Button, {
     type: "submit",
     kind: "primary",
@@ -362,11 +369,11 @@ ImportModal.propTypes = {
   /**
    * Specify a handler for "submitting" modal. Access the imported file via `file => {}`
    */
-  onRequestSubmit: PropTypes.func,
+  onRequestSubmit: PropTypes.func.isRequired,
   /**
    * Specify whether the Modal is currently open
    */
-  open: PropTypes.bool,
+  open: PropTypes.bool.isRequired,
   /**
    * Specify the text for the primary button
    */

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/NotificationsPanel/preview-components/UnreadNotificationBell.js

@@ -15,34 +15,19 @@ var UnreadNotificationBell = function UnreadNotificationBell() {
     xmlns: "http://www.w3.org/2000/svg",
     xmlnsXlink: "http://www.w3.org/1999/xlink"
   }, /*#__PURE__*/React.createElement("title", null, "Unread notification bell"), /*#__PURE__*/React.createElement("g", {
-    id: "Page-1",
-    stroke: "none",
-    strokeWidth: "1",
-    fill: "none",
-    fillRule: "evenodd"
-  }, /*#__PURE__*/React.createElement("g", {
     id: "Group",
     transform: "translate(-1.000000, 0.000000)"
-  }, /*#__PURE__*/React.createElement("g", {
-    id: "notification"
   }, /*#__PURE__*/React.createElement("path", {
     d: "M17.9419375,12.058125 L16.25,10.3661875 L16.25,8.125 C16.245845,4.91692673 13.816599,2.23147626 10.625,1.90675 L10.625,0.625 L9.375,0.625 L9.375,1.90675 C6.183401,2.23147626 3.754155,4.91692673 3.75,8.125 L3.75,10.3661875 L2.0580625,12.058125 C1.94086706,12.1753182 1.875,12.3342622 1.875,12.5 L1.875,14.375 C1.875,14.720178 2.15482203,15 2.5,15 L6.875,15 L6.875,15.4855 C6.84694527,17.1272367 8.05869477,18.5271305 9.6875,18.7346875 C10.5660567,18.8218694 11.4405518,18.5337871 12.0952737,17.9415019 C12.7499955,17.3492167 13.1239886,16.5078712 13.125,15.625 L13.125,15 L17.5,15 C17.845178,15 18.125,14.720178 18.125,14.375 L18.125,12.5 C18.125,12.3342622 18.0591329,12.1753182 17.9419375,12.058125 Z M11.875,15.625 C11.875,16.6605339 11.0355339,17.5 10,17.5 C8.96446609,17.5 8.125,16.6605339 8.125,15.625 L8.125,15 L11.875,15 L11.875,15.625 Z M16.875,13.75 L3.125,13.75 L3.125,12.7588125 L4.816875,11.066875 C4.93409336,10.949692 4.9999646,10.7907468 5,10.625 L5,8.125 C5,5.36357625 7.23857625,3.125 10,3.125 C12.7614237,3.125 15,5.36357625 15,8.125 L15,10.625 C15.0000354,10.7907468 15.0659066,10.949692 15.183125,11.066875 L16.875,12.7588125 L16.875,13.75 Z",
     id: "Shape",
-    fill: "#FFFFFF",
     fillRule: "nonzero"
-  }), /*#__PURE__*/React.createElement("rect", {
-    id: "_Transparent_Rectangle_",
-    x: "0",
-    y: "0",
-    width: "20",
-    height: "20"
-  })), /*#__PURE__*/React.createElement("circle", {
+  }), /*#__PURE__*/React.createElement("circle", {
     id: "Oval",
     stroke: "#161616",
     fill: "#DA1E28",
     cx: "15",
     cy: "4.375",
     r: "2.5"
-  }))));
+  })));
 };
 export { UnreadNotificationBell };

package/es/components/PageHeader/PageHeaderUtils.js

@@ -65,11 +65,11 @@ export var utilCheckUpdateVerticalSpace = function utilCheckUpdateVerticalSpace(
     var scrollableContainer = scrollableAncestor(headerRef.current);
 
     /* istanbul ignore next */
-    var scrollableContainerTop = scrollableContainer ? scrollableContainer.scrollTop - scrollableContainer.offsetTop : 0;
+    var scrollableContainerTop = scrollableContainer ? scrollableContainer.scrollTop - scrollableContainer.getBoundingClientRect().top : 0;
 
     // The header offset calculation is either going to work out at 0 if we have no gap between scrolling container
     // top and the measuring ref top, or the difference between. It does not change on scroll or resize.
-    update.headerOffset = scrollableContainerTop + offsetTopMeasuringRef.current.getBoundingClientRect().top;
+    update.headerOffset = (offsetTopMeasuringRef.current ? offsetTopMeasuringRef.current.getBoundingClientRect().top : 0) + scrollableContainerTop;
 
     /* istanbul ignore next */
     update.breadcrumbRowHeight = breadcrumbRowEl ? breadcrumbRowEl.clientHeight : 0;

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;

package/es/components/SingleAddSelect/SingleAddSelect.js

@@ -13,6 +13,10 @@ import { getDevtoolsProps } from '../../global/js/utils/devtools';
 import { pkg } from '../../settings';
 import { prepareProps } from '../../global/js/utils/props-helper';
 var componentName = 'SingleAddSelect';
+
+/**
+ * Used to add or select one or more items from larger lists or hierarchies.
+ */
 export var SingleAddSelect = /*#__PURE__*/forwardRef(function (props, ref) {
   // remove multi add select specific props
   var validProps = prepareProps(props, ['columnInputPlaceholder', 'globalFilters', 'globalFiltersIconDescription', 'globalFiltersPlaceholderText', 'globalFiltersPrimaryButtonText', 'globalFiltersSecondaryButtonText', 'influencerTitle', 'multi', 'noSelectionDescription', 'noSelectionTitle', 'removeIconDescription']);

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

@@ -0,0 +1,17 @@
+import React from 'react';
+import { StoryDocsPage } from '../../global/js/utils/StoryDocsPage';
+import * as stories from './StatusIcon.stories';
+var DocsPage = function DocsPage() {
+  return /*#__PURE__*/React.createElement(StoryDocsPage, {
+    blocks: [{
+      story: stories.Default
+    }, {
+      title: 'Accessibility',
+      description: "The `StatusIcon` component follows the Carbon guidelines for status icons with\nsome added specifications around illustration usage. For additional usage\nguidelines and documentation please refer to the links above.\n\n_Status icons_ are an important method of communicating severity level\ninformation to users. The shapes and colors, communicate severity that enable\nusers to quickly assess and identify status and respond accordingly."
+    }, {
+      title: 'Sizing',
+      description: "\n| Size    | Pixels  |\n| ------- | ------- |\n| small   | 16 x 16 |\n| medium  | 20 x 20 |\n| large   | 24 x 24 |\n| x-large | 32 x 32 |\n          "
+    }]
+  });
+};
+export default DocsPage;

package/es/components/StatusIcon/StatusIcon.js

@@ -16,6 +16,16 @@ import { getDevtoolsProps } from '../../global/js/utils/devtools';
 import { pkg } from '../../settings';
 var blockClass = "".concat(pkg.prefix, "--status-icon");
 var componentName = 'StatusIcon';
+
+/**
+The `StatusIcon` component follows the Carbon guidelines for status icons with
+some added specifications around illustration usage. For additional usage
+guidelines and documentation please refer to the links above.
+
+_Status icons_ are an important method of communicating severity level
+information to users. The shapes and colors, communicate severity that enable
+users to quickly assess and identify status and respond accordingly.
+ */
 export var StatusIcon = /*#__PURE__*/forwardRef(function (_ref, ref) {
   var _icons$kind;
   var kind = _ref.kind,

package/es/components/Tearsheet/TearsheetShell.js

@@ -55,7 +55,13 @@ export var tearsheetHasCloseIcon = function tearsheetHasCloseIcon(actions, hasCl
   return hasCloseIcon !== null && hasCloseIcon !== void 0 ? hasCloseIcon : tearsheetIsPassive(actions);
 };
 
-// TearSheetShell is used internally by TearSheet and TearSheetNarrow
+/**
+ *  TearSheetShell is used internally by TearSheet and TearSheetNarrow
+ *
+ * The component is not public.
+ *
+ * See the canvas tab for the component API details.
+ * */
 export var TearsheetShell = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
   var actions = _ref.actions,
     children = _ref.children,
@@ -216,7 +222,8 @@ export var TearsheetShell = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
       closeModal: onClose,
       iconDescription: closeIconDescription
     }, /*#__PURE__*/React.createElement(Wrap, {
-      className: "".concat(bc, "__header-content")
+      className: "".concat(bc, "__header-content"),
+      element: wide ? Layer : undefined
     }, /*#__PURE__*/React.createElement(Wrap, {
       className: "".concat(bc, "__header-fields")
     }, /*#__PURE__*/React.createElement(Wrap, {
@@ -241,12 +248,10 @@ export var TearsheetShell = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
       className: "".concat(bc, "__right")
     }, /*#__PURE__*/React.createElement(Wrap, {
       className: "".concat(bc, "__main"),
-      alwaysRender: includeActions,
-      element: wide ? Layer : undefined
+      alwaysRender: includeActions
     }, /*#__PURE__*/React.createElement(Wrap, {
       className: "".concat(bc, "__content"),
-      alwaysRender: influencer && influencerPosition === 'right',
-      element: wide ? Layer : undefined
+      alwaysRender: influencer && influencerPosition === 'right'
     }, children), /*#__PURE__*/React.createElement(Wrap, {
       className: cx((_cx6 = {}, _defineProperty(_cx6, "".concat(bc, "__influencer"), true), _defineProperty(_cx6, "".concat(bc, "__influencer--wide"), influencerWidth === 'wide'), _cx6)),
       neverRender: influencerPosition !== 'right'

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

@@ -0,0 +1,14 @@
+import React from 'react';
+import { StoryDocsPage } from '../../global/js/utils/StoryDocsPage';
+import * as stories from './Toolbar.stories';
+var DocsPage = function DocsPage() {
+  return /*#__PURE__*/React.createElement(StoryDocsPage, {
+    blocks: [{
+      story: stories._Toolbar
+    }, {
+      story: stories.vertical,
+      description: "A toolbar orientation for floating the toolbar on the canvas."
+    }]
+  });
+};
+export default DocsPage;

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

@@ -0,0 +1,17 @@
+import React from 'react';
+import { StoryDocsPage } from '../../global/js/utils/StoryDocsPage';
+import * as stories from './UserProfileImage.stories';
+var DocsPage = function DocsPage() {
+  return /*#__PURE__*/React.createElement(StoryDocsPage, {
+    blocks: [{
+      story: stories.Default
+    }, {
+      story: stories.WithGroupIcon,
+      description: "By passing in icon prop with a value of `group`, the avatar will display the group icon"
+    }, {
+      story: stories.WithInitials,
+      description: "When passing a display name to the component, the display name will be distilled down to the first and last initials of the display name. `Thomas Watson` and `Thomas J. Watson` will both display `TW` as the initials."
+    }]
+  });
+};
+export default DocsPage;

package/es/components/UserProfileImage/UserProfileImage.js

@@ -33,7 +33,7 @@ var defaults = {
   tooltipAlignment: 'bottom'
 };
 /**
- * This is a user profile image component which displays an image, or initials or icon for a user.
+ * The user profile avatar allows for an image of the user to be displayed by passing in the image prop. By default the component will display a user icon on a blue background.
  */
 export var UserProfileImage = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
   var backgroundColor = _ref.backgroundColor,

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

@@ -0,0 +1,52 @@
+import React from 'react';
+import { StoryDocsPage } from '../../global/js/utils/StoryDocsPage';
+import * as stories from './WebTerminal.stories';
+var DocsPage = function DocsPage() {
+  return /*#__PURE__*/React.createElement(StoryDocsPage, {
+    blocks: [{
+      description: "To get started using the WebTerminal, you have to first wrap your\n              application with the `<WebTerminalProvider>`\n              component. This will allow all the WebTerminal components to be\n              used with the `useWebTerminal()` custom hook.\n          ",
+      title: 'Getting Started',
+      source: {
+        code: "import { WebTerminalProvider } from '@carbon/ibm-products';\n\nconst App = () => {\n  return (\n    <WebTerminalProvider>\n      ...\n    <WebTerminalProvider>\n  )\n};"
+      }
+    }, {
+      title: 'useWebTerminal()',
+      source: {
+        code: "const { open, openWebTerminal, closeWebTerminal, toggleWebTerminal } =\n  useWebTerminal();"
+      }
+    }, {
+      description: "The `useWebTerminal()` hook returns an object with 4 properties:\n1. Read the `open` state (true or false)\n2. `openWebTerminal` sets the `open` state to true\n3. `closeWebTerminal` sets the `open` state to false\n4. `toggleWebTerminal` toggles between true and false\n\nExample:\n",
+      source: {
+        code: "const MyComponent = () => {\n  const { open, openWebTerminal, closeWebTerminal, toggleWebTerminal } =\n    useWebTerminal();\n\n  return (\n    <div>\n      <button onClick={() => openWebTerminal()}>Open web terminal</button>\n      <button onClick={() => closeWebTerminal()}>Close web terminal</button>\n      <button onClick={() => toggleWebTerminal()}>Toggle web terminal</button>\n      <p>The web terminal is now {open}</p>\n\n      <WebTerminal>...</WebTerminal>\n    </div>\n  );\n};"
+      }
+    }, {
+      subTitle: 'Passing in your own terminal.',
+      description: "The `WebTerminal` is wrapper component for your own\nterminal component that you may have been using for your product.\nSimply pass your own terminal component as children.\n            "
+    }, {
+      subTitle: 'Optional wrapper component.',
+      description: "Optionally you can import `WebTerminalContentWrapper` to have\n              content adjust their width based off the `WebTerminal` width when\n              it is opened.",
+      source: {
+        code: "<WebTerminalContentWrapper>\n  content\n</WebTerminalContentWrapper>\n\n<WebTerminal>\n  ...\n</WebTerminal>"
+      }
+    }, {
+      description: 'The default web terminal is one which opens and the terminal loads. Then if the user desires to dismiss it they can click the close icon on the top right corner of the component.',
+      story: stories.Default
+    }, {
+      story: stories.WithDocumentationLinks
+    }, {
+      subTitle: 'Help users with helpful documentation links',
+      description: "Optionally you can pass documentation links to help point your users to useful\ndocumentation for your terminal, or kubernetes commands etc.\n\nThe documentation links should reflect the same props as `OverflowMenuItem` from\ncarbon.\n\nLearn more:\nhttps://react.carbondesignsystem.com/?path=/docs/components-overflowmenu--default\n",
+      source: {
+        code: "const documentationLinks = [\n  {\n    itemText: 'BX/ICP docs',\n    href: '#',\n    onClick: () => console.log('clicked'),\n  },\n  {\n    itemText: 'Kubernetes docs',\n    href: '#',\n    onClick: () => console.log('clicked'),\n  },\n  {\n    itemText: 'Docker docs',\n    href: '#',\n    onClick: () => console.log('clicked'),\n  },\n  {\n    itemText: 'Helm docs',\n    href: '#',\n    onClick: () => console.log('clicked'),\n  },\n];"
+      }
+    }, {
+      story: stories.WithActions
+    }, {
+      description: "Optionally you can add actions to the web terminal header bar. To add actions\nyou need to pass in an array of actions with objects for each object.",
+      source: {
+        code: "<WebTerminal\n  actions={[\n    {\n      renderIcon: Code32,\n      onClick: () => {},\n      iconDescription: 'Create new deployment',\n    },\n  ]}\n>\n  ...\n</WebTerminal>"
+      }
+    }]
+  });
+};
+export default DocsPage;

package/es/components/WebTerminal/WebTerminal.js

@@ -39,6 +39,10 @@ var defaults = {
   documentationLinksIconDescription: 'Show documentation links',
   isInitiallyOpen: false
 };
+
+/**
+ * The `WebTerminal` is prompted by the user and is persistent until dismissed. The purpose of a web terminal is to provide users with the ability to type commands manually instead of using the GUI.
+ */
 export var WebTerminal = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
   var _ref3;
   var _ref$actions = _ref.actions,

package/es/global/js/hooks/useCreateComponentStepChange.js

@@ -30,6 +30,20 @@ export var useCreateComponentStepChange = function useCreateComponentStepChange(
     componentBlockClass = _ref.componentBlockClass,
     setCreateComponentActions = _ref.setCreateComponentActions,
     setModalIsOpen = _ref.setModalIsOpen;
+  var continueToNextStep = useCallback(function () {
+    setIsSubmitting(false);
+    setCurrentStep(function (prev) {
+      // Find next included step to render
+      // There will always be a next step otherwise we will
+      // have reach the onSubmit
+      do {
+        var _stepData;
+        prev++;
+      } while (!((_stepData = stepData[prev - 1]) !== null && _stepData !== void 0 && _stepData.shouldIncludeStep));
+      return prev;
+    });
+  }, [setCurrentStep, setIsSubmitting, stepData]);
+
   // useEffect to handle multi step logic
   useEffect(function () {
     var onUnmount = function onUnmount() {
@@ -157,9 +171,9 @@ export var useCreateComponentStepChange = function useCreateComponentStepChange(
               // There will always be a previous step otherwise we will
               // have disabled the back button since we have reached the first visible step
               do {
-                var _stepData;
+                var _stepData2;
                 prev--;
-              } while (!((_stepData = stepData[prev - 1]) !== null && _stepData !== void 0 && _stepData.shouldIncludeStep));
+              } while (!((_stepData2 = stepData[prev - 1]) !== null && _stepData2 !== void 0 && _stepData2.shouldIncludeStep));
               return prev;
             });
           },
@@ -187,17 +201,4 @@ export var useCreateComponentStepChange = function useCreateComponentStepChange(
       setCreateComponentActions(buttons);
     }
   }, [firstIncludedStep, lastIncludedStep, stepData, onNext, isSubmitDisabled, backButtonText, cancelButtonText, currentStep, onClose, nextButtonText, submitButtonText, onRequestSubmit, isSubmitting, shouldViewAll, componentBlockClass, componentName, continueToNextStep, setCurrentStep, setCreateComponentActions, setIsSubmitting, setShouldViewAll, setModalIsOpen]);
-  var continueToNextStep = useCallback(function () {
-    setIsSubmitting(false);
-    setCurrentStep(function (prev) {
-      // Find next included step to render
-      // There will always be a next step otherwise we will
-      // have reach the onSubmit
-      do {
-        var _stepData2;
-        prev++;
-      } while (!((_stepData2 = stepData[prev - 1]) !== null && _stepData2 !== void 0 && _stepData2.shouldIncludeStep));
-      return prev;
-    });
-  }, [setCurrentStep, setIsSubmitting, stepData]);
 };