@carbon/ibm-products 2.43.2-canary.31 → 2.43.2-canary.317

package/es/components/TagSet/TagSetModal.d.ts

@@ -9,6 +9,7 @@ type AllTags = TagType[] & Omit<React.ComponentProps<Tag>, 'filter'>[];
 interface TagSetModalProps {
     allTags?: AllTags;
     className?: string;
+    modalAriaLabel?: string;
     onClose?: () => void;
     open?: boolean;
     portalTarget?: ReactNode;
@@ -17,7 +18,7 @@ interface TagSetModalProps {
     title?: string;
 }
 export declare const TagSetModal: {
-    ({ allTags, className, title, onClose, open, portalTarget: portalTargetIn, searchLabel, searchPlaceholder, ...rest }: TagSetModalProps): any;
+    ({ allTags, className, title, modalAriaLabel, onClose, open, portalTarget: portalTargetIn, searchLabel, searchPlaceholder, ...rest }: TagSetModalProps): any;
     propTypes: {
         allTags: PropTypes.Requireable<(PropTypes.InferProps<{
             label: PropTypes.Validator<string>;

package/es/components/TagSet/TagSetModal.js

@@ -7,20 +7,22 @@
 
 import { objectSpread2 as _objectSpread2, objectWithoutProperties as _objectWithoutProperties, slicedToArray as _slicedToArray, extends as _extends } from '../../_virtual/_rollupPluginBabelHelpers.js';
 import React__default, { useState, useEffect } from 'react';
-import PropTypes from '../../node_modules/prop-types/index.js';
+import PropTypes from '../../_virtual/index.js';
 import cx from 'classnames';
 import { Tag, ComposedModal, ModalHeader, Search, ModalBody } from '@carbon/react';
 import { pkg } from '../../settings.js';
 import { prepareProps } from '../../global/js/utils/props-helper.js';
 import { usePortalTarget } from '../../global/js/hooks/usePortalTarget.js';
 
-var _excluded = ["allTags", "className", "title", "onClose", "open", "portalTarget", "searchLabel", "searchPlaceholder"],
+var _excluded = ["allTags", "className", "title", "modalAriaLabel", "onClose", "open", "portalTarget", "searchLabel", "searchPlaceholder"],
   _excluded2 = ["label"];
 var componentName = 'TagSetModal';
 var blockClass = "".concat(pkg.prefix, "--tag-set-modal");
 
 // Default values for props
 var defaults = {
+  // required for accessibility if using hasScrollingContent
+  modalAriaLabel: 'List of all tags',
   // marked as required by TagSet if needed, default used to satisfy <Search /> component
   searchLabel: ''
 };
@@ -28,6 +30,8 @@ var TagSetModal = function TagSetModal(_ref) {
   var allTags = _ref.allTags,
     className = _ref.className,
     title = _ref.title,
+    _ref$modalAriaLabel = _ref.modalAriaLabel,
+    modalAriaLabel = _ref$modalAriaLabel === void 0 ? defaults.modalAriaLabel : _ref$modalAriaLabel,
     onClose = _ref.onClose,
     open = _ref.open,
     portalTargetIn = _ref.portalTarget,
@@ -85,17 +89,18 @@ var TagSetModal = function TagSetModal(_ref) {
     size: "lg"
   })), /*#__PURE__*/React__default.createElement(ModalBody, {
     className: "".concat(blockClass, "__body"),
-    hasForm: true
+    hasForm: true,
+    hasScrollingContent: true,
+    "aria-label": modalAriaLabel
   }, filteredModalTags.map(function (_ref2, index) {
     var label = _ref2.label,
       other = _objectWithoutProperties(_ref2, _excluded2);
     return /*#__PURE__*/React__default.createElement(Tag, _extends({}, other, {
-      filter: false,
       key: "all-tags-".concat(index)
     }), label);
-  })), /*#__PURE__*/React__default.createElement("div", {
+  }), /*#__PURE__*/React__default.createElement("div", {
     className: "".concat(blockClass, "__fade")
-  })));
+  }))));
 };
 TagSetModal.propTypes = {
   allTags: PropTypes.arrayOf(PropTypes.shape(_objectSpread2(_objectSpread2({}, prepareProps(Tag.propTypes, 'filter')), {}, {

package/es/components/TagSet/TagSetOverflow.d.ts

@@ -10,6 +10,10 @@ interface TagSetOverflowProps {
      * className
      */
     className?: string;
+    /**
+     * An optional click handler that overrides the default functionality of displaying all tags in a modal
+     */
+    onOverflowClick?: ((overFlowTags: ReactNode[]) => void) | undefined;
     /**
      * function to execute on clicking show all
      */
@@ -26,6 +30,10 @@ interface TagSetOverflowProps {
      * Type of rendering displayed inside of the tag overflow component
      */
     overflowType?: OverflowType;
+    /**
+     * Will auto-align the popover on first render if it is not visible. This prop is currently experimental and is subject to future changes.
+     */
+    overflowAutoAlign?: boolean;
     /**
      * Open state of the popover
      */
@@ -33,11 +41,15 @@ interface TagSetOverflowProps {
     /**
      * Setter function for the popoverOpen state value
      */
-    setPopoverOpen?: ((value: boolean) => void) | undefined;
+    setPopoverOpen: (value: boolean) => void;
     /**
      * label for the overflow show all tags link
      */
     showAllTagsLabel?: string;
+    /**
+     * Size of the overflow tag
+     */
+    size?: string;
 }
 export declare const TagSetOverflow: React.ForwardRefExoticComponent<TagSetOverflowProps & {
     children?: React.ReactNode;

package/es/components/TagSet/TagSetOverflow.js

@@ -7,13 +7,13 @@
 
 import { objectWithoutProperties as _objectWithoutProperties, extends as _extends, defineProperty as _defineProperty } from '../../_virtual/_rollupPluginBabelHelpers.js';
 import React__default, { useRef } from 'react';
-import PropTypes from '../../node_modules/prop-types/index.js';
+import PropTypes from '../../_virtual/index.js';
 import cx from 'classnames';
-import { Popover, Tag, PopoverContent, Link } from '@carbon/react';
+import { OperationalTag, Popover, PopoverContent, Link } from '@carbon/react';
 import { pkg } from '../../settings.js';
 import { useClickOutside } from '../../global/js/hooks/useClickOutside.js';
 
-var _excluded = ["allTagsModalSearchThreshold", "className", "onShowAllClick", "overflowAlign", "overflowTags", "overflowType", "showAllTagsLabel", "popoverOpen", "setPopoverOpen"];
+var _excluded = ["allTagsModalSearchThreshold", "onOverflowClick", "className", "onShowAllClick", "overflowAlign", "overflowAutoAlign", "overflowTags", "overflowType", "showAllTagsLabel", "popoverOpen", "setPopoverOpen", "size"];
 var componentName = 'TagSetOverflow';
 var blockClass = "".concat(pkg.prefix, "--tag-set-overflow");
 
@@ -24,35 +24,61 @@ var defaults = {
 var TagSetOverflow = /*#__PURE__*/React__default.forwardRef(function (_ref, ref) {
   var _ref$allTagsModalSear = _ref.allTagsModalSearchThreshold,
     allTagsModalSearchThreshold = _ref$allTagsModalSear === void 0 ? defaults.allTagsModalSearchThreshold : _ref$allTagsModalSear,
+    onOverflowClick = _ref.onOverflowClick,
     className = _ref.className,
     onShowAllClick = _ref.onShowAllClick,
     _ref$overflowAlign = _ref.overflowAlign,
     overflowAlign = _ref$overflowAlign === void 0 ? 'bottom' : _ref$overflowAlign,
+    overflowAutoAlign = _ref.overflowAutoAlign,
     overflowTags = _ref.overflowTags,
     overflowType = _ref.overflowType,
     showAllTagsLabel = _ref.showAllTagsLabel,
     popoverOpen = _ref.popoverOpen,
     setPopoverOpen = _ref.setPopoverOpen,
+    size = _ref.size,
     rest = _objectWithoutProperties(_ref, _excluded);
   var localRef = useRef(null);
   var overflowTagContent = useRef(null);
   useClickOutside(ref || localRef, function () {
     if (popoverOpen) {
-      setPopoverOpen === null || setPopoverOpen === void 0 || setPopoverOpen(false);
+      setPopoverOpen(false);
     }
   });
   var handleShowAllTagsClick = function handleShowAllTagsClick(ev) {
     ev.stopPropagation();
     ev.preventDefault();
-    setPopoverOpen === null || setPopoverOpen === void 0 || setPopoverOpen(false);
+    setPopoverOpen(false);
     onShowAllClick();
   };
   var handleEscKeyPress = function handleEscKeyPress(event) {
     var key = event.key;
     if (key === 'Escape') {
-      setPopoverOpen === null || setPopoverOpen === void 0 || setPopoverOpen(false);
+      setPopoverOpen(false);
     }
   };
+  var handleOverflowClick = function handleOverflowClick() {
+    // If a custom overflow function is provided then trigger that function
+    // on clicking the overflow
+    if (onOverflowClick) {
+      onOverflowClick(overflowTags);
+    } else {
+      setPopoverOpen(!popoverOpen);
+    }
+  };
+  if (onOverflowClick) {
+    return /*#__PURE__*/React__default.createElement("span", _extends({}, rest, {
+      "aria-hidden": overflowTags.length === 0,
+      className: cx("".concat(blockClass), _defineProperty({}, "".concat(blockClass, "--hidden"), overflowTags.length === 0)),
+      ref: ref || localRef
+    }), /*#__PURE__*/React__default.createElement(OperationalTag, {
+      onClick: function onClick() {
+        return handleOverflowClick();
+      },
+      className: "".concat(blockClass, "__popover-trigger"),
+      size: size,
+      text: "+".concat(overflowTags.length)
+    }));
+  }
   return /*#__PURE__*/React__default.createElement("span", _extends({}, rest, {
     "aria-hidden": overflowTags.length === 0,
     className: cx("".concat(blockClass), _defineProperty({}, "".concat(blockClass, "--hidden"), overflowTags.length === 0)),
@@ -63,13 +89,16 @@ var TagSetOverflow = /*#__PURE__*/React__default.forwardRef(function (_ref, ref)
     dropShadow: true,
     highContrast: true,
     onKeyDown: handleEscKeyPress,
-    open: popoverOpen
-  }, /*#__PURE__*/React__default.createElement(Tag, {
+    open: popoverOpen,
+    autoAlign: overflowAutoAlign
+  }, /*#__PURE__*/React__default.createElement(OperationalTag, {
     onClick: function onClick() {
-      return setPopoverOpen === null || setPopoverOpen === void 0 ? void 0 : setPopoverOpen(!popoverOpen);
+      return setPopoverOpen(!popoverOpen);
     },
-    className: cx("".concat(blockClass, "__popover-trigger"))
-  }, "+", overflowTags.length), /*#__PURE__*/React__default.createElement(PopoverContent, null, /*#__PURE__*/React__default.createElement("div", {
+    className: cx("".concat(blockClass, "__popover-trigger")),
+    size: size,
+    text: "+".concat(overflowTags.length)
+  }), /*#__PURE__*/React__default.createElement(PopoverContent, null, /*#__PURE__*/React__default.createElement("div", {
     ref: overflowTagContent,
     className: "".concat(blockClass, "__content")
   }, /*#__PURE__*/React__default.createElement("ul", {
@@ -107,6 +136,10 @@ TagSetOverflow.propTypes = {
    * className
    */
   className: PropTypes.string,
+  /**
+   * An optional click handler that overrides the default functionality of displaying all tags in a modal
+   */
+  onOverflowClick: PropTypes.func,
   /**
    * function to execute on clicking show all
    */
@@ -115,6 +148,10 @@ TagSetOverflow.propTypes = {
    * overflowAlign from the standard tooltip
    */
   overflowAlign: PropTypes.oneOf(['top', 'top-left', 'top-right', 'bottom', 'bottom-left', 'bottom-right', 'left', 'left-bottom', 'left-top', 'right', 'right-bottom', 'right-top']),
+  /**
+   * Will auto-align the popover on first render if it is not visible. This prop is currently experimental and is subject to future changes.
+   */
+  overflowAutoAlign: PropTypes.bool,
   /**
    * tags shown in overflow
    */
@@ -131,11 +168,15 @@ TagSetOverflow.propTypes = {
   /**
    * Setter function for the popoverOpen state value
    */
-  setPopoverOpen: PropTypes.func,
+  setPopoverOpen: PropTypes.func.isRequired,
   /**
    * label for the overflow show all tags link
    */
-  showAllTagsLabel: PropTypes.string
+  showAllTagsLabel: PropTypes.string,
+  /**
+   * Size of the overflow tag
+   */
+  size: PropTypes.string
 };
 
 export { TagSetOverflow };

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

@@ -1 +1,2 @@
-export { TagSet } from "./TagSet";
+export { TagSet } from './TagSet';
+export type { TagSetProps } from './TagSet';

package/es/components/Tearsheet/Tearsheet.d.ts

@@ -5,9 +5,9 @@
  * LICENSE file in the root directory of this source tree.
  */
 /// <reference path="../../../src/custom-typings/index.d.ts" />
+import { ButtonProps } from '@carbon/react';
 import React, { PropsWithChildren, ReactNode } from 'react';
 import PropTypes from 'prop-types';
-import { ButtonProps } from '@carbon/react';
 /**
  * The accessibility title for the close icon (if shown).
  *
@@ -21,7 +21,7 @@ export type CloseIconDescriptionTypes = {
     hasCloseIcon: true;
     closeIconDescription: string;
 };
-interface TearsheetProps extends PropsWithChildren {
+export interface TearsheetProps extends PropsWithChildren {
     /**
      * The navigation actions to be shown as buttons in the action area at the
      * bottom of the tearsheet. Each action is specified as an object with
@@ -35,7 +35,7 @@ interface TearsheetProps extends PropsWithChildren {
      *
      * See https://react.carbondesignsystem.com/?path=/docs/components-button--default#component-api
      */
-    actions: ButtonProps[];
+    actions?: ButtonProps<'button'>[];
     /**
      * The aria-label for the tearsheet, which is optional.
      * if it is not passed, the title will be used as the aria-label.
@@ -58,6 +58,13 @@ interface TearsheetProps extends PropsWithChildren {
      * this prop to either true or false.
      */
     hasCloseIcon?: boolean;
+    /**
+     * The content for the header actions area, displayed alongside the title in
+     * the header area of the tearsheet. This is typically a drop-down, or a set
+     * of small buttons, or similar. NB the headerActions is only applicable for
+     * wide tearsheets.
+     */
+    headerActions?: ReactNode;
     /**
      * The content for the influencer section of the tearsheet, displayed
      * alongside the main content. This is typically a menu, or filter, or
@@ -97,7 +104,7 @@ interface TearsheetProps extends PropsWithChildren {
     /**
      * The DOM element that the tearsheet should be rendered within. Defaults to document.body.
      */
-    portalTarget: ReactNode;
+    portalTarget?: ReactNode;
     /**
      * Specify a CSS selector that matches the DOM element that should be
      * focused when the Modal opens.
@@ -148,4 +155,3 @@ export declare const deprecatedProps: {
      */
     verticalPosition: PropTypes.Requireable<string>;
 };
-export {};

package/es/components/Tearsheet/Tearsheet.js

@@ -5,15 +5,15 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import { objectWithoutProperties as _objectWithoutProperties, objectSpread2 as _objectSpread2 } from '../../_virtual/_rollupPluginBabelHelpers.js';
+import { objectSpread2 as _objectSpread2, objectWithoutProperties as _objectWithoutProperties } from '../../_virtual/_rollupPluginBabelHelpers.js';
+import { Button } from '@carbon/react';
 import React__default from 'react';
-import PropTypes from '../../node_modules/prop-types/index.js';
-import { getDevtoolsProps } from '../../global/js/utils/devtools.js';
+import { tearsheetHasCloseIcon, portalType, TearsheetShell } from './TearsheetShell.js';
+import { ActionSet } from '../ActionSet/ActionSet.js';
+import PropTypes from '../../_virtual/index.js';
 import { allPropTypes } from '../../global/js/utils/props-helper.js';
+import { getDevtoolsProps } from '../../global/js/utils/devtools.js';
 import { pkg } from '../../settings.js';
-import { Button } from '@carbon/react';
-import { TearsheetShell, tearsheetHasCloseIcon, portalType } from './TearsheetShell.js';
-import { ActionSet } from '../ActionSet/ActionSet.js';
 
 var _excluded = ["influencerPosition", "influencerWidth"];
 var componentName = 'Tearsheet';
@@ -144,6 +144,13 @@ Tearsheet.propTypes = _objectSpread2({
    */
   /**@ts-ignore */
   hasCloseIcon: PropTypes.bool,
+  /**
+   * The content for the header actions area, displayed alongside the title in
+   * the header area of the tearsheet. This is typically a drop-down, or a set
+   * of small buttons, or similar. NB the headerActions is only applicable for
+   * wide tearsheets.
+   */
+  headerActions: PropTypes.element,
   /**
    * The content for the influencer section of the tearsheet, displayed
    * alongside the main content. This is typically a menu, or filter, or

package/es/components/Tearsheet/TearsheetNarrow.d.ts

@@ -5,10 +5,10 @@
  * LICENSE file in the root directory of this source tree.
  */
 /// <reference path="../../../src/custom-typings/index.d.ts" />
-import React, { ReactNode, PropsWithChildren } from 'react';
-import PropTypes from 'prop-types';
 import { ButtonProps } from '@carbon/react';
 import { CloseIconDescriptionTypes } from './TearsheetShell';
+import React, { PropsWithChildren, ReactNode } from 'react';
+import PropTypes from 'prop-types';
 interface TearsheetNarrowBaseProps extends PropsWithChildren {
     /**
      * The navigation actions to be shown as buttons in the action area at the
@@ -23,7 +23,7 @@ interface TearsheetNarrowBaseProps extends PropsWithChildren {
      *
      * See https://react.carbondesignsystem.com/?path=/docs/components-button--default#component-api
      */
-    actions?: ButtonProps[];
+    actions?: ButtonProps<'button'>[];
     /**
      * The aria-label for the tearsheet, which is optional.
      * if it is not passed, the title will be used as the aria-label.
@@ -90,7 +90,7 @@ interface TearsheetNarrowBaseProps extends PropsWithChildren {
      */
     verticalPosition?: 'normal' | 'lower';
 }
-type TearsheetNarrowProps = TearsheetNarrowBaseProps & CloseIconDescriptionTypes;
+export type TearsheetNarrowProps = TearsheetNarrowBaseProps & CloseIconDescriptionTypes;
 /**
  * A narrow tearsheet is a slimmer variant of the tearsheet, providing a dialog
  * that keeps users in-context and focused by bringing actionable content front

package/es/components/Tearsheet/TearsheetNarrow.js

@@ -5,15 +5,15 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import { objectWithoutProperties as _objectWithoutProperties, objectSpread2 as _objectSpread2 } from '../../_virtual/_rollupPluginBabelHelpers.js';
+import { objectSpread2 as _objectSpread2, objectWithoutProperties as _objectWithoutProperties } from '../../_virtual/_rollupPluginBabelHelpers.js';
+import { Button } from '@carbon/react';
+import { tearsheetHasCloseIcon, portalType, TearsheetShell, tearsheetShellWideProps } from './TearsheetShell.js';
 import React__default from 'react';
-import PropTypes from '../../node_modules/prop-types/index.js';
+import { allPropTypes, prepareProps } from '../../global/js/utils/props-helper.js';
+import { ActionSet } from '../ActionSet/ActionSet.js';
+import PropTypes from '../../_virtual/index.js';
 import { getDevtoolsProps } from '../../global/js/utils/devtools.js';
-import { prepareProps, allPropTypes } from '../../global/js/utils/props-helper.js';
 import { pkg } from '../../settings.js';
-import { Button } from '@carbon/react';
-import { TearsheetShell, tearsheetHasCloseIcon, portalType, tearsheetShellWideProps } from './TearsheetShell.js';
-import { ActionSet } from '../ActionSet/ActionSet.js';
 
 var _excluded = ["verticalPosition"];
 var componentName = 'TearsheetNarrow';

package/es/components/Tearsheet/TearsheetShell.d.ts

@@ -9,7 +9,12 @@ import React, { PropsWithChildren, ReactNode, RefObject } from 'react';
 import PropTypes from 'prop-types';
 import { type ButtonProps } from '@carbon/react';
 interface TearsheetShellProps extends PropsWithChildren {
-    actions?: ButtonProps[];
+    actions?: ButtonProps<'button'>[];
+    /**
+     * Optional prop that is intended for any scenario where something is being generated by AI to reinforce AI transparency,
+     * accountability, and explainability at the UI level.
+     */
+    aiLabel?: ReactNode;
     ariaLabel?: string;
     /**
      * An optional class or classes to be added to the outermost element.
@@ -96,15 +101,15 @@ interface TearsheetShellProps extends PropsWithChildren {
      * Specifies the width of the tearsheet, 'narrow' or 'wide'.
      */
     size: 'narrow' | 'wide';
-    /**
-     *  **Experimental:** Provide a `Slug` component to be rendered inside the `Tearsheet` component
-     */
-    slug?: ReactNode;
     /**
      * The main title of the tearsheet, displayed in the header area.
      */
     title?: ReactNode;
     verticalPosition?: 'normal' | 'lower';
+    /**
+     * @deprecated Property replaced by `aiLabel`
+     */
+    slug?: ReactNode;
 }
 export type CloseIconDescriptionTypes = {
     hasCloseIcon?: false;
@@ -126,6 +131,10 @@ export declare const tearsheetHasCloseIcon: (actions: any, hasCloseIcon: any) =>
 export declare const TearsheetShell: React.ForwardRefExoticComponent<(TearsheetShellProps & CloseIconDescriptionTypes) & React.RefAttributes<HTMLDivElement>>;
 export declare const portalType: PropTypes.Requireable<object>;
 export declare const deprecatedProps: {
+    /**
+     *  @deprecated Property replaced by `aiLabel`
+     */
+    slug: (props: any, propName: any, comp: any, loc: any, propFullName: any, secret: any) => any;
     /**
      * **Deprecated**
      *