@carbon/ibm-products 2.3.2 → 2.4.1

package/es/components/ProductiveCard/ProductiveCard.js

@@ -27,7 +27,7 @@ export var ProductiveCard = /*#__PURE__*/forwardRef(function (_ref, ref) {
   var _ref$actionsPlacement = _ref.actionsPlacement,
     actionsPlacement = _ref$actionsPlacement === void 0 ? defaults.actionsPlacement : _ref$actionsPlacement,
     rest = _objectWithoutProperties(_ref, _excluded);
-  var validProps = prepareProps(rest, ['media', 'mediaPosition', 'onSecondaryButtonClick', 'pictogram', 'primaryButtonClick', 'productive', 'secondaryButtonKind', 'secondaryButtonText']);
+  var validProps = prepareProps(rest, ['media', 'mediaPosition', 'pictogram', 'primaryButtonClick', 'productive', 'secondaryButtonKind']);
   return /*#__PURE__*/React.createElement(Card, _extends({}, _objectSpread(_objectSpread({}, validProps), {}, {
     actionsPlacement: actionsPlacement,
     ref: ref
@@ -82,6 +82,10 @@ ProductiveCard.propTypes = {
    * Function that's called from the primary button or action icon
    */
   onPrimaryButtonClick: PropTypes.func,
+  /**
+   * Function that's called from the secondary button or action icon
+   */
+  onSecondaryButtonClick: PropTypes.func,
   /**
    * Use an overflow menu instead of action icons. Refer to design documentation for implementation guidelines
    */
@@ -111,6 +115,22 @@ ProductiveCard.propTypes = {
    * The text that's displayed in the primary button
    */
   primaryButtonText: PropTypes.node,
+  /**
+   * Optionally specify an href for your Button to become an <a> element
+   */
+  secondaryButtonHref: PropTypes.string,
+  /**
+   * Optional prop to allow overriding the icon rendering. Can be a React component class
+   */
+  secondaryButtonIcon: PropTypes.oneOfType([PropTypes.func, PropTypes.object]),
+  /**
+   * Determines if the secondary button is on the top or bottom of the card
+   */
+  secondaryButtonPlacement: PropTypes.oneOf(['top', 'bottom']),
+  /**
+   * The text that's displayed in the secondary button
+   */
+  secondaryButtonText: PropTypes.node,
   /**
    * Title that's displayed at the top of the card
    */

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

@@ -25,7 +25,7 @@ export var CustomBlocks = function CustomBlocks(_ref) {
       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, {
+    }, block.title), block.subTitle && /*#__PURE__*/React.createElement("h4", null, block.subTitle), block.image, 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));
   });
@@ -194,6 +194,10 @@ StoryDocsPage.propTypes = {
      * Optional description, strings treated as markdown.
      */
     description: PropTypes.node,
+    /**
+     * Optional block image
+     */
+    image: PropTypes.node,
     /**
      * Story imported from story file
      */
@@ -203,7 +207,7 @@ StoryDocsPage.propTypes = {
      * default language `jsx`
      */
     source: PropTypes.shape({
-      language: PropTypes.oneOf('javascript', 'css', 'jsx'),
+      language: PropTypes.oneOf('javascript', 'css', 'jsx', 'json'),
       code: PropTypes.string
     })
   })),

package/lib/components/Card/Card.js

@@ -16,7 +16,7 @@ var _propTypes = _interopRequireDefault(require("prop-types"));
 var _CardHeader = require("./CardHeader");
 var _CardFooter = require("./CardFooter");
 var _settings = require("../../settings");
-var _excluded = ["actionIcons", "actionsPlacement", "children", "className", "clickZone", "description", "label", "media", "mediaPosition", "onClick", "onKeyDown", "onPrimaryButtonClick", "overflowActions", "overflowAriaLabel", "onSecondaryButtonClick", "pictogram", "primaryButtonHref", "primaryButtonIcon", "primaryButtonKind", "primaryButtonPlacement", "primaryButtonText", "productive", "secondaryButtonHref", "secondaryButtonIcon", "secondaryButtonKind", "secondaryButtonText", "title", "titleSize"],
+var _excluded = ["actionIcons", "actionsPlacement", "children", "className", "clickZone", "description", "label", "media", "mediaPosition", "onClick", "onKeyDown", "onPrimaryButtonClick", "overflowActions", "overflowAriaLabel", "onSecondaryButtonClick", "pictogram", "primaryButtonHref", "primaryButtonIcon", "primaryButtonKind", "primaryButtonPlacement", "primaryButtonText", "productive", "secondaryButtonHref", "secondaryButtonIcon", "secondaryButtonKind", "secondaryButtonPlacement", "secondaryButtonText", "title", "titleSize"],
   _excluded2 = ["id"],
   _excluded3 = ["id", "icon", "onClick", "iconDescription", "href"]; //
 // Copyright IBM Corp. 2020, 2023
@@ -41,6 +41,7 @@ var defaults = {
   primaryButtonPlacement: 'bottom',
   productive: false,
   secondaryButtonKind: 'secondary',
+  secondaryButtonPlacement: 'bottom',
   titleSize: 'default'
 };
 var Card = /*#__PURE__*/(0, _react.forwardRef)(function (_ref, ref) {
@@ -78,6 +79,8 @@ var Card = /*#__PURE__*/(0, _react.forwardRef)(function (_ref, ref) {
     secondaryButtonIcon = _ref.secondaryButtonIcon,
     _ref$secondaryButtonK = _ref.secondaryButtonKind,
     secondaryButtonKind = _ref$secondaryButtonK === void 0 ? defaults.secondaryButtonKind : _ref$secondaryButtonK,
+    _ref$secondaryButtonP = _ref.secondaryButtonPlacement,
+    secondaryButtonPlacement = _ref$secondaryButtonP === void 0 ? defaults.secondaryButtonPlacement : _ref$secondaryButtonP,
     secondaryButtonText = _ref.secondaryButtonText,
     title = _ref.title,
     _ref$titleSize = _ref.titleSize,
@@ -182,12 +185,17 @@ var Card = /*#__PURE__*/(0, _react.forwardRef)(function (_ref, ref) {
       noActionIcons: actionIcons.length > 0 && actionsPlacement === 'top' ? false : true,
       actionsPlacement: actionsPlacement,
       onPrimaryButtonClick: onPrimaryButtonClick,
+      onSecondaryButtonClick: onSecondaryButtonClick,
       primaryButtonIcon: primaryButtonIcon,
       primaryButtonPlacement: primaryButtonPlacement,
       primaryButtonText: primaryButtonText,
       description: description,
       hasActions: hasActions,
       label: label,
+      secondaryButtonHref: secondaryButtonHref,
+      secondaryButtonIcon: secondaryButtonIcon,
+      secondaryButtonPlacement: secondaryButtonPlacement,
+      secondaryButtonText: secondaryButtonText,
       title: title,
       titleSize: titleSize
     };
@@ -216,6 +224,7 @@ var Card = /*#__PURE__*/(0, _react.forwardRef)(function (_ref, ref) {
       secondaryButtonHref: secondaryButtonHref,
       secondaryButtonIcon: secondaryButtonIcon,
       secondaryButtonKind: secondaryButtonKind,
+      secondaryButtonPlacement: secondaryButtonPlacement,
       secondaryButtonText: secondaryButtonText
     };
   };
@@ -266,6 +275,7 @@ Card.propTypes = {
   secondaryButtonHref: _propTypes.default.string,
   secondaryButtonIcon: _propTypes.default.oneOfType([_propTypes.default.func, _propTypes.default.object]),
   secondaryButtonKind: _propTypes.default.oneOf(['secondary', 'ghost']),
+  secondaryButtonPlacement: _propTypes.default.oneOf(['top', 'bottom']),
   secondaryButtonText: _propTypes.default.string,
   title: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.object, _propTypes.default.node]),
   titleSize: _propTypes.default.oneOf(['default', 'large'])

package/lib/components/Card/CardFooter.js

@@ -44,14 +44,15 @@ var CardFooter = function CardFooter(_ref) {
     secondaryButtonIcon = _ref.secondaryButtonIcon,
     _ref$secondaryButtonK = _ref.secondaryButtonKind,
     secondaryButtonKind = _ref$secondaryButtonK === void 0 ? defaults.secondaryButtonKind : _ref$secondaryButtonK,
+    secondaryButtonPlacement = _ref.secondaryButtonPlacement,
     secondaryButtonText = _ref.secondaryButtonText;
   var blockClass = "".concat(_settings.pkg.prefix, "--card");
   var footerClass = "".concat(_settings.pkg.prefix, "--card__footer");
   var footerClasses = (0, _classnames.default)(footerClass, (0, _defineProperty2.default)({}, "".concat(footerClass, "-no-button"), !hasButton));
   return /*#__PURE__*/_react.default.createElement("div", {
     className: footerClasses
-  }, secondaryButtonText && /*#__PURE__*/_react.default.createElement(_react2.Button, {
-    kind: secondaryButtonKind,
+  }, secondaryButtonText && secondaryButtonPlacement === 'bottom' && /*#__PURE__*/_react.default.createElement(_react2.Button, {
+    kind: productive ? 'ghost' : secondaryButtonKind,
     onClick: onSecondaryButtonClick,
     size: "md",
     renderIcon: secondaryButtonIcon,
@@ -82,6 +83,7 @@ CardFooter.propTypes = {
   secondaryButtonHref: _propTypes.default.string,
   secondaryButtonIcon: _propTypes.default.oneOfType([_propTypes.default.func, _propTypes.default.object]),
   secondaryButtonKind: _propTypes.default.oneOf(['secondary', 'ghost']),
+  secondaryButtonPlacement: _propTypes.default.oneOf(['top', 'bottom']),
   secondaryButtonText: _propTypes.default.string
 };
 CardFooter.displayName = componentName;

package/lib/components/Card/CardHeader.js

@@ -28,6 +28,7 @@ var CardHeader = function CardHeader(_ref) {
   var actions = _ref.actions,
     noActionIcons = _ref.noActionIcons,
     onPrimaryButtonClick = _ref.onPrimaryButtonClick,
+    onSecondaryButtonClick = _ref.onSecondaryButtonClick,
     primaryButtonIcon = _ref.primaryButtonIcon,
     primaryButtonPlacement = _ref.primaryButtonPlacement,
     primaryButtonText = _ref.primaryButtonText,
@@ -35,6 +36,10 @@ var CardHeader = function CardHeader(_ref) {
     _ref$hasActions = _ref.hasActions,
     hasActions = _ref$hasActions === void 0 ? defaults.hasActions : _ref$hasActions,
     label = _ref.label,
+    secondaryButtonHref = _ref.secondaryButtonHref,
+    secondaryButtonIcon = _ref.secondaryButtonIcon,
+    secondaryButtonPlacement = _ref.secondaryButtonPlacement,
+    secondaryButtonText = _ref.secondaryButtonText,
     title = _ref.title,
     _ref$titleSize = _ref.titleSize,
     titleSize = _ref$titleSize === void 0 ? defaults.titleSize : _ref$titleSize;
@@ -57,9 +62,16 @@ var CardHeader = function CardHeader(_ref) {
     className: "".concat(blockClass, "__description")
   }, description)), hasActions && /*#__PURE__*/_react.default.createElement("div", {
     className: "".concat(blockClass, "__actions ").concat(blockClass, "__actions-header")
-  }, actions, primaryButtonText && primaryButtonPlacement === 'top' && /*#__PURE__*/_react.default.createElement(_react2.Button, {
+  }, actions, secondaryButtonText && secondaryButtonPlacement === 'top' && /*#__PURE__*/_react.default.createElement(_react2.Button, {
     kind: "ghost",
-    size: "small",
+    onClick: onSecondaryButtonClick,
+    size: "sm",
+    renderIcon: secondaryButtonIcon,
+    href: secondaryButtonHref,
+    className: actionGhostButtonClass
+  }, secondaryButtonText), primaryButtonText && primaryButtonPlacement === 'top' && /*#__PURE__*/_react.default.createElement(_react2.Button, {
+    kind: "ghost",
+    size: "sm",
     renderIcon: primaryButtonIcon,
     onClick: onPrimaryButtonClick,
     className: actionGhostButtonClass
@@ -73,9 +85,15 @@ CardHeader.propTypes = {
   label: _propTypes.default.string,
   noActionIcons: _propTypes.default.bool,
   onPrimaryButtonClick: _propTypes.default.func,
+  onSecondaryButtonClick: _propTypes.default.func,
   primaryButtonIcon: _propTypes.default.oneOfType([_propTypes.default.func, _propTypes.default.object]),
   primaryButtonPlacement: _propTypes.default.oneOf(['top', 'bottom']),
   primaryButtonText: _propTypes.default.string,
+  secondaryButtonHref: _propTypes.default.string,
+  secondaryButtonIcon: _propTypes.default.oneOfType([_propTypes.default.func, _propTypes.default.object]),
+  secondaryButtonKind: _propTypes.default.oneOf(['secondary', 'ghost']),
+  secondaryButtonPlacement: _propTypes.default.oneOf(['top', 'bottom']),
+  secondaryButtonText: _propTypes.default.string,
   title: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.object, _propTypes.default.node]),
   titleSize: _propTypes.default.oneOf(['default', 'large'])
 };

package/lib/components/Datagrid/Datagrid/Datagrid.js

@@ -18,13 +18,17 @@ var _DatagridContent = require("./DatagridContent");
 var _FilterProvider = require("./addons/Filtering/FilterProvider");
 var _excluded = ["datagridState"];
 /**
- * Copyright IBM Corp. 2020, 2022
+ * Copyright IBM Corp. 2020, 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.
  */
 var blockClass = "".concat(_settings.pkg.prefix, "--datagrid");
 var componentName = 'Datagrid';
+
+/**
+ * The `Datagrid` component is an extension of Carbon's DataTable component. At the most basic level, the `Datagrid` component takes in columns and rows and renders a data table. There is a set of data table extensions which this component provides support for, these can be found [here](https://pages.github.ibm.com/cdai-design/pal/components/data-table/overview/). This component is data driven and allows you to choose what pieces will be included based on the hooks/plugins that are provided.
+ */
 var Datagrid = /*#__PURE__*/_react.default.forwardRef(function (_ref, ref) {
   var datagridState = _ref.datagridState,
     rest = (0, _objectWithoutProperties2.default)(_ref, _excluded);

package/lib/components/Datagrid/Datagrid/addons/RowSize/RowSizeDropdown.js

@@ -13,7 +13,6 @@ var React = _interopRequireWildcard(require("react"));
 var _propTypes = _interopRequireDefault(require("prop-types"));
 var _icons = require("@carbon/react/icons");
 var _react2 = require("@carbon/react");
-var _classnames = _interopRequireDefault(require("classnames"));
 var _RowSizeRadioGroup = _interopRequireDefault(require("./RowSizeRadioGroup"));
 var _settings = require("../../../../../settings");
 var _excluded = ["align", "legendText"];
@@ -28,7 +27,7 @@ function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj &&
 var blockClass = "".concat(_settings.pkg.prefix, "--datagrid");
 var RowSizeDropdown = function RowSizeDropdown(_ref) {
   var _ref$align = _ref.align,
-    align = _ref$align === void 0 ? 'bottom' : _ref$align,
+    align = _ref$align === void 0 ? 'bottom-right' : _ref$align,
     _ref$legendText = _ref.legendText,
     legendText = _ref$legendText === void 0 ? 'Row height' : _ref$legendText,
     props = (0, _objectWithoutProperties2.default)(_ref, _excluded);
@@ -36,33 +35,28 @@ var RowSizeDropdown = function RowSizeDropdown(_ref) {
     _React$useState2 = (0, _slicedToArray2.default)(_React$useState, 2),
     isOpen = _React$useState2[0],
     setIsOpen = _React$useState2[1];
-  return /*#__PURE__*/React.createElement(React.Fragment, null, !isOpen && /*#__PURE__*/React.createElement(_react2.IconButton, {
-    kind: "ghost",
+  return /*#__PURE__*/React.createElement(_react2.Popover, {
+    isTabTip: true,
+    align: "bottom-right",
+    open: isOpen,
+    onRequestClose: function onRequestClose() {
+      return setIsOpen(false);
+    },
+    className: "".concat(blockClass, "__row-size-options-container")
+  }, /*#__PURE__*/React.createElement(_react2.IconButton, {
     align: align,
+    kind: "ghost",
     onClick: function onClick() {
       return setIsOpen(function (prevOpen) {
         return !prevOpen;
       });
     },
     label: legendText,
-    className: (0, _classnames.default)("".concat(blockClass, "__row-size-button"))
-  }, /*#__PURE__*/React.createElement(_icons.Settings, {
-    size: 16
-  })), isOpen && /*#__PURE__*/React.createElement(_react2.Toggletip, {
-    defaultOpen: true,
-    className: "".concat(blockClass, "__row-size-toggle-tip")
-  }, /*#__PURE__*/React.createElement(_react2.ToggletipButton, {
-    className: (0, _classnames.default)("".concat(blockClass, "__row-size-toggle-tip-button"), "".concat(blockClass, "__row-size-button--open")),
-    label: legendText
+    className: "".concat(blockClass, "__row-size-button")
   }, /*#__PURE__*/React.createElement(_icons.Settings, {
     size: 16
-  })), /*#__PURE__*/React.createElement(_react2.ToggletipContent, {
-    className: "".concat(blockClass, "__row-size-toggle-tip-content")
-  }, /*#__PURE__*/React.createElement(_RowSizeRadioGroup.default, (0, _extends2.default)({}, props, {
-    legendText: legendText,
-    hideRadioGroup: function hideRadioGroup() {
-      setIsOpen(false);
-    }
+  })), /*#__PURE__*/React.createElement(_react2.PopoverContent, null, /*#__PURE__*/React.createElement(_react2.Layer, null, /*#__PURE__*/React.createElement(_RowSizeRadioGroup.default, (0, _extends2.default)({}, props, {
+    legendText: legendText
   })))));
 };
 RowSizeDropdown.propTypes = {

package/lib/components/Datagrid/Datagrid/addons/RowSize/RowSizeRadioGroup.js

@@ -1,27 +1,20 @@
 "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 = _interopRequireWildcard(require("react"));
+var _react = _interopRequireDefault(require("react"));
 var _propTypes = _interopRequireDefault(require("prop-types"));
 var _react2 = require("@carbon/react");
 var _isArray = _interopRequireDefault(require("lodash/isArray"));
 var _settings = require("../../../../../settings");
-var _hooks = require("../../../../../global/js/hooks");
-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; }
-/* eslint-disable react/default-props-match-prop-types */
-// @flow
-/*
- * Licensed Materials - Property of IBM
- * 5724-Q36
- * (c) Copyright IBM Corp. 2021
- * US Government Users Restricted Rights - Use, duplication or disclosure
- * restricted by GSA ADP Schedule Contract with IBM Corp.
+/**
+ * Copyright IBM Corp. 2021, 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.
  */
 
 var blockClass = "".concat(_settings.pkg.prefix, "--datagrid");
@@ -30,7 +23,6 @@ var RowSizeRadioGroup = function RowSizeRadioGroup(_ref) {
     selectedOption = _ref.selectedOption,
     datagridName = _ref.datagridName,
     onChange = _ref.onChange,
-    hideRadioGroup = _ref.hideRadioGroup,
     legendText = _ref.legendText,
     _ref$rowSizeLabels = _ref.rowSizeLabels,
     rowSizeLabels = _ref$rowSizeLabels === void 0 ? {
@@ -40,15 +32,7 @@ var RowSizeRadioGroup = function RowSizeRadioGroup(_ref) {
       sm: 'Small',
       xs: 'Extra small'
     } : _ref$rowSizeLabels;
-  var popoverContentRef = (0, _react.useRef)();
-  (0, _hooks.useClickOutside)(popoverContentRef, function (target) {
-    if (target.closest(".".concat(blockClass, "__row-size-button"))) {
-      return;
-    }
-    hideRadioGroup();
-  });
   return /*#__PURE__*/_react.default.createElement("div", {
-    ref: popoverContentRef,
     className: "".concat(blockClass, "__row-size-dropdown"),
     role: "presentation",
     onClick: function onClick(e) {
@@ -105,7 +89,6 @@ RowSizeRadioGroup.defaultProps = {
 };
 RowSizeRadioGroup.propTypes = {
   datagridName: _propTypes.default.string,
-  hideRadioGroup: _propTypes.default.func.isRequired,
   legendText: _propTypes.default.string,
   onChange: _propTypes.default.func.isRequired,
   rowSizeLabels: _propTypes.default.object,

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

@@ -0,0 +1,134 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _typeof = require("@babel/runtime/helpers/typeof");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.DocsPage = void 0;
+var _react = _interopRequireDefault(require("react"));
+var _StoryDocsPage = require("../../global/js/utils/StoryDocsPage");
+var stories = _interopRequireWildcard(require("./Datagrid.stories"));
+var _datagridActionsExample = _interopRequireDefault(require("./storybook-assets/datagrid-actions-example.png"));
+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: [{
+      title: 'Getting started',
+      description: "You can use the `Datagrid` component to create various kinds of Carbon data tables. Simply import the `Datagrid` along with any accompanying hooks (listed below) depending on what extensions you'd like to be included.",
+      source: {
+        code: "import {\n  Datagrid,\n  useDatagrid,\n  useInfiniteScroll,\n  useNestedRows,\n  useSelectRows,\n  useExpandedRow,\n  useOnRowClick,\n  useSortableColumns,\n  useRowIsMouseOver,\n  useColumnRightAlign,\n  useDisableSelectRows,\n  useStickyColumn,\n  useActionsColumn,\n  useCustomizeColumns,\n  useSelectAllWithToggle,\n  useColumnCenterAlign,\n  useColumnOrder,\n  useEditableCell,\n  useFiltering,\n  useFilterContext\n} from '@carbon/ibm-products';"
+      }
+    }, {
+      title: 'Basic',
+      description: "Here is a basic usage example. The following component will render the datagrid seen below, with pagination and some toolbar actions. One of the key pieces to building the `Datagrid` is the `useDatagrid` hook, this will give you all of the state/props required to render a `Datagrid`."
+    }, {
+      subTitle: 'Multi line wrap',
+      description: 'This setting enables the table cell text wrap to two lines. This can be turned on for only one column in the datagrid or for every column.',
+      source: {
+        language: 'jsx',
+        code: "\n          import { Datagrid, useDatagrid } from '@carbon/ibm-products';\n\nconst App = () => {\n  const columns = React.useMemo(() => defaultHeader, []); // These are the columns that will be used by the datagrid\n  const [data] = useState(makeData(10)); // This is the data that will be rendered by the datagrid\n\n  const columns = React.useMemo(\n    () => [\n      ...defaultHeader,\n      {\n        Header: 'Someone 11',\n        accessor: 'someone11',\n        multiLineWrap: true, //If `multiLineWrap` is required only for specific columns\n      },\n    ],\n    []\n  );\n\n  const datagridState = useDatagrid({\n    columns,\n    data,\n    multiLineWrapAll: true, // If `multiLineWrap` is required for all columns in data grid\n  });\n\n  return <Datagrid datagridState={datagridState} />;\n};\n          "
+      }
+    }, {
+      story: stories.BasicUsage
+    }, {
+      title: 'Column structure',
+      description: "The columns that are passed to the `useDatagrid` hook will have the following structure:",
+      source: {
+        language: 'jsx',
+        code: "\n          const columns = [\n    {\n      Header: 'First Name',\n      accessor: 'firstName',\n    },\n    {\n      Header: 'Last Name',\n      accessor: 'lastName',\n    },\n];"
+      }
+    }, {
+      description: "To change the default/initial width of a column, add a `width` property to the column.",
+      source: {
+        language: 'jsx',
+        code: "\n          const columns = [\n  {\n    Header: 'First Name',\n    accessor: 'firstName',\n    width: 120,\n  },\n  {\n    Header: 'Last Name',\n    accessor: 'lastName',\n    width: 180,\n  },\n];\n          "
+      }
+    }, {
+      description: 'If needed, it is also possible to wrap each cell in a containing element. See below:',
+      source: {
+        language: 'jsx',
+        code: "\n          const columns = [\n  {\n    Header: 'First Name',\n    accessor: 'firstName',\n  },\n  {\n    Header: 'Last Name',\n    accessor: 'lastName',\n    Cell: ({ cell: { value } }) => (\n      <span className=\"custom-cell-wrapper\">{value}</span>\n    ),\n  },\n];\n          "
+      }
+    }, {
+      title: 'Rendering the table toolbar',
+      image: /*#__PURE__*/_react.default.createElement("img", {
+        src: _datagridActionsExample.default,
+        alt: "Datagrid highlighting toolbar area"
+      }),
+      description: "In some of the examples you will see a component named `DatagridActions` passed to the `useDatagrid` hook. This component will render the table toolbar and is something that you will need to create on your own and then provide it to the `useDatagrid` hook. You can reference the `DatagridActions` that we have [created for our stories](https://github.com/carbon-design-system/ibm-products/blob/main/packages/ibm-products/src/components/Datagrid/utils/DatagridActions.js) when building your own."
+    }, {
+      title: 'Empty',
+      story: stories.EmptyState,
+      description: "The `Datagrid` supports empty states, when the data prop passed to the `useDatagrid` hook is an empty array.\n        ",
+      source: {
+        language: 'jsx',
+        code: "\nimport { Datagrid, useDatagrid } from '@carbon/ibm-products';\n\nconst App = () => {\n  const columns = React.useMemo(() => defaultHeader, []); // These are the columns that will be used by the datagrid\n  const [data] = useState([]); // This is the data that will be rendered by the datagrid\n\n  const datagridState = useDatagrid({\n    columns,\n    data,\n    emptyStateTitle: 'Empty state title',\n    emptyStateDescription: 'Description explaining why table is empty',\n    emptyStateSize: 'lg', // See empty state size options from the EmptyState component\n  });\n\n  return <Datagrid datagridState={datagridState} />;\n};\n          "
+      }
+    }, {
+      title: 'Auto size column to fit content',
+      description: "The `getAutoSizedColumnWidth` utility function can be used to auto size columns based on it's content. The width will be set to that of the largest cell in the column or the column header, whichever is greater. If this is not used, the width will be set to the default column width (150px) or the value passed to the `width` property in the column definition. See example below:",
+      source: {
+        code: "\nimport { Datagrid, useDatagrid, getAutoSizedColumnWidth } from '@carbon/ibm-products';\n\n...\n\nconst myColumns = [\n  {\n    Header: 'Column 1',\n    accessor: 'column_1',\n    width: getAutoSizedColumnWidth(rows, 'column_1', 'Column 1'),\n  }\n]\n\n...\n          "
+      }
+    }, {
+      title: 'Disabling select rows',
+      description: "\n        Disabling select rows allows you to choose which rows will be disabled in the table.\n\n- Include the `useDisableSelectRows` hook in the `endPlugins` property of `useDatagrid`.\n- Add the `shouldDisableSelectRow` to the `useDatagrid` hook, this will be a function that returns the row indexes that will be disabled.\n        ",
+      source: {
+        code: "\nconst [data] = useState(makeData(10));\nconst columns = React.useMemo(() => getColumns(data), []);\nconst datagridState = useDatagrid(\n  {\n    columns,\n    data,\n    DatagridActions,\n    DatagridBatchActions,\n    endPlugins: [useDisableSelectRows],\n    shouldDisableSelectRow: (row) => row.id % 2 === 0,\n    disableSelectAll: true,\n  },\n  useSelectRows\n);\n\nreturn <Datagrid datagridState={datagridState} />;\n          "
+      }
+    }, {
+      title: 'Infinite scroll',
+      description: "Infinite scroll is supported via the `useInfiniteScroll` hook. This hook will allow you to fetch more data to display to the user after a certain scroll threshold. The `useInfiniteScroll` hook can also be used to support virtualized data, this is required when working with large amounts of data, only rendering the rows that need to be visible in the component at a point in time."
+    }, {
+      description: "Infinite scroll:\n- Include `useInfiniteScroll` hook\n- Add `fetchMoreData` property to `useDatagrid`, this will be a function that is called when the scroll threshold is met. Optionally change the height of the grid with the `virtualHeight` property.",
+      source: {
+        code: "\nconst datagridState = useDatagrid(\n  {\n    columns,\n    data,\n    isFetching,\n    fetchMoreData: fetchData,\n    virtualHeight: 540,\n    emptyStateTitle: 'Empty state title',\n    emptyStateDescription: 'Description explaining why the table is empty',\n  },\n  useInfiniteScroll\n);"
+      }
+    }, {
+      description: "Virtualized data:\n- Include `useInfiniteScroll` hook\n- The Datagrid will know to use virtualized data just by providing the `useInfiniteScroll` hook\n        ",
+      source: {
+        code: "\nconst [data] = useState(makeData(10000));\nconst columns = React.useMemo(() => getColumns(data), []);\nconst datagridState = useDatagrid(\n  {\n    columns,\n    data,\n  },\n  useInfiniteScroll\n);\n          "
+      }
+    }, {
+      title: 'Detect row hover',
+      description: "There may be cases when you want to detect if a user is hovering on a particular row. In this case, use the `useRowIsMouseOver` hook.\n- Include the `useRowIsMouseOver` hook\n- When hover is detected on a row, a property called `isMouseOver` is changed from `false` to `true` within that row.\n        "
+    }, {
+      title: 'Select items across all pages',
+      description: "By default, selecting all items with paginated rows will result in just the current page rows being selected. Incorporating the `useSelectAllWithToggle` hook will provide the option to select all rows across all pages.\n- Include `useSelectAllWithToggle` and `useSelectRows` hook\n- Add the `selectAllToggle` property to the `useDatagrid` hook\n- Optionally pass in labels to ensure proper translation\n- Optionally pass in `onSelectAllRoss`, function that will be called via the select all rows checkbox `onChange`\n        ",
+      source: {
+        code: "\nconst [data] = useState(makeData(100));\nconst columns = React.useMemo(() => getColumns(data), []);\nconst [areAllSelected, setAreAllSelected] = useState(false);\nconst datagridState = useDatagrid(\n  {\n    columns,\n    data,\n    initialState: {\n      pageSize: 10,\n      pageSizes: [5, 10, 25, 50],\n    },\n    selectAllToggle: {\n      labels: {\n        allRows: 'Select all',\n        allPageRows: 'Select all on page',\n      },\n      onSelectAllRows: setAreAllSelected,\n    },\n    DatagridPagination,\n    DatagridActions,\n    DatagridBatchActions,\n  },\n  useSelectRows,\n  useSelectAllWithToggle\n);\n\nreturn (\n  <Datagrid datagridState={datagridState} />\n);\n          "
+      }
+    }, {
+      title: 'Selecting rows',
+      description: "When building a Datagrid that requires selectable rows, use the `useSelectRows` hook.\n- Include `useSelectRows` hook\n- Add `onRowSelect` to the `useDatagrid` hook, this is a callback function called when on a row's selection checkbox onChange, and sends back the row object and the event\n        ",
+      source: {
+        code: "\nconst [data] = useState(makeData(10));\nconst columns = React.useMemo(() => getColumns(data), []);\nconst datagridState = useDatagrid(\n  {\n    columns,\n    data,\n    onRowSelect: (row, event) => console.log(row, event),\n  },\n  useSelectRows\n);\n\nreturn <Datagrid datagridState={datagridState} />;\n          "
+      }
+    }, {
+      description: "The select all checkbox can be optionally hidden by settings the `hideSelectAll` property to `true` in the `useDatagrid` hook.",
+      source: {
+        code: "\nconst datagridState = useDatagrid(\n  {\n    columns,\n    data,\n    onRowSelect: (row, event) => console.log(row, event),\n    hideSelectAll: true,\n  },\n  useSelectRows\n);\n          "
+      }
+    }, {
+      description: "Datagrid also provides the option to use radio selection in cases where only one row should be selected at a time. Additionally, you can have preselected row/rows, see example below.",
+      source: {
+        code: "\nconst [data] = useState(makeData(10));\nconst columns = React.useMemo(() => getColumns(data), []);\nconst datagridState = useDatagrid(\n  {\n    columns,\n    data,\n    radio: true,\n    onRadioSelect: (row) => console.log(`Row clicked`),\n    initialState: {\n      selectedRowIds: {\n        3: true,\n      },\n    },\n  },\n  useSelectRows\n);\n\nreturn <Datagrid datagridState={datagridState} />;\n          "
+      }
+    }, {
+      title: 'Sortable columns',
+      description: "To add sortable columns to your Datagrid, simply add the `useSortableColumns` hook. This will allow each column header to be clickable and sort each column in either ascending or descending order.\n- Include `useSortableColumns` hook\n        ",
+      source: {
+        code: "\nconst [data] = useState(makeData(10));\nconst columns = React.useMemo(() => getColumns(data), []);\nconst datagridState = useDatagrid(\n  {\n    columns,\n    data,\n  },\n  useSortableColumns\n);\n\nreturn <Datagrid datagridState={datagridState} />;\n          "
+      }
+    }, {
+      title: 'Sticky column',
+      description: "Sticky columns can be useful when you have many columns that create a horizontal scroll and you have important data in the first or last column that you always want to be visible.\n- Include the `useStickyColumn` hook\n- Sticky columns can _only_ be applied to the first and the last columns in the Datagrid. To have the first column stick, add `sticky: 'left'` to the first column definition. To have the last column stick, add `sticky: 'right'` to the last column definition.\n        ",
+      source: {
+        code: "\nconst columns = [\n  {\n    Header: 'First column',\n    accessor: 'first_column',\n    sticky: 'left',\n  },\n  {\n    ...\n  },\n  {\n    ...\n  }\n];\nconst datagridState = useDatagrid(\n  {\n    columns,\n    data,\n  },\n  useStickyColumn\n);\n\nreturn <Datagrid datagridState={datagridState} />;\n          "
+      }
+    }]
+  });
+};
+exports.DocsPage = DocsPage;

package/lib/components/Datagrid/Extensions/ColumnAlignment/ColumnAlignment.docs-page.js

@@ -0,0 +1,21 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.DocsPage = 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, {
+    blocks: [{
+      description: "The default column alignment in the `Datagrid` is left, however there is support for center and right aligned as well. See [design guidance](https://pages.github.ibm.com/cdai-design/pal/components/data-table/column-alignment/usage) for details around when to change default column alignment.\n\nTo utilize center or right aligned columns refer to the steps below:\n\n  - Include `useColumnCenterAlign` or `useColumnRightAlign` hook/s.\n  - Add `rightAlignedColumn` or `centerAlignedColumn` to the column object in which you which to change the default column alignment.\n        ",
+      source: {
+        language: 'jsx',
+        code: "\nimport {\n  Datagrid,\n  useDatagrid,\n  useColumnCenterAlign,\n  useColumnRightAlign,\n} from '@carbon/ibm-products';\n\nconst defaultColumns = [\n  ...defaultCols,\n  {\n    Header: 'Bonus',\n    accessor: 'bonus',\n    width: 120,\n    rightAlignedColumn: true,\n  },\n  {\n    Header: 'Status',\n    accessor: 'status_icon',\n    width: 100,\n    centerAlignedColumn: true,\n  },\n];\n\nconst App = () => {\n  const columns = React.useMemo(() => [...defaultHeader], []);\n  const [data] = useState(makeData(10));\n\n  const datagridState = useDatagrid(\n    {\n      columns,\n      data,\n      initialState: {\n        pageSize: 10,\n        pageSizes: [5, 10, 25, 50],\n      },\n      DatagridActions,\n      DatagridPagination,\n    },\n    useColumnCenterAlign,\n    useColumnRightAlign\n  );\n\n  return <Datagrid datagridState={datagridState} />;\n};\n          "
+      }
+    }]
+  });
+};
+exports.DocsPage = DocsPage;

package/lib/components/Datagrid/Extensions/ColumnCustomization/ColumnCustomization.docs-page.js

@@ -0,0 +1,21 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.DocsPage = 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, {
+    blocks: [{
+      title: 'Customizing columns',
+      description: "Customizing columns allows user to reorder and hide certain columns of the datagrid. Consuming component can use the provided callback to save/update according to their persistent strategy.\n- Include `useCustomizeColumns` and `useColumnOrder` hooks (required)\n  - `useColumnOrder` comes from `react-table` but is exported by `@carbon/ibm-products` to be used alongside `useCustomizeColumns`.\n- Implement `options.DatagridActions` component\n  - this component will have props: `datagridState`\n  - render `datagridState.CustomizeColumnsButton` component wherever makes sense.\n- Options available to set:\n  - `options.initialState.hiddenColumns: Array<ColumnId: String>`\n    - Array of column ids that will be hidden after initial render\n    - [react-table doc](https://react-table.tanstack.com/docs/api/useTable#table-options)\n  - `options.initialState.columnOrder: Array<ColumnId: String>`\n    - Order of the columns. Any column ids not in this array will be ordered by their position in the `options.columns`\n    - [react-table doc](https://react-table.tanstack.com/docs/api/useColumnOrder#table-options)\n  - `options.customizeColumnsProps.onSaveColumnPrefs`\n    - type: `Function(Columns: Array<{ColumnId: String, isVisible: Boolean}>) => void`\n    - Callback function when 'Save' button clicked on the narrow tearsheet. It allows consumer to preserve the updated column preference. This output can also be used to compute the `hiddenColumns` and `columnOrder`\n  - Reset to default (optional)\n    - There is a reset to default button on the modal. It will use the `options.columns` as the default. If there are columns should be hidden by default, denote them with property: `isVisible: false` (undefined will be treated as `true`).\n        ",
+      source: {
+        code: "\nconst columns = React.useMemo(() => defaultHeader, []);\nconst [data] = useState(makeData(10));\nconst DatagridActions = (datagridState) => (\n  <TableToolbarContent>\n    <TableToolbarSearch ... />\n    <Button ... />\n    <datagridState.CustomizeColumnsButton />\n  </TableToolbarContent>\n)\nconst datagridState = useDatagrid(\n  {\n    columns,\n    data,\n    initialState: {\n      hiddenColumns: ['age'],\n      columnOrder: [],\n    },\n    customizeColumnsProps: {\n      onSaveColumnPrefs: (newColDefs) => {\n        console.log(newColDefs);\n      },\n    },\n    DatagridActions,\n  },\n  useCustomizeColumns,\n  useColumnOrder,\n);\n\nreturn (\n  <Datagrid datagridState={datagridState} />\n);\n          "
+      }
+    }]
+  });
+};
+exports.DocsPage = DocsPage;

package/lib/components/Datagrid/Extensions/EditableCell/EditableCell.docs-page.js

@@ -0,0 +1,55 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.DocsPage = void 0;
+var _react = _interopRequireDefault(require("react"));
+var _StoryDocsPage = require("../../../../global/js/utils/StoryDocsPage");
+var _EditableCell = require("./EditableCell.stories");
+var DocsPage = function DocsPage() {
+  return /*#__PURE__*/_react.default.createElement(_StoryDocsPage.StoryDocsPage, {
+    blocks: [{
+      description: "The `Datagrid` supports inline editing when used with the `useEditableCell` hook (previously named `useInlineEdit` in v1) and columns are provided the required configuration. The four data types supported are strings, numbers, dates, and\n        selection (dropdown)."
+    }, {
+      description: "Below are example column configurations for the supported inline edit data types:\n        \nDefault/string:\n        ",
+      source: {
+        language: 'json',
+        code: "\n  {\n    Header: 'First Name',\n    accessor: 'firstName',\n    inlineEdit: {\n      type: 'text',\n      // required for including validation, this is used to set the invalid prop internally\n      validator: (n) => n.length >= 40,\n      // These props are passed to the Carbon component used for inline editing, in this case the TextInput\n      inputProps: {\n        invalidText: 'Invalid text, character count must be less than 40',\n      },\n    },\n  }\n          "
+      }
+    }, {
+      description: 'Number',
+      source: {
+        language: 'json',
+        code: "\n{\n  Header: 'Age',\n  accessor: 'age',\n  width: 120,\n  inlineEdit: {\n    // required for including validation, this is used to set the invalid prop internally\n    validator: (n) => n && n < 18,\n    type: 'number',\n    // These props are passed to the Carbon component used for inline editing, in this case NumberInput\n    inputProps: {\n      invalidText: 'Invalid number, must be 18 or greater',\n    },\n  },\n},\n          "
+      }
+    }, {
+      description: 'Date',
+      source: {
+        language: 'json',
+        code: "\n{\n  Header: 'Active since',\n  accessor: 'activeSince',\n  inlineEdit: {\n    type: 'date',\n    inputProps: {\n      // optionally pass props here to be passed through to Carbon's DatePicker component\n      onChange: (newDateObj, cell) => {\n        console.log(newDateObj, cell);\n      },\n      labelText: 'Change active since date',\n      // optionally pass props here to be passed through to Carbon's DatePickerInput component\n      datePickerInputProps: {\n        labelText: 'Change active since date',\n      },\n    },\n  },\n},\n          "
+      }
+    }, {
+      description: 'Selection',
+      source: {
+        language: 'json',
+        code: "\n{\n  Header: 'Chart type',\n  accessor: 'chartType',\n  inlineEdit: {\n    type: 'selection',\n    inputProps: {\n      // These props are passed to the Carbon component used for inline editing\n      items: [\n        {\n          id: 'option-0',\n          icon: ChartColumnFloating16,\n          text: 'Column Chart',\n        },\n        {\n          id: 'option-1',\n          icon: ChartBubble16,\n          text: 'Bubble Chart',\n        },\n        {\n          id: 'option-2',\n          icon: ChartVennDiagram16,\n          text: 'Venn Diagram',\n        },\n      ],\n      onChange: (item) => {\n        console.log(item);\n      },\n    },\n  },\n},\n          "
+      }
+    }, {
+      description: "Using the column structure outlined above, along with the use of the `useEditableCell` hook (previously named `useInlineEdit` in v1), the `Datagrid` will support inline editing. See example below:",
+      source: {
+        code: "\nimport { Datagrid, useDatagrid, useEditableCell } from '@carbon/ibm-products';\nconst App = () => {\n  const [data, setData] = useState(makeData(10));\n  const columns = React.useMemo(() => getInlineEditColumns(), []); // These columns follow the inline edit column configuration detailed above\n  const datagridState = useDatagrid(\n    {\n      columns,\n      data,\n      onDataUpdate: setData,\n    },\n    useEditableCell\n  );\n  return <Datagrid datagridState={datagridState} />;\n};\n          "
+      },
+      story: _EditableCell.EditableCellUsageStory
+    }, {
+      title: 'Using deprecated useInlineEdit hook',
+      description: "At this time, it is possible to still use the deprecated `useInlineEdit` hook but requires setting a feature flag. See example below:",
+      source: {
+        code: "\nimport {\n  Datagrid,\n  useDatagrid,\n  useInlineEdit,\n  pkg,\n} from '@carbon/ibm-products';\n\nconst MyInlineEditDatagrid = () => {\n  pkg.feature['Datagrid.useInlineEdit'] = true;\n  const [data, setData] = useState(gridData);\n  const datagridState = useDatagrid(\n    {\n      columns,\n      data,\n      onDataUpdate: setData,\n    },\n    useInlineEdit\n  );\n  return <Datagrid datagridState={datagridState} />;\n};\n          "
+      },
+      story: _EditableCell.InlineEditUsageStory
+    }]
+  });
+};
+exports.DocsPage = DocsPage;