@carbon/ibm-products 2.33.0 → 2.34.0

package/lib/components/FilterPanel/FilterPanelCheckboxWithOverflow/FilterPanelCheckboxWithOverflow.js

@@ -0,0 +1,164 @@
+/**
+ * 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.
+ */
+
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var _rollupPluginBabelHelpers = require('../../../_virtual/_rollupPluginBabelHelpers.js');
+var React = require('react');
+var index = require('../../../node_modules/prop-types/index.js');
+var cx = require('classnames');
+var react = require('@carbon/react');
+var devtools = require('../../../global/js/utils/devtools.js');
+var settings = require('../../../settings.js');
+var FilterPanelCheckbox = require('../FilterPanelCheckbox/FilterPanelCheckbox.js');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var React__default = /*#__PURE__*/_interopDefaultLegacy(React);
+var cx__default = /*#__PURE__*/_interopDefaultLegacy(cx);
+
+var _excluded = ["children", "className", "count", "id", "labelText", "overflowMenuProps", "title"];
+
+// The block part of our conventional BEM class names (blockClass__E--M).
+var blockClass = "".concat(settings.pkg.prefix, "--filter-panel-checkbox-with-overflow");
+var componentName = 'FilterPanelCheckboxWithOverflow';
+var defaults = {
+  overflowMenuProps: {}
+};
+
+/**
+ * Provides a filter panel checkbox with an overflow menu.
+ *
+ * This component's props refer to the Carbon Checkbox,
+ * just like FilterPanelCheckbox.
+ *
+ * Use `overflowMenuProps` for properties specific to the OverflowMenu.
+ */
+exports.FilterPanelCheckboxWithOverflow = /*#__PURE__*/React__default["default"].forwardRef(function (_ref, ref) {
+  var children = _ref.children,
+    className = _ref.className,
+    count = _ref.count,
+    id = _ref.id,
+    labelText = _ref.labelText,
+    _ref$overflowMenuProp = _ref.overflowMenuProps,
+    overflowMenuProps = _ref$overflowMenuProp === void 0 ? defaults.overflowMenuProps : _ref$overflowMenuProp,
+    title = _ref.title,
+    rest = _rollupPluginBabelHelpers.objectWithoutProperties(_ref, _excluded);
+  var _useState = React.useState(false),
+    _useState2 = _rollupPluginBabelHelpers.slicedToArray(_useState, 2),
+    menuIsOpen = _useState2[0],
+    setMenuIsOpen = _useState2[1];
+  var _useState3 = React.useState(false),
+    _useState4 = _rollupPluginBabelHelpers.slicedToArray(_useState3, 2),
+    showMenuButton = _useState4[0],
+    setShowMenuButton = _useState4[1];
+  // Destructure overflow menu properties.
+  var other = _rollupPluginBabelHelpers["extends"]({}, (_rollupPluginBabelHelpers.objectDestructuringEmpty(overflowMenuProps), overflowMenuProps));
+  var backupRef = React.useRef();
+  var localRef = ref || backupRef;
+  var setHideButton = function setHideButton(activeElement) {
+    if (!menuIsOpen && !localRef.current.contains(activeElement)) {
+      setShowMenuButton(false);
+    }
+  };
+  React.useEffect(function () {
+    setShowMenuButton(menuIsOpen);
+  }, [menuIsOpen]);
+  return (
+    /*#__PURE__*/
+    // eslint-disable-next-line jsx-a11y/no-static-element-interactions
+    React__default["default"].createElement("div", _rollupPluginBabelHelpers["extends"]({
+      className: cx__default["default"](blockClass, className, _rollupPluginBabelHelpers.defineProperty({}, "".concat(blockClass, "--open"), menuIsOpen)),
+      onBlur: function onBlur(_ref2) {
+        var relatedTarget = _ref2.relatedTarget;
+        return setHideButton(relatedTarget);
+      },
+      onFocus: function onFocus() {
+        return setShowMenuButton(true);
+      }
+      /**
+       * Desired behavior: onMouseEnter shows the menu, even when the user mouse-presses and -releases the checkbox/label.
+       * Issue: onMouseDown > checkbox/label triggers an onBlur event and hides the menu button.
+       *   Releasing the mouse button then shows the button again.
+       *   This behavior "flickers" the menu button.
+       * Solution: onMouseDown > preventDefault prevents onBlur from being called.
+       *   The menu button remains visible at all times.
+       *   This applies only when using the mouse; it is not an issue using the keyboard.
+       */,
+      onMouseDown: function onMouseDown(event) {
+        return event.preventDefault();
+      },
+      onMouseEnter: function onMouseEnter() {
+        return setShowMenuButton(true);
+      },
+      onMouseLeave: function onMouseLeave() {
+        return setHideButton(document.activeElement);
+      },
+      ref: localRef
+    }, devtools.getDevtoolsProps(componentName)), /*#__PURE__*/React__default["default"].createElement(FilterPanelCheckbox.FilterPanelCheckbox, _rollupPluginBabelHelpers["extends"]({}, rest, {
+      className: cx__default["default"]("".concat(blockClass, "__checkbox")),
+      count: count,
+      id: id,
+      labelText: labelText,
+      title: title
+    })), showMenuButton && /*#__PURE__*/React__default["default"].createElement(react.OverflowMenu, _rollupPluginBabelHelpers["extends"]({
+      open: overflowMenuProps === null || overflowMenuProps === void 0 ? void 0 : overflowMenuProps.open,
+      className: cx__default["default"]("".concat(blockClass, "__overflow-button"), overflowMenuProps === null || overflowMenuProps === void 0 ? void 0 : overflowMenuProps.menuClass),
+      menuOptionsClass: cx__default["default"]("".concat(blockClass, "__overflow-options"), overflowMenuProps === null || overflowMenuProps === void 0 ? void 0 : overflowMenuProps.menuOptionsClass),
+      "aria-label": overflowMenuProps === null || overflowMenuProps === void 0 ? void 0 : overflowMenuProps['aria-label'],
+      iconDescription: overflowMenuProps === null || overflowMenuProps === void 0 ? void 0 : overflowMenuProps['aria-label'],
+      onOpen: function onOpen() {
+        return setMenuIsOpen(true);
+      },
+      onClose: function onClose() {
+        return setMenuIsOpen(false);
+      },
+      flipped: (overflowMenuProps === null || overflowMenuProps === void 0 ? void 0 : overflowMenuProps.flipped) || true,
+      selectorPrimaryFocus: overflowMenuProps === null || overflowMenuProps === void 0 ? void 0 : overflowMenuProps.selectorPrimaryFocus
+    }, other), children))
+  );
+});
+
+// Return a placeholder if not released and not enabled by feature flag
+exports.FilterPanelCheckboxWithOverflow = settings.pkg.checkComponentEnabled(exports.FilterPanelCheckboxWithOverflow, componentName);
+exports.FilterPanelCheckboxWithOverflow.displayName = componentName;
+exports.FilterPanelCheckboxWithOverflow.propTypes = {
+  /**
+   * Children containing `OverflowMenuItems`.
+   */
+  children: index["default"].node.isRequired,
+  /**
+   * Optional class to be applied to the containing node.
+   */
+  className: index["default"].string,
+  /**
+   * Number to be displayed with the checkbox.
+   */
+  count: index["default"].oneOfType([index["default"].number, index["default"].string]),
+  /**
+   * Unique identifier.
+   */
+  id: index["default"].string.isRequired,
+  /**
+   * Label to be displayed with the checkbox.
+   */
+  labelText: index["default"].node.isRequired,
+  /**
+   * Checkbox event handler.
+   */
+  onChange: index["default"].func,
+  /**
+   * Props specific to the internal `OverflowMenu`.
+   */
+  overflowMenuProps: index["default"].shape(_rollupPluginBabelHelpers.defineProperty(_rollupPluginBabelHelpers.defineProperty(_rollupPluginBabelHelpers.defineProperty(_rollupPluginBabelHelpers.defineProperty(_rollupPluginBabelHelpers.defineProperty(_rollupPluginBabelHelpers.defineProperty({}, 'aria-label', index["default"].string), "flipped", index["default"].bool), "menuClass", index["default"].string), "menuOptionsClass", index["default"].string), "open", index["default"].bool), "selectorPrimaryFocus", index["default"].string)),
+  /**
+   * Optional title attribute for the label.
+   */
+  title: index["default"].string
+};

package/lib/components/FilterPanel/FilterPanelGroup/FilterPanelGroup.d.ts

@@ -0,0 +1,5 @@
+/**
+ * A container with a label and optional count.
+ */
+export let FilterPanelGroup: React.ForwardRefExoticComponent<React.RefAttributes<any>>;
+import React from 'react';

package/lib/components/FilterPanel/FilterPanelGroup/FilterPanelGroup.js

@@ -0,0 +1,79 @@
+/**
+ * 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.
+ */
+
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var _rollupPluginBabelHelpers = require('../../../_virtual/_rollupPluginBabelHelpers.js');
+var React = require('react');
+var index = require('../../../node_modules/prop-types/index.js');
+var cx = require('classnames');
+var devtools = require('../../../global/js/utils/devtools.js');
+var settings = require('../../../settings.js');
+var FilterPanelLabel = require('../FilterPanelLabel/FilterPanelLabel.js');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var React__default = /*#__PURE__*/_interopDefaultLegacy(React);
+var cx__default = /*#__PURE__*/_interopDefaultLegacy(cx);
+
+var _excluded = ["children", "className", "count", "labelText", "title"];
+
+// The block part of our conventional BEM class names (blockClass__E--M).
+var blockClass = "".concat(settings.pkg.prefix, "--filter-panel-group");
+var componentName = 'FilterPanelGroup';
+
+/**
+ * A container with a label and optional count.
+ */
+exports.FilterPanelGroup = /*#__PURE__*/React__default["default"].forwardRef(function (_ref, ref) {
+  var children = _ref.children,
+    className = _ref.className,
+    count = _ref.count,
+    labelText = _ref.labelText,
+    title = _ref.title,
+    rest = _rollupPluginBabelHelpers.objectWithoutProperties(_ref, _excluded);
+  return /*#__PURE__*/React__default["default"].createElement("div", _rollupPluginBabelHelpers["extends"]({}, rest, {
+    className: cx__default["default"](blockClass, className),
+    ref: ref
+  }, devtools.getDevtoolsProps(componentName)), labelText && /*#__PURE__*/React__default["default"].createElement("h2", {
+    className: "".concat(blockClass, "__title")
+  }, /*#__PURE__*/React__default["default"].createElement(FilterPanelLabel.FilterPanelLabel, {
+    count: count,
+    labelText: labelText,
+    title: title
+  })), /*#__PURE__*/React__default["default"].createElement("div", {
+    className: "".concat(blockClass, "__content")
+  }, children));
+});
+
+// Return a placeholder if not released and not enabled by feature flag
+exports.FilterPanelGroup = settings.pkg.checkComponentEnabled(exports.FilterPanelGroup, componentName);
+exports.FilterPanelGroup.displayName = componentName;
+exports.FilterPanelGroup.propTypes = {
+  /**
+   * Provide the contents of the FilterPanelGroup.
+   */
+  children: index["default"].node.isRequired,
+  /**
+   * Optional class to be applied to the containing node.
+   */
+  className: index["default"].string,
+  /**
+   * Number to be displayed with the label.
+   */
+  count: index["default"].oneOfType([index["default"].number, index["default"].string]),
+  /**
+   * The label for the component.
+   */
+  labelText: index["default"].node.isRequired,
+  /**
+   * Optional title attribute for the label.
+   */
+  title: index["default"].string
+};

package/lib/components/FilterPanel/FilterPanelLabel/FilterPanelLabel.js

@@ -42,9 +42,9 @@ exports.FilterPanelLabel = /*#__PURE__*/React__default["default"].forwardRef(fun
   }, devtools.getDevtoolsProps(componentName)), /*#__PURE__*/React__default["default"].createElement("span", {
     className: "".concat(blockClass, "__text"),
     title: title
-  }, labelText), /*#__PURE__*/React__default["default"].createElement("span", {
+  }, labelText), count && /*#__PURE__*/React__default["default"].createElement("span", {
     className: "".concat(blockClass, "__count")
-  }, count));
+  }, count), ' ');
 });
 
 // Return a placeholder if not released and not enabled by feature flag

package/lib/components/FilterPanel/index.d.ts

@@ -1,3 +1,7 @@
 export { FilterPanel } from "./FilterPanel";
+export { FilterPanelAccordion } from "./FilterPanelAccordion/FilterPanelAccordion";
+export { FilterPanelAccordionItem } from "./FilterPanelAccordionItem/FilterPanelAccordionItem";
 export { FilterPanelCheckbox } from "./FilterPanelCheckbox/FilterPanelCheckbox";
+export { FilterPanelCheckboxWithOverflow } from "./FilterPanelCheckboxWithOverflow/FilterPanelCheckboxWithOverflow";
+export { FilterPanelGroup } from "./FilterPanelGroup/FilterPanelGroup";
 export { FilterPanelLabel } from "./FilterPanelLabel/FilterPanelLabel";

package/lib/components/OptionsTile/OptionsTile.d.ts

@@ -1,5 +1,79 @@
 /**
- * TODO: A description of the component.
+ * Copyright IBM Corp. 2021, 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.
  */
-export let OptionsTile: React.ForwardRefExoticComponent<React.RefAttributes<any>>;
-import React from 'react';
+import React, { ReactNode } from 'react';
+interface OptionsTileProps {
+    /**
+     * Provide content to render as expandable OptionsTile. If no children
+     * are present, the OptionsTile will render as its variant.
+     */
+    children?: ReactNode;
+    /**
+     * Provide an optional class to be applied to the containing node.
+     */
+    className?: string;
+    /**
+     * Whether the toggle is enabled or disabled. If nothing is passed,
+     * no toggle will be rendered.
+     */
+    enabled?: boolean;
+    /**
+     * Whether the OptionsTile is in invalid validation state.
+     */
+    invalid?: boolean;
+    /**
+     * Provide a text explaining why the OptionsTile is in invalid state.
+     */
+    invalidText?: string;
+    /**
+     * Whether the OptionsTile is in locked validation state.
+     */
+    locked?: boolean;
+    /**
+     * Provide a text explaining why the OptionsTile is in locked state.
+     */
+    lockedText?: string;
+    /**
+     * Provide a function which will be called each time the user
+     * toggles the open state of the OptionsTile.
+     */
+    onChange?: (value: boolean) => void;
+    /**
+     * Provide a function which will be called each time the user
+     * interacts with the toggle.
+     */
+    onToggle: (value: boolean) => void;
+    /**
+     * Whether the OptionsTile is in open state.
+     */
+    open?: boolean;
+    /**
+     * Define the size of the OptionsTile.
+     */
+    size: 'lg' | 'xl';
+    /**
+     * Optionally provide a text summarizing the current state of the content.
+     */
+    summary?: string;
+    /**
+     * Provide the title for this OptionsTile.
+     */
+    title: string;
+    /**
+     * Optionally provide an id which should be used for the title.
+     */
+    titleId?: string;
+    /**
+     * Whether the OptionsTile is in warning validation state.
+     */
+    warn?: boolean;
+    /**
+     * Provide a text explaining why the OptionsTile is in warning state.
+     */
+    warnText?: string;
+}
+export declare let OptionsTile: React.ForwardRefExoticComponent<OptionsTileProps & React.RefAttributes<HTMLDivElement>>;
+export {};

package/lib/components/OptionsTile/OptionsTile.js

@@ -47,22 +47,12 @@ var carbonMotion__namespace = /*#__PURE__*/_interopNamespace(carbonMotion);
 
 var _Locked;
 var _excluded = ["children", "className", "enabled", "invalid", "invalidText", "locked", "lockedText", "onChange", "onToggle", "open", "size", "summary", "title", "titleId", "warn", "warnText"];
-
-// The block part of our conventional BEM class names (blockClass__E--M).
 var blockClass = "".concat(settings.pkg.prefix, "--options-tile");
 var componentName = 'OptionsTile';
-
-// NOTE: the component SCSS is not imported here: it is rolled up separately.
-
 // Default values for props
 var defaults = {
-  onChange: function onChange() {},
-  size: 'xl'
+  size: 'lg'
 };
-
-/**
- * TODO: A description of the component.
- */
 exports.OptionsTile = /*#__PURE__*/React__default["default"].forwardRef(function (_ref, ref) {
   var children = _ref.children,
     className = _ref.className,
@@ -71,8 +61,7 @@ exports.OptionsTile = /*#__PURE__*/React__default["default"].forwardRef(function
     invalidText = _ref.invalidText,
     locked = _ref.locked,
     lockedText = _ref.lockedText,
-    _ref$onChange = _ref.onChange,
-    _onChange = _ref$onChange === void 0 ? defaults.onChange : _ref$onChange,
+    _onChange = _ref.onChange,
     onToggle = _ref.onToggle,
     open = _ref.open,
     _ref$size = _ref.size,
@@ -92,11 +81,12 @@ exports.OptionsTile = /*#__PURE__*/React__default["default"].forwardRef(function
     closing = _useState4[0],
     setClosing = _useState4[1];
   var _useControllableState = useControllableState.useControllableState({
-      value: open,
       defaultValue: open || null,
+      name: 'OptionsTile',
       onChange: function onChange(value) {
-        return _onChange(value);
-      }
+        return _onChange === null || _onChange === void 0 ? void 0 : _onChange(value);
+      },
+      value: open
     }),
     _useControllableState2 = _rollupPluginBabelHelpers.slicedToArray(_useControllableState, 2),
     isOpen = _useControllableState2[0],
@@ -228,10 +218,7 @@ exports.OptionsTile = /*#__PURE__*/React__default["default"].forwardRef(function
     }, text)));
   }
   return /*#__PURE__*/React__default["default"].createElement("div", _rollupPluginBabelHelpers["extends"]({}, rest, {
-    className: cx__default["default"](blockClass,
-    // Apply the block class to the main HTML element
-    className, // Apply any supplied class names to the main HTML element.
-    "".concat(blockClass, "--").concat(size), _rollupPluginBabelHelpers.defineProperty({}, "".concat(blockClass, "--closing"), closing)),
+    className: cx__default["default"](blockClass, className, "".concat(blockClass, "--").concat(size), _rollupPluginBabelHelpers.defineProperty({}, "".concat(blockClass, "--closing"), closing)),
     ref: ref
   }, devtools.getDevtoolsProps(componentName)), enabled !== undefined && /*#__PURE__*/React__default["default"].createElement("div", {
     className: "".concat(blockClass, "__toggle-container")
@@ -322,6 +309,7 @@ exports.OptionsTile.propTypes = {
    * Provide a function which will be called each time the user
    * interacts with the toggle.
    */
+  /**@ts-ignore*/
   onToggle: index["default"].func,
   /**
    * Whether the OptionsTile is in open state.
@@ -330,6 +318,7 @@ exports.OptionsTile.propTypes = {
   /**
    * Define the size of the OptionsTile.
    */
+  /**@ts-ignore*/
   size: index["default"].oneOf(['lg', 'xl']),
   /**
    * Optionally provide a text summarizing the current state of the content.

package/lib/components/RemoveModal/RemoveModal.d.ts

@@ -1,7 +1,81 @@
-/**
-The `RemoveModal` covers what is known as high impact and medium impact deleting.
-Enabling `textConfirmation` enables what would be considered the high impact state of the modal.
-For additional information on differentiating between delete / remove and low / medium / high impact please refer to the usage guidelines.
- */
-export let RemoveModal: React.ForwardRefExoticComponent<React.RefAttributes<any>>;
-import React from 'react';
+/// <reference path="../../../src/custom-typings/index.d.ts" />
+import React, { ReactNode } from 'react';
+import { ComposedModal } from '@carbon/react';
+interface RemoveModalProps extends React.ComponentProps<typeof ComposedModal> {
+    /**
+     * The content to be displayed in the body of the modal
+     */
+    body: string;
+    /**
+     * Optional classname
+     */
+    className?: string;
+    /**
+     * Provide a description for "close" icon that can be read by screen readers
+     */
+    iconDescription: string;
+    /**
+     * Message showed when user input fails validation
+     */
+    inputInvalidText?: string;
+    /**
+     * Label for text box
+     */
+    inputLabelText?: ReactNode;
+    /**
+     * Placeholder for text box
+     */
+    inputPlaceholderText?: string;
+    /**
+     * Specify the modal label texts
+     */
+    label?: string;
+    /**
+     * Callback function that runs when user closes the modal
+     */
+    onClose?: () => void;
+    /**
+     * Callback function that runs when user submits the modal
+     */
+    onRequestSubmit?: () => void;
+    /**
+     * Specify whether the Modal is currently open
+     */
+    open: boolean;
+    /**
+     * The DOM node the tearsheet should be rendered within. Defaults to document.body.
+     */
+    portalTarget?: ReactNode;
+    /**
+     * Prevent closing on click outside of modal
+     */
+    preventCloseOnClickOutside?: boolean;
+    /**
+     * Specify whether the primary button should be disabled. This value will override textConfirmation
+     */
+    primaryButtonDisabled?: boolean;
+    /**
+     * Specify the text for the primary button
+     */
+    primaryButtonText?: string;
+    /**
+     * The name of the resource being acted upon
+     */
+    resourceName: string;
+    /**
+     * Specify the text for the secondary button
+     */
+    secondaryButtonText?: string;
+    /**
+     * Specify whether or not to show the text confirmation input
+     */
+    textConfirmation?: boolean;
+    /**
+     * The text displayed at the top of the modal
+     */
+    title: string;
+}
+export declare let RemoveModal: React.ForwardRefExoticComponent<RemoveModalProps & {
+    children?: React.ReactNode;
+} & React.RefAttributes<unknown>>;
+export {};

package/lib/components/RemoveModal/RemoveModal.js

@@ -33,6 +33,7 @@ The `RemoveModal` covers what is known as high impact and medium impact deleting
 Enabling `textConfirmation` enables what would be considered the high impact state of the modal.
 For additional information on differentiating between delete / remove and low / medium / high impact please refer to the usage guidelines.
  */
+
 exports.RemoveModal = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
   var body = _ref.body,
     className = _ref.className,

package/lib/components/ScrollGradient/ScrollGradient.d.ts

@@ -0,0 +1,5 @@
+/**
+ * TODO: A description of the component.
+ */
+export let ScrollGradient: React.ForwardRefExoticComponent<React.RefAttributes<any>>;
+import React from 'react';