@coreui/react-pro 5.10.0 → 5.12.0

package/dist/esm/components/tooltip/CTooltip.d.ts

@@ -1,28 +1,45 @@
 import React, { HTMLAttributes, ReactNode } from 'react';
+import type { Options } from '@popperjs/core';
 import type { Placements, Triggers } from '../../types';
 export interface CTooltipProps extends Omit<HTMLAttributes<HTMLDivElement>, 'content'> {
     /**
-     * Apply a CSS fade transition to the tooltip.
+     * Enables or disables the CSS fade transition for the React Tooltip.
      *
      * @since 4.9.0
      */
     animation?: boolean;
     /**
-     * A string of all className you want applied to the component.
+     * Adds a custom class name to the React Tooltip container. Useful for overriding default styles or applying additional design choices.
      */
     className?: string;
     /**
-     * Appends the react tooltip to a specific element. You can pass an HTML element or function that returns a single element. By default `document.body`.
+     * Appends the React Tooltip to a specific element instead of the default `document.body`. You may pass:
+     * - A DOM element (`HTMLElement` or `DocumentFragment`)
+     * - A function that returns a single element
+     * - `null`
      *
+     * @example
+     * <CTooltip container={document.getElementById('my-container')}>...</CTooltip>
+     *
+     * @default document.body
      * @since 4.11.0
      */
     container?: DocumentFragment | Element | (() => DocumentFragment | Element | null) | null;
     /**
-     * Content node for your component.
+     * Content to be displayed within the React Tooltip. Can be a string or any valid React node.
      */
     content: ReactNode | string;
     /**
-     * The delay for displaying and hiding the tooltip (in milliseconds). When a numerical value is provided, the delay applies to both the hide and show actions. The object structure for specifying the delay is as follows: delay: `{ 'show': 500, 'hide': 100 }`.
+     * The delay (in milliseconds) before showing or hiding the React Tooltip.
+     * - If provided as a number, the delay is applied to both "show" and "hide".
+     * - If provided as an object, it should have distinct "show" and "hide" values.
+     *
+     * @example
+     * // Delays 300ms on both show and hide
+     * <CTooltip delay={300}>...</CTooltip>
+     *
+     * // Delays 500ms on show and 100ms on hide
+     * <CTooltip delay={{ show: 500, hide: 100 }}>...</CTooltip>
      *
      * @since 4.9.0
      */
@@ -31,35 +48,70 @@ export interface CTooltipProps extends Omit<HTMLAttributes<HTMLDivElement>, 'con
         hide: number;
     };
     /**
-     * Specify the desired order of fallback placements by providing a list of placements as an array. The placements should be prioritized based on preference.
+     * Array of fallback placements for the React Tooltip to use when the preferred placement cannot be achieved. These placements are tried in order.
      *
+     * @type 'top', 'right', 'bottom', 'left' | ('top', 'right', 'bottom', 'left')[]
      * @since 4.9.0
      */
     fallbackPlacements?: Placements | Placements[];
     /**
-     * Offset of the tooltip relative to its target.
+     * Adjusts the offset of the React Tooltip relative to its target. Expects a tuple `[x-axis, y-axis]`.
+     *
+     * @example
+     * // Offset the menu 0px in X and 10px in Y direction
+     * <CTooltip offset={[0, 10]}>...</CTooltip>
+     *
+     * // Offset the menu 5px in both X and Y direction
+     * <CTooltip offset={[5, 5]}>...</CTooltip>
      */
     offset?: [number, number];
     /**
-     * Callback fired when the component requests to be hidden.
+     * Callback fired immediately after the React Tooltip is hidden.
      */
     onHide?: () => void;
     /**
-     * Callback fired when the component requests to be shown.
+     * Callback fired immediately after the React Tooltip is shown.
      */
     onShow?: () => void;
     /**
-     * Sets which event handlers you’d like provided to your toggle prop. You can specify one trigger or an array of them.
+     * Initial placement of the React Tooltip. Note that Popper.js modifiers may alter this placement automatically if there's insufficient space in the chosen position.
+     */
+    placement?: 'auto' | 'top' | 'right' | 'bottom' | 'left';
+    /**
+     * Customize the Popper.js configuration used to position the React Tooltip. Pass either an object or a function returning a modified config. [Learn more](https://popper.js.org/docs/v2/constructors/#options)
      *
-     * @type 'hover' | 'focus' | 'click'
+     * @example
+     * <CTooltip
+     *   popperConfig={(defaultConfig) => ({
+     *     ...defaultConfig,
+     *     strategy: 'fixed',
+     *     modifiers: [
+     *       ...defaultConfig.modifiers,
+     *       { name: 'computeStyles', options: { adaptive: false } },
+     *     ],
+     *   })}
+     * >...</CTooltip>
+     *
+     * @since 5.5.0
      */
-    trigger?: Triggers | Triggers[];
+    popperConfig?: Partial<Options> | ((defaultPopperConfig: Partial<Options>) => Partial<Options>);
     /**
-     * Describes the placement of your component after Popper.js has applied all the modifiers that may have flipped or altered the originally provided placement property.
+     * Determines the events that toggle the visibility of the React Tooltip. Can be a single trigger or an array of triggers.
+     *
+     * @example
+     * // Hover-only tooltip
+     * <CTooltip trigger="hover">...</CTooltip>
+     *
+     * // Hover + click combined
+     * <CTooltip trigger={['hover', 'click']}>...</CTooltip>
+     *
+     * @type 'hover' | 'focus' | 'click' | ('hover' | 'focus' | 'click')[]
      */
-    placement?: 'auto' | 'top' | 'right' | 'bottom' | 'left';
+    trigger?: Triggers | Triggers[];
     /**
-     * Toggle the visibility of tooltip component.
+     * Controls the visibility of the React Tooltip.
+     * - `true` to show the tooltip.
+     * - `false` to hide the tooltip.
      */
     visible?: boolean;
 }

package/dist/esm/components/tooltip/CTooltip.js

@@ -10,7 +10,7 @@ import { useForkedRef } from '../../hooks/useForkedRef.js';
 import { fallbackPlacementsPropType, triggerPropType } from '../../props.js';
 
 var CTooltip = forwardRef(function (_a, ref) {
-    var children = _a.children, _b = _a.animation, animation = _b === void 0 ? true : _b, className = _a.className, container = _a.container, content = _a.content, _c = _a.delay, delay = _c === void 0 ? 0 : _c, _d = _a.fallbackPlacements, fallbackPlacements = _d === void 0 ? ['top', 'right', 'bottom', 'left'] : _d, _e = _a.offset, offset = _e === void 0 ? [0, 6] : _e, onHide = _a.onHide, onShow = _a.onShow, _f = _a.placement, placement = _f === void 0 ? 'top' : _f, _g = _a.trigger, trigger = _g === void 0 ? ['hover', 'focus'] : _g, visible = _a.visible, rest = __rest(_a, ["children", "animation", "className", "container", "content", "delay", "fallbackPlacements", "offset", "onHide", "onShow", "placement", "trigger", "visible"]);
+    var children = _a.children, _b = _a.animation, animation = _b === void 0 ? true : _b, className = _a.className, container = _a.container, content = _a.content, _c = _a.delay, delay = _c === void 0 ? 0 : _c, _d = _a.fallbackPlacements, fallbackPlacements = _d === void 0 ? ['top', 'right', 'bottom', 'left'] : _d, _e = _a.offset, offset = _e === void 0 ? [0, 6] : _e, onHide = _a.onHide, onShow = _a.onShow, _f = _a.placement, placement = _f === void 0 ? 'top' : _f, popperConfig = _a.popperConfig, _g = _a.trigger, trigger = _g === void 0 ? ['hover', 'focus'] : _g, visible = _a.visible, rest = __rest(_a, ["children", "animation", "className", "container", "content", "delay", "fallbackPlacements", "offset", "onHide", "onShow", "placement", "popperConfig", "trigger", "visible"]);
     var tooltipRef = useRef(null);
     var togglerRef = useRef(null);
     var forkedRef = useForkedRef(ref, tooltipRef);
@@ -19,29 +19,15 @@ var CTooltip = forwardRef(function (_a, ref) {
     var _j = useState(visible), _visible = _j[0], setVisible = _j[1];
     var _k = usePopper(), initPopper = _k.initPopper, destroyPopper = _k.destroyPopper, updatePopper = _k.updatePopper;
     var _delay = typeof delay === 'number' ? { show: delay, hide: delay } : delay;
-    var popperConfig = {
+    var defaultPopperConfig = {
         modifiers: [
-            {
-                name: 'arrow',
-                options: {
-                    element: '.tooltip-arrow',
-                },
-            },
-            {
-                name: 'flip',
-                options: {
-                    fallbackPlacements: fallbackPlacements,
-                },
-            },
-            {
-                name: 'offset',
-                options: {
-                    offset: offset,
-                },
-            },
+            { name: 'arrow', options: { element: '.tooltip-arrow' } },
+            { name: 'flip', options: { fallbackPlacements: fallbackPlacements } },
+            { name: 'offset', options: { offset: offset } },
         ],
         placement: getRTLPlacement(placement, togglerRef.current),
     };
+    var computedPopperConfig = __assign(__assign({}, defaultPopperConfig), (typeof popperConfig === 'function' ? popperConfig(defaultPopperConfig) : popperConfig));
     useEffect(function () {
         if (visible) {
             handleShow();
@@ -51,7 +37,7 @@ var CTooltip = forwardRef(function (_a, ref) {
     }, [visible]);
     useEffect(function () {
         if (mounted && togglerRef.current && tooltipRef.current) {
-            initPopper(togglerRef.current, tooltipRef.current, popperConfig);
+            initPopper(togglerRef.current, tooltipRef.current, computedPopperConfig);
             setTimeout(function () {
                 setVisible(true);
             }, _delay.show);
@@ -121,6 +107,7 @@ CTooltip.propTypes = {
     onHide: PropTypes.func,
     onShow: PropTypes.func,
     placement: PropTypes.oneOf(['auto', 'top', 'right', 'bottom', 'left']),
+    popperConfig: PropTypes.oneOfType([PropTypes.func, PropTypes.object]),
     trigger: triggerPropType,
     visible: PropTypes.bool,
 };

package/dist/esm/components/tooltip/CTooltip.js.map

@@ -1 +1 @@
-{"version":3,"file":"CTooltip.js","sources":["../../../../src/components/tooltip/CTooltip.tsx"],"sourcesContent":[null],"names":[],"mappings":";;;;;;;;;;;IA+Ea,QAAQ,GAAG,UAAU,CAChC,UACE,EAeC,EACD,GAAG,EAAA;AAfD,IAAA,IAAA,QAAQ,GAAA,EAAA,CAAA,QAAA,EACR,EAAgB,GAAA,EAAA,CAAA,SAAA,EAAhB,SAAS,GAAG,EAAA,KAAA,KAAA,CAAA,GAAA,IAAI,GAAA,EAAA,EAChB,SAAS,GAAA,EAAA,CAAA,SAAA,EACT,SAAS,GAAA,EAAA,CAAA,SAAA,EACT,OAAO,GAAA,EAAA,CAAA,OAAA,EACP,EAAS,GAAA,EAAA,CAAA,KAAA,EAAT,KAAK,GAAG,EAAA,KAAA,KAAA,CAAA,GAAA,CAAC,KAAA,EACT,EAAA,GAAA,EAAA,CAAA,kBAAuD,EAAvD,kBAAkB,GAAA,EAAA,KAAA,KAAA,CAAA,GAAG,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,CAAC,GAAA,EAAA,EACvD,EAAe,GAAA,EAAA,CAAA,MAAA,EAAf,MAAM,GAAG,EAAA,KAAA,KAAA,CAAA,GAAA,CAAC,CAAC,EAAE,CAAC,CAAC,GAAA,EAAA,EACf,MAAM,YAAA,EACN,MAAM,YAAA,EACN,EAAA,GAAA,EAAA,CAAA,SAAiB,EAAjB,SAAS,GAAA,EAAA,KAAA,KAAA,CAAA,GAAG,KAAK,GAAA,EAAA,EACjB,EAA4B,GAAA,EAAA,CAAA,OAAA,EAA5B,OAAO,GAAG,EAAA,KAAA,KAAA,CAAA,GAAA,CAAC,OAAO,EAAE,OAAO,CAAC,GAAA,EAAA,EAC5B,OAAO,GAAA,EAAA,CAAA,OAAA,EACJ,IAAI,GAAA,MAAA,CAAA,EAAA,EAdT,8JAeC,CADQ;AAIT,IAAA,IAAM,UAAU,GAAG,MAAM,CAAiB,IAAI,CAAC;AAC/C,IAAA,IAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC;IAC/B,IAAM,SAAS,GAAG,YAAY,CAAC,GAAG,EAAE,UAAU,CAAC;AAE/C,IAAA,IAAM,EAAE,GAAG,SAAA,CAAA,MAAA,CAAU,KAAK,EAAE,CAAE;IACxB,IAAA,EAAA,GAAwB,QAAQ,CAAC,KAAK,CAAC,EAAtC,OAAO,GAAA,EAAA,CAAA,CAAA,CAAA,EAAE,UAAU,GAAA,EAAA,CAAA,CAAA,CAAmB;IACvC,IAAA,EAAA,GAAyB,QAAQ,CAAC,OAAO,CAAC,EAAzC,QAAQ,GAAA,EAAA,CAAA,CAAA,CAAA,EAAE,UAAU,GAAA,EAAA,CAAA,CAAA,CAAqB;AAE1C,IAAA,IAAA,EAA8C,GAAA,SAAS,EAAE,EAAvD,UAAU,GAAA,EAAA,CAAA,UAAA,EAAE,aAAa,GAAA,EAAA,CAAA,aAAA,EAAE,YAAY,GAAA,EAAA,CAAA,YAAgB;IAE/D,IAAM,MAAM,GAAG,OAAO,KAAK,KAAK,QAAQ,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,KAAK;AAE/E,IAAA,IAAM,YAAY,GAAG;AACnB,QAAA,SAAS,EAAE;AACT,YAAA;AACE,gBAAA,IAAI,EAAE,OAAO;AACb,gBAAA,OAAO,EAAE;AACP,oBAAA,OAAO,EAAE,gBAAgB;AAC1B,iBAAA;AACF,aAAA;AACD,YAAA;AACE,gBAAA,IAAI,EAAE,MAAM;AACZ,gBAAA,OAAO,EAAE;AACP,oBAAA,kBAAkB,EAAE,kBAAkB;AACvC,iBAAA;AACF,aAAA;AACD,YAAA;AACE,gBAAA,IAAI,EAAE,QAAQ;AACd,gBAAA,OAAO,EAAE;AACP,oBAAA,MAAM,EAAE,MAAM;AACf,iBAAA;AACF,aAAA;AACF,SAAA;QACD,SAAS,EAAE,eAAe,CAAC,SAAS,EAAE,UAAU,CAAC,OAAO,CAAC;KAC1D;AAED,IAAA,SAAS,CAAC,YAAA;QACR,IAAI,OAAO,EAAE;AACX,YAAA,UAAU,EAAE;YACZ;;AAGF,QAAA,UAAU,EAAE;AACd,KAAC,EAAE,CAAC,OAAO,CAAC,CAAC;AAEb,IAAA,SAAS,CAAC,YAAA;QACR,IAAI,OAAO,IAAI,UAAU,CAAC,OAAO,IAAI,UAAU,CAAC,OAAO,EAAE;YACvD,UAAU,CAAC,UAAU,CAAC,OAAO,EAAE,UAAU,CAAC,OAAO,EAAE,YAAY,CAAC;AAChE,YAAA,UAAU,CAAC,YAAA;gBACT,UAAU,CAAC,IAAI,CAAC;AAClB,aAAC,EAAE,MAAM,CAAC,IAAI,CAAC;YAEf;;QAGF,IAAI,CAAC,OAAO,IAAI,UAAU,CAAC,OAAO,IAAI,UAAU,CAAC,OAAO,EAAE;AACxD,YAAA,aAAa,EAAE;;AAEnB,KAAC,EAAE,CAAC,OAAO,CAAC,CAAC;AAEb,IAAA,SAAS,CAAC,YAAA;QACR,IAAI,CAAC,QAAQ,IAAI,UAAU,CAAC,OAAO,IAAI,UAAU,CAAC,OAAO,EAAE;AACzD,YAAA,sBAAsB,CAAC,YAAA;gBACrB,UAAU,CAAC,KAAK,CAAC;AACnB,aAAC,EAAE,UAAU,CAAC,OAAO,CAAC;;AAE1B,KAAC,EAAE,CAAC,QAAQ,CAAC,CAAC;AAEd,IAAA,IAAM,UAAU,GAAG,YAAA;QACjB,UAAU,CAAC,IAAI,CAAC;QAChB,IAAI,MAAM,EAAE;AACV,YAAA,MAAM,EAAE;;AAEZ,KAAC;AAED,IAAA,IAAM,UAAU,GAAG,YAAA;AACjB,QAAA,UAAU,CAAC,YAAA;YACT,UAAU,CAAC,KAAK,CAAC;YACjB,IAAI,MAAM,EAAE;AACV,gBAAA,MAAM,EAAE;;AAEZ,SAAC,EAAE,MAAM,CAAC,IAAI,CAAC;AACjB,KAAC;AAED,IAAA,SAAS,CAAC,YAAA;AACR,QAAA,YAAY,EAAE;AAChB,KAAC,EAAE,CAAC,OAAO,CAAC,CAAC;AAEb,IAAA,QACE,KAAA,CAAA,aAAA,CAAA,KAAA,CAAA,QAAA,EAAA,IAAA;AACG,QAAA,KAAK,CAAC,YAAY,CAAC,QAAmC,EAClD,QAAA,CAAA,QAAA,CAAA,QAAA,CAAA,QAAA,CAAA,QAAA,CAAA,EAAA,GAAC,QAAQ,IAAI;AACd,YAAA,kBAAkB,EAAE,EAAE;AACvB,SAAA,MACD,GAAG,EAAE,UAAU,EACZ,CAAA,GAAC,CAAC,OAAO,KAAK,OAAO,IAAI,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK;AACxD,YAAA,OAAO,EAAE,YAAM,EAAA,QAAC,QAAQ,GAAG,UAAU,EAAE,GAAG,UAAU,EAAE,IAAC;AACxD,SAAA,EACE,GAAC,CAAC,OAAO,KAAK,OAAO,IAAI,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK;AACxD,YAAA,OAAO,EAAE,YAAM,EAAA,OAAA,UAAU,EAAE,GAAA;AAC3B,YAAA,MAAM,EAAE,YAAM,EAAA,OAAA,UAAU,EAAE,GAAA;AAC3B,SAAA,EACE,GAAC,CAAC,OAAO,KAAK,OAAO,IAAI,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK;AACxD,YAAA,YAAY,EAAE,YAAM,EAAA,OAAA,UAAU,EAAE,GAAA;AAChC,YAAA,YAAY,EAAE,YAAM,EAAA,OAAA,UAAU,EAAE,GAAA;AACjC,SAAA,EACD,CAAA;QACF,KAAC,CAAA,aAAA,CAAA,kBAAkB,IAAC,SAAS,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,EAAA,EACnD,OAAO,KACN,sCACE,SAAS,EAAE,UAAU,CACnB,SAAS,EACT,iBAAiB,EACjB;AACE,gBAAA,IAAI,EAAE,SAAS;AACf,gBAAA,IAAI,EAAE,QAAQ;AACf,aAAA,EACD,SAAS,CACV,EACD,EAAE,EAAE,EAAE,EACN,GAAG,EAAE,SAAS,EACd,IAAI,EAAC,SAAS,IACV,IAAI,CAAA;YAER,KAAK,CAAA,aAAA,CAAA,KAAA,EAAA,EAAA,SAAS,EAAC,eAAe,EAAO,CAAA;YACrC,KAAK,CAAA,aAAA,CAAA,KAAA,EAAA,EAAA,SAAS,EAAC,eAAe,EAAE,EAAA,OAAO,CAAO,CAC1C,CACP,CACkB,CACpB;AAEP,CAAC;AAGH,QAAQ,CAAC,SAAS,GAAG;IACnB,SAAS,EAAE,SAAS,CAAC,IAAI;IACzB,QAAQ,EAAE,SAAS,CAAC,IAAI;IACxB,SAAS,EAAE,SAAS,CAAC,GAAG;AACxB,IAAA,OAAO,EAAE,SAAS,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,MAAM,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC;AAChE,IAAA,KAAK,EAAE,SAAS,CAAC,SAAS,CAAC;AACzB,QAAA,SAAS,CAAC,MAAM;QAChB,SAAS,CAAC,KAAK,CAAC;AACd,YAAA,IAAI,EAAE,SAAS,CAAC,MAAM,CAAC,UAAU;AACjC,YAAA,IAAI,EAAE,SAAS,CAAC,MAAM,CAAC,UAAU;SAClC,CAAC;KACH,CAAC;AACF,IAAA,kBAAkB,EAAE,0BAA0B;AAC9C,IAAA,MAAM,EAAE,SAAS,CAAC,GAAG;IACrB,MAAM,EAAE,SAAS,CAAC,IAAI;IACtB,MAAM,EAAE,SAAS,CAAC,IAAI;AACtB,IAAA,SAAS,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;AACtE,IAAA,OAAO,EAAE,eAAe;IACxB,OAAO,EAAE,SAAS,CAAC,IAAI;CACxB;AAED,QAAQ,CAAC,WAAW,GAAG,UAAU;;;;"}
+{"version":3,"file":"CTooltip.js","sources":["../../../../src/components/tooltip/CTooltip.tsx"],"sourcesContent":[null],"names":[],"mappings":";;;;;;;;;;;IA+Ia,QAAQ,GAAG,UAAU,CAChC,UACE,EAgBC,EACD,GAAG,EAAA;AAhBD,IAAA,IAAA,QAAQ,GAAA,EAAA,CAAA,QAAA,EACR,iBAAgB,EAAhB,SAAS,mBAAG,IAAI,GAAA,EAAA,EAChB,SAAS,eAAA,EACT,SAAS,eAAA,EACT,OAAO,aAAA,EACP,EAAA,GAAA,EAAA,CAAA,KAAS,EAAT,KAAK,mBAAG,CAAC,GAAA,EAAA,EACT,EAAuD,GAAA,EAAA,CAAA,kBAAA,EAAvD,kBAAkB,GAAG,EAAA,KAAA,KAAA,CAAA,GAAA,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,CAAC,KAAA,EACvD,EAAA,GAAA,EAAA,CAAA,MAAe,EAAf,MAAM,mBAAG,CAAC,CAAC,EAAE,CAAC,CAAC,KAAA,EACf,MAAM,GAAA,EAAA,CAAA,MAAA,EACN,MAAM,GAAA,EAAA,CAAA,MAAA,EACN,iBAAiB,EAAjB,SAAS,mBAAG,KAAK,GAAA,EAAA,EACjB,YAAY,kBAAA,EACZ,EAAA,GAAA,EAAA,CAAA,OAA4B,EAA5B,OAAO,GAAA,EAAA,KAAA,KAAA,CAAA,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,GAAA,EAAA,EAC5B,OAAO,GAAA,EAAA,CAAA,OAAA,EACJ,IAAI,GAAA,MAAA,CAAA,EAAA,EAfT,8KAgBC,CADQ;AAIT,IAAA,IAAM,UAAU,GAAG,MAAM,CAAiB,IAAI,CAAC;AAC/C,IAAA,IAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC;IAC/B,IAAM,SAAS,GAAG,YAAY,CAAC,GAAG,EAAE,UAAU,CAAC;AAE/C,IAAA,IAAM,EAAE,GAAG,SAAA,CAAA,MAAA,CAAU,KAAK,EAAE,CAAE;IACxB,IAAA,EAAA,GAAwB,QAAQ,CAAC,KAAK,CAAC,EAAtC,OAAO,GAAA,EAAA,CAAA,CAAA,CAAA,EAAE,UAAU,GAAA,EAAA,CAAA,CAAA,CAAmB;IACvC,IAAA,EAAA,GAAyB,QAAQ,CAAC,OAAO,CAAC,EAAzC,QAAQ,GAAA,EAAA,CAAA,CAAA,CAAA,EAAE,UAAU,GAAA,EAAA,CAAA,CAAA,CAAqB;AAE1C,IAAA,IAAA,EAA8C,GAAA,SAAS,EAAE,EAAvD,UAAU,GAAA,EAAA,CAAA,UAAA,EAAE,aAAa,GAAA,EAAA,CAAA,aAAA,EAAE,YAAY,GAAA,EAAA,CAAA,YAAgB;IAE/D,IAAM,MAAM,GAAG,OAAO,KAAK,KAAK,QAAQ,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,KAAK;AAE/E,IAAA,IAAM,mBAAmB,GAAqB;AAC5C,QAAA,SAAS,EAAE;YACT,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,OAAO,EAAE,gBAAgB,EAAE,EAAE;YACzD,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,kBAAkB,EAAA,kBAAA,EAAE,EAAE;YACjD,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,EAAE,MAAM,EAAA,MAAA,EAAE,EAAE;AACxC,SAAA;QACD,SAAS,EAAE,eAAe,CAAC,SAAS,EAAE,UAAU,CAAC,OAAO,CAAC;KAC1D;IAED,IAAM,oBAAoB,yBACrB,mBAAmB,CAAA,GAClB,OAAO,YAAY,KAAK,UAAU,GAAG,YAAY,CAAC,mBAAmB,CAAC,GAAG,YAAY,EAC1F;AAED,IAAA,SAAS,CAAC,YAAA;QACR,IAAI,OAAO,EAAE;AACX,YAAA,UAAU,EAAE;YACZ;;AAGF,QAAA,UAAU,EAAE;AACd,KAAC,EAAE,CAAC,OAAO,CAAC,CAAC;AAEb,IAAA,SAAS,CAAC,YAAA;QACR,IAAI,OAAO,IAAI,UAAU,CAAC,OAAO,IAAI,UAAU,CAAC,OAAO,EAAE;YACvD,UAAU,CAAC,UAAU,CAAC,OAAO,EAAE,UAAU,CAAC,OAAO,EAAE,oBAAoB,CAAC;AACxE,YAAA,UAAU,CAAC,YAAA;gBACT,UAAU,CAAC,IAAI,CAAC;AAClB,aAAC,EAAE,MAAM,CAAC,IAAI,CAAC;YAEf;;QAGF,IAAI,CAAC,OAAO,IAAI,UAAU,CAAC,OAAO,IAAI,UAAU,CAAC,OAAO,EAAE;AACxD,YAAA,aAAa,EAAE;;AAEnB,KAAC,EAAE,CAAC,OAAO,CAAC,CAAC;AAEb,IAAA,SAAS,CAAC,YAAA;QACR,IAAI,CAAC,QAAQ,IAAI,UAAU,CAAC,OAAO,IAAI,UAAU,CAAC,OAAO,EAAE;AACzD,YAAA,sBAAsB,CAAC,YAAA;gBACrB,UAAU,CAAC,KAAK,CAAC;AACnB,aAAC,EAAE,UAAU,CAAC,OAAO,CAAC;;AAE1B,KAAC,EAAE,CAAC,QAAQ,CAAC,CAAC;AAEd,IAAA,IAAM,UAAU,GAAG,YAAA;QACjB,UAAU,CAAC,IAAI,CAAC;QAChB,IAAI,MAAM,EAAE;AACV,YAAA,MAAM,EAAE;;AAEZ,KAAC;AAED,IAAA,IAAM,UAAU,GAAG,YAAA;AACjB,QAAA,UAAU,CAAC,YAAA;YACT,UAAU,CAAC,KAAK,CAAC;YACjB,IAAI,MAAM,EAAE;AACV,gBAAA,MAAM,EAAE;;AAEZ,SAAC,EAAE,MAAM,CAAC,IAAI,CAAC;AACjB,KAAC;AAED,IAAA,SAAS,CAAC,YAAA;AACR,QAAA,YAAY,EAAE;AAChB,KAAC,EAAE,CAAC,OAAO,CAAC,CAAC;AAEb,IAAA,QACE,KAAA,CAAA,aAAA,CAAA,KAAA,CAAA,QAAA,EAAA,IAAA;AACG,QAAA,KAAK,CAAC,YAAY,CAAC,QAAmC,EAClD,QAAA,CAAA,QAAA,CAAA,QAAA,CAAA,QAAA,CAAA,QAAA,CAAA,EAAA,GAAC,QAAQ,IAAI;AACd,YAAA,kBAAkB,EAAE,EAAE;AACvB,SAAA,MACD,GAAG,EAAE,UAAU,EACZ,CAAA,GAAC,CAAC,OAAO,KAAK,OAAO,IAAI,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK;AACxD,YAAA,OAAO,EAAE,YAAM,EAAA,QAAC,QAAQ,GAAG,UAAU,EAAE,GAAG,UAAU,EAAE,IAAC;AACxD,SAAA,EACE,GAAC,CAAC,OAAO,KAAK,OAAO,IAAI,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK;AACxD,YAAA,OAAO,EAAE,YAAM,EAAA,OAAA,UAAU,EAAE,GAAA;AAC3B,YAAA,MAAM,EAAE,YAAM,EAAA,OAAA,UAAU,EAAE,GAAA;AAC3B,SAAA,EACE,GAAC,CAAC,OAAO,KAAK,OAAO,IAAI,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK;AACxD,YAAA,YAAY,EAAE,YAAM,EAAA,OAAA,UAAU,EAAE,GAAA;AAChC,YAAA,YAAY,EAAE,YAAM,EAAA,OAAA,UAAU,EAAE,GAAA;AACjC,SAAA,EACD,CAAA;QACF,KAAC,CAAA,aAAA,CAAA,kBAAkB,IAAC,SAAS,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,EAAA,EACnD,OAAO,KACN,sCACE,SAAS,EAAE,UAAU,CACnB,SAAS,EACT,iBAAiB,EACjB;AACE,gBAAA,IAAI,EAAE,SAAS;AACf,gBAAA,IAAI,EAAE,QAAQ;AACf,aAAA,EACD,SAAS,CACV,EACD,EAAE,EAAE,EAAE,EACN,GAAG,EAAE,SAAS,EACd,IAAI,EAAC,SAAS,IACV,IAAI,CAAA;YAER,KAAK,CAAA,aAAA,CAAA,KAAA,EAAA,EAAA,SAAS,EAAC,eAAe,EAAO,CAAA;YACrC,KAAK,CAAA,aAAA,CAAA,KAAA,EAAA,EAAA,SAAS,EAAC,eAAe,EAAE,EAAA,OAAO,CAAO,CAC1C,CACP,CACkB,CACpB;AAEP,CAAC;AAGH,QAAQ,CAAC,SAAS,GAAG;IACnB,SAAS,EAAE,SAAS,CAAC,IAAI;IACzB,QAAQ,EAAE,SAAS,CAAC,IAAI;IACxB,SAAS,EAAE,SAAS,CAAC,GAAG;AACxB,IAAA,OAAO,EAAE,SAAS,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,MAAM,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC;AAChE,IAAA,KAAK,EAAE,SAAS,CAAC,SAAS,CAAC;AACzB,QAAA,SAAS,CAAC,MAAM;QAChB,SAAS,CAAC,KAAK,CAAC;AACd,YAAA,IAAI,EAAE,SAAS,CAAC,MAAM,CAAC,UAAU;AACjC,YAAA,IAAI,EAAE,SAAS,CAAC,MAAM,CAAC,UAAU;SAClC,CAAC;KACH,CAAC;AACF,IAAA,kBAAkB,EAAE,0BAA0B;AAC9C,IAAA,MAAM,EAAE,SAAS,CAAC,GAAG;IACrB,MAAM,EAAE,SAAS,CAAC,IAAI;IACtB,MAAM,EAAE,SAAS,CAAC,IAAI;AACtB,IAAA,SAAS,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;AACtE,IAAA,YAAY,EAAE,SAAS,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC;AACrE,IAAA,OAAO,EAAE,eAAe;IACxB,OAAO,EAAE,SAAS,CAAC,IAAI;CACxB;AAED,QAAQ,CAAC,WAAW,GAAG,UAAU;;;;"}

package/dist/esm/hooks/index.d.ts

@@ -1,3 +1,4 @@
+import { useClipboard } from './useClipboard';
 import { useColorModes } from './useColorModes';
 import { useDebounce } from './useDebounce';
 import { useDebouncedCallback } from './useDebouncedCallback';
@@ -6,4 +7,4 @@ import { useForkedRef } from './useForkedRef';
 import { useIsVisible } from './useIsVisible';
 import { usePopper } from './usePopper';
 import { useStateWithCallback } from './useStateWithCallback';
-export { useColorModes, useDebounce, useDebouncedCallback, useDropdownWithPopper, useForkedRef, useIsVisible, usePopper, useStateWithCallback, };
+export { useClipboard, useColorModes, useDebounce, useDebouncedCallback, useDropdownWithPopper, useForkedRef, useIsVisible, usePopper, useStateWithCallback, };

package/dist/esm/hooks/useClipboard.d.ts

@@ -0,0 +1,12 @@
+/**
+ * useClipboard Hook
+ *
+ * Provides functionality to copy text to the clipboard and track the copy status.
+ *
+ * @returns An object containing the copy function, copy status, and any error encountered.
+ */
+export declare const useClipboard: () => {
+    copy: (text: string) => Promise<void>;
+    isCopied: boolean;
+    error: Error | null;
+};

package/dist/esm/hooks/useClipboard.js

@@ -0,0 +1,52 @@
+import { __awaiter, __generator } from '../node_modules/tslib/tslib.es6.js';
+import { useState, useCallback } from 'react';
+
+/**
+ * useClipboard Hook
+ *
+ * Provides functionality to copy text to the clipboard and track the copy status.
+ *
+ * @returns An object containing the copy function, copy status, and any error encountered.
+ */
+var useClipboard = function () {
+    var _a = useState(false), isCopied = _a[0], setIsCopied = _a[1];
+    var _b = useState(null), error = _b[0], setError = _b[1];
+    /**
+     * Copies the provided text to the clipboard.
+     *
+     * @param text - The text to be copied to the clipboard.
+     */
+    var copy = useCallback(function (text) { return __awaiter(void 0, void 0, void 0, function () {
+        var _error_1;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    if (!(navigator === null || navigator === void 0 ? void 0 : navigator.clipboard)) {
+                        setError(new Error('Clipboard API is not available'));
+                        return [2 /*return*/];
+                    }
+                    _a.label = 1;
+                case 1:
+                    _a.trys.push([1, 3, , 4]);
+                    return [4 /*yield*/, navigator.clipboard.writeText(text)];
+                case 2:
+                    _a.sent();
+                    setIsCopied(true);
+                    setError(null);
+                    // Reset the isCopied state after 2 seconds
+                    setTimeout(function () { return setIsCopied(false); }, 2000);
+                    return [3 /*break*/, 4];
+                case 3:
+                    _error_1 = _a.sent();
+                    setError(_error_1);
+                    setIsCopied(false);
+                    return [3 /*break*/, 4];
+                case 4: return [2 /*return*/];
+            }
+        });
+    }); }, []);
+    return { copy: copy, isCopied: isCopied, error: error };
+};
+
+export { useClipboard };
+//# sourceMappingURL=useClipboard.js.map

package/dist/esm/hooks/useClipboard.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useClipboard.js","sources":["../../../src/hooks/useClipboard.ts"],"sourcesContent":[null],"names":[],"mappings":";;;AAEA;;;;;;AAMG;AACU,IAAA,YAAY,GAAG,YAAA;IACpB,IAAA,EAAA,GAA0B,QAAQ,CAAU,KAAK,CAAC,EAAjD,QAAQ,GAAA,EAAA,CAAA,CAAA,CAAA,EAAE,WAAW,GAAA,EAAA,CAAA,CAAA,CAA4B;IAClD,IAAA,EAAA,GAAoB,QAAQ,CAAe,IAAI,CAAC,EAA/C,KAAK,GAAA,EAAA,CAAA,CAAA,CAAA,EAAE,QAAQ,GAAA,EAAA,CAAA,CAAA,CAAgC;AAEtD;;;;AAIG;AACH,IAAA,IAAM,IAAI,GAAG,WAAW,CAAC,UAAO,IAAY,EAAA,EAAA,OAAA,SAAA,CAAA,KAAA,CAAA,EAAA,KAAA,CAAA,EAAA,KAAA,CAAA,EAAA,YAAA;;;;;oBAC1C,IAAI,EAAC,SAAS,KAAT,IAAA,IAAA,SAAS,KAAT,KAAA,CAAA,GAAA,KAAA,CAAA,GAAA,SAAS,CAAE,SAAS,CAAA,EAAE;AACzB,wBAAA,QAAQ,CAAC,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;wBACrD,OAAM,CAAA,CAAA,YAAA;;;;;oBAIN,OAAM,CAAA,CAAA,YAAA,SAAS,CAAC,SAAS,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;;AAAzC,oBAAA,EAAA,CAAA,IAAA,EAAyC;oBACzC,WAAW,CAAC,IAAI,CAAC;oBACjB,QAAQ,CAAC,IAAI,CAAC;;AAEd,oBAAA,UAAU,CAAC,YAAA,EAAM,OAAA,WAAW,CAAC,KAAK,CAAC,CAAA,EAAA,EAAE,IAAI,CAAC;;;;oBAE1C,QAAQ,CAAC,QAAe,CAAC;oBACzB,WAAW,CAAC,KAAK,CAAC;;;;;SAErB,EAAE,EAAE,CAAC;IAEN,OAAO,EAAE,IAAI,EAAA,IAAA,EAAE,QAAQ,UAAA,EAAE,KAAK,EAAA,KAAA,EAAE;AAClC;;;;"}

package/dist/esm/index.js

@@ -142,6 +142,7 @@ export { CWidgetStatsC } from './components/widgets/CWidgetStatsC.js';
 export { CWidgetStatsD } from './components/widgets/CWidgetStatsD.js';
 export { CWidgetStatsE } from './components/widgets/CWidgetStatsE.js';
 export { CWidgetStatsF } from './components/widgets/CWidgetStatsF.js';
+export { useClipboard } from './hooks/useClipboard.js';
 export { useColorModes } from './hooks/useColorModes.js';
 export { useDebounce } from './hooks/useDebounce.js';
 export { useDebouncedCallback } from './hooks/useDebouncedCallback.js';

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/dist/esm/node_modules/react-device-detect/dist/lib.js

@@ -131,7 +131,7 @@ function requireLib () {
 	}
 
 	function _createClass(Constructor, protoProps, staticProps) {
-	  if (protoProps) _defineProperties(Constructor.prototype, protoProps);
+	  _defineProperties(Constructor.prototype, protoProps);
 	  return Constructor;
 	}