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

package/dist/components/table/MrlTableRow/index.d.ts

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

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

@@ -1,21 +0,0 @@
-export type MrlTableItemId = string;
-export type MrlTableColumnId = string;
-export declare enum MrlSortDirection {
-    ASC = 1,
-    DESC = -1
-}
-export interface MrlTableColumnSortDescriptor {
-    /**
-     * The key of the column to sort by.
-     */
-    column: MrlTableColumnId;
-    /**
-     * The direction to sort by.
-     */
-    direction: MrlSortDirection;
-    /**
-     * The name of the column to sort by.
-     */
-    name: string;
-}
-export type MrlTableSelectionMode = 'single' | 'multiple';

package/dist/components/table/fixtures.d.ts

@@ -1,89 +0,0 @@
-declare enum STICKY_VALUES {
-    LEFT = "left",
-    RIGHT = "right"
-}
-export declare const SAMPLE_COLUMNS: ({
-    allowsSorting: boolean;
-    id: string;
-    name: string;
-    tooltip?: undefined;
-} | {
-    allowsSorting: boolean;
-    id: string;
-    name: string;
-    tooltip: string;
-} | {
-    id: string;
-    name: string;
-    allowsSorting?: undefined;
-    tooltip?: undefined;
-})[];
-export declare const SAMPLE_ITEMS: {
-    dateModified: string;
-    id: string;
-    name: string;
-    type: string;
-}[];
-export declare const SAMPLE_ITEMS_WITH_NON_SELECTABLE_ITEM: ({
-    dateModified: string;
-    id: string;
-    name: string;
-    type: string;
-    isSelectable?: undefined;
-} | {
-    dateModified: string;
-    id: string;
-    isSelectable: boolean;
-    name: string;
-    type: string;
-})[];
-export declare const SAMPLE_ITEMS_WITH_DISABLED_ITEM: ({
-    dateModified: string;
-    id: string;
-    name: string;
-    type: string;
-    isDisabled?: undefined;
-} | {
-    dateModified: string;
-    id: string;
-    isDisabled: boolean;
-    name: string;
-    type: string;
-})[];
-export declare const SAMPLE_STICKY_COLUMNS: ({
-    allowsSorting: boolean;
-    id: string;
-    name: string;
-    sticky: STICKY_VALUES;
-} | {
-    allowsSorting: boolean;
-    id: string;
-    name: string;
-    sticky?: undefined;
-} | {
-    id: string;
-    name: string;
-    sticky: STICKY_VALUES;
-    allowsSorting?: undefined;
-})[];
-export declare const SAMPLE_STICKY_ITEMS: {
-    dateModified: string;
-    foobars: string;
-    id: string;
-    name: string;
-    type: string;
-    widgets: string;
-}[];
-export declare const SAMPLE_ITEMS_WITH_LONG_CONTENT: {
-    dateModified: string;
-    id: string;
-    name: string;
-    type: string;
-}[];
-export declare const SAMPLE_ITEMS_500: {
-    id: string;
-    dateModified: string;
-    name: string;
-    type: string;
-}[];
-export {};

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

@@ -1,9 +0,0 @@
-export * from './MrlTable';
-export * from './MrlTableBody';
-export * from './MrlTableCell';
-export * from './MrlTableColumn';
-export * from './MrlTableHeader';
-export * from './MrlTableRow';
-export * from './MrlSmartTable';
-export * from './MrlTableEmptyState';
-export * from './constants';

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

@@ -1,43 +0,0 @@
-import { sortAsc, sortDes } from '@muraldevkit/ds-icons';
-import { MrlSortDirection } from './constants';
-/**
- * Used as a generic sort comparator for unknown types by coercing each value
- * to a string and sorting alphabetically. It will likely produce unexpected and/or
- * undesirable results for anything other than the most basic text or numeric data.
- *
- * @param {unknown} a first of two values
- * @param {unknown} b second of two values
- * @returns {number} A negative number if a occurs before b; positive if the
- * a occurs after b; 0 if they are equivalent.
- */
-export declare const sortAlphabeticallyAsCoercedStrings: (a: unknown, b: unknown) => number;
-/**
- * Used to generate consistent keys for the entire structure of MrlSmartTable
- *
- * @param {string} prefix the unique structure prefix
- * @param {string} elementType the element type to generate a key for
- * @param {string[]} keys a set of properties to uniquely identify the element
- * @returns {string} the generated key
- */
-export declare const keyFor: (prefix: string, elementType: 'header' | 'column' | 'body' | 'row' | 'row-cell', ...keys: string[]) => string;
-/**
- * Provides sort icon based on direction.
- *
- * @param {MrlSortDirection} direction the sort direction
- * @returns {typeof sortAsc | typeof sortDes} the icon
- */
-export declare const sortIcon: (direction: MrlSortDirection) => typeof sortAsc | typeof sortDes;
-/**
- * Provides text label based on sort direction.
- *
- * @param {MrlSortDirection} direction the sort direction
- * @returns {string} the text label
- */
-export declare const sortText: (direction: MrlSortDirection) => string;
-/**
- * Provides next sort direction based on current direction.
- *
- * @param {MrlSortDirection} current sort direction
- * @returns {MrlSortDirection} next sort direction
- */
-export declare const nextSortDirection: (current?: MrlSortDirection) => MrlSortDirection;

package/dist/components/tabs/MrlTab/MrlTab.d.ts

@@ -1,21 +0,0 @@
-import * as React from 'react';
-export interface MrlTabProps extends React.ComponentProps<'button'> {
-    /** Class to be applied to the button element of the MrlTab */
-    className?: string;
-    icon?: React.ReactElement;
-    /**
-     * The id that will be passed to the MrlTabContext to set the active state.
-     * NOTE: This must match the `tabId` set on `MrlTabContent`!
-     */
-    id: string;
-    /** An addition function to call when clicking on a tab */
-    hookClick?: () => void;
-    text: string;
-}
-/**
- * Renders a tab component
- *
- * @param {MrlTabProps} props the props for your MrlTab
- * @returns {React.ReactElement} an a element containing the text you pass
- */
-export declare const MrlTab: ({ className, icon, id, hookClick, text }: MrlTabProps) => React.ReactElement;

package/dist/components/tabs/MrlTab/index.d.ts

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

package/dist/components/tabs/MrlTabContent/MrlTabContent.d.ts

@@ -1,9 +0,0 @@
-import * as React from 'react';
-export interface MrlTabContentPropTypes {
-    children: React.ReactNode;
-    /** Class to be applied to the container element of the MrlTabContent */
-    className?: string;
-    /** The id of the tab button associated to this content */
-    tabId: string;
-}
-export declare const MrlTabContent: React.FC<MrlTabContentPropTypes>;

package/dist/components/tabs/MrlTabContent/index.d.ts

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

package/dist/components/tabs/MrlTabGroup/MrlTabGroup.d.ts

@@ -1,10 +0,0 @@
-import * as React from 'react';
-export interface MrlTabGroupPropTypes {
-    children: React.ReactNode;
-    /** Class to be applied to the container element of the MrlTabGroup */
-    className?: string;
-    disablePageControls?: boolean;
-    /** A hidden label for the tab group for accessiblity purposes */
-    label?: string;
-}
-export declare const MrlTabGroup: React.FC<MrlTabGroupPropTypes>;

package/dist/components/tabs/MrlTabGroup/index.d.ts

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

package/dist/components/tabs/MrlTabLink/MrlTabLink.d.ts

@@ -1,22 +0,0 @@
-import * as React from 'react';
-import { NavLinkProps } from 'react-router-dom';
-export interface MrlTabLinkProps extends NavLinkProps {
-    /** Class to be applied to the NavLink element of the MrlTabLink */
-    className?: string;
-    icon?: React.ReactElement;
-    /**
-     * The id that will be passed to the MrlTabContext to set the active state.
-     * NOTE: This must match the `tabId` set on `MrlTabContent`!
-     */
-    id: string;
-    /** An addition function to call when clicking on a tab */
-    hookClick?: () => void;
-    text: string;
-}
-/**
- * Renders a tab component
- *
- * @param {MrlTabLinkProps} props the props for your MrlTabLink
- * @returns {React.ReactElement} an a element containing the text you pass
- */
-export declare const MrlTabLink: ({ className, icon, id, hookClick, text, to, ...remainingProps }: MrlTabLinkProps) => React.ReactElement;

package/dist/components/tabs/MrlTabLink/index.d.ts

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

package/dist/components/tabs/MrlTabs/MrlTabs.d.ts

@@ -1,21 +0,0 @@
-import * as React from 'react';
-import { MrlTabContextProps } from '../../../';
-export type MrlTabSize = 'small' | 'large';
-export interface MrlTabsPropTypes {
-    /** Sets the tabs to be styled with capital case */
-    capitalizeTabTitles?: boolean;
-    children: React.ReactNode;
-    /** Class to be applied to the container element of the MrlTabs */
-    className?: string;
-    /** Sets the default active tab by id */
-    selectedTab?: string;
-    size?: MrlTabSize;
-    spaceTabsEvenly?: boolean;
-}
-export declare const MrlTabs: React.FC<MrlTabsPropTypes>;
-/**
- * Tab context to prevent us from having to do any prop drilling.
- *
- * @returns {MrlTabContextProps} the context of the tabs
- */
-export declare function useMrlTabContext(): MrlTabContextProps;

package/dist/components/tabs/MrlTabs/index.d.ts

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

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

@@ -1 +0,0 @@
-export type TabActionType = 'ArrowUp' | 'ArrowDown' | 'ArrowLeft' | 'ArrowRight' | 'Home' | 'End' | null;

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

@@ -1,5 +0,0 @@
-export * from './MrlTab';
-export * from './MrlTabContent';
-export * from './MrlTabGroup';
-export * from './MrlTabLink';
-export * from './MrlTabs';

package/dist/components/text/MrlText/MrlText.d.ts

@@ -1,26 +0,0 @@
-import * as React from 'react';
-import { AttrsObject } from '../../../utils';
-import { TextSizes } from '../constants';
-import { DataQa } from '../../../utils/dataQa';
-interface MrlTextProps extends React.ComponentPropsWithoutRef<'p'>, DataQa {
-    /**
-     * Applies additional HTML attributes to the text element
-     *
-     * @deprecated - use the regular HTML attributes instead.
-     */
-    attrs?: AttrsObject;
-    /** Children to be rendered within the text component */
-    children?: React.ReactNode;
-    /** Visual size of the text element */
-    size?: TextSizes;
-    /** Textual content when it's a static string; if you have nested elements, use children to provide content */
-    text?: string;
-}
-/**
- * MrlText Component
- *
- * @param {MrlTextProps} props - MrlText component props
- * @returns a paragraph element
- */
-export declare function MrlText(props: MrlTextProps): JSX.Element;
-export {};

package/dist/components/text/MrlText/index.d.ts

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

package/dist/components/text/MrlTextHeading/MrlTextHeading.d.ts

@@ -1,39 +0,0 @@
-import * as React from 'react';
-import { AttrsObject } from '../../../utils';
-import { LevelType, HeadingHierarchies, HeadingSizes, TextSizes, HeadingKinds } from '../constants';
-import { DataQa } from '../../../utils/dataQa';
-interface MrlTextHeadingProps extends React.ComponentPropsWithRef<'h1'>, DataQa {
-    /**
-     * Applies additional HTML attributes to the text element
-     *
-     * @deprecated - use the regular HTML attributes instead.
-     */
-    attrs?: AttrsObject;
-    /** Children to be rendered within the text heading component */
-    children?: React.ReactNode;
-    /** Set the semantic level of the heading based on its usage in the page hierarchy */
-    level?: LevelType;
-    /** Visual styling use case for the heading */
-    kind?: HeadingKinds;
-    /**
-     * Visual size of the heading
-     * xsmall and xxsmall are only supported when kind="title"
-     */
-    size?: HeadingSizes | TextSizes;
-    /**
-     * Clear and concise description of the content that the heading describes
-     *
-     * Note: hierarchy only impacts MrlTextHeading components with `kind="title"`
-     */
-    hierarchy?: HeadingHierarchies;
-    text?: string;
-}
-/**
- * MuralTextHeading component
- * Used for creating semantic headings within a page
- *
- * @param {MrlTextHeadingProps} props - MrlTextHeading component props
- * @returns a heading element
- */
-export declare function MrlTextHeading(props: MrlTextHeadingProps): JSX.Element;
-export {};

package/dist/components/text/MrlTextHeading/index.d.ts

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

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

@@ -1,40 +0,0 @@
-import { AttrsObject } from '../../utils';
-export type TextSizes = 'xxsmall' | 'xsmall' | 'small' | 'medium' | 'large';
-export interface TextDefaults {
-    attrs: AttrsObject;
-    size: TextSizes;
-}
-export declare const textAllowedValues: {
-    sizes: string[];
-};
-/**
- * Default values for props on the Text component;
- * Shared between the component and Storybook
- */
-export declare const textDefaults: TextDefaults;
-export type LevelType = '1' | '2' | '3' | '4' | '5' | '6';
-export type HeadingKinds = 'display' | 'headline' | 'title';
-export type HeadingSizes = 'small' | 'medium' | 'large';
-export type HeadingHierarchies = 'primary' | 'secondary';
-export interface HeadingDefaults {
-    attrs: AttrsObject;
-    hierarchy: HeadingHierarchies;
-    kind: HeadingKinds;
-    level: LevelType;
-    size: HeadingSizes | TextSizes;
-}
-/**
- * Defines all of classes allowed for the type attribute;
- * used for Storybook and testing
- */
-export declare const headingAllowedValues: {
-    hierarchy: string[];
-    kinds: string[];
-    level: string[];
-    sizes: string[];
-};
-/**
- * Default values for props on the Text component;
- * Shared between the component and Storybook
- */
-export declare const headingDefaults: HeadingDefaults;

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

@@ -1,2 +0,0 @@
-export * from './MrlText';
-export * from './MrlTextHeading';

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

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

package/dist/components/toolbar/MrlToolbar/MrlToolbar.d.ts

@@ -1,38 +0,0 @@
-import * as React from 'react';
-import { MrlIconButtonProps, MrlMenuProps } from '../../../';
-/**
- * Props for the MrlToolbar component.
- */
-export interface MrlToolbarProps extends React.ComponentPropsWithRef<'div'> {
-    children?: React.ReactNode;
-    kind?: 'default' | 'inverse' | 'skeleton';
-    /**
-     * An optional prop to apply an aria-label to the MrlToobar
-     */
-    label?: string;
-    lastToolbarInRow?: boolean;
-    /**
-     * An optional prop to set the maximum number of visible items in a toolbar.
-     * Additional items will appear in a menu.
-     */
-    maxVisibleItems?: number;
-    menuButtonProps?: MrlIconButtonProps;
-    menuProps?: MrlMenuProps;
-    orientation?: 'horizontal' | 'vertical';
-    /**
-     * A boolean prop that sets RovingTabindex in the MrlToolbar
-     */
-    shouldUseRti?: boolean;
-    /**
-     * Sets the size of the toolbar - defaults to 'small'
-     */
-    size?: 'xsmall' | 'small' | 'medium';
-    spaced?: boolean;
-}
-/**
- * MrlToolbar component.
- *
- * @param props The MrlToolbar component properties.
- * @returns The MrlToolbar component.
- */
-export declare const MrlToolbar: (props: MrlToolbarProps) => React.ReactElement;

package/dist/components/toolbar/MrlToolbar/index.d.ts

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

package/dist/components/toolbar/MrlToolbarButton/MrlToolbarButton.d.ts

@@ -1,58 +0,0 @@
-import * as React from 'react';
-import { MrlIconButtonProps, MrlMenuItemProps } from '../../../';
-/**
- * Props for the MrlToolbarButton component.
- */
-export interface MrlToolbarButtonProps {
-    /** Additional class to add to the Toolbar button */
-    className?: string;
-    /**
-     * The icon that will be rendered.
-     */
-    icon: React.ReactElement;
-    includeInRoving?: boolean;
-    /**
-     * A prop used to set a toolbar button to never move into the menu.
-     */
-    lockedInToolbar?: boolean;
-    /**
-     * onClick event for the button.
-     */
-    onClick?: (e?: React.MouseEvent<HTMLButtonElement>) => void;
-    /**
-     * Props used to control the display of the button in the menu.
-     */
-    menuItemProps?: Omit<MrlMenuItemProps, 'onClick'>;
-    qa?: string;
-    /**
-     * A prop used to render the item in the menu instead of the toolbar.
-     */
-    renderInMenu?: boolean;
-    text: string;
-    /**
-     * Props used to control the display of the button in the toolbar.
-     */
-    toolbarButtonProps?: {
-        badge?: MrlIconButtonProps['badge'];
-        disableEvents?: MrlIconButtonProps['disableEvents'];
-        kind?: MrlIconButtonProps['kind'];
-        loading?: MrlIconButtonProps['loading'];
-        loadingText?: MrlIconButtonProps['loadingText'];
-        onKeyUp?: MrlIconButtonProps['onKeyUp'];
-        onMouseUp?: MrlIconButtonProps['onMouseUp'];
-        position?: MrlIconButtonProps['position'];
-        size?: MrlIconButtonProps['size'];
-        state?: MrlIconButtonProps['state'];
-        tipAnchor?: MrlIconButtonProps['tipAnchor'];
-        toggleAria?: MrlIconButtonProps['toggleAria'];
-        toggleStyle?: MrlIconButtonProps['toggleStyle'];
-        tooltipKind?: MrlIconButtonProps['tooltipKind'];
-    };
-}
-/**
- * MrlToolbarButton component.
- *
- * @param props The MrlToolbarButton component properties.
- * @returns The MrlToolbarButton component.
- */
-export declare const MrlToolbarButton: React.ForwardRefExoticComponent<MrlToolbarButtonProps & React.RefAttributes<HTMLButtonElement>>;

package/dist/components/toolbar/MrlToolbarButton/index.d.ts

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

package/dist/components/toolbar/MrlToolbarItem/MrlToolbarItem.d.ts

@@ -1,30 +0,0 @@
-/// <reference types="react" />
-/**
- * Props for the MrlToolbarItem component.
- */
-export interface MrlToolbarItemProps {
-    /**
-     * A prop used to set a toolbar button to never move into the menu.
-     */
-    lockedInToolbar?: boolean;
-    /**
-     * The rendered component in the overflow menu.
-     * If nothing is passed, the toolbarItem will be rendered in the menu.
-     */
-    menuItem?: JSX.Element;
-    /**
-     * A prop used to render the item in the menu instead of the toolbar.
-     */
-    renderInMenu?: boolean;
-    /**
-     * The rendered markup in the toolbar.
-     */
-    toolbarItem: JSX.Element;
-}
-/**
- * MrlToolbarItem component.
- *
- * @param props The MrlToolbarItem component properties.
- * @returns The MrlToolbarItem component.
- */
-export declare const MrlToolbarItem: (props: MrlToolbarItemProps) => JSX.Element | null;

package/dist/components/toolbar/MrlToolbarItem/index.d.ts

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

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

@@ -1,3 +0,0 @@
-export * from './MrlToolbar';
-export * from './MrlToolbarButton';
-export * from './MrlToolbarItem';

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

@@ -1,58 +0,0 @@
-import * as React from 'react';
-import { AttrsObject } from '../../../utils';
-import { MrlTooltipAnchor, MrlTooltipPosition, MrlTooltipState, MrlTooltipVariant } from '../constants';
-import '../../../styles/shared/a11y-helpers/a11y.global.scss';
-interface MrlTooltipProps {
-    /** The arrow position of the tooltip in relation to its trigger's content */
-    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;
-    /**
-     * Children to be rendered within the tooltip. The first child is used as the trigger.
-     *
-     * Warning: The tooltip is only setup to work with a single trigger. If multiple children
-     * are passed in the component will not have event handling for the additional child elements.
-     */
-    children: React.ReactElement;
-    /** Whether the tooltip should close when clicked */
-    clickToClose?: boolean;
-    /** The data-qa attribute for the tooltip */
-    dataQa?: string;
-    /** The state value to determine if the tooltip should be displayed */
-    display?: MrlTooltipState;
-    /**
-     * Whether to disable the screen reader text
-     *
-     * !!! only use this prop if you are sure that the tooltip content is not needed for screen reader users !!!
-     */
-    disableScreenReaderText?: boolean;
-    /** Whether to disable the tooltip hover action that keeps it open */
-    disableTooltipHover?: boolean;
-    /** The kind of tooltip to be rendered */
-    kind?: MrlTooltipVariant;
-    /** The placement of the tooltip in relation to its trigger */
-    position?: MrlTooltipPosition;
-    /** The textual label of tooltip */
-    text: string;
-    /** A custom class selector to be applied to the tooltip wrapper */
-    tooltipClass?: string;
-    /** A class to be applied ot the tooltip content */
-    tooltipContentClass?: string;
-}
-/**
- * MrlTooltip Component
- *
- * This component is not displayed when rendering this component if the primary pointing device can’t hover. Examples include touchscreens and screens that use a basic drawing stylus.
-Pointing devices that can hover, but for which doing so is inconvenient and not part of the normal way they are used, also match this criteria. For example, a touchscreen where a long press is treated as hovering.
- *
- * @param {MrlTooltipProps} props - The props of the component
- * @returns {HTMLElement} a configured Tooltip component
- */
-export declare const MrlTooltip: React.MemoExoticComponent<(props: MrlTooltipProps) => React.ReactElement>;
-export {};

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

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

package/dist/components/tooltip/MrlTooltip/utilities.d.ts

@@ -1,8 +0,0 @@
-import * as React from 'react';
-/**
- * Function to recursively extract all text content from children
- *
- * @param children - the children of the component
- * @returns the combined text content of the children
- */
-export declare const extractTextContent: (children: React.ReactNode) => string;