gantri-components 2.33.1 → 2.34.0-beta.2

package/dist/components/aspect-ratio/aspect-ratio.styles.d.ts

@@ -1,7 +1,6 @@
 import { Property } from 'csstype';
 import { ResolutionAwareProp } from '../../types/resolution-aware-prop.type';
 import { AspectRatioProps } from './aspect-ratio.types';
-import { PropsWithHidden } from '../box/box.types';
 export declare const populateAspectRatioStyles: (aspectRatio: ResolutionAwareProp<string>, height?: ResolutionAwareProp<Property.Height>) => import("styled-components").FlattenSimpleInterpolation;
-export declare const StyledAspectRatio: import("styled-components").StyledComponent<"div", import("styled-components").DefaultTheme, Partial<PropsWithHidden<AspectRatioProps>>, never>;
+export declare const StyledAspectRatio: import("styled-components").StyledComponent<"div", import("styled-components").DefaultTheme, Partial<AspectRatioProps>, never>;
 export declare const StyledAspectRatioContent: import("styled-components").StyledComponent<"div", import("styled-components").DefaultTheme, {}, never>;

package/dist/components/badge/badge.styles.d.ts

@@ -1,2 +1,2 @@
 import { BadgeProps } from './badge.types';
-export declare const StyledBadge: import("styled-components").StyledComponent<"span", import("styled-components").DefaultTheme, Pick<BadgeProps, "color" | "minWidth" | "width" | "variant" | "opacity" | "size" | "borderColor" | "textColor">, never>;
+export declare const StyledBadge: import("styled-components").StyledComponent<"span", import("styled-components").DefaultTheme, Pick<BadgeProps, "color" | "variant" | "minWidth" | "width" | "opacity" | "size" | "borderColor" | "textColor">, never>;

package/dist/components/box/box.styles.d.ts

@@ -1,4 +1,2 @@
 import { BoxProps } from './box.types';
-export declare const StyledBoxContainer: import("styled-components").StyledComponent<"div", import("styled-components").DefaultTheme, BoxProps & {
-    $hidden?: import("../../types/resolution-aware-prop.type").ResolutionAwareProp<boolean> | undefined;
-}, never>;
+export declare const StyledBoxContainer: import("styled-components").StyledComponent<"div", import("styled-components").DefaultTheme, BoxProps, never>;

package/dist/components/box/box.types.d.ts

@@ -1,22 +1,9 @@
 import { HTMLAttributes } from 'react';
-import { Property } from 'csstype';
-import { Color } from '../../styles';
+import { Globals, Property } from 'csstype';
 import { ResolutionAwareProp } from '../../types/resolution-aware-prop.type';
-/**
- * @deprecated Use values from our 8 point grid instead
- */
-type DeprecatedSize = 's1' | 's2' | 's3' | 's4' | 's5' | 's6';
-/**
- *
- */
-export type BoxDimension = DeprecatedSize | '.5x' | 'x' | '2x' | '3x' | '4x' | '5x' | '6x' | '7x' | '8x' | '9x' | '10x' | '11x' | '12x' | '24x' | 'unset' | null | `${number}px` | `${number}rem`;
-type AllowedBoxDimension<T> = T extends BoxDimension ? T : never;
-export interface ResolutionAwarePropBase<T> {
-    lg?: AllowedBoxDimension<T>;
-    md?: AllowedBoxDimension<T>;
-    sm?: AllowedBoxDimension<T>;
-}
-export interface BaseProps extends Omit<HTMLAttributes<any>, 'hidden'> {
+import { Color } from '../../styles';
+export type BoxDimension = 's1' | 's2' | 's3' | 's4' | 's5' | 's6' | Globals | string;
+export interface BaseProps extends HTMLAttributes<any> {
     children?: any;
     className?: string;
 }
@@ -49,7 +36,3 @@ export interface BoxProps extends BaseProps {
     verticalPadding?: ResolutionAwareProp<BoxDimension>;
     width?: ResolutionAwareProp<string>;
 }
-export type PropsWithHidden<T> = T & {
-    $hidden?: ResolutionAwareProp<boolean>;
-};
-export {};

package/dist/components/button/button.styles.d.ts

@@ -1,5 +1,4 @@
 import { DefaultTheme } from 'styled-components';
 import { ButtonProps } from './button.types';
-import { PropsWithHidden } from '../box/box.types';
-export declare const StyledButton: import("styled-components").StyledComponent<"button", DefaultTheme, Partial<PropsWithHidden<ButtonProps>>, never>;
+export declare const StyledButton: import("styled-components").StyledComponent<"button", DefaultTheme, Partial<ButtonProps>, never>;
 export declare const StyledButtonContent: import("styled-components").StyledComponent<"div", DefaultTheme, ButtonProps, never>;

package/dist/components/cell/cell.styles.d.ts

@@ -1,4 +1,2 @@
 import { CellProps } from './cell.types';
-export declare const StyledCell: import("styled-components").StyledComponent<"div", import("styled-components").DefaultTheme, CellProps & {
-    $hidden?: import("../../types/resolution-aware-prop.type").ResolutionAwareProp<boolean> | undefined;
-}, never>;
+export declare const StyledCell: import("styled-components").StyledComponent<"div", import("styled-components").DefaultTheme, CellProps, never>;

package/dist/components/grid/grid.styles.d.ts

@@ -1,4 +1,2 @@
 import { GridProps } from './grid.types';
-export declare const StyledGrid: import("styled-components").StyledComponent<"div", import("styled-components").DefaultTheme, GridProps & {
-    $hidden?: import("../../types/resolution-aware-prop.type").ResolutionAwareProp<boolean> | undefined;
-}, never>;
+export declare const StyledGrid: import("styled-components").StyledComponent<"div", import("styled-components").DefaultTheme, GridProps, never>;

package/dist/components/icon/generated/ui-control/ExlamationCircleFilled.d.ts

@@ -0,0 +1,3 @@
+import React from 'react';
+declare const SvgExlamationCircleFilled: React.NamedExoticComponent<object>;
+export default SvgExlamationCircleFilled;

package/dist/components/icon/generated/ui-control/ExlamationCircleFilled24.d.ts

@@ -0,0 +1,3 @@
+import React from 'react';
+declare const SvgExlamationCircleFilled24: React.NamedExoticComponent<object>;
+export default SvgExlamationCircleFilled24;

package/dist/components/index.d.ts

@@ -26,6 +26,7 @@ export * from './radio';
 export * from './search-field';
 export * from './slider';
 export * from './stack';
+export * from './table';
 export * from './tabs';
 export * from './text-area';
 export * from './text-field';

package/dist/components/modal/modal.styles.d.ts

@@ -1,14 +1,12 @@
 /// <reference types="react" />
-import { Property } from 'csstype';
 import { ModalProps } from './modal.types';
-import { ResolutionAwareProp } from '../../types/resolution-aware-prop.type';
 export declare const StyledModal: import("styled-components").StyledComponent<"div", import("styled-components").DefaultTheme, {}, never>;
 export declare const StyledModalBody: import("styled-components").StyledComponent<"div", import("styled-components").DefaultTheme, ModalProps & {
     isFullScreen?: boolean | undefined;
     noTopSpacing?: boolean | undefined;
 } & {
-    $height?: ResolutionAwareProp<Property.Height<0 | (string & {})>> | undefined;
-    $width?: ResolutionAwareProp<Property.Width<0 | (string & {})>> | undefined;
+    $height?: 0 | (string & {}) | "-moz-initial" | "inherit" | "initial" | "revert" | "unset" | "auto" | import("../../types/resolution-aware-prop.type").ResolutionAwarePropBase<string & {}> | import("../../types/resolution-aware-prop.type").ResolutionAwarePropBase<"-moz-initial"> | import("../../types/resolution-aware-prop.type").ResolutionAwarePropBase<"inherit"> | import("../../types/resolution-aware-prop.type").ResolutionAwarePropBase<"initial"> | import("../../types/resolution-aware-prop.type").ResolutionAwarePropBase<"revert"> | import("../../types/resolution-aware-prop.type").ResolutionAwarePropBase<"unset"> | import("../../types/resolution-aware-prop.type").ResolutionAwarePropBase<"auto"> | import("../../types/resolution-aware-prop.type").ResolutionAwarePropBase<0> | "-moz-max-content" | "-moz-min-content" | "-webkit-fit-content" | "fit-content" | "max-content" | "min-content" | import("../../types/resolution-aware-prop.type").ResolutionAwarePropBase<"-moz-max-content"> | import("../../types/resolution-aware-prop.type").ResolutionAwarePropBase<"-moz-min-content"> | import("../../types/resolution-aware-prop.type").ResolutionAwarePropBase<"-webkit-fit-content"> | import("../../types/resolution-aware-prop.type").ResolutionAwarePropBase<"fit-content"> | import("../../types/resolution-aware-prop.type").ResolutionAwarePropBase<"max-content"> | import("../../types/resolution-aware-prop.type").ResolutionAwarePropBase<"min-content"> | undefined;
+    $width?: 0 | (string & {}) | "-moz-initial" | "inherit" | "initial" | "revert" | "unset" | "auto" | import("../../types/resolution-aware-prop.type").ResolutionAwarePropBase<string & {}> | import("../../types/resolution-aware-prop.type").ResolutionAwarePropBase<"-moz-initial"> | import("../../types/resolution-aware-prop.type").ResolutionAwarePropBase<"inherit"> | import("../../types/resolution-aware-prop.type").ResolutionAwarePropBase<"initial"> | import("../../types/resolution-aware-prop.type").ResolutionAwarePropBase<"revert"> | import("../../types/resolution-aware-prop.type").ResolutionAwarePropBase<"unset"> | import("../../types/resolution-aware-prop.type").ResolutionAwarePropBase<"auto"> | import("../../types/resolution-aware-prop.type").ResolutionAwarePropBase<0> | "-moz-max-content" | "-moz-min-content" | "-webkit-fit-content" | "fit-content" | "max-content" | "min-content" | import("../../types/resolution-aware-prop.type").ResolutionAwarePropBase<"-moz-max-content"> | import("../../types/resolution-aware-prop.type").ResolutionAwarePropBase<"-moz-min-content"> | import("../../types/resolution-aware-prop.type").ResolutionAwarePropBase<"-webkit-fit-content"> | import("../../types/resolution-aware-prop.type").ResolutionAwarePropBase<"fit-content"> | import("../../types/resolution-aware-prop.type").ResolutionAwarePropBase<"max-content"> | import("../../types/resolution-aware-prop.type").ResolutionAwarePropBase<"min-content"> | "-moz-fit-content" | "-webkit-max-content" | "intrinsic" | import("../../types/resolution-aware-prop.type").ResolutionAwarePropBase<"-moz-fit-content"> | import("../../types/resolution-aware-prop.type").ResolutionAwarePropBase<"-webkit-max-content"> | import("../../types/resolution-aware-prop.type").ResolutionAwarePropBase<"intrinsic"> | "min-intrinsic" | import("../../types/resolution-aware-prop.type").ResolutionAwarePropBase<"min-intrinsic"> | undefined;
 }, never>;
 export declare const StyledModalContent: import("styled-components").StyledComponent<import("react").ForwardRefExoticComponent<import("../stack/stack.types").StackProps & import("react").RefAttributes<import("../stack/stack.types").StackProps>>, import("styled-components").DefaultTheme, {
     isFullScreen?: boolean | undefined;

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

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

package/dist/components/paging/paging.d.ts

@@ -0,0 +1,5 @@
+import { PagingProps } from './paging.types';
+export declare const Paging: {
+    (props: PagingProps): JSX.Element;
+    defaultProps: Partial<PagingProps>;
+};

package/dist/components/paging/paging.presets.d.ts

@@ -0,0 +1,2 @@
+import { PagingProps } from './paging.types';
+export declare const pagingDefaultProps: Partial<PagingProps>;

package/dist/components/paging/paging.styles.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="react" />
+export declare const StyledFlex: import("styled-components").StyledComponent<import("react").ForwardRefExoticComponent<import("../flex/flex.types").FlexProps & import("react").RefAttributes<import("../flex/flex.types").FlexProps>>, import("styled-components").DefaultTheme, {}, never>;
+export declare const StyledPagingButton: import("styled-components").StyledComponent<"div", import("styled-components").DefaultTheme, {
+    disabled: boolean;
+}, never>;

package/dist/components/paging/paging.types.d.ts

@@ -0,0 +1,6 @@
+export interface PagingProps {
+    currentPage: number;
+    onPageChange: (page: number) => void;
+    pageCount: number;
+    total: number;
+}

package/dist/components/table/components/table-actions-wrapper/components/search/index.d.ts

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

package/dist/components/table/components/table-actions-wrapper/components/search/search.d.ts

@@ -0,0 +1,2 @@
+import { SearchProps } from './search.types';
+export declare const Search: (props: SearchProps) => JSX.Element;

package/dist/components/table/components/table-actions-wrapper/components/search/search.styles.d.ts

@@ -0,0 +1 @@
+export declare const StyledSearchInputWrapper: import("styled-components").StyledComponent<"div", import("styled-components").DefaultTheme, {}, never>;

package/dist/components/table/components/table-actions-wrapper/components/search/search.types.d.ts

@@ -0,0 +1,7 @@
+import { TextFieldProps } from '../../../../../text-field';
+export interface SearchProps {
+    onChange: TextFieldProps['onTextChange'];
+    onFocus?: TextFieldProps['onFocus'];
+    placeholder?: string;
+    value?: string;
+}

package/dist/components/table/components/table-actions-wrapper/components/sort/helpers/get-sort-mapping/get-sort-mapping.d.ts

@@ -0,0 +1,3 @@
+import { TableSortField } from '../../sort.types';
+import { SortMapping } from './get-sort-mapping.types';
+export declare const getSortMapping: <SortingField = string>(sortingOptions?: TableSortField<SortingField>[]) => SortMapping<SortingField>;

package/dist/components/table/components/table-actions-wrapper/components/sort/helpers/get-sort-mapping/get-sort-mapping.types.d.ts

@@ -0,0 +1,2 @@
+import { SortInfo } from '../../../../table.props';
+export type SortMapping<SortingField = string> = Record<string, SortInfo<SortingField>>;

package/dist/components/table/components/table-actions-wrapper/components/sort/helpers/get-sort-mapping/index.d.ts

@@ -0,0 +1 @@
+export * from './get-sort-mapping';

package/dist/components/table/components/table-actions-wrapper/components/sort/index.d.ts

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

package/dist/components/table/components/table-actions-wrapper/components/sort/sort.d.ts

@@ -0,0 +1,2 @@
+import { SortProps } from './sort.types';
+export declare const Sort: (props: SortProps) => JSX.Element;

package/dist/components/table/components/table-actions-wrapper/components/sort/sort.styles.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="react" />
+export declare const StyledDropdown: import("styled-components").StyledComponent<import("react").FC<import("react").PropsWithChildren<import("../../../../../dropdown").DropdownProps<any>>>, import("styled-components").DefaultTheme, {}, never>;

package/dist/components/table/components/table-actions-wrapper/components/sort/sort.types.d.ts

@@ -0,0 +1,24 @@
+export interface SortProps {
+    current: SortInfo;
+    disabled?: boolean;
+    fields: TableSortField<string>[];
+    onSort: (sortInfo: SortInfo) => void;
+}
+export interface SortInfo<SortingField = string> {
+    label?: string;
+    sortingField: SortingField;
+    sortingType?: SortingType;
+}
+export type SortingType = 'ASC' | 'DESC';
+export type TableSortField<SortingField = string> = {
+    bidirectional?: never;
+    label: string;
+    sortingField: SortingField;
+    /** If not provided, defaults to 'DESC' */
+    sortingType?: SortingType;
+} | {
+    bidirectional: true;
+    label: string;
+    sortingField: SortingField;
+    sortingType?: never;
+};

package/dist/components/table/components/table-actions-wrapper/index.d.ts

@@ -0,0 +1 @@
+export * from './table-actions-wrapper';

package/dist/components/table/components/table-actions-wrapper/table-actions-wrapper.d.ts

@@ -0,0 +1,30 @@
+import { JSXElementConstructor, PropsWithChildren } from 'react';
+import { PagingProps } from '../../../paging/paging.types';
+import { SortProps } from './components/sort/sort.types';
+export type FiltersProps = {
+    FiltersContent: JSX.Element;
+    count: number;
+    numActive: number;
+    onApply: () => void;
+    onClose: () => void;
+    onReset: () => void;
+};
+export interface SearchProps {
+    onSearch: (value: string) => void;
+    placeholder?: string;
+    value: string;
+}
+export interface CustomActionProps {
+    Component: JSXElementConstructor<Record<never, never>>;
+    position?: 'left' | 'right';
+}
+interface TableActionsWrapperProps {
+    customAction: CustomActionProps | undefined;
+    filters: FiltersProps | undefined;
+    paging: PagingProps | undefined;
+    search: SearchProps | undefined;
+    sorting: SortProps | undefined;
+}
+/** Wraps the table with relevant components for paging, filters, sort, and table actions. */
+export declare const TableActionsWrapper: (props: PropsWithChildren<TableActionsWrapperProps>) => JSX.Element;
+export {};

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

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

package/dist/components/table/components/table-footer/table-footer.d.ts

@@ -0,0 +1,3 @@
+import { BaseDataType } from '../../table.types';
+import { TableFooterProps } from './table-footer.types';
+export declare const TableFooter: <DataType extends BaseDataType>(props: TableFooterProps<DataType>) => JSX.Element;

package/dist/components/table/components/table-footer/table-footer.types.d.ts

@@ -0,0 +1,5 @@
+import { Table } from '@tanstack/react-table';
+import { BaseDataType } from '../../table.types';
+export type TableFooterProps<DataType extends BaseDataType> = {
+    table: Table<DataType>;
+};

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

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

package/dist/components/table/components/table-header/table-header.d.ts

@@ -0,0 +1,3 @@
+import { BaseDataType } from '../../table.types';
+import { TableHeaderProps } from './table-header.types';
+export declare const TableHeader: <DataType extends BaseDataType>(props: TableHeaderProps<DataType>) => JSX.Element;

package/dist/components/table/components/table-header/table-header.types.d.ts

@@ -0,0 +1,5 @@
+import { Table } from '@tanstack/react-table';
+import { BaseDataType } from '../../table.types';
+export type TableHeaderProps<DataType extends BaseDataType> = {
+    table: Table<DataType>;
+};

package/dist/components/table/components/table-row/hooks/use-drag-and-drop/index.d.ts

@@ -0,0 +1 @@
+export * from './use-drag-and-drop';

package/dist/components/table/components/table-row/hooks/use-drag-and-drop/use-drag-and-drop.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+import { BaseDataType } from '../../../../table.types';
+import { UseDragAndDropProps } from './use-drag-and-drop.types';
+export declare const useDragAndDrop: <DataType extends BaseDataType>(props: UseDragAndDropProps<DataType>) => {
+    dragAndDropRef: import("react").RefObject<HTMLTableRowElement>;
+    isDragging: boolean;
+};

package/dist/components/table/components/table-row/hooks/use-drag-and-drop/use-drag-and-drop.types.d.ts

@@ -0,0 +1,10 @@
+import { Row } from '@tanstack/react-table';
+import { BaseDataType } from '../../../../table.types';
+export interface UseDragAndDropProps<DataType extends BaseDataType> {
+    enableReordering: boolean;
+    handleOnReorder: () => Promise<void>;
+    index: number;
+    isSubRow: boolean;
+    moveRow: (startIndex: number, endIndex: number) => void;
+    row: Row<DataType>;
+}

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

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

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

@@ -0,0 +1,10 @@
+/** See `RowStatusValue` type for possible values. */
+export declare const dataAttrRowStatus: "data-row-status";
+export declare const dataAttrRowIsClickable: "data-row-is-clickable";
+export declare const dataAttrRowHighlightOnHover: "data-row-highlight-on-hover";
+/** Applying this data attribute marks a row as active, applying a new background color. */
+export declare const dataAttrActiveRow: "data-active-row";
+/** Prefix added to table cell data attrs (like cell ID). */
+export declare const dataAttrCellPrefix: "data-cell";
+/** Applied when a sticky styled element is observed to have become sticky via `markStickyElements`. */
+export declare const dataAttrIsSticky: "data-is-sticky";

package/dist/components/table/components/table-row/table-row.d.ts

@@ -0,0 +1,3 @@
+import { BaseDataType } from '../../table.types';
+import { TableRowProps } from './table-row.types';
+export declare const TableRow: <DataType extends BaseDataType>(props: TableRowProps<DataType>) => JSX.Element;

package/dist/components/table/components/table-row/table-row.styles.d.ts

@@ -0,0 +1,4 @@
+export declare const StyledTR: import("styled-components").StyledComponent<"tr", import("styled-components").DefaultTheme, {
+    canReorder: boolean;
+    isDragging: boolean;
+}, never>;

package/dist/components/table/components/table-row/table-row.types.d.ts

@@ -0,0 +1,12 @@
+import { Row } from '@tanstack/react-table';
+import { MouseEvent } from 'react';
+import { BaseDataType, CustomRowProps } from '../../table.types';
+export interface TableRowProps<DataType extends BaseDataType> {
+    customRowProps: CustomRowProps;
+    enableReordering: boolean;
+    handleOnReorder: () => Promise<void>;
+    index: number;
+    moveRow: (startIndex: number, endIndex: number) => void;
+    onRowClick?: (data: Row<DataType>, event: MouseEvent<HTMLTableRowElement>) => void;
+    row: Row<DataType>;
+}

package/dist/components/table/helpers/add-missing-ids/index.d.ts

@@ -0,0 +1,3 @@
+import { BaseDataType } from '../../table.types';
+/** If an index does not contain an `id` value, one is added using uuid. */
+export declare const addMissingIds: <DataType extends BaseDataType>(data: DataType[]) => DataType[];

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

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

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

@@ -0,0 +1,5 @@
+import { BaseDataType, TableProps } from './table.types';
+export declare const Table: {
+    <DataType extends BaseDataType>(props: TableProps<DataType>): JSX.Element;
+    defaultProps: import("./table.types").TableDefaultProps;
+};

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

@@ -0,0 +1,2 @@
+import { TableDefaultProps } from './table.types';
+export declare const tableDefaultProps: TableDefaultProps;

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

@@ -0,0 +1,3 @@
+export declare const StyledTable: import("styled-components").StyledComponent<"table", import("styled-components").DefaultTheme, {
+    stickyFirstColumn: boolean | undefined;
+}, never>;

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

@@ -0,0 +1,32 @@
+import { ColumnDef, Row, TableOptions } from '@tanstack/react-table';
+import { HTMLAttributes, MouseEvent } from 'react';
+import { PagingProps } from '../paging/paging.types';
+import { CustomActionProps, FiltersProps, SearchProps } from './components/table-actions-wrapper';
+import { SortProps } from './components/table-actions-wrapper/components/sort/sort.types';
+export interface BaseDataType {
+    [key: string]: unknown;
+    id?: string | number;
+    subRows?: BaseDataType[];
+}
+export interface TableProps<DataType extends BaseDataType> extends Partial<TableDefaultProps> {
+    columns: ColumnDef<DataType, any>[];
+    customAction?: CustomActionProps;
+    data: DataType[];
+    enableReordering?: boolean;
+    filters?: FiltersProps;
+    /** Include `status` in the returned value to set the row status color. */
+    getRowProps?: (row: Row<DataType>, rows: Row<DataType>[]) => CustomRowProps;
+    onReorder?: (data: DataType[]) => Promise<void>;
+    onRowClick?: (data: Row<DataType>, event: MouseEvent<HTMLTableRowElement>) => void;
+    options?: Partial<TableOptions<DataType>>;
+    paging?: PagingProps;
+    search?: SearchProps;
+    sorting?: SortProps;
+}
+export interface TableDefaultProps {
+    stickyFirstColumn: boolean;
+}
+export interface CustomRowProps extends HTMLAttributes<HTMLTableRowElement> {
+    status?: RowStatusValue | undefined;
+}
+export type RowStatusValue = 'handled' | 'next' | 'error' | 'warning';

package/dist/global/index.d.ts

@@ -1,4 +1,3 @@
 export * from './hooks';
 export * from './typings';
 export * from './environment';
-export * from './constants';

package/dist/helpers/format-as-locale-number/format-as-locale-number.d.ts

@@ -0,0 +1,6 @@
+import { FormatAsLocaleNumberOptions } from './format-as-locale-number.types';
+/**
+ * Set `locale` in `options` to override default `'en-US'`.
+ *
+ * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#options */
+export declare const formatAsLocaleNumber: (value: number, options?: FormatAsLocaleNumberOptions) => string;

package/dist/helpers/format-as-locale-number/format-as-locale-number.types.d.ts

@@ -0,0 +1,3 @@
+export interface FormatAsLocaleNumberOptions extends Intl.NumberFormatOptions {
+    locale?: string;
+}

package/dist/helpers/format-as-locale-number/index.d.ts

@@ -0,0 +1 @@
+export * from './format-as-locale-number';

package/dist/helpers/mark-sticky-elements/__tests__/mark-sticky-elements.test.d.ts

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

package/dist/helpers/mark-sticky-elements/__tests__/setup.d.ts

@@ -0,0 +1,2 @@
+import { StickyTo } from '../mark-sticky-elements.types';
+export declare const setupMockElements: (stickyTo: StickyTo) => any;

package/dist/helpers/mark-sticky-elements/helpers/get-intersection-observer-callback/__tests__/get-intersection-observer-callback.test.d.ts

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

package/dist/helpers/mark-sticky-elements/helpers/get-intersection-observer-callback/get-intersection-observer-callback.d.ts

@@ -0,0 +1,2 @@
+import { GetIntersectionObserverCallbackArgs } from './get-intersection-observer-callback.types';
+export declare const getIntersectionObserverCallback: (args: GetIntersectionObserverCallbackArgs) => IntersectionObserverCallback;

package/dist/helpers/mark-sticky-elements/helpers/get-intersection-observer-callback/get-intersection-observer-callback.types.d.ts

@@ -0,0 +1,8 @@
+import { StickyTo } from '../../mark-sticky-elements.types';
+export interface GetIntersectionObserverCallbackArgs {
+    /** If not provided, the `dataAttrIsSticky` variable value will be used. If `stickyTo` is provided, it will apply that value as a suffix to the attr (ie `${dataAttrIsSticky}-${stickyTo}`). */
+    attrToApply?: string;
+    elementsToMark: Element[];
+    /** If not provided, an intersection in any direction mark the elements. */
+    stickyTo?: StickyTo;
+}

package/dist/helpers/mark-sticky-elements/helpers/get-intersection-observer-callback/index.d.ts

@@ -0,0 +1 @@
+export * from './get-intersection-observer-callback';

package/dist/helpers/mark-sticky-elements/index.d.ts

@@ -0,0 +1 @@
+export * from './mark-sticky-elements';

package/dist/helpers/mark-sticky-elements/mark-sticky-elements.constants.d.ts

@@ -0,0 +1,2 @@
+/** Applied when a sticky styled element is observed to have become sticky via `markStickyElements`. */
+export declare const dataAttrIsSticky = "data-is-sticky";

package/dist/helpers/mark-sticky-elements/mark-sticky-elements.d.ts

@@ -0,0 +1,26 @@
+import { MarkStickyElementsArgs } from './mark-sticky-elements.types';
+/**
+ * When each arg's `elementsToObserve` is recognized as sticky, the `dataAttrIsSticky` variable value is applied to that element.
+ * @example
+ * useEffect(() => {
+ *   const elementsToMark = [document.querySelector('table')];
+ *   const elementsToObserve = Array.from(
+ *     document.querySelectorAll('tr td:first-child'),
+ *   );
+ *   const stickyTo = 'left';
+ *
+ *    const { cleanupUseEffect } = markStickyElements({
+ *     attrToApply: `${dataAttrIsSticky}-${stickyTo}`,
+ *     elementsToMark,
+ *     elementsToObserve,
+ *     stickyTo,
+ *   });
+ *
+ *    return cleanupUseEffect;
+ * }, [allColumns]);
+ *
+ * @source https://css-tricks.com/how-to-detect-when-a-sticky-element-gets-pinned/
+ */
+export declare const markStickyElements: (...args: MarkStickyElementsArgs) => {
+    cleanupUseEffect: () => void;
+};

package/dist/helpers/mark-sticky-elements/mark-sticky-elements.types.d.ts

@@ -0,0 +1,28 @@
+export interface StickyElementsDetails {
+    /** If not provided, the `dataAttrIsSticky` variable value will be used. If `stickyTo` is provided, it will apply that value as a suffix to the attr (ie `${dataAttrIsSticky}-${stickyTo}`). */
+    attrToApply?: string;
+    /**
+     * All elements in this array will be labeled as sticky according to the status of `elementsToObserve`.
+     *
+     * If using `document.querySelectorAll`, you can use `Array.from(document.querySelectorAll(SELECTOR))` to satisfy TypeScript.
+     */
+    elementsToMark?: Element[];
+    /**
+     * When any of these elements are detected as sticky, all elements in `elementsToMark` are labeled with `attrToApply` (or fallback). If `elementsToMark` is not provided, only these elements will be labeled.
+     *
+     * If using `document.querySelectorAll`, you can use `Array.from(document.querySelectorAll(SELECTOR))` to satisfy TypeScript.
+     *
+     * **IMPORTANT:** These elements should have a `-1px` styling applied to them in the direction of the sticky direction (ie, if sticky to right, add `position: sticky; right: -1px;`). Without this styling, this function may not work.
+     */
+    elementsToObserve: Element[];
+    /**
+     * Value passed to IntersectionObserver options.
+     *
+     * https://developer.mozilla.org/en-US/docs/Web/API/IntersectionObserver/root
+     * */
+    root?: Document | Element;
+    /** If not provided, an intersection in any direction mark the elements. */
+    stickyTo?: StickyTo;
+}
+export type StickyTo = 'top' | 'bottom' | 'left' | 'right';
+export type MarkStickyElementsArgs = StickyElementsDetails[];