@carbon/ibm-products 2.1.2 → 2.1.3

package/lib/components/EmptyStates/NoDataEmptyState/NoDataEmptyState.js

@@ -31,6 +31,10 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 // The block part of our conventional BEM class names (blockClass__E--M).
 var blockClass = "".concat(_settings.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.
+ */
 var NoDataEmptyState = /*#__PURE__*/_react.default.forwardRef(function (_ref, ref) {
   var action = _ref.action,
     className = _ref.className,

package/lib/components/EmptyStates/NoTagsEmptyState/NoTagsEmptyState.js

@@ -31,6 +31,10 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 // The block part of our conventional BEM class names (blockClass__E--M).
 var blockClass = "".concat(_settings.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.
+ */
 var NoTagsEmptyState = /*#__PURE__*/_react.default.forwardRef(function (_ref, ref) {
   var action = _ref.action,
     className = _ref.className,

package/lib/components/EmptyStates/NotFoundEmptyState/NotFoundEmptyState.js

@@ -31,6 +31,10 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 // The block part of our conventional BEM class names (blockClass__E--M).
 var blockClass = "".concat(_settings.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.
+ */
 var NotFoundEmptyState = /*#__PURE__*/_react.default.forwardRef(function (_ref, ref) {
   var action = _ref.action,
     className = _ref.className,

package/lib/components/EmptyStates/NotificationsEmptyState/NotificationsEmptyState.js

@@ -31,6 +31,10 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 // The block part of our conventional BEM class names (blockClass__E--M).
 var blockClass = "".concat(_settings.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.
+ */
 var NotificationsEmptyState = /*#__PURE__*/_react.default.forwardRef(function (_ref, ref) {
   var action = _ref.action,
     className = _ref.className,

package/lib/components/EmptyStates/UnauthorizedEmptyState/UnauthorizedEmptyState.js

@@ -31,6 +31,10 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 // The block part of our conventional BEM class names (blockClass__E--M).
 var blockClass = "".concat(_settings.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.
+ */
 var UnauthorizedEmptyState = /*#__PURE__*/_react.default.forwardRef(function (_ref, ref) {
   var action = _ref.action,
     className = _ref.className,

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

@@ -0,0 +1,33 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _typeof = require("@babel/runtime/helpers/typeof");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _react = _interopRequireDefault(require("react"));
+var _StoryDocsPage = require("../../global/js/utils/StoryDocsPage");
+var stories = _interopRequireWildcard(require("./ExampleComponent.stories"));
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+/**
+ * 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.
+ */
+
+/**
+ * OPTIONAL: required only to customize default docs page
+ */
+var DocsPage = function DocsPage() {
+  return /*#__PURE__*/_react.default.createElement(_StoryDocsPage.StoryDocsPage, {
+    blocks: [{
+      description: 'Here it is in use.',
+      story: stories.exampleComponent
+    }]
+  });
+};
+var _default = DocsPage;
+exports.default = _default;

package/lib/components/ExportModal/ExportModal.js

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

package/lib/components/HTTPErrors/HTTPError403/HTTPError403.js

@@ -26,6 +26,12 @@ var _excluded = ["className", "description", "errorCodeLabel", "links", "title"]
 // The block part of our conventional BEM class names (blockClass__E--M).
 var blockClass = "".concat(_settings.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.
+ */
 var HTTPError403 = /*#__PURE__*/_react.default.forwardRef(function (_ref, ref) {
   var className = _ref.className,
     description = _ref.description,

package/lib/components/HTTPErrors/HTTPError404/HTTPError404.js

@@ -26,6 +26,12 @@ var _excluded = ["className", "description", "errorCodeLabel", "links", "title"]
 // The block part of our conventional BEM class names (blockClass__E--M).
 var blockClass = "".concat(_settings.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.
+ */
 var HTTPError404 = /*#__PURE__*/_react.default.forwardRef(function (_ref, ref) {
   var className = _ref.className,
     description = _ref.description,

package/lib/components/HTTPErrors/HTTPErrorOther/HTTPErrorOther.js

@@ -26,6 +26,12 @@ var _excluded = ["className", "description", "errorCodeLabel", "links", "title"]
 // The block part of our conventional BEM class names (blockClass__E--M).
 var blockClass = "".concat(_settings.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.
+ */
 var HTTPErrorOther = /*#__PURE__*/_react.default.forwardRef(function (_ref, ref) {
   var className = _ref.className,
     description = _ref.description,

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

@@ -0,0 +1,26 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _react = _interopRequireDefault(require("react"));
+var _StoryDocsPage = require("../../global/js/utils/StoryDocsPage");
+var _blocks = require("@storybook/blocks");
+var _storyHelper = require("../../global/js/utils/story-helper");
+var DocsPage = function DocsPage() {
+  var _useOf = (0, _blocks.useOf)('meta', ['meta']),
+    csfFile = _useOf.csfFile;
+  return /*#__PURE__*/_react.default.createElement(_StoryDocsPage.StoryDocsPage, {
+    altGuidelinesHref: [(0, _storyHelper.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'
+    }]
+  });
+};
+var _default = DocsPage;
+exports.default = _default;

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

@@ -0,0 +1,25 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _react = _interopRequireDefault(require("react"));
+var _StoryDocsPage = require("../../global/js/utils/StoryDocsPage");
+var DocsPage = function DocsPage() {
+  return /*#__PURE__*/_react.default.createElement(_StoryDocsPage.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."
+    }]
+  });
+};
+var _default = DocsPage;
+exports.default = _default;

package/lib/components/MultiAddSelect/MultiAddSelect.js

@@ -22,6 +22,10 @@ function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj &&
 //
 
 var componentName = 'MultiAddSelect';
+
+/**
+ * Used to add or select multiple or more items from larger lists or hierarchies.
+ */
 var MultiAddSelect = /*#__PURE__*/(0, _react.forwardRef)(function (props, ref) {
   return /*#__PURE__*/_react.default.createElement(_AddSelect.AddSelect, (0, _extends2.default)({}, props, {
     multi: true,

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

@@ -0,0 +1,26 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _react = _interopRequireDefault(require("react"));
+var _StoryDocsPage = require("../../global/js/utils/StoryDocsPage");
+var _blocks = require("@storybook/blocks");
+var _storyHelper = require("../../global/js/utils/story-helper");
+var DocsPage = function DocsPage() {
+  var _useOf = (0, _blocks.useOf)('meta', ['meta']),
+    csfFile = _useOf.csfFile;
+  return /*#__PURE__*/_react.default.createElement(_StoryDocsPage.StoryDocsPage, {
+    altGuidelinesHref: [(0, _storyHelper.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'
+    }]
+  });
+};
+var _default = DocsPage;
+exports.default = _default;

package/lib/components/RemoveModal/RemoveModal.js

@@ -29,6 +29,12 @@ function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj &&
 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) { (0, _defineProperty2.default)(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; }
 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.
+ */
 var RemoveModal = /*#__PURE__*/(0, _react.forwardRef)(function (_ref, ref) {
   var body = _ref.body,
     className = _ref.className,

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

@@ -0,0 +1,23 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _react = _interopRequireDefault(require("react"));
+var _StoryDocsPage = require("../../global/js/utils/StoryDocsPage");
+var DocsPage = function DocsPage() {
+  return /*#__PURE__*/_react.default.createElement(_StoryDocsPage.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}"
+      }
+    }]
+  });
+};
+var _default = DocsPage;
+exports.default = _default;

package/lib/components/SingleAddSelect/SingleAddSelect.js

@@ -23,6 +23,10 @@ function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj &&
 //
 
 var componentName = 'SingleAddSelect';
+
+/**
+ * Used to add or select one or more items from larger lists or hierarchies.
+ */
 var SingleAddSelect = /*#__PURE__*/(0, _react.forwardRef)(function (props, ref) {
   // remove multi add select specific props
   var validProps = (0, _propsHelper.prepareProps)(props, ['columnInputPlaceholder', 'globalFilters', 'globalFiltersIconDescription', 'globalFiltersPlaceholderText', 'globalFiltersPrimaryButtonText', 'globalFiltersSecondaryButtonText', 'influencerTitle', 'multi', 'noSelectionDescription', 'noSelectionTitle', 'removeIconDescription']);

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

@@ -0,0 +1,28 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _typeof = require("@babel/runtime/helpers/typeof");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _react = _interopRequireDefault(require("react"));
+var _StoryDocsPage = require("../../global/js/utils/StoryDocsPage");
+var stories = _interopRequireWildcard(require("./StatusIcon.stories"));
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+var DocsPage = function DocsPage() {
+  return /*#__PURE__*/_react.default.createElement(_StoryDocsPage.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          "
+    }]
+  });
+};
+var _default = DocsPage;
+exports.default = _default;

package/lib/components/StatusIcon/StatusIcon.js

@@ -26,6 +26,16 @@ function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "functio
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
 var blockClass = "".concat(_settings.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.
+ */
 var StatusIcon = /*#__PURE__*/(0, _react.forwardRef)(function (_ref, ref) {
   var _icons$kind;
   var kind = _ref.kind,

package/lib/components/Tearsheet/TearsheetShell.js

@@ -63,7 +63,13 @@ var tearsheetHasCloseIcon = function tearsheetHasCloseIcon(actions, hasCloseIcon
   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.
+ * */
 exports.tearsheetHasCloseIcon = tearsheetHasCloseIcon;
 var TearsheetShell = /*#__PURE__*/_react.default.forwardRef(function (_ref, ref) {
   var actions = _ref.actions,

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

@@ -0,0 +1,25 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _typeof = require("@babel/runtime/helpers/typeof");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _react = _interopRequireDefault(require("react"));
+var _StoryDocsPage = require("../../global/js/utils/StoryDocsPage");
+var stories = _interopRequireWildcard(require("./Toolbar.stories"));
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+var DocsPage = function DocsPage() {
+  return /*#__PURE__*/_react.default.createElement(_StoryDocsPage.StoryDocsPage, {
+    blocks: [{
+      story: stories._Toolbar
+    }, {
+      story: stories.vertical,
+      description: "A toolbar orientation for floating the toolbar on the canvas."
+    }]
+  });
+};
+var _default = DocsPage;
+exports.default = _default;

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

@@ -0,0 +1,28 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _typeof = require("@babel/runtime/helpers/typeof");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _react = _interopRequireDefault(require("react"));
+var _StoryDocsPage = require("../../global/js/utils/StoryDocsPage");
+var stories = _interopRequireWildcard(require("./UserProfileImage.stories"));
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+var DocsPage = function DocsPage() {
+  return /*#__PURE__*/_react.default.createElement(_StoryDocsPage.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."
+    }]
+  });
+};
+var _default = DocsPage;
+exports.default = _default;

package/lib/components/UserProfileImage/UserProfileImage.js

@@ -36,7 +36,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.
  */
 var UserProfileImage = /*#__PURE__*/_react.default.forwardRef(function (_ref, ref) {
   var backgroundColor = _ref.backgroundColor,

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

@@ -0,0 +1,63 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _typeof = require("@babel/runtime/helpers/typeof");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _react = _interopRequireDefault(require("react"));
+var _StoryDocsPage = require("../../global/js/utils/StoryDocsPage");
+var stories = _interopRequireWildcard(require("./WebTerminal.stories"));
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+var DocsPage = function DocsPage() {
+  return /*#__PURE__*/_react.default.createElement(_StoryDocsPage.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>"
+      }
+    }]
+  });
+};
+var _default = DocsPage;
+exports.default = _default;

package/lib/components/WebTerminal/WebTerminal.js

@@ -45,6 +45,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.
+ */
 var WebTerminal = /*#__PURE__*/_react.default.forwardRef(function (_ref, ref) {
   var _ref3;
   var _ref$actions = _ref.actions,