@muraldevkit/ui-toolkit 4.45.1-dev-bdtT.1 → 4.45.2-dev-jOrv.1

package/dist/utils/checkInvalidAttributes/index.d.ts

@@ -1,7 +0,0 @@
-import { AttrsObject } from '../setAttributes';
-/**
- * Checks attrs object for invalid properties and provides a warning
- *
- * @param {AttrsObject} attrs - attrs object from a component
- */
-export declare const checkInvalidAttributes: (attrs: AttrsObject | undefined) => void;

package/dist/utils/commonProps/index.d.ts

@@ -1,20 +0,0 @@
-import { AttrsObject } from '../setAttributes';
-/**
- * These common props are used available on all UI Toolkit components.
- */
-export interface MrlComponentProps {
-    /**
-     * Applies additional HTML attributes to the `svg` element.
-     * When using in a framework wrapper (e.g., React), treat it as an object and don't stringify.
-     * Otherwise, the value object needs to be stringified to not receive `"[Object object]"`.
-     * Example: `attrs='{ "data-foo": "bar" }'`
-     *
-     * @deprecated - `attrs` will be removed in favor of using HTML Attributes directly on components. Please update your usage accordingly.
-     */
-    attrs?: AttrsObject;
-    /**
-     * A object of CSS properties. Please use style sparingly, and only in cases where your
-     * needs can not be met by passing a class to the component.
-     */
-    style?: Record<string, unknown>;
-}

package/dist/utils/dataQa/index.d.ts

@@ -1,6 +0,0 @@
-export interface DataQa {
-    /**
-     * optional data-qa attribute for testing purposes.
-     */
-    ['data-qa']?: string;
-}

package/dist/utils/findAdjacentInteractiveElement/findAdjacentInteractiveElement.d.ts

@@ -1,8 +0,0 @@
-/**
- * Find the interactive element immediately before or after a reference element
- *
- * @param ref - The reference element
- * @param direction - The direction to search in
- * @returns The interactive element or null if none is found
- */
-export declare const findAdjacentInteractiveElement: (ref: React.RefObject<HTMLElement> | undefined, direction?: 'next' | 'previous') => HTMLElement | null;

package/dist/utils/findAdjacentInteractiveElement/index.d.ts

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

package/dist/utils/frameDebounce/index.d.ts

@@ -1,22 +0,0 @@
-export interface FrameDebounceType {
-    debounce(callback: () => void): void;
-    cancel(): void;
-}
-/**
- * @description Creates a wrapper for request animation frame that helps a little with performance this helps us only animate current frame reducing in jumps/tearing on slow devices.
- */
-export declare const FrameDebounce: {
-    new (): {
-        frame: null | number;
-        /**
-         * debounce a callback wrapped in animation frame.
-         *
-         * @param callback callback to call after frame runs
-         */
-        debounce: (callback: () => void) => void;
-        /**
-         * cancel our frame.
-         */
-        cancel: () => void;
-    };
-};

package/dist/utils/getCamelCase/getCamelCase.d.ts

@@ -1,7 +0,0 @@
-/**
- * Takes a string and returns a camelCase version of the string
- *
- * @param {string} str - a string to set to camelCase
- * @returns {string} - a string with special characters spaces removed, where words after a space are Uppercase leading
- */
-export declare const getCamelCase: (str: string) => string;

package/dist/utils/getCamelCase/getCamelCase.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/utils/getCamelCase/index.d.ts

@@ -1,2 +0,0 @@
-import { getCamelCase } from './getCamelCase';
-export { getCamelCase };

package/dist/utils/getScrollableContainer/getScrollableContainer.d.ts

@@ -1,7 +0,0 @@
-/**
- * Get the scrollable container of an element
- *
- * @param element - the element you want to get the scrollable container of
- * @returns - the scrollable container
- */
-export declare const getScrollableContainer: (element: HTMLElement) => HTMLElement;

package/dist/utils/hasHorizontalScroll/hasHorizontalScroll.d.ts

@@ -1,11 +0,0 @@
-export type HasHorizontalScrollReturn = {
-    hasScrollLeft: boolean;
-    hasScrollRight: boolean;
-};
-/**
- * Test if an element has scrollable content in the horizontal axis
- *
- * @param element - the element that is scrollable
- * @returns - object with hasScrollLeft and hasScrollRight properties
- */
-export declare const hasHorizontalScroll: (element: HTMLElement) => HasHorizontalScrollReturn;

package/dist/utils/hasScrollContent/hasScrollContent.d.ts

@@ -1,11 +0,0 @@
-export type HasScrollContentReturn = {
-    hasScrollTop: boolean;
-    hasScrollBottom: boolean;
-};
-/**
- * Test if an element has scrollable content left
- *
- * @param {HTMLElement} element - the element you want to test
- * @returns {HasScrollContentReturn} - object with hasScrollTop and hasScrollBottom properties
- */
-export declare const hasScrollContent: (element: HTMLElement) => HasScrollContentReturn;

package/dist/utils/index.d.ts

@@ -1,11 +0,0 @@
-export * from './commonProps';
-export * from './findAdjacentInteractiveElement';
-export * from './getCamelCase';
-export * from './isImagePath';
-export * from './isImageUri';
-export * from './isObject';
-export * from './setAttributes';
-export * from './noop';
-export * from './preventDefault';
-export * from './trapFocus';
-export * from './layers';

package/dist/utils/isElementScrollable/index.d.ts

@@ -1,7 +0,0 @@
-/**
- * Test if an element is scrollable
- *
- * @param {HTMLElement} element - the element you want to test
- * @returns {boolean} - true if the element is scrollable, false if it is not scrollable
- */
-export declare const isElementScrollable: (element: HTMLElement) => boolean;

package/dist/utils/isImagePath/index.d.ts

@@ -1,7 +0,0 @@
-/**
- * Checks if a passed image string is a valid URL
- *
- * @param {string} image - the image string being tested
- * @returns {boolean} - if the image is an image URL
- */
-export declare const isImagePath: (image: string) => image is string;

package/dist/utils/isImageUri/index.d.ts

@@ -1,7 +0,0 @@
-/**
- * Checks if a passed image string is an image URI
- *
- * @param {string} image - the image string being tested
- * @returns {boolean} - if the image is an image URI
- */
-export declare const isImageUri: (image: string) => image is string;

package/dist/utils/isObject/index.d.ts

@@ -1,2 +0,0 @@
-import { Item, isObject } from "./isObject";
-export { type Item, isObject };

package/dist/utils/isObject/isObject.d.ts

@@ -1,14 +0,0 @@
-/**
- * Item is passed to the `isObject` function.
- * Since we want to be able to check if anything is an object, we allow
- * anything to be passed to the function.
- */
-export type Item = unknown;
-/**
- * Tests that a variable is actually an object and not an array  or null
- * which can mistakenly be flagged as an object
- *
- * @param {Item} item - variable to tests
- * @returns {boolean} - value if item is actually an Object
- */
-export declare const isObject: (item: Item) => boolean;

package/dist/utils/isObject/isObject.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/utils/isTouch/index.d.ts

@@ -1,6 +0,0 @@
-/**
- * Check if the device is a touch device
- *
- * @returns {boolean} - True if the device is a touch device
- */
-export declare const isTouchDevice: () => boolean;

package/dist/utils/layers/index.d.ts

@@ -1,48 +0,0 @@
-/**
- * References to the different portal layers
- */
-export declare const PORTAL_LAYERS: {
-    readonly ROOT: {
-        readonly name: "mrl-root-portal";
-        readonly zIndex: 50000;
-    };
-    readonly TOAST: {
-        readonly name: "mrl-toast-portal";
-        readonly zIndex: 50001;
-    };
-    readonly MENU: {
-        readonly name: "mrl-menu-portal";
-        readonly zIndex: 50002;
-    };
-    readonly POPOVER: {
-        readonly name: "mrl-popover-portal";
-        readonly zIndex: 50003;
-    };
-    readonly CALLOUT: {
-        readonly name: "mrl-callout-portal";
-        readonly zIndex: 50004;
-    };
-    readonly MODAL: {
-        readonly name: "mrl-modal";
-        readonly zIndex: 50005;
-    };
-    readonly SELECT: {
-        readonly name: "mrl-select-portal";
-        readonly zIndex: 50006;
-    };
-    readonly TOOLTIP: {
-        readonly name: "mrl-tooltip-portal";
-        readonly zIndex: 50007;
-    };
-    readonly TOP: {
-        readonly name: "mrl-top-portal";
-        readonly zIndex: 50008;
-    };
-};
-/**
- * Get the current portal layer based on the provided element
- *
- * @param element - the element to check for the closest portal layer
- * @returns the portal layer id
- */
-export declare const getCurrentPortalLayer: (element: HTMLElement) => string | null;

package/dist/utils/noop/index.d.ts

@@ -1,7 +0,0 @@
-/**
- * No operation function to be used as a default callback.
- *
- * Example usage: in tests where there is a required handler, but we do not want to do anything.
- * Better than passing a console log which clutters up our test output.
- */
-export declare const noop: () => void;

package/dist/utils/preventDefault/index.d.ts

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

package/dist/utils/preventDefault/preventDefault.d.ts

@@ -1,6 +0,0 @@
-/**
- * Prevent default on event
- *
- * @param e - The event
- */
-export declare const preventDefault: (e: React.MouseEvent | React.KeyboardEvent | MouseEvent | KeyboardEvent) => void;

package/dist/utils/setAttributes/index.d.ts

@@ -1,2 +0,0 @@
-import { AttrsObject, ClassObject, getUniqueId, setAttributes, setClasses } from './setAttributes';
-export { type AttrsObject, type ClassObject, getUniqueId, setAttributes, setClasses };

package/dist/utils/setAttributes/setAttributes.d.ts

@@ -1,35 +0,0 @@
-export type AttrsObject = Record<string, any>;
-/**
- * Object that contains all of the classes that can be applied to an element
- * and a condition that determines if that instance should have it
- * applied or not. The structure is:
- * "my-class": !theConditional
- */
-export type ClassObject = Record<string, boolean>;
-/**
- * Sets up a classObject to be used by the className prop
- *
- * @todo - 2563 - use setClasses across components
- * @param {string} customClasses - custom classes to apply via the attrs prop
- * @param {ClassObject} defaultClasses - design system component classes to apply
- * @returns {ClassObject} - with all classes
- */
-export declare const setClasses: (customClasses: AttrsObject | undefined, defaultClasses: ClassObject) => ClassObject;
-/**
- * Set an object of attributes to be used in a given component.
- *
- * @param {AttrsObject} attributes - The custom attributes passed to the component
- * @param {AttrsObject} [defaults={}] - An optional object of the default attributes of a component
- * @param {string} className - Default classes to apply to the component
- *
- * Use when applying attributes such as a className directly to a react component.
- * @returns {AttrsObject} - An object of component attributes
- */
-export declare const setAttributes: (attributes: AttrsObject | undefined, defaults?: AttrsObject, className?: string) => AttrsObject;
-/**
- *  Generates unique identifier
- *
- * @param {string} prefix  - prefix for identifier
- * @returns {string} - prefixed unique identifier
- */
-export declare const getUniqueId: (prefix?: string) => string;

package/dist/utils/setAttributes/setAttributes.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/utils/trapFocus/index.d.ts

@@ -1,24 +0,0 @@
-/**
- * Focus trap logic
- *
- * @param {HTMLElement} element - The component props.
- * @returns {HTMLElement[]} - The focusable elements inside the element.
- */
-export declare const getFocusableElementsInsideElement: (element: HTMLElement) => HTMLElement[];
-/**
- * Gets the first element with the data-autofocus="true" attribute within the container element
- *
- * @param {HTMLElement} containerElement - container element
- * @returns {HTMLElement | undefined} - the first element that has autofocus="true" or undefined
- */
-export declare const getElementWithAutofocus: (containerElement: HTMLElement) => HTMLElement | undefined;
-/**
- * Traps focus inside of an element.
- * Adapted from https://hidde.blog/using-javascript-to-trap-focus-in-an-element/
- *
- * @param {HTMLElement} element // Element to trap focus in
- * @param {boolean} disableAutofocus // Whether to disable autofocus
- * @returns {Function}          // Cleanup function to be run when component is
- *                              // removed from the DOM
- */
-export declare const trapFocus: (element: HTMLElement, disableAutofocus?: boolean) => (() => void);