@carbon/ibm-products 2.33.0 → 2.34.0

package/lib/components/ScrollGradient/ScrollGradient.js

@@ -0,0 +1,163 @@
+/**
+ * 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 lodash = require('lodash');
+var constants = require('./constants.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", "color", "onScroll", "scrollElementClassName", "getScrollElementRef", "hideStartGradient"];
+var blockClass = "".concat(settings.pkg.prefix, "--scroll-gradient");
+var componentName = 'ScrollGradient';
+
+// Default values for props
+var defaults = {
+  color: "var(--".concat(settings.carbon.prefix, "-layer-01)"),
+  hideStartGradient: false,
+  onScroll: function onScroll() {},
+  getScrollElementRef: function getScrollElementRef() {}
+};
+
+/**
+ * TODO: A description of the component.
+ */
+exports.ScrollGradient = /*#__PURE__*/React__default["default"].forwardRef(function (_ref, ref) {
+  var children = _ref.children,
+    className = _ref.className,
+    _ref$color = _ref.color,
+    color = _ref$color === void 0 ? defaults.color : _ref$color,
+    _ref$onScroll = _ref.onScroll,
+    onScroll = _ref$onScroll === void 0 ? defaults.onScroll : _ref$onScroll,
+    scrollElementClassName = _ref.scrollElementClassName,
+    _ref$getScrollElement = _ref.getScrollElementRef,
+    getScrollElementRef = _ref$getScrollElement === void 0 ? defaults.getScrollElementRef : _ref$getScrollElement,
+    _ref$hideStartGradien = _ref.hideStartGradient,
+    hideStartGradient = _ref$hideStartGradien === void 0 ? defaults.hideStartGradient : _ref$hideStartGradien,
+    rest = _rollupPluginBabelHelpers.objectWithoutProperties(_ref, _excluded);
+  var _useState = React.useState(constants.ScrollStates.NONE),
+    _useState2 = _rollupPluginBabelHelpers.slicedToArray(_useState, 2),
+    verticalPosition = _useState2[0],
+    setVerticalPosition = _useState2[1];
+  var _useState3 = React.useState(constants.ScrollStates.NONE),
+    _useState4 = _rollupPluginBabelHelpers.slicedToArray(_useState3, 2),
+    horizontalPosition = _useState4[0],
+    setHorizontalPosition = _useState4[1];
+  var scrollContainer = React.useRef();
+  var contentChildrenContainer = React.useRef();
+  var updateScrollState = lodash.throttle(function () {
+    var updatedVerticalVal = constants.getScrollState(scrollContainer.current, constants.ScrollDirection.Y);
+    var updatedHorizontalVal = constants.getScrollState(scrollContainer.current, constants.ScrollDirection.X);
+    setVerticalPosition(updatedVerticalVal);
+    setHorizontalPosition(updatedHorizontalVal);
+  }, 150);
+  var scrollHandler = React.useCallback(function (event) {
+    onScroll(event);
+    updateScrollState();
+  }, [onScroll, updateScrollState]);
+  var setRefs = function setRefs(element) {
+    scrollContainer.current = element;
+    getScrollElementRef(element);
+  };
+  React.useEffect(function () {
+    scrollHandler();
+  }, [scrollHandler]);
+  var _useIsOverflow = constants.useIsOverflow(scrollContainer),
+    xScrollable = _useIsOverflow.xScrollable,
+    yScrollable = _useIsOverflow.yScrollable;
+  var gradientRight = yScrollable && scrollContainer.current && contentChildrenContainer.current ? scrollContainer.current.offsetWidth - contentChildrenContainer.current.offsetWidth : 0;
+  var gradientBottom = xScrollable && scrollContainer.current && contentChildrenContainer.current ? scrollContainer.current.offsetHeight - contentChildrenContainer.current.offsetHeight : 0;
+  return /*#__PURE__*/React__default["default"].createElement("div", _rollupPluginBabelHelpers["extends"]({}, rest, {
+    className: cx__default["default"](blockClass, "".concat(blockClass, "--x-").concat(horizontalPosition.toLowerCase()), "".concat(blockClass, "--y-").concat(verticalPosition.toLowerCase()), _rollupPluginBabelHelpers.defineProperty(_rollupPluginBabelHelpers.defineProperty({}, "".concat(blockClass, "--x-scrollable"), xScrollable), "".concat(blockClass, "--y-scrollable"), yScrollable), className),
+    ref: ref,
+    role: "presentation"
+  }, devtools.getDevtoolsProps(componentName)), /*#__PURE__*/React__default["default"].createElement("div", {
+    onScroll: scrollHandler,
+    ref: setRefs,
+    className: cx__default["default"]("".concat(blockClass, "__content"), scrollElementClassName)
+  }, /*#__PURE__*/React__default["default"].createElement("div", {
+    ref: contentChildrenContainer,
+    className: "".concat(blockClass, "__content-children")
+  }, children)), !hideStartGradient && /*#__PURE__*/React__default["default"].createElement(React__default["default"].Fragment, null, /*#__PURE__*/React__default["default"].createElement("div", {
+    className: "".concat(blockClass, "__start-vertical"),
+    style: {
+      right: gradientRight,
+      backgroundImage: "linear-gradient(0deg, transparent, ".concat(color, " 90%)")
+    },
+    role: "presentation",
+    "aria-hidden": true
+  }), /*#__PURE__*/React__default["default"].createElement("div", {
+    className: "".concat(blockClass, "__start-horizontal"),
+    style: {
+      backgroundImage: "linear-gradient(-90deg, transparent, ".concat(color, " 90%)"),
+      bottom: gradientBottom
+    },
+    role: "presentation",
+    "aria-hidden": true
+  })), /*#__PURE__*/React__default["default"].createElement("div", {
+    className: "".concat(blockClass, "__end-vertical"),
+    style: {
+      right: gradientRight,
+      bottom: gradientBottom,
+      backgroundImage: "linear-gradient(0deg, ".concat(color, " 10%, transparent)")
+    },
+    role: "presentation",
+    "aria-hidden": true
+  }), /*#__PURE__*/React__default["default"].createElement("div", {
+    className: "".concat(blockClass, "__end-horizontal"),
+    style: {
+      right: gradientRight,
+      bottom: gradientBottom,
+      backgroundImage: "linear-gradient(-90deg, ".concat(color, " 10%, transparent)")
+    },
+    role: "presentation",
+    "aria-hidden": true
+  }));
+});
+
+// Return a placeholder if not released and not enabled by feature flag
+exports.ScrollGradient = settings.pkg.checkComponentEnabled(exports.ScrollGradient, componentName);
+
+// The display name of the component, used by React. Note that displayName
+// is used in preference to relying on function.name.
+exports.ScrollGradient.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.
+exports.ScrollGradient.propTypes = {
+  /**
+   * Provide the contents of the ScrollGradient.
+   */
+  children: index["default"].oneOfType([index["default"].arrayOf(index["default"].node), index["default"].node]),
+  /**
+   * Provide an optional class to be applied to the containing node.
+   */
+  className: index["default"].string,
+  /** @type {string} Fade out color. Any valid CSS color value works */
+  color: index["default"].string,
+  /** @type {(element: HTMLElement) => {}} Optional function to get reference to scrollable DOM element */
+  getScrollElementRef: index["default"].func,
+  /** @type {boolean} Set to true if you want to hide gradient on the start side (top or left) of scrollable element. */
+  hideStartGradient: index["default"].bool,
+  /** @type {Function} Optional scroll handler */
+  onScroll: index["default"].func,
+  /** @type {string} Optional classname for scroll element. */
+  scrollElementClassName: index["default"].string
+};

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

@@ -0,0 +1,15 @@
+export namespace ScrollDirection {
+    let X: string;
+    let Y: string;
+}
+export namespace ScrollStates {
+    let NONE: string;
+    let INITIAL: string;
+    let STARTED: string;
+    let END: string;
+}
+export function getScrollState(element: any, scrollDirection: any): string;
+export function useIsOverflow(ref: any): {
+    xScrollable: undefined;
+    yScrollable: undefined;
+};

package/lib/components/ScrollGradient/constants.js

@@ -0,0 +1,128 @@
+/**
+ * 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 ScrollDirection = {
+  X: 'X',
+  Y: 'Y'
+};
+var ScrollStates = {
+  // No scrolling required because content fits within container.
+  NONE: 'NONE',
+  // Scroll position is a the start of the scrollable content.
+  INITIAL: 'INITIAL',
+  // Scroll position is neither at start or end of scrollable content.
+  STARTED: 'STARTED',
+  // Scroll position is a the end of the scrollable content.
+  END: 'END'
+};
+
+// FUNCTIONS
+
+var getScrollState = function getScrollState(element, scrollDirection) {
+  // console.log('getScrollState - element: ', element);
+  // console.log('getScrollState - scrollDirection: ', scrollDirection);
+  // console.log('-------------------------------------------------');
+  switch (scrollDirection) {
+    case ScrollDirection.X:
+      {
+        if (element.scrollWidth === element.clientWidth) {
+          return ScrollStates.NONE;
+        }
+        if (element.scrollLeft === 0) {
+          return ScrollStates.INITIAL;
+        }
+        if (element.scrollLeft + element.clientWidth === element.scrollWidth) {
+          return ScrollStates.END;
+        }
+        return ScrollStates.STARTED;
+      }
+    case ScrollDirection.Y:
+    default:
+      {
+        if (element.scrollHeight === element.clientHeight) {
+          return ScrollStates.NONE;
+        }
+        if (element.scrollTop === 0) {
+          return ScrollStates.INITIAL;
+        }
+        if (element.scrollTop + element.clientHeight === element.scrollHeight) {
+          return ScrollStates.END;
+        }
+        return ScrollStates.STARTED;
+      }
+  }
+};
+var useIsOverflow = function useIsOverflow(ref) {
+  var _useState = React.useState(),
+    _useState2 = _rollupPluginBabelHelpers.slicedToArray(_useState, 2),
+    isHorizontallyScrollable = _useState2[0],
+    setIsHorizontallyScrollable = _useState2[1];
+  var _useState3 = React.useState(),
+    _useState4 = _rollupPluginBabelHelpers.slicedToArray(_useState3, 2),
+    isVerticallyScrollable = _useState4[0],
+    setIsVerticallyScrollable = _useState4[1];
+  var _useState5 = React.useState(),
+    _useState6 = _rollupPluginBabelHelpers.slicedToArray(_useState5, 2),
+    mutationObserver = _useState6[0],
+    setMutationObserver = _useState6[1];
+  var _useState7 = React.useState(),
+    _useState8 = _rollupPluginBabelHelpers.slicedToArray(_useState7, 2),
+    resizeObserver = _useState8[0],
+    setResizeObserver = _useState8[1];
+  var checkOverflow = React.useCallback(function () {
+    if (!ref.current) {
+      return;
+    }
+    setIsHorizontallyScrollable(ref.current.scrollWidth > ref.current.clientWidth);
+    setIsVerticallyScrollable(ref.current.scrollHeight > ref.current.clientHeight);
+  }, [ref]);
+  React.useEffect(function () {
+    if (!mutationObserver) {
+      return;
+    }
+    return function () {
+      if (mutationObserver) {
+        mutationObserver.disconnect();
+      }
+      if (resizeObserver) {
+        resizeObserver.disconnect();
+      }
+    };
+  });
+  React.useLayoutEffect(function () {
+    var current = ref.current;
+    if (current) {
+      if ('ResizeObserver' in window && !resizeObserver) {
+        setResizeObserver(new ResizeObserver(checkOverflow).observe(current));
+      }
+      if ('MutationObserver' in window && !mutationObserver) {
+        setMutationObserver(new MutationObserver(checkOverflow).observe(current, {
+          attributes: false,
+          childList: true,
+          subtree: false
+        }));
+      }
+      checkOverflow();
+    }
+  }, [ref, checkOverflow, mutationObserver, resizeObserver]);
+  return {
+    xScrollable: isHorizontallyScrollable,
+    yScrollable: isVerticallyScrollable
+  };
+};
+
+exports.ScrollDirection = ScrollDirection;
+exports.ScrollStates = ScrollStates;
+exports.getScrollState = getScrollState;
+exports.useIsOverflow = useIsOverflow;

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

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

package/lib/components/SidePanel/SidePanel.d.ts

@@ -1,5 +1,147 @@
+/**
+ * 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.
+ */
+/// <reference path="../../../src/custom-typings/index.d.ts" />
+import React, { ReactNode } from 'react';
+import { ButtonProps } from '@carbon/react';
+type SidePanelBaseProps = {
+    /**
+     * Sets the action toolbar buttons
+     */
+    actionToolbarButtons?: ButtonProps[];
+    /**
+     * The primary actions to be shown in the side panel. Each action is
+     * specified as an object that will render expressive Buttons. Any Button
+     * props can be passed in and any other fields in the object will be
+     * passed through to the button element as HTML attributes.
+     *
+     * See https://react.carbondesignsystem.com/?path=/docs/components-button--default#component-api
+     */
+    actions?: ButtonProps[];
+    /**
+     * Determines if the title will animate on scroll
+     */
+    animateTitle?: boolean;
+    /**
+     * Sets the body content of the side panel
+     */
+    children: ReactNode;
+    /**
+     * Sets an optional className to be added to the side panel outermost element
+     */
+    className?: string;
+    /**
+     * Sets the close button icon description
+     */
+    closeIconDescription?: string;
+    /**
+     * Determines whether the side panel should render the condensed version (affects action buttons primarily)
+     */
+    condensedActions?: boolean;
+    /**
+     * Sets the current step of the side panel
+     */
+    currentStep?: number;
+    /**
+     * Unique identifier
+     */
+    id?: string;
+    /**
+     * Determines whether the side panel should render with an overlay
+     */
+    includeOverlay?: boolean;
+    /**
+     * Sets the label text which will display above the title text
+     */
+    labelText?: string;
+    /**
+     * Sets the icon description for the navigation back icon button
+     */
+    navigationBackIconDescription?: string;
+    /**
+     * Changes the current side panel page to the previous page
+     */
+    onNavigationBack?(): void;
+    /**
+     * Specify a handler for closing the side panel.
+     * This handler closes the modal, e.g. changing `open` prop.
+     */
+    onRequestClose?(): void;
+    /**
+     * Optional function called when the side panel exit animation is complete.
+     * This handler can be used for any state cleanup needed before the panel is removed from the DOM.
+     */
+    onUnmount?(): void;
+    /**
+     * Determines whether the side panel should render or not
+     */
+    open: boolean;
+    /**
+     * Determines if the side panel is on the right or left
+     */
+    placement?: 'left' | 'right';
+    /**
+     * Prevent closing on click outside of the panel
+     */
+    preventCloseOnClickOutside?: boolean;
+    /**
+     * This is the selector to the element that contains all of the page content that will shrink if the panel is a slide in.
+     * This prop is required when using the `slideIn` variant of the side panel.
+     */
+    selectorPageContent?: string;
+    /**
+     * Specify a CSS selector that matches the DOM element that should
+     * be focused when the side panel opens
+     */
+    selectorPrimaryFocus?: string;
+    /**
+     * Sets the size of the side panel
+     */
+    size: 'xs' | 'sm' | 'md' | 'lg' | '2xl';
+    /**
+     * Determines if this panel slides in
+     */
+    slideIn?: boolean;
+    /**
+     *  **Experimental:** Provide a `Slug` component to be rendered inside the `SidePanel` component
+     */
+    slug?: ReactNode;
+    /**
+     * Sets the subtitle text
+     */
+    subtitle?: ReactNode;
+    /**
+     * Sets the title text
+     */
+    title?: string;
+};
+type SidePanelSlideInProps = {
+    /**
+     * Determines if this panel slides in
+     */
+    slideIn?: false;
+    /**
+     * This is the selector to the element that contains all of the page content that will shrink if the panel is a slide in.
+     * This prop is required when using the `slideIn` variant of the side panel.
+     */
+    selectorPageContent?: string;
+} | {
+    /**
+     * Determines if this panel slides in
+     */
+    slideIn: true;
+    /**
+     * This is the selector to the element that contains all of the page content that will shrink if the panel is a slide in.
+     * This prop is required when using the `slideIn` variant of the side panel. Required for slideIn panels.
+     */
+    selectorPageContent: string;
+};
+type SidePanelProps = SidePanelBaseProps & SidePanelSlideInProps;
 /**
  * Side panels keep users in-context of a page while performing tasks like navigating, editing, viewing details, or configuring something new.
  */
-export let SidePanel: React.ForwardRefExoticComponent<React.RefAttributes<any>>;
-import React from 'react';
+export declare let SidePanel: React.ForwardRefExoticComponent<SidePanelProps & React.RefAttributes<HTMLDivElement>>;
+export {};