@carbon/react 1.24.0-rc.0 → 1.25.0

package/es/components/Toggle/Toggle.js

@@ -64,8 +64,8 @@ function Toggle(_ref) {
 
   var isSm = size === 'sm';
   var sideLabel = hideLabel ? labelText : checked ? labelB : labelA;
-  var renderSideLabel = !(hideLabel && ariaLabelledby);
-  var LabelComponent = ariaLabelledby ? 'div' : 'label';
+  var renderSideLabel = !(hideLabel && !labelText);
+  var LabelComponent = labelText ? 'label' : 'div';
   var wrapperClasses = cx("".concat(prefix, "--toggle"), (_classNames = {}, _defineProperty(_classNames, "".concat(prefix, "--toggle--disabled"), disabled), _defineProperty(_classNames, "".concat(prefix, "--toggle--readonly"), readOnly), _classNames), className);
   var labelTextClasses = cx("".concat(prefix, "--toggle__label-text"), _defineProperty({}, "".concat(prefix, "--visually-hidden"), hideLabel));
   var appearanceClasses = cx("".concat(prefix, "--toggle__appearance"), _defineProperty({}, "".concat(prefix, "--toggle__appearance--sm"), isSm));
@@ -75,7 +75,7 @@ function Toggle(_ref) {
     // eslint-disable-next-line jsx-a11y/click-events-have-key-events, jsx-a11y/no-static-element-interactions
     React__default.createElement("div", {
       className: wrapperClasses,
-      onClick: ariaLabelledby ? function (e) {
+      onClick: !labelText ? function (e) {
         // the underlying <button> can only be activated by keyboard as it is visually hidden;
         // therefore, if this event's target is the <button>, it had to be triggered by
         // the keyboard event which already calls handleClick. if we wouldn't catch this, the
@@ -141,10 +141,7 @@ Toggle.propTypes = {
 
   /**
    * If true, the side labels (props.labelA and props.labelB) will be replaced by
-   * props.labelText, so that the toggle doesn't render a top label. In order to fully
-   * hide any labels, you can use props['aria-labelledby'] to refer to another element
-   * that labels the toggle. props.labelText would no longer be required in that case
-   * and can therefore be omitted.
+   * props.labelText (if passed), so that the toggle doesn't render a top label.
    */
   hideLabel: PropTypes.bool,
 
@@ -165,19 +162,11 @@ Toggle.propTypes = {
 
   /**
    * Provide the text that will be read by a screen reader when visiting this
-   * control. This is required unless 'aria-labelledby' is provided instead
+   * control. This should be provided unless 'aria-labelledby' is set instead
+   * or you use an external <label> element with its "for" attribute set to the
+   * toggle's id.
    */
-  labelText: function labelText(props) {
-    if (!props['aria-labelledby'] && !props.labelText) {
-      return new Error('labelText property is required if no aria-labelledby is provided.');
-    }
-
-    for (var _len = arguments.length, rest = new Array(_len > 1 ? _len - 1 : 0), _key = 1; _key < _len; _key++) {
-      rest[_key - 1] = arguments[_key];
-    }
-
-    return PropTypes.node.apply(PropTypes, [props].concat(rest));
-  },
+  labelText: PropTypes.string,
 
   /**
    * Provide an event listener that is called when the control is clicked

package/es/components/Tooltip/DefinitionTooltip.d.ts

@@ -0,0 +1,52 @@
+/**
+ * Copyright IBM Corp. 2016, 2023
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import React from 'react';
+import { PopoverAlignment } from '../Popover';
+export interface DefinitionTooltipProps extends Omit<React.ButtonHTMLAttributes<HTMLButtonElement>, 'id' | 'classname' | 'children' | 'type'> {
+    /**
+     * Specify how the trigger should align with the tooltip
+     */
+    align?: PopoverAlignment;
+    /**
+     * The `children` prop will be used as the value that is being defined
+     */
+    children?: React.ReactNode;
+    /**
+     * Specify an optional className to be applied to the container node
+     */
+    className?: string;
+    /**
+     * Specify whether the tooltip should be open when it first renders
+     */
+    defaultOpen?: boolean;
+    /**
+     * The `definition` prop is used as the content inside of the tooltip that
+     * appears when a user interacts with the element rendered by the `children`
+     * prop
+     */
+    definition: React.ReactNode;
+    /**
+     * Provide a value that will be assigned as the id of the tooltip
+     */
+    id?: string;
+    /**
+     * Specifies whether or not the `DefinitionTooltip` should open on hover or not
+     */
+    openOnHover?: boolean;
+    /**
+     * @deprecated [Deprecated in v11] Please use the `definition` prop instead.
+     *
+     * Provide the text that will be displayed in the tooltip when it is rendered.
+     */
+    tooltipText?: React.ReactNode;
+    /**
+     * The CSS class name of the trigger element
+     */
+    triggerClassName?: string;
+}
+declare const DefinitionTooltip: React.FC<DefinitionTooltipProps>;
+export { DefinitionTooltip };

package/es/components/Tooltip/DefinitionTooltip.js

@@ -18,7 +18,7 @@ import { Escape } from '../../internal/keyboard/keys.js';
 
 var _excluded = ["align", "className", "children", "definition", "defaultOpen", "id", "openOnHover", "tooltipText", "triggerClassName"];
 
-function DefinitionTooltip(_ref) {
+var DefinitionTooltip = function DefinitionTooltip(_ref) {
   var _ref$align = _ref.align,
       align = _ref$align === void 0 ? 'bottom-left' : _ref$align,
       className = _ref.className,
@@ -75,7 +75,7 @@ function DefinitionTooltip(_ref) {
     className: "".concat(prefix, "--definition-tooltip"),
     id: tooltipId
   }, tooltipText !== null && tooltipText !== void 0 ? tooltipText : definition));
-}
+};
 
 DefinitionTooltip.propTypes = {
   /**

package/es/components/Tooltip/Tooltip.d.ts

@@ -0,0 +1,117 @@
+/**
+ * Copyright IBM Corp. 2016, 2023
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import PropTypes from 'prop-types';
+import React from 'react';
+import { PopoverAlignment } from '../Popover';
+import { PolymorphicProps } from '../../types/common';
+interface TooltipBaseProps {
+    /**
+     * Specify how the trigger should align with the tooltip
+     */
+    align?: PopoverAlignment;
+    /**
+     * Pass in the child to which the tooltip will be applied
+     */
+    children?: React.ReactElement;
+    /**
+     * Specify an optional className to be applied to the container node
+     */
+    className?: string;
+    /**
+     * Determines wether the tooltip should close when inner content is activated (click, Enter or Space)
+     */
+    closeOnActivation?: boolean;
+    /**
+     * Specify whether the tooltip should be open when it first renders
+     */
+    defaultOpen?: boolean;
+    /**
+     * Provide the description to be rendered inside of the Tooltip. The
+     * description will use `aria-describedby` and will describe the child node
+     * in addition to the text rendered inside of the child. This means that if you
+     * have text in the child node, that it will be announced alongside the
+     * description to the screen reader.
+     *
+     * Note: if label and description are both provided, label will be used and
+     * description will not be used
+     */
+    description?: React.ReactNode;
+    /**
+     * Specify the duration in milliseconds to delay before displaying the tooltip
+     */
+    enterDelayMs?: number;
+    /**
+     * Provide the label to be rendered inside of the Tooltip. The label will use
+     * `aria-labelledby` and will fully describe the child node that is provided.
+     * This means that if you have text in the child node, that it will not be
+     * announced to the screen reader.
+     *
+     * Note: if label and description are both provided, description will not be
+     * used
+     */
+    label?: React.ReactNode;
+    /**
+     * Specify the duration in milliseconds to delay before hiding the tooltip
+     */
+    leaveDelayMs?: number;
+}
+export type TooltipProps<T extends React.ElementType> = PolymorphicProps<T, TooltipBaseProps>;
+declare function Tooltip<T extends React.ElementType>({ align, className: customClassName, children, label, description, enterDelayMs, leaveDelayMs, defaultOpen, closeOnActivation, ...rest }: TooltipProps<T>): JSX.Element;
+declare namespace Tooltip {
+    var propTypes: {
+        /**
+         * Specify how the trigger should align with the tooltip
+         */
+        align: PropTypes.Requireable<string>;
+        /**
+         * Pass in the child to which the tooltip will be applied
+         */
+        children: PropTypes.Requireable<PropTypes.ReactNodeLike>;
+        /**
+         * Specify an optional className to be applied to the container node
+         */
+        className: PropTypes.Requireable<string>;
+        /**
+         * Determines wether the tooltip should close when inner content is activated (click, Enter or Space)
+         */
+        closeOnActivation: PropTypes.Requireable<boolean>;
+        /**
+         * Specify whether the tooltip should be open when it first renders
+         */
+        defaultOpen: PropTypes.Requireable<boolean>;
+        /**
+         * Provide the description to be rendered inside of the Tooltip. The
+         * description will use `aria-describedby` and will describe the child node
+         * in addition to the text rendered inside of the child. This means that if you
+         * have text in the child node, that it will be announced alongside the
+         * description to the screen reader.
+         *
+         * Note: if label and description are both provided, label will be used and
+         * description will not be used
+         */
+        description: PropTypes.Requireable<PropTypes.ReactNodeLike>;
+        /**
+         * Specify the duration in milliseconds to delay before displaying the tooltip
+         */
+        enterDelayMs: PropTypes.Requireable<number>;
+        /**
+         * Provide the label to be rendered inside of the Tooltip. The label will use
+         * `aria-labelledby` and will fully describe the child node that is provided.
+         * This means that if you have text in the child node, that it will not be
+         * announced to the screen reader.
+         *
+         * Note: if label and description are both provided, description will not be
+         * used
+         */
+        label: PropTypes.Requireable<PropTypes.ReactNodeLike>;
+        /**
+         * Specify the duration in milliseconds to delay before hiding the tooltip
+         */
+        leaveDelayMs: PropTypes.Requireable<number>;
+    };
+}
+export { Tooltip };

package/es/components/Tooltip/Tooltip.js

@@ -103,10 +103,12 @@ function Tooltip(_ref) {
 
   useNoInteractiveChildren(tooltipRef, 'The Tooltip component must have no interactive content rendered by the' + '`label` or `description` prop');
   useEffect(function () {
-    var interactiveContent = getInteractiveContent(containerRef.current);
+    if (containerRef !== null && containerRef.current) {
+      var interactiveContent = getInteractiveContent(containerRef.current);
 
-    if (!interactiveContent) {
-      setOpen(false);
+      if (!interactiveContent) {
+        setOpen(false);
+      }
     }
   });
   return /*#__PURE__*/React__default.createElement(Popover, _extends({}, rest, {
@@ -118,7 +120,7 @@ function Tooltip(_ref) {
     onMouseLeave: onMouseLeave,
     open: open,
     ref: containerRef
-  }), /*#__PURE__*/React__default.cloneElement(child, _objectSpread2(_objectSpread2({}, triggerProps), getChildEventHandlers(child.props))), /*#__PURE__*/React__default.createElement(PopoverContent, {
+  }), child !== undefined ? /*#__PURE__*/React__default.cloneElement(child, _objectSpread2(_objectSpread2({}, triggerProps), getChildEventHandlers(child.props))) : null, /*#__PURE__*/React__default.createElement(PopoverContent, {
     "aria-hidden": "true",
     className: "".concat(prefix, "--tooltip-content"),
     id: id,

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

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

package/es/index.d.ts

@@ -107,6 +107,8 @@ export * from './components/Layer';
 export { LayoutDirection as unstable_LayoutDirection, useLayoutDirection as unstable_useLayoutDirection, } from './components/Layout';
 export { Menu as unstable_Menu, MenuItem as unstable_MenuItem, MenuItemDivider as unstable_MenuItemDivider, MenuItemGroup as unstable_MenuItemGroup, MenuItemRadioGroup as unstable_MenuItemRadioGroup, MenuItemSelectable as unstable_MenuItemSelectable, } from './components/Menu';
 export { OverflowMenuV2 as unstable_OverflowMenuV2 } from './components/OverflowMenuV2';
+export { ComboButton as unstable_ComboButton } from './components/ComboButton';
+export { MenuButton as unstable_MenuButton } from './components/MenuButton';
 export { PageSelector as unstable_PageSelector, Pagination as unstable_Pagination, } from './components/Pagination/experimental';
 export * from './components/Popover';
 export * from './components/ProgressBar';

package/es/index.js

@@ -37,10 +37,13 @@ export { Heading, Section } from './components/Heading/index.js';
 export { IconButton } from './components/IconButton/index.js';
 export { Layer, useLayer } from './components/Layer/index.js';
 export { OverflowMenuV2 as unstable_OverflowMenuV2 } from './components/OverflowMenuV2/index.js';
+export { ComboButton as unstable_ComboButton } from './components/ComboButton/index.js';
+export { MenuButton as unstable_MenuButton } from './components/MenuButton/index.js';
 export { Popover, PopoverContent } from './components/Popover/index.js';
 export { HStack, VStack } from './components/Stack/index.js';
-import './components/Text/index.js';
 export { DefinitionTooltip } from './components/Tooltip/DefinitionTooltip.js';
+export { Tooltip } from './components/Tooltip/Tooltip.js';
+import './components/Text/index.js';
 export { GlobalTheme, Theme, ThemeContext, useTheme } from './components/Theme/index.js';
 export { PrefixContext, usePrefix } from './internal/usePrefix.js';
 export { useIdPrefix } from './internal/useIdPrefix.js';
@@ -76,7 +79,6 @@ export { default as NumberInputSkeleton } from './components/NumberInput/NumberI
 export { default as ProgressIndicatorSkeleton } from './components/ProgressIndicator/ProgressIndicator.Skeleton.js';
 export { default as ExpandableSearch } from './components/ExpandableSearch/ExpandableSearch.js';
 export { default as TabsSkeleton } from './components/Tabs/Tabs.Skeleton.js';
-export { default as RadioTile } from './components/RadioTile/RadioTile.js';
 export { Toggle } from './components/Toggle/Toggle.js';
 export { default as TreeNode } from './components/TreeView/TreeNode.js';
 export { default as TreeView } from './components/TreeView/TreeView.js';
@@ -185,6 +187,7 @@ export { default as TextArea } from './components/TextArea/TextArea.js';
 export { default as TextInputSkeleton } from './components/TextInput/TextInput.Skeleton.js';
 export { default as TextInput } from './components/TextInput/TextInput.js';
 export { ClickableTile, ExpandableTile, SelectableTile, Tile, TileAboveTheFoldContent, TileBelowTheFoldContent } from './components/Tile/Tile.js';
+export { default as RadioTile } from './components/RadioTile/RadioTile.js';
 export { default as TimePicker } from './components/TimePicker/TimePicker.js';
 export { default as UnorderedList } from './components/UnorderedList/UnorderedList.js';
 export { default as SkeletonText } from './components/SkeletonText/SkeletonText.js';
@@ -212,4 +215,3 @@ export { default as SideNavMenu } from './components/UIShell/SideNavMenu.js';
 export { default as SideNavMenuItem } from './components/UIShell/SideNavMenuItem.js';
 export { default as SideNavSwitcher } from './components/UIShell/SideNavSwitcher.js';
 export { Stack } from './components/Stack/Stack.js';
-export { Tooltip } from './components/Tooltip/Tooltip.js';

package/es/internal/ClickListener.js

@@ -25,8 +25,7 @@ var ClickListener = /*#__PURE__*/function (_React$Component) {
     _classCallCheck(this, ClickListener);
 
     _this = _super.call(this, props); // We manually bind handlers in this Component, versus using class
-    // properties, so that we can properly test the `handleRef` handler with
-    // enzyme.
+    // properties, so that we can properly test the `handleRef` handler.
 
     _this.handleRef = _this.handleRef.bind(_assertThisInitialized(_this));
     _this.handleDocumentClick = _this.handleDocumentClick.bind(_assertThisInitialized(_this));

package/es/internal/keyboard/match.js

@@ -53,7 +53,7 @@ function matches(event, keysToMatch) {
  *   }
  * }
  *
- * @param {Event|number|string} eventOrCode
+ * @param {React.KeyboardEvent|Event|number|string} eventOrCode
  * @param {Key} key
  * @returns {boolean}
  */

package/es/internal/useAttachedMenu.js

@@ -0,0 +1,85 @@
+/**
+ * Copyright IBM Corp. 2016, 2023
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import { slicedToArray as _slicedToArray } from '../_virtual/_rollupPluginBabelHelpers.js';
+import { useState } from 'react';
+
+/**
+ * @typedef {object} useAttachedMenuReturn
+ * @property {boolean} open Whether the menu is open or not
+ * @property {[number, number]} x The x position of the menu
+ * @property {[number, number]} y The y position of the menu
+ * @property {Function} handleClick A function to be called when the trigger element receives a click event
+ * @property {Function} handleMousedown A function to be called when the trigger element recives a mousedown event
+ * @property {Function} handleClose A function to be called when the menu emits onClose
+ */
+
+/**
+ * This hook contains common code to be used when a menu should be visually attached to an anchor based on a click event.
+ *
+ * @param {Element|object} anchor The element or ref the menu should visually be attached to.
+ * @returns {useAttachedMenuReturn}
+ */
+
+function useAttachedMenu(anchor) {
+  var _useState = useState(false),
+      _useState2 = _slicedToArray(_useState, 2),
+      open = _useState2[0],
+      setOpen = _useState2[1];
+
+  var _useState3 = useState([[-1, -1], [-1, -1]]),
+      _useState4 = _slicedToArray(_useState3, 2),
+      position = _useState4[0],
+      setPosition = _useState4[1];
+
+  function openMenu() {
+    var anchorEl = (anchor === null || anchor === void 0 ? void 0 : anchor.current) || anchor;
+
+    if (anchorEl) {
+      var _anchorEl$getBounding = anchorEl.getBoundingClientRect(),
+          left = _anchorEl$getBounding.left,
+          top = _anchorEl$getBounding.top,
+          right = _anchorEl$getBounding.right,
+          bottom = _anchorEl$getBounding.bottom;
+
+      setPosition([[left, right], [top, bottom]]);
+    }
+
+    setOpen(true);
+  }
+
+  function closeMenu() {
+    setOpen(false);
+  }
+
+  function handleClick() {
+    if (open) {
+      closeMenu();
+    } else {
+      openMenu();
+    }
+  }
+
+  function handleMousedown(e) {
+    // prevent default for mousedown on trigger element to avoid
+    // the "blur" event from firing on the menu as this would close
+    // it and immediately re-open since "click" event is fired after
+    // "blur" event.
+    e.preventDefault();
+  }
+
+  return {
+    open: open,
+    x: position[0],
+    y: position[1],
+    handleClick: handleClick,
+    handleMousedown: handleMousedown,
+    handleClose: closeMenu
+  };
+}
+
+export { useAttachedMenu };

package/es/internal/useDelayedState.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Copyright IBM Corp. 2016, 2023
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import { SetStateAction } from 'react';
+/**
+ * `useDelayedState` mirrors `useState` but also allows you to add a delay to
+ * when your state updates. You can provide a second argument to `setState`,
+ * `delayMs`, which will be the time in milliseconds after which the state is
+ * updated.
+ *
+ * This hook will clean up pending timers in `useEffect` and will cancel any
+ * pending timers when a `setState` is called before the state is updated from
+ * a previous call
+ */
+export type DispatchWithDelay<A> = (value: A, delayMS?: number) => void;
+export declare function useDelayedState<S>(initialState: S): [S, DispatchWithDelay<SetStateAction<S>>];

package/es/internal/useDelayedState.js

@@ -29,8 +29,10 @@ function useDelayedState(initialState) {
   // always return the same reference for the `setState` updater
 
   var setStateWithDelay = useCallback(function (stateToSet) {
+    var _timeoutId$current;
+
     var delayMs = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 0;
-    clearTimeout(timeoutId.current);
+    window.clearTimeout((_timeoutId$current = timeoutId.current) !== null && _timeoutId$current !== void 0 ? _timeoutId$current : undefined);
     timeoutId.current = null;
 
     if (delayMs === 0) {
@@ -38,14 +40,16 @@ function useDelayedState(initialState) {
       return;
     }
 
-    timeoutId.current = setTimeout(function () {
+    timeoutId.current = window.setTimeout(function () {
       setState(stateToSet);
       timeoutId.current = null;
     }, delayMs);
   }, []);
   useEffect(function () {
     return function () {
-      clearTimeout(timeoutId.current);
+      var _timeoutId$current2;
+
+      window.clearTimeout((_timeoutId$current2 = timeoutId.current) !== null && _timeoutId$current2 !== void 0 ? _timeoutId$current2 : undefined);
     };
   }, []);
   return [state, setStateWithDelay];

package/es/internal/useId.js

@@ -50,7 +50,7 @@ function useId() {
 }
 /**
  * Generate a unique id if a given `id` is not provided
- * @param {string} id
+ * @param {string|undefined} id
  * @returns {string}
  */
 

package/es/internal/useMergedRefs.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Copyright IBM Corp. 2016, 2023
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import { Ref, ForwardedRef } from 'react';
+/**
+ * Combine multiple refs into a single ref. This use useful when you have two
+ * refs from both `React.forwardRef` and `useRef` that you would like to add to
+ * the same node.
+ */
+export declare const useMergedRefs: <T>(refs: ForwardedRef<T>[]) => Ref<T>;

package/es/internal/useMergedRefs.js

@@ -11,12 +11,9 @@ import { useCallback } from 'react';
  * Combine multiple refs into a single ref. This use useful when you have two
  * refs from both `React.forwardRef` and `useRef` that you would like to add to
  * the same node.
- *
- * @param {Array} refs
- * @returns {Function}
  */
 
-function useMergedRefs(refs) {
+var useMergedRefs = function useMergedRefs(refs) {
   return useCallback(function (node) {
     refs.forEach(function (ref) {
       if (typeof ref === 'function') {
@@ -26,6 +23,6 @@ function useMergedRefs(refs) {
       }
     }); // eslint-disable-next-line react-hooks/exhaustive-deps
   }, refs);
-}
+};
 
 export { useMergedRefs };

package/es/internal/useNormalizedInputProps.js

@@ -25,6 +25,7 @@ import { usePrefix } from './usePrefix.js';
  * @property {boolean} disabled - Whether the input is disabled
  * @property {boolean} invalid - Whether the input is invalid (takes precedence over warn)
  * @property {string} invalidId - The invalid message's id
+ * @property {string} helperId - id used for helper text
  * @property {boolean} warn - Whether the input is in warning state
  * @property {string} warnId - The warning message's id
  * @property {React.ReactNode | null} validation – React node rendering the appropriate validation message (if any)