@carbon/ibm-products 2.25.0 → 2.27.0

package/es/components/BigNumbers/BigNumbers.d.ts

@@ -0,0 +1,11 @@
+/**
+ * BigNumbers is used to display large values in a small area. The display of
+ * values can be the value itself, or grouped in a numerator / denominator fashion.
+ * Control over the total fraction decimals displayed as well as how the
+ * values/totals are displayed are done via a locale prop. Other optional props
+ * allow control over size, truncation, if the value is a percentage, the addition
+ * of a button as well as tool tip functionality.
+ * The default locale is English (`en-US`) if one is not provided or if the provided one is not supported.
+ */
+export let BigNumbers: React.ForwardRefExoticComponent<React.RefAttributes<any>>;
+import React from 'react';

package/es/components/BigNumbers/BigNumbers.js

@@ -0,0 +1,238 @@
+/**
+ * Copyright IBM Corp. 2020, 2024
+ *
+ * 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 { objectWithoutProperties as _objectWithoutProperties, defineProperty as _defineProperty, extends as _extends } from '../../_virtual/_rollupPluginBabelHelpers.js';
+import React__default from 'react';
+import PropTypes from '../../node_modules/prop-types/index.js';
+import cx from '../../node_modules/classnames/index.js';
+import { getDevtoolsProps } from '../../global/js/utils/devtools.js';
+import { pkg } from '../../settings.js';
+import { Information, ArrowUp } from '@carbon/react/icons';
+import { Tooltip, SkeletonText } from '@carbon/react';
+import { DefaultLocale, BigNumbersSize, getSupportedLocale, formatValue, Characters, getIconSize } from './constants.js';
+import { TooltipTrigger } from '../TooltipTrigger/TooltipTrigger.js';
+
+var _Information;
+var _excluded = ["className", "forceShowTotal", "fractionDigits", "iconButton", "loading", "label", "locale", "percentage", "size", "tooltipDescription", "total", "trending", "truncate", "value"],
+  _excluded2 = ["className", "size"];
+
+// The block part of our conventional BEM class names (blockClass__E--M).
+var blockClass = "".concat(pkg.prefix, "--big-numbers");
+var skeletonBlockClass = "".concat(pkg.prefix, "--big-numbers-skeleton");
+var componentName = 'BigNumbers';
+
+// NOTE: the component SCSS is not imported here: it is rolled up separately.
+
+// Default values for props
+var defaults = {
+  forceShowTotal: false,
+  fractionDigits: 1,
+  loading: false,
+  locale: DefaultLocale,
+  percentage: false,
+  size: BigNumbersSize.Default,
+  total: 0,
+  trending: false,
+  truncate: true,
+  value: null
+};
+
+/**
+ * BigNumbers is used to display large values in a small area. The display of
+ * values can be the value itself, or grouped in a numerator / denominator fashion.
+ * Control over the total fraction decimals displayed as well as how the
+ * values/totals are displayed are done via a locale prop. Other optional props
+ * allow control over size, truncation, if the value is a percentage, the addition
+ * of a button as well as tool tip functionality.
+ * The default locale is English (`en-US`) if one is not provided or if the provided one is not supported.
+ */
+var BigNumbers = /*#__PURE__*/React__default.forwardRef(function (_ref, ref) {
+  var _formatValue, _formatValue2;
+  var className = _ref.className,
+    _ref$forceShowTotal = _ref.forceShowTotal,
+    forceShowTotal = _ref$forceShowTotal === void 0 ? defaults.forceShowTotal : _ref$forceShowTotal,
+    _ref$fractionDigits = _ref.fractionDigits,
+    fractionDigits = _ref$fractionDigits === void 0 ? defaults.fractionDigits : _ref$fractionDigits,
+    iconButton = _ref.iconButton,
+    _ref$loading = _ref.loading,
+    loading = _ref$loading === void 0 ? defaults.loading : _ref$loading,
+    label = _ref.label,
+    _ref$locale = _ref.locale,
+    locale = _ref$locale === void 0 ? defaults.locale : _ref$locale,
+    _ref$percentage = _ref.percentage,
+    percentage = _ref$percentage === void 0 ? defaults.percentage : _ref$percentage,
+    _ref$size = _ref.size,
+    size = _ref$size === void 0 ? defaults.size : _ref$size,
+    tooltipDescription = _ref.tooltipDescription,
+    _ref$total = _ref.total,
+    total = _ref$total === void 0 ? defaults.total : _ref$total,
+    _ref$trending = _ref.trending,
+    trending = _ref$trending === void 0 ? defaults.trending : _ref$trending,
+    _ref$truncate = _ref.truncate,
+    truncate = _ref$truncate === void 0 ? defaults.truncate : _ref$truncate,
+    _ref$value = _ref.value,
+    value = _ref$value === void 0 ? defaults.value : _ref$value,
+    rest = _objectWithoutProperties(_ref, _excluded);
+  var BigNumbersClasses = cx(className, _defineProperty(_defineProperty({}, "".concat(blockClass, "--lg"), size === BigNumbersSize.Large), "".concat(blockClass, "--xl"), size === BigNumbersSize.XLarge));
+  var supportedLocale = getSupportedLocale(locale);
+  var truncatedValue = (_formatValue = formatValue(supportedLocale, value, fractionDigits, truncate)) !== null && _formatValue !== void 0 ? _formatValue : Characters.Dash;
+  var truncatedTotal = (_formatValue2 = formatValue(supportedLocale, total, fractionDigits, truncate)) !== null && _formatValue2 !== void 0 ? _formatValue2 : 'Unknown';
+  var shouldDisplayDenominator = !percentage && total > value && truncatedValue !== truncatedTotal || forceShowTotal && total > 0;
+  if (loading) {
+    return /*#__PURE__*/React__default.createElement(SkeletonBigNumbers, _extends({}, rest, {
+      ref: ref,
+      className: className,
+      size: size
+    }, getDevtoolsProps(componentName)));
+  }
+  return /*#__PURE__*/React__default.createElement("div", _extends({}, rest, {
+    className: cx(blockClass, BigNumbersClasses, className),
+    ref: ref
+  }, getDevtoolsProps(componentName)), /*#__PURE__*/React__default.createElement("span", {
+    className: "".concat(blockClass, "__row")
+  }, /*#__PURE__*/React__default.createElement("h4", {
+    className: "".concat(blockClass, "__label")
+  }, label), tooltipDescription && /*#__PURE__*/React__default.createElement(Tooltip, {
+    description: tooltipDescription,
+    align: "right",
+    className: "".concat(blockClass, "__info")
+  }, /*#__PURE__*/React__default.createElement(TooltipTrigger, {
+    className: "".concat(blockClass, "__tooltip-trigger")
+  }, _Information || (_Information = /*#__PURE__*/React__default.createElement(Information, {
+    size: 16
+  }))))), /*#__PURE__*/React__default.createElement("span", {
+    className: "".concat(blockClass, "__row"),
+    role: "math"
+  }, trending && /*#__PURE__*/React__default.createElement(ArrowUp, {
+    className: "".concat(blockClass, "__trend"),
+    size: getIconSize(size)
+  }), /*#__PURE__*/React__default.createElement("span", {
+    className: "".concat(blockClass, "__value")
+  }, percentage ? /*#__PURE__*/React__default.createElement("div", {
+    className: "".concat(blockClass, "__percentage")
+  }, truncatedValue, /*#__PURE__*/React__default.createElement("span", {
+    className: "".concat(blockClass, "__percentage-mark")
+  }, "%")) : truncatedValue), shouldDisplayDenominator && /*#__PURE__*/React__default.createElement("span", {
+    className: "".concat(blockClass, "__total")
+  }, /*#__PURE__*/React__default.createElement("span", null, Characters.Slash, truncatedTotal)), iconButton));
+});
+
+// Return a placeholder if not released and not enabled by feature flag
+BigNumbers = pkg.checkComponentEnabled(BigNumbers, componentName);
+
+// The display name of the component, used by React. Note that displayName
+// is used in preference to relying on function.name.
+BigNumbers.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.
+BigNumbers.propTypes = {
+  /**
+   * Optional class name.
+   * @type number
+   */
+  className: PropTypes.string,
+  /**
+   * Display the `total` even when the `value` is equal to
+   * the `total` when `forceShowTotal` prop is true on the
+   * condition that the `total` is greater than 0.
+   * @type bool
+   */
+  forceShowTotal: PropTypes.bool,
+  /**
+   * Optional value to control the maximum fraction digits
+   * used when truncating the value and total.
+   * @type number
+   */
+  fractionDigits: PropTypes.number,
+  /** Displays an iconButton next to the BigNumbers value
+   * @type node
+   */
+  iconButton: PropTypes.node,
+  /**
+   * Text label for BigNumbers.
+   * @type string
+   */
+  label: PropTypes.string.isRequired,
+  /** Specify if the BigNumbers is in a loading state
+   * @type bool
+   */
+  loading: PropTypes.bool,
+  /**
+   * Locale value to determine approach to formatting numbers.
+   * @type string
+   */
+  locale: PropTypes.string,
+  /**
+   * Format number to percentage when `percentage` prop is true.
+   * @type bool
+   */
+  percentage: PropTypes.bool,
+  /** The size of the BigNumbers.
+   * @type string
+   */
+  size: PropTypes.oneOf(Object.values(BigNumbersSize)),
+  /** Label applied to a Tooltip - marked with the Information icon.
+   * @type string
+   */
+  tooltipDescription: PropTypes.string,
+  /**
+   * Total value that the main BigNumbers value is a subset of.
+   * @type number
+   */
+  total: PropTypes.number,
+  /** Display trending icon.
+   * @type boolean
+   */
+  trending: PropTypes.bool,
+  /** Specify whether or not the values should be truncated.
+   * @type boolean
+   */
+  truncate: PropTypes.bool,
+  /**
+   * The main BigNumbers value to display
+   * @type number
+   */
+  value: PropTypes.number
+};
+
+/**
+ * SkeletonBigNumbers is used to display a skeleton version while
+ * content is loading (handled by the BigNumbers prop `loading').
+ *
+ * Note: This component is only used within BigNumbers.
+ */
+var SkeletonBigNumbers = /*#__PURE__*/React__default.forwardRef(function (_ref2, ref) {
+  var className = _ref2.className,
+    size = _ref2.size,
+    rest = _objectWithoutProperties(_ref2, _excluded2);
+  var BigNumbersSkeletonClasses = cx(className, _defineProperty(_defineProperty({}, "".concat(skeletonBlockClass, "--lg"), size === BigNumbersSize.Large), "".concat(skeletonBlockClass, "--xl"), size === BigNumbersSize.XLarge));
+  return /*#__PURE__*/React__default.createElement("div", _extends({}, rest, {
+    className: cx(className, skeletonBlockClass, BigNumbersSkeletonClasses),
+    ref: ref
+  }, getDevtoolsProps(componentName)), /*#__PURE__*/React__default.createElement(SkeletonText, {
+    className: "".concat(skeletonBlockClass, "__label")
+  }), /*#__PURE__*/React__default.createElement(SkeletonText, {
+    heading: true,
+    className: "".concat(skeletonBlockClass, "__value"),
+    width: "80%"
+  }));
+});
+SkeletonBigNumbers.propTypes = {
+  /**
+   * Optional class name.
+   * @type number
+   */
+  className: PropTypes.string,
+  /** The size of the BigNumbers.
+   * @type string
+   */
+  size: PropTypes.oneOf(Object.values(BigNumbersSize))
+};
+
+export { BigNumbers };

package/es/components/BigNumbers/constants.d.ts

@@ -0,0 +1,13 @@
+export namespace BigNumbersSize {
+    let Default: string;
+    let Large: string;
+    let XLarge: string;
+}
+export namespace Characters {
+    let Dash: string;
+    let Slash: string;
+}
+export const DefaultLocale: "en-US";
+export function formatValue(locale: string, value: number, fractionDigits: number, truncate: boolean): string | null;
+export function getIconSize(size: string): 16 | 20 | 24;
+export function getSupportedLocale(locale: string): string;

package/es/components/BigNumbers/constants.js

@@ -0,0 +1,67 @@
+/**
+ * Copyright IBM Corp. 2020, 2024
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+/* **************************** | CONSTANTS | ***************************** */
+
+var BigNumbersSize = {
+  Default: 'default',
+  Large: 'lg',
+  XLarge: 'xl'
+};
+var Characters = {
+  Dash: '–',
+  Slash: '/'
+};
+var DefaultLocale = 'en-US';
+
+/* ************************ | UTILITY FUNCTIONS | ************************* */
+
+/**
+ * Ensure that the value is formatted correctly based on whether it should be truncated or not.
+ * @param {string} locale Locale value to be used in formatting numbers.
+ * @param {number} value The value to format.
+ * @param {number} fractionDigits How many significant figures should be displayed.
+ * @param {boolean} truncate Whether or not the value should be truncated.
+ * @returns {string | null} The formatted value.
+ */
+var formatValue = function formatValue(locale, value, fractionDigits, truncate) {
+  if (value === null || value === undefined || typeof value !== 'number') {
+    return null;
+  }
+  return truncate ? Intl.NumberFormat(locale, {
+    notation: 'compact',
+    minimumFractionDigits: 0,
+    maximumFractionDigits: Math.round(fractionDigits)
+  }).format(value) : Intl.NumberFormat(locale).format(value);
+};
+
+/**
+ * Function which takes a size and returns a numeric value for sizing icons
+ * @param {string} size Size of desired icon. Expected values are 'default', 'lg', or 'xl'.
+ */
+var getIconSize = function getIconSize(size) {
+  switch (size) {
+    case BigNumbersSize.Large:
+      return 20;
+    case BigNumbersSize.XLarge:
+      return 24;
+    default:
+      return 16;
+  }
+};
+
+/**
+ * Function which takes a locale and returns a supported locale or the default
+ * @param {string} locale Desired locale for number formatting.
+ *
+ * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#locales
+ */
+var getSupportedLocale = function getSupportedLocale(locale) {
+  return Intl.NumberFormat.supportedLocalesOf(locale).length > 0 ? locale : DefaultLocale;
+};
+
+export { BigNumbersSize, Characters, DefaultLocale, formatValue, getIconSize, getSupportedLocale };

package/es/components/BigNumbers/index.d.ts

@@ -0,0 +1 @@
+export { BigNumbers } from "./BigNumbers";

package/es/components/Cascade/Cascade.d.ts

@@ -1,3 +1,18 @@
+import React, { ReactNode } from 'react';
+interface CascadeProps {
+    children: ReactNode;
+    /**
+     * Specify an optional className to be applied to
+     * the container node.
+     */
+    className?: string;
+    /**
+     * 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.
+     */
+    grid?: boolean;
+}
 /**
 
 This pattern is intended for use with cards, tiles, or similarly styled
@@ -7,5 +22,7 @@ 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.
 
 */
-export let Cascade: React.ForwardRefExoticComponent<React.RefAttributes<any>>;
-import React from 'react';
+export declare let Cascade: React.ForwardRefExoticComponent<CascadeProps & {
+    children?: React.ReactNode;
+} & React.RefAttributes<HTMLDivElement>>;
+export {};

package/es/components/Cascade/Cascade.js

@@ -53,16 +53,19 @@ var Cascade = /*#__PURE__*/forwardRef(function (_ref, ref) {
   if (grid) {
     var colIdx = 0;
     var gridElm = React__default.Children.map(children, function (row) {
-      var cols = React__default.Children.map(row.props.children, function (col) {
-        colIdx = colIdx + 1;
-        var colClassnames = cx(col.props.className, "".concat(blockClass, "__col"), "".concat(blockClass, "__col-").concat(colIdx));
-        return /*#__PURE__*/React__default.cloneElement(col, {
-          className: colClassnames
+      if ( /*#__PURE__*/React__default.isValidElement(row)) {
+        var cols = React__default.Children.map(row === null || row === void 0 ? void 0 : row.props.children, function (col) {
+          colIdx = colIdx + 1;
+          var colClassnames = cx(col.props.className, "".concat(blockClass, "__col"), "".concat(blockClass, "__col-").concat(colIdx));
+          return /*#__PURE__*/React__default.cloneElement(col, {
+            className: colClassnames
+          });
         });
-      });
-      return /*#__PURE__*/React__default.cloneElement(row, {
-        children: cols
-      });
+        return /*#__PURE__*/React__default.cloneElement(row, {
+          children: cols
+        });
+      }
+      return children;
     });
     return /*#__PURE__*/React__default.createElement("div", props, /*#__PURE__*/React__default.createElement(Grid, null, gridElm));
   }

package/es/components/Coachmark/CoachmarkTagline.js

@@ -9,12 +9,11 @@ import { objectWithoutProperties as _objectWithoutProperties, extends as _extend
 import React__default from 'react';
 import PropTypes from '../../node_modules/prop-types/index.js';
 import cx from '../../node_modules/classnames/index.js';
+import { Idea, Close } from '@carbon/react/icons';
 import { Button } from '@carbon/react';
 import { useCoachmark } from './utils/context.js';
 import { getDevtoolsProps } from '../../global/js/utils/devtools.js';
 import { pkg } from '../../settings.js';
-import { Idea } from '../../node_modules/@carbon/icons-react/es/generated/bucket-8.js';
-import { Close } from '../../node_modules/@carbon/icons-react/es/generated/bucket-3.js';
 
 var _Idea;
 var _excluded = ["closeIconDescription", "onClose", "theme", "title"];

package/es/components/CoachmarkStack/CoachmarkStackHome.js

@@ -10,12 +10,12 @@ import React__default, { forwardRef, useRef, useState, useEffect } from 'react';
 import pconsole from '../../global/js/utils/pconsole.js';
 import PropTypes from '../../node_modules/prop-types/index.js';
 import cx from '../../node_modules/classnames/index.js';
+import { Idea } from '@carbon/react/icons';
 import { Button } from '@carbon/react';
 import { getDevtoolsProps } from '../../global/js/utils/devtools.js';
 import { pkg } from '../../settings.js';
 import { createPortal } from 'react-dom';
 import { CoachmarkHeader } from '../Coachmark/CoachmarkHeader.js';
-import { Idea } from '../../node_modules/@carbon/icons-react/es/generated/bucket-8.js';
 import { SteppedAnimatedMedia } from '../SteppedAnimatedMedia/SteppedAnimatedMedia.js';
 
 var _excluded = ["className", "description", "isOpen", "media", "navLinkLabels", "onClickNavItem", "onClose", "portalTarget", "closeButtonLabel", "title"];

package/es/components/DataSpreadsheet/DataSpreadsheetBody.js

@@ -20,6 +20,7 @@ import { checkActiveHeaderCell } from './utils/checkActiveHeaderCell.js';
 import { checkSelectedHeaderCell } from './utils/checkSelectedHeaderCell.js';
 import { handleHeaderCellSelection } from './utils/handleHeaderCellSelection.js';
 import { getSpreadsheetWidth } from './utils/getSpreadsheetWidth.js';
+import { checkForHoldingKey } from './utils/checkForHoldingKey.js';
 import { usePreviousValue } from '../../global/js/hooks/usePreviousValue.js';
 import { useSpreadsheetMouseUp } from './hooks/useSpreadsheetMouseUp.js';
 
@@ -204,8 +205,8 @@ var DataSpreadsheetBody = /*#__PURE__*/forwardRef(function (_ref, ref) {
       var closestBodyCell = event.target.closest(".".concat(blockClass, "__body--td"));
       var isValidSelectionAreaStart = closestBodyCell.classList.contains("".concat(blockClass, "__body--td"));
       setValidStartingPoint(isValidSelectionAreaStart);
-      var isHoldingCommandKey = event.metaKey || event.ctrlKey;
-      var isHoldingShiftKey = event.shiftKey;
+      var isHoldingCommandKey = checkForHoldingKey(event, 'cmd');
+      var isHoldingShiftKey = checkForHoldingKey(event, 'shiftKey');
       setContainerHasFocus(true);
       var activeCoordinates = {
         row: cell.row.index,
@@ -307,7 +308,7 @@ var DataSpreadsheetBody = /*#__PURE__*/forwardRef(function (_ref, ref) {
   }, [clickAndHoldActive, currentMatcher, setSelectionAreas]);
   var handleRowHeaderClick = useCallback(function (index) {
     return function (event) {
-      var isHoldingCommandKey = event.metaKey || event.ctrlKey;
+      var isHoldingCommandKey = checkForHoldingKey(event, 'cmd');
       handleHeaderCellSelection({
         type: 'row',
         activeCellCoordinates: activeCellCoordinates,

package/es/components/DataSpreadsheet/DataSpreadsheetHeader.js

@@ -16,6 +16,7 @@ import { checkSelectedHeaderCell } from './utils/checkSelectedHeaderCell.js';
 import { handleHeaderCellSelection } from './utils/handleHeaderCellSelection.js';
 import { selectAllCells } from './utils/selectAllCells.js';
 import { getSpreadsheetWidth } from './utils/getSpreadsheetWidth.js';
+import { checkForHoldingKey } from './utils/checkForHoldingKey.js';
 import { usePreviousValue } from '../../global/js/hooks/usePreviousValue.js';
 import { useSpreadsheetMouseMove } from './hooks/useSpreadsheetMouseMove.js';
 
@@ -62,8 +63,8 @@ var DataSpreadsheetHeader = /*#__PURE__*/forwardRef(function (_ref, ref) {
   }, [cellSize, ref, scrollBarSize, previousState === null || previousState === void 0 ? void 0 : previousState.cellSize]);
   var handleColumnHeaderClick = function handleColumnHeaderClick(index) {
     return function (event) {
-      var isHoldingCommandKey = event.metaKey || event.ctrlKey;
-      var isHoldingShiftKey = event.shiftKey;
+      var isHoldingCommandKey = checkForHoldingKey(event, 'cmd');
+      var isHoldingShiftKey = checkForHoldingKey(event, 'shiftKey');
       handleHeaderCellSelection({
         type: 'column',
         activeCellCoordinates: activeCellCoordinates,

package/es/components/DataSpreadsheet/utils/checkForHoldingKey.d.ts

@@ -0,0 +1 @@
+export function checkForHoldingKey(event: any, key: any): any;

package/es/components/DataSpreadsheet/utils/checkForHoldingKey.js

@@ -0,0 +1,17 @@
+/**
+ * Copyright IBM Corp. 2020, 2024
+ *
+ * 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 checkForHoldingKey = function checkForHoldingKey(event, key) {
+  // possible key inputs: altKey,ctrlKey,metaKey,shiftKey
+  if (key == 'cmd') {
+    return event.metaKey || event.ctrlKey;
+  } else {
+    return event[key];
+  }
+};
+
+export { checkForHoldingKey };

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

@@ -16,7 +16,7 @@ import { DatagridContent } from './DatagridContent.js';
 import { FilterProvider } from './addons/Filtering/FilterProvider.js';
 import { InlineEditProvider } from './addons/InlineEdit/InlineEditContext/InlineEditContext.js';
 
-var _excluded = ["datagridState", "title"];
+var _excluded = ["datagridState", "title", "ariaToolbarLabel"];
 var blockClass = "".concat(pkg.prefix, "--datagrid");
 var componentName = 'Datagrid';
 
@@ -26,6 +26,7 @@ var componentName = 'Datagrid';
 var Datagrid = /*#__PURE__*/React__default.forwardRef(function (_ref, ref) {
   var datagridState = _ref.datagridState,
     title = _ref.title,
+    ariaToolbarLabel = _ref.ariaToolbarLabel,
     rest = _objectWithoutProperties(_ref, _excluded);
   if (!datagridState) {
     pconsole.warn('Datagrid was not passed datagridState which is required to render this component.');
@@ -41,7 +42,8 @@ var Datagrid = /*#__PURE__*/React__default.forwardRef(function (_ref, ref) {
   var rows = DatagridPagination && datagridState.page || datagridState.rows;
   var props = {
     title: title,
-    datagridState: datagridState
+    datagridState: datagridState,
+    ariaToolbarLabel: ariaToolbarLabel
   };
   return /*#__PURE__*/React__default.createElement(FilterProvider, {
     filters: filters,
@@ -62,6 +64,11 @@ Datagrid = pkg.checkComponentEnabled(Datagrid, componentName);
 // is used in preference to relying on function.name.
 Datagrid.displayName = componentName;
 Datagrid.propTypes = {
+  /**
+   * Specify a label to be read by screen readers on the container node
+   * 'aria-label' of the TableToolbar component.
+   */
+  ariaToolbarLabel: PropTypes.string,
   /**
    * The data grid state, much of it being supplied by the useDatagrid hook
    */

package/es/components/Datagrid/Datagrid/DatagridContent.d.ts

@@ -1,9 +1,11 @@
-export function DatagridContent({ datagridState, title }: {
+export function DatagridContent({ datagridState, title, ariaToolbarLabel }: {
     datagridState: any;
     title: any;
+    ariaToolbarLabel: any;
 }): import("react/jsx-runtime").JSX.Element;
 export namespace DatagridContent {
     namespace propTypes {
+        let ariaToolbarLabel: PropTypes.Requireable<string>;
         let datagridState: PropTypes.Requireable<PropTypes.InferProps<{
             getTableProps: PropTypes.Requireable<(...args: any[]) => any>;
             getFilterFlyoutProps: PropTypes.Requireable<(...args: any[]) => any>;

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

@@ -30,7 +30,8 @@ var blockClass = "".concat(pkg.prefix, "--datagrid");
 var gcClass = "".concat(blockClass, "__grid-container");
 var DatagridContent = function DatagridContent(_ref) {
   var datagridState = _ref.datagridState,
-    title = _ref.title;
+    title = _ref.title,
+    ariaToolbarLabel = _ref.ariaToolbarLabel;
   var _useContext = useContext(InlineEditContext),
     inlineEditState = _useContext.state,
     dispatch = _useContext.dispatch;
@@ -151,7 +152,9 @@ var DatagridContent = function DatagridContent(_ref) {
     className: cx("".concat(gcClass), _defineProperty(_defineProperty(_defineProperty(_defineProperty(_defineProperty(_defineProperty({}, "".concat(gcClass, "-active"), gridActive), "".concat(gcClass, "-active--without-toolbar"), withInlineEdit && !DatagridActions), "".concat(gcClass, "-inline-edit"), withInlineEdit), "".concat(blockClass, "__full-height"), withVirtualScroll || fullHeightDatagrid), "".concat(blockClass, "__with-pagination"), DatagridPagination), "".concat(blockClass, "__dense-header"), useDenseHeader)),
     title: gridTitle,
     description: gridDescription
-  }, /*#__PURE__*/React__default.createElement(DatagridToolbar, datagridState), /*#__PURE__*/React__default.createElement("div", {
+  }, /*#__PURE__*/React__default.createElement(DatagridToolbar, _extends({}, datagridState, {
+    ariaToolbarLabel: ariaToolbarLabel
+  })), /*#__PURE__*/React__default.createElement("div", {
     className: cx("".concat(blockClass, "__table-container"), _defineProperty({}, "".concat(blockClass, "__table-container--filter-open"), panelOpen)),
     ref: gridAreaRef
   }, (filterProps === null || filterProps === void 0 ? void 0 : filterProps.variation) === 'panel' && /*#__PURE__*/React__default.createElement(FilterPanel, _extends({}, getFilterFlyoutProps(), {
@@ -171,6 +174,7 @@ var DatagridContent = function DatagridContent(_ref) {
   }));
 };
 DatagridContent.propTypes = {
+  ariaToolbarLabel: PropTypes.string,
   datagridState: PropTypes.shape({
     getTableProps: PropTypes.func,
     getFilterFlyoutProps: PropTypes.func,