@carbon/ibm-products 2.1.1 → 2.1.3

package/es/global/js/utils/StoryDocsPage.js

@@ -0,0 +1,218 @@
+import _toConsumableArray from "@babel/runtime/helpers/toConsumableArray";
+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. 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 PropTypes from 'prop-types';
+import { Title, Description, Source, Controls, Canvas, Stories, AnchorMdx, useOf } from '@storybook/blocks';
+import { paramCase } from 'change-case';
+import { codeSandboxHref, stackblitzHref, storyDocsPageInfo } from './story-helper';
+export var CustomBlocks = function CustomBlocks(_ref) {
+  var blocks = _ref.blocks;
+  return blocks.map(function (block, index) {
+    var source = _objectSpread({}, block === null || block === void 0 ? void 0 : block.source);
+    if (source.code && !source.language) {
+      source.language = 'jsx';
+    }
+    return /*#__PURE__*/React.createElement("div", {
+      key: "block-index--".concat(index)
+    }, block.title && /*#__PURE__*/React.createElement("h3", {
+      id: paramCase(block.title)
+    }, block.title), block.subTitle && /*#__PURE__*/React.createElement("h4", null, block.subTitle), block.description && typeof block.description === 'string' ? /*#__PURE__*/React.createElement(Description, null, block.description) : block.description, block.story && /*#__PURE__*/React.createElement(Canvas, {
+      of: block.story
+    }), block.source && /*#__PURE__*/React.createElement(Source, source));
+  });
+};
+
+/**
+ * This function checks blocks against stories and then
+ * - Adds title if no alternative is supplied
+ * - Adds blocks for unreferenced stories if omitUnreferencedStories is false
+ */
+var processBlocks = function processBlocks(blocks, stories, omitUnreferencedStories) {
+  var blocksWithStoryTitles = blocks ? _toConsumableArray(blocks) : [];
+  var restOfStories = [];
+  var storyKeys = Object.keys(stories);
+  storyKeys.forEach(function (sk) {
+    var story = stories[sk].moduleExport;
+    var storyName = stories[sk].name;
+    var matchingBlock = blocksWithStoryTitles.find(function (block) {
+      return block.story === story;
+    });
+    if (matchingBlock) {
+      var _matchingBlock$title;
+      matchingBlock.title = (_matchingBlock$title = matchingBlock.title) !== null && _matchingBlock$title !== void 0 ? _matchingBlock$title : storyName;
+    } else if (!omitUnreferencedStories) {
+      restOfStories.push({
+        story: story,
+        title: storyName
+      });
+    }
+  });
+  if (!omitUnreferencedStories) {
+    return blocksWithStoryTitles.concat(restOfStories);
+  }
+  return blocksWithStoryTitles;
+};
+
+/**
+ * Calling with no parameters will produce the default output.
+ * Customize by providing alternative values and/or blocks defining sections
+ * @param {*} param0
+ * @returns
+ */
+export var StoryDocsPage = function StoryDocsPage(_ref2) {
+  var _csfFile$meta, _csfFile$meta$paramet, _processedBlocks$filt;
+  var altTitle = _ref2.altTitle,
+    altDescription = _ref2.altDescription,
+    altGuidelinesHref = _ref2.altGuidelinesHref,
+    blocks = _ref2.blocks,
+    omitCodedExample = _ref2.omitCodedExample,
+    omitUnreferencedStories = _ref2.omitUnreferencedStories;
+  var _useOf = useOf('meta', ['meta']),
+    csfFile = _useOf.csfFile;
+  var storyInfo = storyDocsPageInfo(csfFile);
+  var guidelinesHref = altGuidelinesHref !== null && altGuidelinesHref !== void 0 ? altGuidelinesHref : storyInfo.guidelinesHref;
+  var isFullScreen = (csfFile === null || csfFile === void 0 ? void 0 : (_csfFile$meta = csfFile.meta) === null || _csfFile$meta === void 0 ? void 0 : (_csfFile$meta$paramet = _csfFile$meta.parameters) === null || _csfFile$meta$paramet === void 0 ? void 0 : _csfFile$meta$paramet.layout) === 'fullscreen' || false;
+  var storyHelperClass = isFullScreen ? 'c4p--story-docs-page--fullscreen' : '';
+  var processedBlocks = processBlocks(blocks, csfFile.stories, omitUnreferencedStories);
+  console.log(processBlocks);
+  var storyCount = (_processedBlocks$filt = processedBlocks === null || processedBlocks === void 0 ? void 0 : processedBlocks.filter(function (block) {
+    return !!block.story;
+  }).length) !== null && _processedBlocks$filt !== void 0 ? _processedBlocks$filt : 0;
+  return /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement(Title, null, altTitle !== null && altTitle !== void 0 ? altTitle : storyInfo.title), guidelinesHref ? guidelinesHref && Array.isArray(guidelinesHref) ? guidelinesHref.map(function (_ref3, index) {
+    var href = _ref3.href,
+      label = _ref3.label;
+    return /*#__PURE__*/React.createElement(React.Fragment, null, index > 0 && ' | ', /*#__PURE__*/React.createElement(AnchorMdx, {
+      key: href,
+      href: href
+    }, label));
+  }) : /*#__PURE__*/React.createElement(AnchorMdx, {
+    href: guidelinesHref
+  }, altTitle ? "".concat(altTitle, " usage guidelines") : storyInfo.guidelinesLinkLabel) : null, /*#__PURE__*/React.createElement("h2", {
+    style: {
+      marginTop: guidelinesHref ? '16px' : ''
+    }
+  }, "Table of contents"), /*#__PURE__*/React.createElement("ul", null, ['Overview', 'Coded examples', 'Example usage', 'Component API'].map(function (item) {
+    return /*#__PURE__*/React.createElement("li", {
+      key: item
+    }, /*#__PURE__*/React.createElement(AnchorMdx, {
+      href: "#".concat(paramCase(item))
+    }, item), processedBlocks && item === 'Example usage' ? /*#__PURE__*/React.createElement("ul", null, processedBlocks.map(function (block) {
+      return block !== null && block !== void 0 && block.title ? /*#__PURE__*/React.createElement("li", {
+        key: block.title
+      }, /*#__PURE__*/React.createElement(AnchorMdx, {
+        href: "#".concat(paramCase(block.title))
+      }, block.title)) : null;
+    })) : null);
+  })), /*#__PURE__*/React.createElement("h2", {
+    id: "overview"
+  }, "Overview"), /*#__PURE__*/React.createElement(Description, null, altDescription), !omitCodedExample && storyInfo.expectCodedExample ? /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement("h2", {
+    id: "coded-examples"
+  }, "Coded examples"), /*#__PURE__*/React.createElement("p", null, "Coded examples can be edited and are a great way to try out a component."), /*#__PURE__*/React.createElement("ul", null, /*#__PURE__*/React.createElement("li", {
+    key: "codesandbox"
+  }, /*#__PURE__*/React.createElement(AnchorMdx, {
+    href: codeSandboxHref(storyInfo.title)
+  }, /*#__PURE__*/React.createElement("svg", {
+    viewBox: "0 0 24 24",
+    xmlns: "http://www.w3.org/2000/svg",
+    style: {
+      height: '16px',
+      width: '16px',
+      color: 'black',
+      boxShadow: '0 0 0 2px white',
+      marginRight: '8px',
+      verticalAlign: '-2px'
+    }
+  }, /*#__PURE__*/React.createElement("path", {
+    fillRule: "evenodd",
+    clipRule: "evenodd",
+    d: "M0 0h23.987v24H0V0Zm21.533 2.455v19.09H2.453V2.456h19.08Z",
+    fill: "currentColor"
+  })), "CodeSandbox")), /*#__PURE__*/React.createElement("li", {
+    key: "stackblitz"
+  }, /*#__PURE__*/React.createElement(AnchorMdx, {
+    href: stackblitzHref(storyInfo.title)
+  }, /*#__PURE__*/React.createElement("img", {
+    src: "https://c.staticblitz.com/assets/favicon_sb-861fe1b85c0dc928750c62de15fed96fc75e57ee366bd937bad17a3938917b3f.svg",
+    alt: "Stackblitz logo",
+    style: {
+      verticalAlign: '-2px',
+      marginRight: '8px'
+    }
+  }), "Stackblitz")))) : null, /*#__PURE__*/React.createElement("h2", {
+    id: "example-usage"
+  }, "Example usage"), /*#__PURE__*/React.createElement("div", {
+    className: storyHelperClass
+  }, processedBlocks ? /*#__PURE__*/React.createElement(CustomBlocks, {
+    blocks: processedBlocks
+  }) : /*#__PURE__*/React.createElement(Stories, null)), /*#__PURE__*/React.createElement("h2", {
+    id: "component-api"
+  }, "Component API"), storyCount > 1 && /*#__PURE__*/React.createElement("p", null, "NOTE: Changing the controls below affects the default/primary example shown on the docs page."), /*#__PURE__*/React.createElement(Controls, null));
+};
+StoryDocsPage.propTypes = {
+  /**
+   * Uses doc block from the component where possible.
+   *
+   * Note: use `export default { component: ExampleComponent }` in the story if the main component is wrapped by some
+   * additional code. This will allow the doc block to pass through.
+   *
+   * If passed as string treated as markdown.
+   */
+  altDescription: PropTypes.node,
+  /**
+   * location if any of guidelines on the PAL site, constructed by default
+   */
+  altGuidelinesHref: PropTypes.oneOfType(PropTypes.string, PropTypes.arrayOf(PropTypes.shape({
+    href: PropTypes.string,
+    label: PropTypes.string
+  }))),
+  /**
+   * Uses component name by default
+   */
+  altTitle: PropTypes.string,
+  /**
+   * Array with content sections
+   */
+  blocks: PropTypes.arrayOf(PropTypes.shape({
+    /**
+     * Optional title story name used by default<h3>
+     */
+    title: PropTypes.string,
+    /**
+     * Optional subTitle a <h4>
+     */
+    subTitle: PropTypes.string,
+    /**
+     * Optional description, strings treated as markdown.
+     */
+    description: PropTypes.node,
+    /**
+     * Story imported from story file
+     */
+    story: PropTypes.func,
+    /**
+     * Some source code
+     * default language `jsx`
+     */
+    source: PropTypes.shape({
+      language: PropTypes.oneOf('javascript', 'css', 'jsx'),
+      code: PropTypes.string
+    })
+  })),
+  /**
+   * Set to true if no published example exists (all components and patterns should have an example)
+   */
+  omitCodedExample: PropTypes.bool,
+  /**
+   * Stories unreferenced in blocks included by default
+   */
+  omitUnreferencedStories: PropTypes.bool
+};

package/es/global/js/utils/story-helper.js

@@ -1,3 +1,5 @@
+import _toArray from "@babel/runtime/helpers/toArray";
+import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
 //
 // Copyright IBM Corp. 2021, 2021
 //
@@ -10,6 +12,7 @@ import PropTypes from 'prop-types';
 import { sanitize } from '@storybook/csf';
 import pkg from '../package-settings';
 import { getPathForComponent } from '../../../../../core/story-structure';
+import { paramCase } from 'change-case';
 
 /**
  * A helper function to return the structured story title for a component.
@@ -64,12 +67,14 @@ export var prepareStory = function prepareStory(template, options) {
  * The link URL is based on the example directory name and the standard codesandbox URL for package examples.
  */
 var packagePath = 'github/carbon-design-system/ibm-products/tree/main/examples/carbon-for-ibm-products';
+export var codeSandboxHref = function codeSandboxHref(exampleDirectory) {
+  return "https://codesandbox.io/p/sandbox/".concat(packagePath, "/").concat(exampleDirectory, "?file=%2Fsrc%2FExample%2FExample.jsx");
+};
 export var CodesandboxLink = function CodesandboxLink(_ref) {
   var exampleDirectory = _ref.exampleDirectory;
-  // const stackblitz = `https://stackblitz.com/${packagePath}/${dir}?file=src%2FExample%2FExample.jsx`;
-  var codesandbox = "https://codesandbox.io/p/sandbox/".concat(packagePath, "/").concat(exampleDirectory, "?file=%2Fsrc%2FExample%2FExample.jsx");
+  var href = codeSandboxHref(exampleDirectory);
   return /*#__PURE__*/React.createElement("a", {
-    href: codesandbox
+    href: href
   }, /*#__PURE__*/React.createElement("img", {
     alt: "Edit on CodeSandbox",
     src: "https://codesandbox.io/static/img/play-codesandbox.svg"
@@ -81,11 +86,14 @@ CodesandboxLink.propTypes = {
    */
   exampleDirectory: PropTypes.string
 };
+export var stackblitzHref = function stackblitzHref(exampleDirectory) {
+  return "https://stackblitz.com/".concat(packagePath, "/").concat(exampleDirectory, "?file=src%2FExample%2FExample.jsx");
+};
 export var StackblitzLink = function StackblitzLink(_ref2) {
   var exampleDirectory = _ref2.exampleDirectory;
-  var stackblitz = "https://stackblitz.com/".concat(packagePath, "/").concat(exampleDirectory, "?file=src%2FExample%2FExample.jsx");
+  var href = stackblitzHref(exampleDirectory);
   return /*#__PURE__*/React.createElement("a", {
-    href: stackblitz
+    href: href
   }, /*#__PURE__*/React.createElement("img", {
     alt: "Edit on Stackblitz",
     src: "https://c.staticblitz.com/assets/favicon_sb-861fe1b85c0dc928750c62de15fed96fc75e57ee366bd937bad17a3938917b3f.svg"
@@ -97,12 +105,106 @@ StackblitzLink.propTypes = {
    */
   exampleDirectory: PropTypes.string
 };
+export var palUsageHref = function palUsageHref(csfFile) {
+  var _csfFile$meta;
+  var title = csfFile === null || csfFile === void 0 ? void 0 : (_csfFile$meta = csfFile.meta) === null || _csfFile$meta === void 0 ? void 0 : _csfFile$meta.title;
+  var _title$split = title.split('/'),
+    _title$split2 = _slicedToArray(_title$split, 3),
+    _pkg = _title$split2[0],
+    kind = _title$split2[1],
+    section = _title$split2[2];
+  if (/components|patterns/i.test(kind) && name) {
+    return "https://pages.github.ibm.com/cdai-design/pal/".concat(kind, "s/").concat(paramCase(section), "/usage");
+  }
+};
+export var storyDocsPageTitle = function storyDocsPageTitle(csfFile) {
+  var _csfFile$meta2;
+  var title = csfFile === null || csfFile === void 0 ? void 0 : (_csfFile$meta2 = csfFile.meta) === null || _csfFile$meta2 === void 0 ? void 0 : _csfFile$meta2.title;
+  var _title$split3 = title.split('/'),
+    _title$split4 = _toArray(_title$split3),
+    _pkg = _title$split4[0],
+    kind = _title$split4[1],
+    a = _title$split4[2],
+    b = _title$split4[3],
+    rest = _title$split4.slice(4);
+  var component;
+  if (/components|patterns/i.test(kind)) {
+    // components and patterns have an additional level
+    component = b;
+  } else {
+    component = a;
+  }
+  var name = component.split('#')[0]; // canary always written as Example#canary};
+
+  if (name) {
+    if (rest.length > 0) {
+      return "".concat(name, " (").concat(rest.join(' '), ")");
+    } else {
+      return name;
+    }
+  }
+  console.error('Error: unable to parse title from metadata.');
+  return title;
+};
+export var storyDocsPageInfo = function storyDocsPageInfo(csfFile) {
+  var _csfFile$meta3;
+  var title = csfFile === null || csfFile === void 0 ? void 0 : (_csfFile$meta3 = csfFile.meta) === null || _csfFile$meta3 === void 0 ? void 0 : _csfFile$meta3.title;
+  var _title$split5 = title.split('/'),
+    _title$split6 = _toArray(_title$split5),
+    pkg = _title$split6[0],
+    kind = _title$split6[1],
+    a = _title$split6[2],
+    b = _title$split6[3],
+    rest = _title$split6.slice(4);
+  var result = {
+    package: pkg,
+    kind: kind,
+    expectCodedExample: false
+  };
+  var component;
+  if (/components|patterns/i.test(kind)) {
+    result.expectCodedExample = true;
+    // components and patterns have an additional level
+    component = b;
+    result.section = a;
+    result.guidelinesHref = "https://pages.github.ibm.com/cdai-design/pal/".concat(kind, "s/").concat(paramCase(result.section), "/usage");
+  } else {
+    component = a;
+  }
+  var nameSplit = component.split('#'); // canary always written as Example#canary};
+  var name = nameSplit[0];
+  if (nameSplit.length > 1 && nameSplit[1] === 'canary') {
+    result.canary = true;
+  }
+  if (name) {
+    if (rest.length > 0) {
+      result.component = result.title = "".concat(name, " (").concat(rest.join(' '), ")");
+    } else {
+      result.component = name;
+      result.title = name;
+    }
+  } else {
+    console.error('Error: unable to parse title from metadata.');
+    result.title = title;
+  }
+  if (result.guidelinesHref) {
+    result.guidelinesLinkLabel = "".concat(result.title, " usage guidelines");
+  }
+  return result;
+};
+export var storyDocsGuidelines = function storyDocsGuidelines(csfFile) {
+  var storyInfo = storyDocsPageInfo(csfFile);
+  return {
+    href: storyInfo.guidelinesHref,
+    label: storyInfo.guidelinesLinkLabel
+  };
+};
 
 /**
  * A helper function that finds the designated theme on the Storybook canvas.
  * @returns "dark" or "light"
  */
 export var getSelectedCarbonTheme = function getSelectedCarbonTheme() {
-  var themeId = document.querySelector('html').getAttribute('storybook-carbon-theme');
+  var themeId = document.querySelector('[storybook-carbon-theme]').getAttribute('storybook-carbon-theme');
   return themeId === 'g90' || themeId === 'g100' ? 'dark' : 'light';
 };

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

@@ -0,0 +1,37 @@
+"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 _blocks = require("@storybook/blocks");
+var _storyHelper = require("../../global/js/utils/story-helper");
+var stories = _interopRequireWildcard(require("./APIKeyModal.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() {
+  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'
+    }],
+    blocks: [{
+      story: stories.Edit,
+      description: "API key creation / generation is assumed to be the default mode for this modal.\nTo enable key editing you have to set the `edit` prop to true and supply any\nother edit related props with the relevant input."
+    }, {
+      description: "By default generate and edit only supply a name input for your key. If you need additional input you should use custom steps",
+      story: stories.CustomEdit
+    }]
+  });
+};
+var _default = DocsPage;
+exports.default = _default;

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

@@ -0,0 +1,32 @@
+"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("./AboutModal.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, {
+    guidelinesHref: "https://pages.github.ibm.com/cdai-design/pal/patterns/about-modal/usage",
+    blocks: [{
+      story: stories.aboutModal
+    }, {
+      story: stories.fullyLoaded
+    }, {
+      title: 'Overriding the Carbon theme',
+      description: 'The design recommendation is to use a dark theme for the AboutModal if the application is currently using a light theme, and vice versa. The theme applied to the AboutModal can easily be customized as follows:',
+      source: {
+        language: 'css',
+        code: ".#{$pkg-prefix}--about-modal {\n  @include carbon--theme(\n    $theme: $carbon--theme--g90\n  );\n}"
+      }
+    }]
+  });
+};
+var _default = DocsPage;
+exports.default = _default;

package/lib/components/AboutModal/AboutModal.js

@@ -39,7 +39,7 @@ var componentName = 'AboutModal';
 // NOTE: the component SCSS is not imported here: it is rolled up separately.
 
 /**
- * The AboutModal component provides a way to communicate product information
+ * The `AboutModal` component provides a way to communicate product information
  * to users. 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

package/lib/components/BreadcrumbWithOverflow/BreadcrumbWithOverflow.js

@@ -167,6 +167,9 @@ var BreadcrumbWithOverflow = function BreadcrumbWithOverflow(_ref) {
     setDisplayedBreadcrumbItems(newDisplayedBreadcrumbItems);
   }, [breadcrumbs, displayCount]);
   var checkFullyVisibleBreadcrumbItems = function checkFullyVisibleBreadcrumbItems() {
+    if (!breadcrumbItemWithOverflow.current) {
+      return;
+    }
     var displayItemIndex = function displayItemIndex(itemCount, index) {
       // In this data set the overflow measuring item is [0]
       // so the first displayItem in the list is [1]

package/lib/components/Cascade/Cascade.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("./Cascade.stories"));
+var _blocks = require("@storybook/blocks");
+var _storyHelper = require("../../global/js/utils/story-helper");
+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() {
+  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/guidelines/motion/overview/',
+      label: 'Carbon motion guidelines'
+    }],
+    blocks: [{
+      story: stories.WithoutGrid
+    }, {
+      description: 'When using `Cascade` with  grid support its important that you follow the example code structure and provide the rows and columns. The component will assume this structure and add the appropriate CSS classes to the columns.',
+      story: stories.WithGrid
+    }]
+  });
+};
+var _default = DocsPage;
+exports.default = _default;

package/lib/components/Cascade/Cascade.js

@@ -29,6 +29,16 @@ var componentName = 'Cascade';
 var defaults = {
   grid: false
 };
+
+/**
+
+This pattern is intended for use with cards, tiles, or similarly styled
+components. Use this patterns in areas that are the primary focus on the page to
+help the user along their journey or locate the most important information on
+the page. It should not be used on a page if it is the secondary focus of the
+page as that will distract the user.
+
+*/
 var Cascade = /*#__PURE__*/(0, _react.forwardRef)(function (_ref, ref) {
   var children = _ref.children,
     className = _ref.className,
@@ -81,7 +91,7 @@ Cascade.propTypes = {
    */
   className: _propTypes.default.string,
   /**
-   * Specifies whether or not to wrap the child content in a <Grid />.
+   * Specifies whether or not to wrap the child content in a `<Grid />`.
    * If this is set to true it's important that the children are being wrapped in rows in columns.
    * Check the documentation for additional clarification.
    */

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

@@ -0,0 +1,50 @@
+"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("./CreateFullPage.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, {
+    altGuidelinesHref: "https://pages.github.ibm.com/cdai-design/pal/patterns/creation-flows/usage#full-page",
+    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.createFullPage,
+      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:\n",
+      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.createFullPageWithSections,
+      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"
+    }]
+  });
+};
+var _default = DocsPage;
+exports.default = _default;

package/lib/components/CreateFullPage/CreateFullPage.js

@@ -43,6 +43,19 @@ var StepsContext = /*#__PURE__*/(0, _react.createContext)(null);
 // to let it know what number it is in the sequence of steps
 exports.StepsContext = StepsContext;
 var StepNumberContext = /*#__PURE__*/(0, _react.createContext)(-1);
+
+/**
+ * Use with creations that must be completed in order for a service to be usable.
+ *
+ * ### Grid
+ *
+ * The `CreateFullPage` component utilizes Carbons' grid system in the inner
+content of the main section inside of the component. You can read more guidance
+on the Carbon's grid system
+[here](https://www.carbondesignsystem.com/guidelines/2x-grid/overview). You can
+include `<Row>` and `<Column>` components inside of each `CreateFullPageStep`
+component to get the desired affect.
+ */
 exports.StepNumberContext = StepNumberContext;
 var CreateFullPage = /*#__PURE__*/_react.default.forwardRef(function (_ref, ref) {
   var backButtonText = _ref.backButtonText,

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

@@ -0,0 +1,35 @@
+"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("./CreateModal.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, {
+    altGuidelinesHref: "https://pages.github.ibm.com/cdai-design/pal/patterns/creation-flows/usage#modal",
+    blocks: [{
+      story: stories.Default
+    }, {
+      title: 'Form validation',
+      description: "All forms, including that within the `CreateModal` should follow C&CS guidelines\nfor form validation.\n\nThis includes the following:\n\n- The `Submit` button in the modal should be disabled, until all required inputs\n  are filled in and valid\n- All required inputs should _only_ throw an invalid error _after_ the element\n  loses focus\n- All optional form fields should have an `(optional)` text at the end of the\n  input `labelText`. Optional should always be in parentheses\n\nYou can find more information on how to validate your form fields in\n[Carbon's Form usage page](https://www.carbondesignsystem.com/components/form/usage)."
+    }, {
+      title: 'Overriding Carbon theme',
+      description: "The design recommendation is to use a dark theme for the CreateModal if the\napplication is currently using a light theme, and vice versa. The theme applied\nto the CreateModal can easily be customized as follows:\n\nIn SCSS:",
+      source: {
+        language: 'css',
+        code: "  .#{$pkg-prefix}--create-modal {\n    @include carbon--theme(\n      $theme: $carbon--theme--g90\n    );\n  }"
+      }
+    }, {
+      description: "Alternatively, the required Carbon theme can be set as above in a custom CSS\nclass which is then applied to the CreateModal using the `className` prop."
+    }]
+  });
+};
+var _default = DocsPage;
+exports.default = _default;