@carbon/ibm-products 1.22.0 → 1.24.0

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

@@ -46,28 +46,33 @@ export var Datagrid = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
       _datagridState$vertic = datagridState.verticalAlign,
       verticalAlign = _datagridState$vertic === void 0 ? 'center' : _datagridState$vertic,
       variableRowHeight = datagridState.variableRowHeight,
-      className = datagridState.className;
+      className = datagridState.className,
+      gridTitle = datagridState.gridTitle,
+      gridDescription = datagridState.gridDescription,
+      useDenseHeader = datagridState.useDenseHeader;
   var rows = DatagridPagination && datagridState.page || datagridState.rows;
   var dataGrid = /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement(TableContainer, {
-    className: cx("".concat(blockClass, "__grid-container"), withVirtualScroll || fullHeightDatagrid ? "".concat(blockClass, "__full-height") : '')
-  }, /*#__PURE__*/React.createElement(Table, _extends({}, getTableProps(), {
-    className: cx(DatagridPagination ? "".concat(blockClass, "__with-pagination") : '', withVirtualScroll ? '' : "".concat(blockClass, "__table-simple"), "".concat(blockClass, "__vertical-align-").concat(verticalAlign), _defineProperty({}, "".concat(blockClass, "__variable-row-height"), variableRowHeight), (_getTableProps = getTableProps()) === null || _getTableProps === void 0 ? void 0 : _getTableProps.className)
+    className: cx("".concat(blockClass, "__grid-container"), withVirtualScroll || fullHeightDatagrid ? "".concat(blockClass, "__full-height") : '', DatagridPagination ? "".concat(blockClass, "__with-pagination") : '', useDenseHeader ? "".concat(blockClass, "__dense-header") : ''),
+    title: gridTitle,
+    description: gridDescription
+  }, /*#__PURE__*/React.createElement(DatagridToolbar, datagridState), /*#__PURE__*/React.createElement("div", {
+    className: "".concat(blockClass, "__table-container")
+  }, leftPanel && leftPanel.isOpen && /*#__PURE__*/React.createElement("div", {
+    className: "".concat(blockClass, "__datagridLeftPanel")
+  }, leftPanel.panelContent), /*#__PURE__*/React.createElement(Table, _extends({}, getTableProps(), {
+    className: cx(withVirtualScroll ? '' : "".concat(blockClass, "__table-simple"), "".concat(blockClass, "__vertical-align-").concat(verticalAlign), _defineProperty({}, "".concat(blockClass, "__variable-row-height"), variableRowHeight), (_getTableProps = getTableProps()) === null || _getTableProps === void 0 ? void 0 : _getTableProps.className)
   }), /*#__PURE__*/React.createElement(DatagridHead, datagridState), /*#__PURE__*/React.createElement(DatagridBody, _extends({}, datagridState, {
     rows: rows
-  })))), (rows === null || rows === void 0 ? void 0 : rows.length) > 0 && !isFetching && DatagridPagination && DatagridPagination(datagridState), CustomizeColumnsModal && /*#__PURE__*/React.createElement(CustomizeColumnsModal, {
+  }))))), (rows === null || rows === void 0 ? void 0 : rows.length) > 0 && !isFetching && DatagridPagination && DatagridPagination(datagridState), CustomizeColumnsModal && /*#__PURE__*/React.createElement(CustomizeColumnsModal, {
     instance: datagridState
   }));
   return /*#__PURE__*/React.createElement("div", _extends({}, rest, {
     id: tableId,
     ref: ref,
     className: cx(className, blockClass, withVirtualScroll ? "".concat(blockClass, "__datagridWrap") : "".concat(blockClass, "__datagridWrap-simple"), !isFetching && rows.length === 0 ? "".concat(blockClass, "__empty-state") : '')
-  }, getDevtoolsProps(componentName)), /*#__PURE__*/React.createElement(DatagridToolbar, datagridState), leftPanel && /*#__PURE__*/React.createElement("div", {
-    className: "".concat(blockClass, "__grid-container ").concat(blockClass, "__displayFlex")
-  }, leftPanel && leftPanel.isOpen && /*#__PURE__*/React.createElement("div", {
-    className: "".concat(blockClass, "__datagridLeftPanel")
-  }, leftPanel.panelContent), /*#__PURE__*/React.createElement("div", {
-    className: "".concat(blockClass, "__datagridWithPanel")
-  }, dataGrid)), leftPanel === undefined && dataGrid);
+  }, getDevtoolsProps(componentName)), leftPanel && /*#__PURE__*/React.createElement("div", {
+    className: "".concat(blockClass, "__datagridWithPanel ").concat(blockClass, "__displayFlex ").concat(blockClass, "__leftPanel-position")
+  }, dataGrid), leftPanel === undefined && dataGrid);
 }); // Return a placeholder if not released and not enabled by feature flag
 
 Datagrid = pkg.checkComponentEnabled(Datagrid, componentName); // The display name of the component, used by React. Note that displayName

package/es/components/Datagrid/Datagrid/DatagridRow.js

@@ -15,15 +15,17 @@ import React from 'react';
 import { DataTable, SkeletonText } from 'carbon-components-react';
 import { selectionColumnId } from '../common-column-ids';
 import cx from 'classnames';
-import { pkg } from '../../../settings';
+import { pkg, carbon } from '../../../settings';
 var blockClass = "".concat(pkg.prefix, "--datagrid");
 var TableRow = DataTable.TableRow,
     TableCell = DataTable.TableCell; // eslint-disable-next-line react/prop-types
 
 var DatagridRow = function DatagridRow(datagridState) {
+  var _cx;
+
   var row = datagridState.row;
   return /*#__PURE__*/React.createElement(TableRow, _extends({
-    className: cx("".concat(blockClass, "__carbon-row"), _defineProperty({}, "".concat(blockClass, "__carbon-row-expanded"), row.isExpanded))
+    className: cx("".concat(blockClass, "__carbon-row"), (_cx = {}, _defineProperty(_cx, "".concat(blockClass, "__carbon-row-expanded"), row.isExpanded), _defineProperty(_cx, "".concat(carbon.prefix, "--data-table--selected"), row.isSelected), _cx))
   }, row.getRowProps(), {
     key: row.id,
     onMouseEnter: function onMouseEnter(event) {

package/es/components/Datagrid/useExpandedRow.js

@@ -37,6 +37,7 @@ var useExpandedRow = function useExpandedRow(hooks) {
       return _objectSpread(_objectSpread({}, row), {}, {
         canExpand: row.original && !row.original.notExpandable,
         expandedContentHeight: expandedRowsHeight[row.index] || expandedContentHeight,
+        // RowRenderer: DatagridExpandedRow(row.RowRenderer, expansionRenderer),
         RowRenderer: DatagridExpandedRow(row.RowRenderer, ExpandedRowContentComponent)
       });
     });

package/es/components/Datagrid/useOnRowClick.js

@@ -6,16 +6,23 @@
  * restricted by GSA ADP Schedule Contract with IBM Corp.
  */
 var useOnRowClick = function useOnRowClick(hooks) {
-  var useInstance = function useInstance(instance) {
-    var onRowClick = instance.onRowClick;
+  var useInstance = function useInstance(rowInstance) {
+    var onRowClick = rowInstance.onRowClick;
 
     var getRowProps = function getRowProps(props, datagridState) {
       var isFetching = datagridState.isFetching,
-          row = datagridState.row;
+          row = datagridState.row,
+          instance = datagridState.instance;
+      var id = row.id,
+          toggleRowSelected = row.toggleRowSelected;
 
       var onClick = function onClick() {
         if (!isFetching && onRowClick) {
           onRowClick(row);
+          instance.selectedFlatRows && instance.selectedFlatRows.map(function (toggleRow) {
+            return toggleRow.toggleRowSelected(false);
+          });
+          toggleRowSelected(id, true);
         }
       };
 

package/es/components/EditFullPage/EditFullPage.js

@@ -0,0 +1,79 @@
+import _extends from "@babel/runtime/helpers/extends";
+import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
+var _excluded = ["children", "className"];
+
+/**
+ * Copyright IBM Corp. 2022, 2022
+ *
+ * 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 portions of React that are needed.
+import React from 'react'; // Other standard imports.
+
+import PropTypes from 'prop-types';
+import cx from 'classnames';
+import { getDevtoolsProps } from '../../global/js/utils/devtools';
+import { pkg
+/*, carbon */
+} from '../../settings'; // Carbon and package components we use.
+
+/* TODO: @import(s) of carbon components and other package components. */
+// The block part of our conventional BEM class names (blockClass__E--M).
+
+var blockClass = "".concat(pkg.prefix, "--edit-full-page");
+var componentName = 'EditFullPage'; // NOTE: the component SCSS is not imported here: it is rolled up separately.
+// Default values can be included here and then assigned to the prop params,
+// e.g. prop = defaults.prop,
+// This gathers default values together neatly and ensures non-primitive
+// values are initialized early to avoid react making unnecessary re-renders.
+// Note that default values are not required for props that are 'required',
+// nor for props where the component can apply undefined values reasonably.
+// Default values should be provided when the component needs to make a choice
+// or assumption when a prop is not supplied.
+// Default values for props
+// const defaults = {
+//   /* TODO: add defaults for relevant props if needed */
+// };
+
+/**
+ * TODO: A description of the component.
+ */
+
+export var EditFullPage = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
+  var children = _ref.children,
+      className = _ref.className,
+      rest = _objectWithoutProperties(_ref, _excluded);
+
+  return /*#__PURE__*/React.createElement("div", _extends({}, rest, {
+    className: cx(blockClass, // Apply the block class to the main HTML element
+    className, // Apply any supplied class names to the main HTML element.
+    // example: `${blockClass}__template-string-class-${kind}-n-${size}`,
+    {// switched classes dependant on props or state
+      // example: [`${blockClass}__here-if-small`]: size === 'sm',
+    }),
+    ref: ref,
+    role: "main"
+  }, getDevtoolsProps(componentName)), children);
+}); // Return a placeholder if not released and not enabled by feature flag
+
+EditFullPage = pkg.checkComponentEnabled(EditFullPage, componentName); // The display name of the component, used by React. Note that displayName
+// is used in preference to relying on function.name.
+
+EditFullPage.displayName = componentName; // The types and DocGen commentary for the component props,
+// in alphabetical order (for consistency).
+// See https://www.npmjs.com/package/prop-types#usage.
+
+EditFullPage.propTypes = {
+  /**
+   * Provide the contents of the EditFullPage.
+   */
+  children: PropTypes.node.isRequired,
+
+  /**
+   * Provide an optional class to be applied to the containing node.
+   */
+  className: PropTypes.string
+  /* TODO: add types and DocGen for all props. */
+
+};

package/es/components/EditFullPage/index.js

@@ -0,0 +1,7 @@
+/**
+ * Copyright IBM Corp. 2022, 2022
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+export { EditFullPage } from './EditFullPage';

package/es/components/EditTearsheet/EditTearsheet.js

@@ -0,0 +1,205 @@
+import _extends from "@babel/runtime/helpers/extends";
+import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
+import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
+var _excluded = ["cancelButtonText", "children", "className", "description", "influencerWidth", "label", "onClose", "open", "submitButtonText", "title", "verticalPosition", "onHandleModalClick"];
+
+/**
+ * Copyright IBM Corp. 2022, 2022
+ *
+ * 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, { forwardRef, useState, useRef, createContext } from 'react';
+import PropTypes from 'prop-types';
+import cx from 'classnames';
+import { Grid, Form, SideNav, SideNavItems, SideNavMenuItem } from 'carbon-components-react';
+import { pkg } from '../../settings';
+import { getDevtoolsProps } from '../../global/js/utils/devtools';
+import { TearsheetShell } from '../Tearsheet/TearsheetShell';
+var componentName = 'EditTearsheet';
+var blockClass = "".concat(pkg.prefix, "--tearsheet-edit"); // This is a general context for the forms container
+// containing information about the state of the container
+// and providing some callback methods for forms to use
+
+export var FormContext = /*#__PURE__*/createContext(null); // This is a context supplied separately to each form in the container
+// to let it know what number it is in the sequence of forms
+
+export var FormNumberContext = /*#__PURE__*/createContext(0); // Default values for props
+
+var defaults = {
+  verticalPosition: 'normal',
+  influencerWidth: 'narrow'
+};
+export var EditTearsheet = /*#__PURE__*/forwardRef(function (_ref, ref) {
+  var cancelButtonText = _ref.cancelButtonText,
+      children = _ref.children,
+      className = _ref.className,
+      description = _ref.description,
+      _ref$influencerWidth = _ref.influencerWidth,
+      influencerWidth = _ref$influencerWidth === void 0 ? defaults.influencerWidth : _ref$influencerWidth,
+      label = _ref.label,
+      onClose = _ref.onClose,
+      open = _ref.open,
+      submitButtonText = _ref.submitButtonText,
+      title = _ref.title,
+      _ref$verticalPosition = _ref.verticalPosition,
+      verticalPosition = _ref$verticalPosition === void 0 ? defaults.verticalPosition : _ref$verticalPosition,
+      onHandleModalClick = _ref.onHandleModalClick,
+      rest = _objectWithoutProperties(_ref, _excluded);
+
+  var _useState = useState(0),
+      _useState2 = _slicedToArray(_useState, 2),
+      currentForm = _useState2[0],
+      setCurrentForm = _useState2[1];
+
+  var contentRef = useRef();
+
+  var handleCurrentForm = function handleCurrentForm(form) {
+    setCurrentForm(form);
+  };
+
+  var sideNavItems = [{
+    label: 'Topic Name'
+  }, {
+    label: 'Location'
+  }, {
+    label: 'Partitions'
+  }, {
+    label: 'Message retention'
+  }];
+  var influencer = /*#__PURE__*/React.createElement("div", {
+    className: "tearsheet-stories__dummy-influencer-block"
+  }, /*#__PURE__*/React.createElement(SideNav, {
+    "aria-label": "Side navigation",
+    className: "".concat(blockClass, "__side-nav"),
+    expanded: true,
+    isFixedNav: false
+  }, /*#__PURE__*/React.createElement(SideNavItems, null, sideNavItems.map(function (item, index) {
+    return /*#__PURE__*/React.createElement(SideNavMenuItem, {
+      key: index,
+      onClick: function onClick() {
+        return handleCurrentForm(index);
+      },
+      isActive: currentForm === index
+    }, item.label);
+  }))));
+  return /*#__PURE__*/React.createElement(TearsheetShell, _extends({}, rest, getDevtoolsProps(componentName), {
+    actions: [{
+      label: submitButtonText,
+      onClick: onHandleModalClick,
+      kind: 'primary'
+    }, {
+      label: cancelButtonText,
+      onClick: onHandleModalClick,
+      kind: 'secondary'
+    }],
+    className: cx(blockClass, className),
+    description: description,
+    hasCloseIcon: false,
+    influencer: influencer,
+    influencerPosition: "left",
+    influencerWidth: influencerWidth,
+    label: label,
+    onClose: onClose,
+    open: open,
+    size: "wide",
+    title: title,
+    verticalPosition: verticalPosition,
+    ref: ref
+  }), /*#__PURE__*/React.createElement("div", {
+    className: "".concat(blockClass, "__content"),
+    ref: contentRef,
+    role: "main"
+  }, /*#__PURE__*/React.createElement(Grid, null, /*#__PURE__*/React.createElement(Form, null, /*#__PURE__*/React.createElement(FormContext.Provider, {
+    value: {
+      currentForm: currentForm
+    }
+  }, React.Children.map(children, function (child, index) {
+    return /*#__PURE__*/React.createElement(FormNumberContext.Provider, {
+      value: index
+    }, child);
+  }))))));
+}); // Return a placeholder if not released and not enabled by feature flag
+
+EditTearsheet = pkg.checkComponentEnabled(EditTearsheet, componentName); // The display name of the component, used by React. Note that displayName
+// is used in preference to relying on function.name.
+
+EditTearsheet.displayName = componentName; // Note that the descriptions here should be kept in sync with those for the
+// corresponding props for TearsheetNarrow and TearsheetShell components.
+
+EditTearsheet.propTypes = {
+  /**
+   * The cancel button text
+   */
+  cancelButtonText: PropTypes.string,
+
+  /**
+   * The main content of the tearsheet
+   */
+  children: PropTypes.node,
+
+  /**
+   * An optional class or classes to be added to the outermost element.
+   */
+  className: PropTypes.string,
+
+  /**
+   * A description of the flow, displayed in the header area of the tearsheet.
+   */
+  description: PropTypes.node,
+
+  /**
+   * The content for the influencer section of the tearsheet, displayed
+   * alongside the main content. This is typically a menu, or filter, or
+   * progress indicator, or similar.
+   */
+  influencer: PropTypes.element,
+
+  /**
+   * Used to set the size of the influencer
+   */
+  influencerWidth: PropTypes.oneOf(['narrow', 'wide']),
+
+  /**
+   * A label for the tearsheet, displayed in the header area of the tearsheet
+   * to maintain context for the tearsheet (e.g. as the title changes from page
+   * to page of a multi-page task).
+   */
+  label: PropTypes.node,
+
+  /**
+   * An optional handler that is called when the user closes the tearsheet (by
+   * clicking the close button, if enabled, or clicking outside, if enabled).
+   * Returning `false` here prevents the modal from closing.
+   */
+  onClose: PropTypes.func,
+
+  /**
+   * Specifies whether the tearsheet is currently open.
+   */
+  onHandleModalClick: PropTypes.func,
+
+  /**
+   * Specifies whether the tearsheet is currently open.
+   */
+  open: PropTypes.bool,
+
+  /**
+   * The submit button text
+   */
+  submitButtonText: PropTypes.string,
+
+  /**
+   * The main title of the tearsheet, displayed in the header area.
+   */
+  title: PropTypes.node,
+
+  /**
+   * The position of the top of tearsheet in the viewport. The 'normal'
+   * position (the default) is a short distance down from the top of the
+   * viewport, leaving room at the top for a global header bar to show through
+   * from below. The 'lower' position provides a little extra room at the top
+   * to allow an action bar navigation or breadcrumbs to also show through.
+   */
+  verticalPosition: PropTypes.oneOf(['normal', 'lower'])
+};

package/es/components/EditTearsheet/EditTearsheetForm.js

@@ -0,0 +1,103 @@
+import _extends from "@babel/runtime/helpers/extends";
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
+var _excluded = ["children", "className", "description", "fieldsetLegendText", "hasFieldset", "subtitle", "title"];
+
+/**
+ * Copyright IBM Corp. 2022, 2022
+ *
+ * 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, { forwardRef, useContext } from 'react';
+import PropTypes from 'prop-types';
+import cx from 'classnames';
+import { Column, FormGroup, Row } from 'carbon-components-react';
+import { FormContext, FormNumberContext } from './EditTearsheet';
+import { pkg } from '../../settings';
+import pconsole from '../../global/js/utils/pconsole';
+var componentName = 'EditTearsheetForm';
+var blockClass = "".concat(pkg.prefix, "--tearsheet-edit__form"); // Default values for props
+
+var defaults = {
+  hasFieldset: true
+};
+export var EditTearsheetForm = /*#__PURE__*/forwardRef(function (_ref, ref) {
+  var _cx;
+
+  var children = _ref.children,
+      className = _ref.className,
+      description = _ref.description,
+      fieldsetLegendText = _ref.fieldsetLegendText,
+      _ref$hasFieldset = _ref.hasFieldset,
+      hasFieldset = _ref$hasFieldset === void 0 ? defaults.hasFieldset : _ref$hasFieldset,
+      subtitle = _ref.subtitle,
+      title = _ref.title,
+      rest = _objectWithoutProperties(_ref, _excluded);
+
+  var formContext = useContext(FormContext);
+  var formNumber = useContext(FormNumberContext);
+  return formContext ? /*#__PURE__*/React.createElement("div", _extends({}, rest, {
+    className: cx(blockClass, className, (_cx = {}, _defineProperty(_cx, "".concat(blockClass, "__form--hidden-form"), formNumber !== (formContext === null || formContext === void 0 ? void 0 : formContext.currentForm)), _defineProperty(_cx, "".concat(blockClass, "__form--visible-form"), formNumber === (formContext === null || formContext === void 0 ? void 0 : formContext.currentForm)), _cx)),
+    ref: ref
+  }), /*#__PURE__*/React.createElement(Row, null, /*#__PURE__*/React.createElement(Column, {
+    xlg: 12,
+    lg: 12,
+    md: 8,
+    sm: 8
+  }, /*#__PURE__*/React.createElement("h4", {
+    className: "".concat(blockClass, "--title")
+  }, title), subtitle && /*#__PURE__*/React.createElement("h6", {
+    className: "".concat(blockClass, "--subtitle")
+  }, subtitle), description && /*#__PURE__*/React.createElement("p", {
+    className: "".concat(blockClass, "--description")
+  }, description))), hasFieldset ? /*#__PURE__*/React.createElement(FormGroup, {
+    legendText: fieldsetLegendText,
+    className: "".concat(blockClass, "--fieldset")
+  }, children) : children) : pconsole.warn("You have tried using a ".concat(componentName, " component outside of a EditTearsheet. This is not allowed. ").concat(componentName, "s should always be children of the EditTearsheet"));
+}); // Return a placeholder if not released and not enabled by feature flag
+
+EditTearsheetForm = pkg.checkComponentEnabled(EditTearsheetForm, componentName);
+EditTearsheetForm.propTypes = {
+  /**
+   * Content that shows in the tearsheet form
+   */
+  children: PropTypes.node,
+
+  /**
+   * Sets an optional className to be added to the tearsheet form
+   */
+  className: PropTypes.string,
+
+  /**
+   * Sets an optional description on the form component
+   */
+  description: PropTypes.string,
+
+  /**
+   * This is the required legend text that appears above a fieldset html element for accessibility purposes.
+   * You can set the `hasFieldset` prop to false if you have multiple fieldset elements or want to control the children of your Full Page's form content.
+   * Otherwise, use CSS to hide/remove this label text.
+   */
+  fieldsetLegendText: PropTypes.string.isRequired.if(function (_ref2) {
+    var hasFieldset = _ref2.hasFieldset;
+    return !!hasFieldset;
+  }),
+
+  /**
+   * This optional prop will render your form content inside of a fieldset html element
+   * and is defaulted to true.
+   * You can set this prop to `false` if you have multiple fieldset elements or want to control the children of your Full Page's form content.
+   */
+  hasFieldset: PropTypes.bool,
+
+  /**
+   * Sets an optional subtitle on the form component
+   */
+  subtitle: PropTypes.string,
+
+  /**
+   * Sets the title text for a tearsheet form
+   */
+  title: PropTypes.node.isRequired
+};

package/es/components/EditTearsheet/index.js

@@ -0,0 +1,8 @@
+/**
+ * Copyright IBM Corp. 2022, 2022
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+export { EditTearsheet } from './EditTearsheet';
+export { EditTearsheetForm } from './EditTearsheetForm';