@muraldevkit/ui-toolkit 4.35.0 → 4.35.1-dev-yPbC.2

package/dist/components/tooltip/MrlTooltipContent/MrlTooltipContent.d.ts

@@ -1,43 +0,0 @@
-import * as React from 'react';
-import { AttrsObject } from '../../../utils';
-import { MrlTooltipAnchor, MrlTooltipPosition, MrlTooltipVariant } from '../constants';
-import './MrlTooltipContent.global.scss';
-interface MrlTooltipContentProps {
-    /**
-     * The arrow position of the tooltip in relation to its trigger's content.
-     * Note, if the content is shorter than the width of the trigger, always use
-     * "center" to ensure the arrow does not become misaligned.
-     */
-    anchor: MrlTooltipAnchor;
-    /**
-     * Attributes that are applied to the component during the initial render.
-     *
-     * Example usage: html attributes, custom data attributes (data-qa), aria
-     *
-     * @deprecated please use props for component instead
-     */
-    attrs: AttrsObject;
-    /** dataQa attribute for tooltip */
-    dataQa?: string;
-    /** The kind of tooltip to be rendered */
-    kind: MrlTooltipVariant;
-    /** The id of the tooltip used for aria-describedby in the parent component */
-    id?: string;
-    /** The placement of the tooltip in relation to its trigger */
-    position: MrlTooltipPosition;
-    /** The tooltip content to display */
-    text: string;
-    /** A class to be applied ot the tooltip content */
-    tooltipContentClass?: string;
-}
-/**
- * MrlTooltipContent Component
- *
- * The tooltip content is the text that is displayed when the user hovers over the trigger.
- * IMPORTANT: This component is not intended to be used directly, it should always be a child of MrlTooltip.
- *
- * @param {MrlTooltipContentProps} props - the props of the tooltip content
- * @returns {HTMLElement} a configured Tooltip Content component
- */
-export declare const MrlTooltipContent: (props: MrlTooltipContentProps) => React.ReactElement;
-export {};

package/dist/components/tooltip/MrlTooltipContent/index.d.ts

@@ -1 +0,0 @@
-export { MrlTooltipContent } from './MrlTooltipContent';

package/dist/components/tooltip/constants.d.ts

@@ -1,25 +0,0 @@
-import { AttrsObject } from '../../utils';
-/**
- * Defines all the values allowed for tooltip props.
- * Used for Storybook and testing
- */
-export declare const allowedMrlTooltipValues: {
-    anchors: readonly ["start", "center", "end"];
-    positions: readonly ["top", "bottom", "left", "right"];
-    state: readonly ["show", "hide"];
-};
-export type MrlTooltipPosition = (typeof allowedMrlTooltipValues.positions)[number];
-export type MrlTooltipAnchor = (typeof allowedMrlTooltipValues.anchors)[number];
-export type MrlTooltipState = (typeof allowedMrlTooltipValues.state)[number];
-export interface MrlTooltipDefaults {
-    anchor: MrlTooltipAnchor;
-    attrs: AttrsObject;
-    position: MrlTooltipPosition;
-    state: MrlTooltipState;
-}
-/**
- * Default values for props on the Tooltip component;
- * Shared between the component and Storybook
- */
-export declare const MrlTooltipDefaults: MrlTooltipDefaults;
-export type MrlTooltipVariant = 'default' | 'inverse';

package/dist/components/tooltip/index.d.ts

@@ -1,2 +0,0 @@
-export * from './MrlTooltip';
-export * from './constants';

package/dist/components/tooltip/utils.d.ts

@@ -1,9 +0,0 @@
-/**
- * Currying function to combine handlers from the parent and child components
- *
- * @template T - The type of the event handlers.
- * @param {T | undefined} ogFunc - The original event handler. This parameter can be undefined.
- * @param {T} newFunc - The new event handler.
- * @returns {T} A function that, when invoked, calls both the original event handler (if it exists) and the new event handler.
- */
-export declare const curryHandlers: <T extends (...args: any[]) => void>(ogFunc: T | undefined, newFunc: T) => T;

package/dist/contexts/MrlTabContext/MrlTabContext.d.ts

@@ -1,6 +0,0 @@
-import { Dispatch, SetStateAction } from 'react';
-export type MrlTabContextProps = {
-    activeTab: string;
-    setActiveTab: Dispatch<SetStateAction<string>>;
-};
-export declare const MrlTabContext: import("react").Context<MrlTabContextProps>;

package/dist/contexts/MrlTabContext/index.d.ts

@@ -1 +0,0 @@
-export * from './MrlTabContext';

package/dist/contexts/index.d.ts

@@ -1 +0,0 @@
-export * from './MrlTabContext';

package/dist/hooks/index.d.ts

@@ -1,3 +0,0 @@
-export * from './useCoordinate';
-export * from './useBreakpoint';
-export * from './useElementDimensions';

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

@@ -1 +0,0 @@
-export * from './useAutoClose';

package/dist/hooks/useAutoClose/useAutoClose.d.ts

@@ -1,11 +0,0 @@
-import * as React from 'react';
-export type useAutoClose = (shouldAutoClose?: boolean, closeAfterMs?: number, onClose?: () => unknown) => [boolean, React.Dispatch<React.SetStateAction<boolean>>];
-/**
- * Hook that exposes a piece of state that allows components to close themselves after a delay
- *
- * @param shouldAutoClose - When false prevents automated close (e.g. can be used to prevent auto-dismissal of interactive elements, an accessibility anti-pattern)
- * @param closeAfterMs - Delay in milliseconds before the component closes
- * @param onClose - Callback to be called when component closes
- * @returns [closed, setClosed] - a boolean tracking closed state, and a setter for that same state
- */
-export declare const useAutoClose: useAutoClose;

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

@@ -1,15 +0,0 @@
-type Breakpoints = {
-    xs: number;
-    sm: number;
-    md: number;
-    lg: number;
-    xl: number;
-    xxl: number;
-};
-/**
- * React Hook to return the current breakpoint
- *
- * @returns {keyof Breakpoints} - the current breakpoint
- */
-export declare const useBreakpoint: () => keyof Breakpoints;
-export default useBreakpoint;

package/dist/hooks/useBreakpoint/useBreakpointDemo.d.ts

@@ -1,7 +0,0 @@
-/// <reference types="react" />
-/**
- * Demo for useBreakpoint hook
- *
- * @returns JSX.Element
- */
-export declare const UseBreakpointDemo: () => JSX.Element;

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

@@ -1,11 +0,0 @@
-/**
- * Hook to detect clicks outside of a given DOM element, with an optional exclusion for selectors.
- *
- * @param menuRef - Reference to the DOM element to detect outside clicks for.
- * @param triggerRef - Reference to the DOM element that caused this menu to be shown.
- * @param eventType - Event type to listen for.
- * @param onOutsideClick - Function to call when a click is detected outside the menuRef element.
- * @param disabled - If the hook should be disabled.
- * @param excludeSelectors - Optional array of CSS selectors to exclude from the outside click detection.
- */
-export declare const useClickOutside: (menuRef: React.RefObject<HTMLElement>, triggerRef: React.RefObject<HTMLElement> | undefined, eventType: "click" | "mousedown" | "mouseup" | undefined, onOutsideClick: () => void, disabled?: boolean, excludeSelectors?: string[]) => void;

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

@@ -1,18 +0,0 @@
-/**
- * get coordinates of an element relative to window and listen for changes.
- *
- * @param element element of type T
- * @param disabledScrollTracking boolean to disable scroll tracking.
- * @param openState boolean to track if the element's open state changed.
- * @returns coordinate object of element.
- */
-export declare const useCoordinate: <T extends HTMLElement | null>(element: T, disabledScrollTracking: boolean | undefined, openState: boolean) => {
-    bottom: number;
-    height: number;
-    left: number;
-    right: number;
-    top: number;
-    width: number;
-    x: number;
-    y: number;
-};

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

@@ -1,16 +0,0 @@
-import * as React from 'react';
-/**
- * Represents the dimensions of an element's border box.
- */
-export type ElementDimensions = {
-    height: number | null;
-    width: number | null;
-};
-/**
- * Calculates the dimensions of an element using the ResizeObserver API.
- *
- * @template T - The type of the element or HTMLElement.
- * @param ref - The ref object that references the element.
- * @returns {ElementDimensions} - The dimensions of the element.
- */
-export declare function useElementDimensions<T>(ref: React.RefObject<T extends HTMLElement ? T : HTMLElement>): ElementDimensions;

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

@@ -1,13 +0,0 @@
-import * as React from 'react';
-export type UseScrollbarInfoReturn<T extends HTMLElement> = {
-    hasScrollbar: boolean;
-    scrollableContainerRef: React.MutableRefObject<T | null>;
-    scrollbarWidth: number;
-};
-/**
- * Custom hook that provides information about the presence and width of scrollbars
- * in a scrollable container.
- *
- * @returns {UseScrollbarInfoReturn} The hasScrollbar and scrollbarWidth values.
- */
-export declare function useScrollbarInfo<T extends HTMLElement>(): UseScrollbarInfoReturn<T>;

package/dist/hooks/useTriggerPosition/constants.d.ts

@@ -1,10 +0,0 @@
-import { MenuPosition, MenuAlignment, CustomMenuPosition } from '../../components/menu/constants';
-export interface Alignment {
-    align: MenuAlignment;
-    position: MenuPosition;
-    customPosition?: CustomMenuPosition;
-}
-export interface Position {
-    top: number;
-    left: number;
-}

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

@@ -1,16 +0,0 @@
-import { RefObject } from 'react';
-import { Alignment, Position } from './constants';
-/**
- * useTriggerPosition hook.
- *
- * Calculates the position of a menu element based on the alignment settings relative to a trigger element.
- *
- * @param {RefObject<HTMLElement>} triggerRef - Reference to the DOM element that triggers the menu.
- * @param {RefObject<HTMLElement>} elementRef - Reference to the DOM element that is the menu.
- * @param {Alignment} menuAlign - The alignment configuration of the menu.
- * @param {boolean} isElementVisible - Tells the hook if the element is visible. If false, the hook will not calculate the position.
- * @param {number} menuOffset - The offset of the menu from the trigger element.
- * @param disable - Whether to disable the hook.
- * @returns {Position} The calculated position of the menu element.
- */
-export declare const useTriggerPosition: (triggerRef: RefObject<HTMLElement> | undefined, elementRef: RefObject<HTMLElement>, menuAlign: Alignment, isElementVisible?: boolean, menuOffset?: number, disable?: boolean) => Position;

package/dist/hooks/useTriggerPosition/utilities.d.ts

@@ -1,11 +0,0 @@
-import { Alignment, Position } from './constants';
-/**
- *  Calculates the position of the menu based on the alignment and offset
- *
- * @param menuAlign - the alignment of the menu
- * @param offset - the offset from the trigger
- * @param elementRect - the bounding client rect of the menu
- * @param triggerRect - the bounding client rect of the trigger
- * @returns - the position of the menu
- */
-export declare const calculatePosition: (menuAlign: Alignment, offset: number, elementRect: DOMRect, triggerRect?: DOMRect) => Position;

package/dist/index.d.ts

@@ -1,4 +0,0 @@
-export * from './components';
-export * from './utils';
-export * from './contexts';
-export * from './hooks';