@carbon/react 1.78.2 → 1.79.0

package/lib/components/OverflowMenu/OverflowMenu.d.ts

@@ -4,32 +4,35 @@
  * 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, { type ElementType, type ReactNode, type Ref } from 'react';
 import { type MenuDirection, type MenuOffset } from '../../internal/FloatingMenu';
-import React, { ComponentType } from 'react';
-import PropTypes from 'prop-types';
+/**
+ * Calculates the offset for the floating menu.
+ *
+ * @param menuBody - The menu body with the menu arrow.
+ * @param direction - The floating menu direction.
+ * @returns The adjustment of the floating menu position, upon the position of
+ *          the menu arrow.
+ */
 export declare const getMenuOffset: MenuOffset;
-type IconProps = {
-    className?: string;
-    'aria-label'?: string;
-};
 export interface OverflowMenuProps {
     /**
      * Specify a label to be read by screen readers on the container node
      */
     ['aria-label']?: string;
     /**
-     * Deprecated, please use `aria-label` instead.
      * Specify a label to be read by screen readers on the container note.
-     * @deprecated
-     * */
-    ariaLabel: string;
+     *
+     * @deprecated - Use `aria-label` instead.
+     */
+    ariaLabel?: string;
     /**
      * The child nodes.
-     * */
-    children: React.ReactNode;
+     */
+    children: ReactNode;
     /**
-     *  The CSS class names.
-     *  */
+     * The CSS class names.
+     */
     className?: string;
     /**
      * The menu direction.
@@ -89,9 +92,9 @@ export interface OverflowMenuProps {
      */
     open?: boolean;
     /**
-     * Function called to override icon rendering.
+     * A component used to render an icon.
      */
-    renderIcon?: ComponentType<IconProps>;
+    renderIcon?: ElementType;
     /**
      * Specify a CSS selector that matches the DOM element that should
      * be focused when the OverflowMenu opens
@@ -104,189 +107,7 @@ export interface OverflowMenuProps {
     /**
      * The ref to the HTML element that should receive focus when the OverflowMenu opens
      */
-    innerRef?: React.Ref<any>;
-}
-export interface OverflowMenuState {
-    open: boolean;
-    prevOpen?: boolean;
-    hasMountedTrigger: boolean;
-    click: boolean;
-}
-interface ReleaseHandle {
-    release: () => null;
-}
-declare class OverflowMenu extends React.Component<OverflowMenuProps, OverflowMenuState> {
-    state: OverflowMenuState;
-    instanceId: number;
-    static propTypes: {
-        /**
-         * Specify a label to be read by screen readers on the container node
-         */
-        "aria-label": PropTypes.Requireable<string>;
-        /**
-         * Deprecated, please use `aria-label` instead.
-         * Specify a label to be read by screen readers on the container note.
-         */
-        ariaLabel: (props: any, propName: any, componentName: any, ...rest: any[]) => any;
-        /**
-         * The child nodes.
-         */
-        children: PropTypes.Requireable<PropTypes.ReactNodeLike>;
-        /**
-         * The CSS class names.
-         */
-        className: PropTypes.Requireable<string>;
-        /**
-         * The menu direction.
-         */
-        direction: PropTypes.Requireable<string>;
-        /**
-         * `true` if the menu alignment should be flipped.
-         */
-        flipped: PropTypes.Requireable<boolean>;
-        /**
-         * Enable or disable focus trap behavior
-         */
-        focusTrap: PropTypes.Requireable<boolean>;
-        /**
-         * The CSS class for the icon.
-         */
-        iconClass: PropTypes.Requireable<string>;
-        /**
-         * The icon description.
-         */
-        iconDescription: PropTypes.Requireable<string>;
-        /**
-         * The element ID.
-         */
-        id: PropTypes.Requireable<string>;
-        /**
-         * `true` to use the light version. For use on $ui-01 backgrounds only.
-         * Don't use this to make OverflowMenu background color same as container background color.
-         */
-        light: (props: any, propName: any, componentName: any, ...rest: any[]) => any;
-        /**
-         * The adjustment in position applied to the floating menu.
-         */
-        menuOffset: PropTypes.Requireable<NonNullable<((...args: any[]) => any) | PropTypes.InferProps<{
-            top: PropTypes.Requireable<number>;
-            left: PropTypes.Requireable<number>;
-        }> | null | undefined>>;
-        /**
-         * The adjustment in position applied to the floating menu.
-         */
-        menuOffsetFlip: PropTypes.Requireable<NonNullable<((...args: any[]) => any) | PropTypes.InferProps<{
-            top: PropTypes.Requireable<number>;
-            left: PropTypes.Requireable<number>;
-        }> | null | undefined>>;
-        /**
-         * The class to apply to the menu options
-         */
-        menuOptionsClass: PropTypes.Requireable<string>;
-        /**
-         * The event handler for the `click` event.
-         */
-        onClick: PropTypes.Requireable<(...args: any[]) => any>;
-        /**
-         * Function called when menu is closed
-         */
-        onClose: PropTypes.Requireable<(...args: any[]) => any>;
-        /**
-         * The event handler for the `focus` event.
-         */
-        onFocus: PropTypes.Requireable<(...args: any[]) => any>;
-        /**
-         * The event handler for the `keydown` event.
-         */
-        onKeyDown: PropTypes.Requireable<(...args: any[]) => any>;
-        /**
-         * Function called when menu is opened
-         */
-        onOpen: PropTypes.Requireable<(...args: any[]) => any>;
-        /**
-         * `true` if the menu should be open.
-         */
-        open: PropTypes.Requireable<boolean>;
-        /**
-         * Function called to override icon rendering.
-         */
-        renderIcon: PropTypes.Requireable<object>;
-        /**
-         * Specify a CSS selector that matches the DOM element that should
-         * be focused when the OverflowMenu opens
-         */
-        selectorPrimaryFocus: PropTypes.Requireable<string>;
-        /**
-         * Specify the size of the OverflowMenu. Currently supports either `sm`, 'md' (default) or 'lg` as an option.
-         */
-        size: PropTypes.Requireable<string>;
-    };
-    static contextType: React.Context<string>;
-    /**
-     * The handle of `onfocusin` or `focus` event handler.
-     * @private
-     */
-    _hFocusIn: ReleaseHandle | null;
-    /**
-     * The timeout handle for handling `blur` event.
-     * @private
-     */
-    _hBlurTimeout: any;
-    /**
-     * The element ref of the tooltip's trigger button.
-     * @type {React.RefObject<HTMLElement>}
-     * @private
-     */
-    _triggerRef: React.RefObject<HTMLElement>;
-    componentDidUpdate(_: any, prevState: any): void;
-    componentDidMount(): void;
-    static getDerivedStateFromProps({ open }: {
-        open: any;
-    }, state: any): {
-        open: any;
-        prevOpen: any;
-    } | null;
-    componentWillUnmount(): void;
-    handleClick: (evt: any) => void;
-    closeMenuAndFocus: () => void;
-    closeMenuOnEscape: () => void;
-    handleKeyPress: (evt: any) => void;
-    handleClickOutside: (evt: any) => void;
-    closeMenu: (onCloseMenu?: any) => void;
-    focusMenuEl: () => void;
-    /**
-     * Focuses the next enabled overflow menu item given the currently focused
-     * item index and direction to move
-     * @param {object} params
-     * @param {number} params.currentIndex - the index of the currently focused
-     * overflow menu item in the list of overflow menu items
-     * @param {number} params.direction - number denoting the direction to move
-     * focus (1 for forwards, -1 for backwards)
-     */
-    handleOverflowMenuItemFocus: ({ currentIndex, direction }: {
-        currentIndex: any;
-        direction: any;
-    }) => void;
-    /**
-     * Handles the floating menu being unmounted or non-floating menu being
-     * mounted or unmounted.
-     * @param {Element} menuBody The DOM element of the menu body.
-     * @private
-     */
-    _menuBody: HTMLElement | null;
-    _bindMenuBody: (menuBody: HTMLElement | null) => void;
-    /**
-     * Handles the floating menu being placed.
-     * @param {Element} menuBody The DOM element of the menu body.
-     * @private
-     */
-    _handlePlace: (menuBody: any) => void;
-    /**
-     * @returns {Element} The DOM element where the floating menu is placed in.
-     */
-    _getTarget: () => Element;
-    render(): import("react/jsx-runtime").JSX.Element;
+    innerRef?: Ref<any>;
 }
-export { OverflowMenu };
-declare const _default: React.ForwardRefExoticComponent<Omit<any, "ref"> & React.RefAttributes<unknown>>;
-export default _default;
+export declare const OverflowMenu: React.ForwardRefExoticComponent<OverflowMenuProps & React.RefAttributes<HTMLButtonElement>>;
+export default OverflowMenu;