schummar-table 0.10.4 → 0.12.0

package/dist/types/misc/csvExport.d.ts

@@ -1,7 +0,0 @@
-export declare type CsvExportOptions = {
-    sepPrefix?: boolean;
-    separator?: string;
-    quote?: string;
-    eol?: string;
-};
-export declare function csvExport(data: (string | number)[][], { sepPrefix, separator, quote, eol }?: CsvExportOptions): string;

package/dist/types/misc/debounce.d.ts

@@ -1,4 +0,0 @@
-export declare function debounce<Args extends any[]>(fn: (...args: Args) => void, ms: number): {
-    (...args: Args): void;
-    flush(): void;
-};

package/dist/types/misc/helpers.d.ts

@@ -1,16 +0,0 @@
-import { Id, TableItem } from '../types';
-export declare const flatMap: <T, S>(arr: Iterable<T>, flatMap: (t: T) => S[]) => S[];
-export declare const orderBy: <T>(arr: T[], selectors?: ((t: T) => any)[], direction?: ('desc' | 'asc')[]) => T[];
-export declare const uniq: <T>(arr: T[]) => T[];
-export declare const intersect: <T>(a: Iterable<T>, b: {
-    has(t: T): boolean;
-}) => Set<T>;
-export declare const getAncestors: <T>(activeItemsById: Map<Id, TableItem<T>>, ...items: TableItem<T>[]) => Set<Id>;
-export declare const getDescendants: <T>(...items: TableItem<T>[]) => Set<Id>;
-export declare const identity: (x: unknown) => any;
-export declare const asString: (x: unknown) => string;
-export declare const asStringOrArray: (x: unknown) => string | string[];
-export declare const defaultEquals: (a: unknown, b: unknown) => boolean;
-export declare const subStringMatch: (a: string, b: string) => boolean;
-export declare const castArray: <T>(a: T | T[]) => T[];
-export declare const cx: (...classNames: (string | false | undefined | null | Record<string, boolean>)[]) => string;

package/dist/types/misc/queue.d.ts

@@ -1,6 +0,0 @@
-export declare class Queue {
-    private q;
-    private isRunning;
-    run<T>(job: () => Promise<T>, replace?: boolean): Promise<T>;
-    private start;
-}

package/dist/types/misc/textMatch.d.ts

@@ -1,2 +0,0 @@
-export declare const textMatch: (text: string, query: string) => boolean;
-export declare const termMatch: (text: string, query: string) => boolean;

package/dist/types/misc/throttle.d.ts

@@ -1,5 +0,0 @@
-export declare function throttle<Args extends any[]>(fn: (...args: Args) => void, ms: number): {
-    (...args: Args): void;
-    flush(): void;
-    cancel(): void;
-};

package/dist/types/theme/defaultTheme/badge.d.ts

@@ -1,2 +0,0 @@
-import { TableTheme } from '../../types';
-export declare const Badge: TableTheme['components']['Badge'];

package/dist/types/theme/defaultTheme/button.d.ts

@@ -1,2 +0,0 @@
-import { TableTheme } from '../../types';
-export declare const Button: TableTheme['components']['Button'];

package/dist/types/theme/defaultTheme/checkbox.d.ts

@@ -1,2 +0,0 @@
-import { TableTheme } from '../../types';
-export declare const Checkbox: TableTheme['components']['Checkbox'];

package/dist/types/theme/defaultTheme/defaultClasses.d.ts

@@ -1,19 +0,0 @@
-export declare const white = "#ffffff";
-export declare const lightGray = "#eeeeee";
-export declare const gray = "#bdbdbd";
-export declare const darkGray = "#777";
-export declare const defaultClasses: {
-    table: import("@emotion/utils").SerializedStyles;
-    cell: import("@emotion/utils").SerializedStyles;
-    cellFill: import("@emotion/utils").SerializedStyles;
-    headerCell: import("@emotion/utils").SerializedStyles;
-    footerCell: import("@emotion/utils").SerializedStyles;
-    firstCell: import("@emotion/utils").SerializedStyles;
-    sticky: import("@emotion/utils").SerializedStyles;
-    stickyBottom: import("@emotion/utils").SerializedStyles;
-    headerFill: import("@emotion/utils").SerializedStyles;
-    footerFill: import("@emotion/utils").SerializedStyles;
-    text: import("@emotion/utils").SerializedStyles;
-    card: import("@emotion/utils").SerializedStyles;
-    clearFiltersButton: import("@emotion/utils").SerializedStyles;
-};

package/dist/types/theme/defaultTheme/defaultColors.d.ts

@@ -1,2 +0,0 @@
-import { TableTheme } from '../../types';
-export declare const defaultColors: TableTheme['colors'];

package/dist/types/theme/defaultTheme/defaultComponents.d.ts

@@ -1,2 +0,0 @@
-import { TableTheme } from '../../types';
-export declare const defaultComponents: TableTheme['components'];

package/dist/types/theme/defaultTheme/defaultIcons.d.ts

@@ -1,2 +0,0 @@
-import { TableTheme } from '../../types';
-export declare const defaultIcons: TableTheme['icons'];

package/dist/types/theme/defaultTheme/defaultTexts.d.ts

@@ -1,2 +0,0 @@
-import { TableTheme } from '../../types';
-export declare const defaultTexts: TableTheme['text'];

package/dist/types/theme/defaultTheme/iconButton.d.ts

@@ -1,2 +0,0 @@
-import { TableTheme } from '../../types';
-export declare const IconButton: TableTheme['components']['IconButton'];

package/dist/types/theme/defaultTheme/index.d.ts

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

package/dist/types/theme/defaultTheme/popover.d.ts

@@ -1,7 +0,0 @@
-import React from 'react';
-import { TableTheme } from '../../types';
-export declare const PopoverContext: React.Context<{
-    depth: number;
-    visible: boolean;
-}>;
-export declare const Popover: TableTheme['components']['Popover'];

package/dist/types/theme/defaultTheme/textField.d.ts

@@ -1,2 +0,0 @@
-import { TableTheme } from '../../types';
-export declare const TextField: TableTheme['components']['TextField'];

package/dist/types/theme/mui4Theme/index.d.ts

@@ -1,7 +0,0 @@
-import { ReactNode } from 'react';
-import { PartialTableTheme } from '../../types';
-export declare const mui4Theme: PartialTableTheme;
-export declare function Mui4TableThemeProvider({ theme, children }: {
-    theme?: PartialTableTheme;
-    children: ReactNode;
-}): import("@emotion/react/jsx-runtime").JSX.Element;

package/dist/types/theme/mui5Theme/index.d.ts

@@ -1,7 +0,0 @@
-import { ReactNode } from 'react';
-import { PartialTableTheme } from '../../types';
-export declare const mui5Theme: PartialTableTheme;
-export declare function Mui5TableThemeProvider({ theme, children }: {
-    theme?: PartialTableTheme;
-    children: ReactNode;
-}): import("@emotion/react/jsx-runtime").JSX.Element;

package/dist/types/theme/tableTheme.d.ts

@@ -1,10 +0,0 @@
-import { ReactNode } from 'react';
-import { PartialTableTheme } from '../types';
-export declare let globalTableTheme: PartialTableTheme;
-export declare function configureTableTheme(tableTheme: PartialTableTheme): void;
-export declare const TableThemeContext: import("react").Context<PartialTableTheme<unknown>>;
-export declare function TableThemeProvider({ theme, children }: {
-    theme: PartialTableTheme;
-    children: ReactNode;
-}): import("@emotion/react/jsx-runtime").JSX.Element;
-export declare function mergeThemes<T>(...themes: PartialTableTheme<T>[]): PartialTableTheme<T>;

package/dist/types/theme/useCssVariables.d.ts

@@ -1,9 +0,0 @@
-export declare function useCssVariables(): {
-    '--spacing': string | number;
-    '--primaryMain': string;
-    '--primaryLight': string;
-    '--primaryContrastText': string;
-    '--secondaryMain': string;
-    '--secondaryLight': string;
-    '--secondaryContrastText': string;
-};

package/dist/types/types.d.ts

@@ -1,329 +0,0 @@
-import { CSSInterpolation } from '@emotion/serialize';
-import React, { ComponentType, DependencyList, ReactNode, Ref } from 'react';
-import { TableStateStorage } from './internalState/tableStateStorage';
-import { CsvExportOptions } from './misc/csvExport';
-export declare type Sort = {
-    columnId: string | number;
-    direction: SortDirection;
-};
-export declare type SortDirection = 'asc' | 'desc';
-export declare type Id = string | number;
-export declare type KeyOfType<T, S> = {
-    [K in keyof T]: T[K] extends S ? K : never;
-}[keyof T];
-export declare type FunctionWithDeps<F extends (...args: any[]) => any> = F | [function: F, ...deps: DependencyList];
-export declare type MemoizedFunctions<T> = {
-    [K in keyof T]: Exclude<T[K], [function: (...args: any[]) => any, ...deps: DependencyList[]]>;
-};
-export interface TableTheme<T = unknown> {
-    /** Define display texts. */
-    text: {
-        selectColumns: ReactNode;
-        noResults: ReactNode;
-        exportTitle: ReactNode;
-        exportCopy: ReactNode;
-        exportDownload: ReactNode;
-        today: ReactNode;
-        thisWeek: ReactNode;
-        reset: ReactNode;
-        loading: ReactNode;
-        clearFilters: ReactNode;
-        deselectAll: ReactNode;
-    };
-    /** Define styles. */
-    classes?: {
-        table?: string;
-        headerCell?: string;
-        footerCell?: string;
-        cell?: string | FunctionWithDeps<(item: T, index: number) => string | undefined>;
-        evenCell?: string;
-        oddCell?: string;
-    };
-    /** Define components to be used in the table. */
-    components: {
-        IconButton: ComponentType<{
-            children: ReactNode;
-            onClick?: (e: React.MouseEvent<Element>) => void;
-            className?: string;
-        }>;
-        Button: ComponentType<{
-            children: ReactNode;
-            onClick?: (e: React.MouseEvent<Element>) => void;
-            startIcon?: ReactNode;
-            variant?: 'text' | 'outlined' | 'contained';
-            disabled?: boolean;
-            className?: string;
-        }>;
-        Checkbox: ComponentType<{
-            checked: boolean;
-            onChange: (e: React.ChangeEvent) => void;
-            disabled?: boolean;
-            className?: string;
-        }>;
-        Popover: ComponentType<{
-            anchorEl: Element | null;
-            open: boolean;
-            hidden?: boolean;
-            onClose: () => void;
-            children: ReactNode;
-            className?: string;
-            align?: 'center' | 'left';
-        }>;
-        Badge: ComponentType<{
-            children: ReactNode;
-            badgeContent: ReactNode;
-        }>;
-        TextField: ComponentType<{
-            value: string | null;
-            onChange: (e: React.ChangeEvent<HTMLInputElement>) => void;
-            endIcon?: ReactNode;
-            className?: string;
-            inputRef?: Ref<HTMLInputElement>;
-        }>;
-        Spinner: (props: {
-            className?: string;
-        }) => JSX.Element;
-    };
-    /** Define icons for the table. */
-    icons: {
-        [K in 'Settings' | 'Export' | 'Clipboard' | 'ChevronRight' | 'Search' | 'Clear' | 'ArrowDropDown' | 'FilterList' | 'ArrowUpward']: ComponentType<{
-            className?: string;
-        }>;
-    };
-    /** Define colors */
-    colors: {
-        primary: {
-            main: string;
-            light: string;
-            contrastText: string;
-        };
-        secondary: {
-            main: string;
-            light: string;
-            contrastText: string;
-        };
-    };
-    /** Spacing. */
-    spacing: string | number;
-}
-export declare type PartialTableTheme<T = unknown> = {
-    [K in keyof TableTheme<T>]?: TableTheme<T>[K] extends Record<string, any> ? Partial<TableTheme<T>[K]> : TableTheme<T>[K];
-};
-export declare type MemoizedTableTheme<T> = Omit<TableTheme, 'classes' | 'text'> & {
-    classes: MemoizedFunctions<TableTheme<T>['classes']>;
-    text: MemoizedFunctions<TableTheme<T>['text']>;
-};
-export interface TableProps<T> extends PartialTableTheme<T> {
-    /** The data to be rendered. One item per row. */
-    items?: T[];
-    /** Unique id for each item/row. */
-    id: FunctionWithDeps<(item: T) => Id> | KeyOfType<T, Id>;
-    /** Create a nested structure by assigning parents to items. Child items are hidden until the parent is expanded. */
-    parentId?: FunctionWithDeps<(item: T) => Id | undefined> | KeyOfType<T, Id | undefined>;
-    /** If true for an item, it means that children will be loaded asynchronously as soon as item is expanded. */
-    hasDeferredChildren?: (item: T) => boolean;
-    /** Column definitions. */
-    columns: Column<T, any>[] | ((col: <V>(value: (item: T) => V, column: Omit<Column<T, V>, 'value'>) => Column<T, V>) => Column<T, any>[]);
-    /** Default props for all column. Will take effect if not overriden in column definition. */
-    defaultColumnProps?: Omit<Column<T, unknown>, 'id' | 'value'>;
-    /** Wrap each cell */
-    wrapCell?: FunctionWithDeps<(content: ReactNode, value: unknown, item: T, index: number) => ReactNode>;
-    /** Display a cell at the start of each row. Useful for "go to details" button for example. */
-    rowAction?: ReactNode | FunctionWithDeps<(item: T, index: number) => ReactNode>;
-    /** Default sort order. */
-    defaultSort?: Sort[];
-    /** If given, controls the sort order. */
-    sort?: Sort[];
-    /** Called when sort order changes. */
-    onSortChange?: (sort: Sort[]) => void;
-    /** Default selection. */
-    defaultSelection?: Set<Id>;
-    /** If given, controls the selection. */
-    selection?: Set<Id>;
-    /** Called when selection changes. */
-    onSelectionChange?: (selection: Set<Id>) => void;
-    /** Whether to show checkboxes at the start of each row.
-     * @default true
-     */
-    enableSelection?: boolean;
-    /** Select and deselect children if a parent is selected or deselected.
-     * @default true
-     */
-    selectSyncChildren?: boolean;
-    /** Expand parents whose children fit a newly selected filter
-     * @default false
-     */
-    revealFiltered?: boolean;
-    /** Default expanded rows. */
-    defaultExpanded?: Set<Id>;
-    /** If given, controls expanded rows. */
-    expanded?: Set<Id>;
-    /** Called when expanded rows change. */
-    onExpandedChange?: (expanded: Set<Id>) => void;
-    /** If enabled and one row is expanded, other rows will be closed.
-     * @default false
-     */
-    expandOnlyOne?: boolean;
-    /** Default hidden columns. */
-    defaultHiddenColumns?: Set<Id>;
-    /** If given, controls hidden columns. */
-    hiddenColumns?: Set<Id>;
-    /** Called when hidden columns change. */
-    onHiddenColumnsChange?: (hiddenColumns: Set<Id>) => void;
-    /** Whether to stretch the table component over the available space. If value is "left" or "right", align accordingly. */
-    fullWidth?: boolean | 'left' | 'right';
-    /** Whether the table header should be sticky.
-     * @default true
-     */
-    stickyHeader?: boolean | {
-        top: number;
-    };
-    /** Whether the table footer should be sticky.
-     * @default true
-     */
-    stickyFooter?: boolean | {
-        bottom: number;
-    };
-    /** Whether the table cells should only be rendered when in viewport.
-     * @default true
-     */
-    virtual?: boolean | {
-        rowHeight?: number;
-        initalRowHeight?: number;
-        throttleScroll?: number;
-        overscan?: number;
-        overscanBottom?: number;
-        overscanTop?: number;
-    };
-    /** Enable menu to select which columns are visible.
-     * @default true
-     */
-    enableColumnSelection?: boolean;
-    /** Enable exporting to csv.
-     * @default false
-     */
-    enableExport?: boolean | {
-        copy?: boolean | CsvExportOptions;
-        download?: boolean | CsvExportOptions;
-    };
-    /** Shows a button to clear all filters while any are active
-     * @default false
-     */
-    enableClearFiltersButton?: boolean;
-    /** Allow to drag and drop column separators to resize the column left of it.
-     * @default true
-     */
-    enableColumnResize?: boolean;
-    /** Allow to drag and drop column header to reorder columns.
-     * @default true
-     */
-    enableColumnReorder?: boolean;
-    /** If enabled, automatically store table state in localStorage, localForage or another compatible storage. */
-    persist?: {
-        storage: TableStateStorage;
-        id: string;
-        include?: ('sort' | 'selection' | 'expanded' | 'hiddenColumns' | 'filterValues' | 'columnWidths' | 'columnOrder')[];
-        exclude?: ('sort' | 'selection' | 'expanded' | 'hiddenColumns' | 'filterValues' | 'columnWidths' | 'columnOrder')[];
-    };
-    debug?: (...output: any) => void;
-    debugRender?: (...output: any) => void;
-}
-export declare type InternalTableProps<T> = MemoizedFunctions<Omit<TableProps<T>, 'id' | 'parentId' | 'columns' | 'defaultColumnProps' | 'enableExport'> & {
-    id: (item: T) => Id;
-    parentId?: (item: T) => Id | undefined;
-    columns: InternalColumn<T, unknown>[];
-    enableExport: {
-        copy?: CsvExportOptions;
-        download?: CsvExportOptions;
-    };
-}>;
-export declare type TableItem<T = unknown> = {
-    id: Id;
-    parentId?: Id;
-    children: TableItem<T>[];
-    value: T;
-};
-export declare type Column<T, V> = {
-    /** Column id. If not provided, the index in the column array will be used.
-     * An explicit id is better however for controlling column related states, persitance etc.
-     */
-    id?: string;
-    /** Render table header for this column. */
-    header?: ReactNode | FunctionWithDeps<(values: V[], items: T[]) => ReactNode>;
-    /** Render table header for this column. */
-    footer?: ReactNode | FunctionWithDeps<(values: V[], items: T[]) => ReactNode>;
-    /** Extract value for this column */
-    value: FunctionWithDeps<(item: T) => V>;
-    /** Render table cell. If not provided, a string representation of the value will be rendered. */
-    renderCell?: FunctionWithDeps<(value: V, item: T) => ReactNode>;
-    /** Serialize column value for exports. If not provided, a string representation of the value will be used. */
-    exportCell?: (value: V, item: T) => string | number;
-    /** Customize sort criteria. By default it will be the value itself in case it's a number or Date, or a string representation of the value otherwise. */
-    sortBy?: FunctionWithDeps<(value: V, item: T) => unknown>[];
-    /** Set filter component that will be displayed in the column header */
-    filter?: ReactNode;
-    /** Prevent hiding the column. */
-    cannotHide?: boolean;
-    /** Specify a css width.
-     * @default 'max-content'
-     */
-    width?: string;
-    /** Provide css class names to override columns styles. */
-    classes?: TableTheme<T>['classes'];
-};
-export declare type InternalColumn<T, V> = MemoizedFunctions<Required<Omit<Column<T, V>, 'id' | 'sortBy'>, 'header' | 'renderCell' | 'exportCell' | 'sortBy'> & {
-    id: Id;
-    sortBy: ((value: V, item: T) => unknown)[];
-}>;
-declare type Required<T, S> = T & {
-    [P in keyof T as P extends S ? P : never]-?: T[P];
-};
-export declare type InternalTableState<T> = {
-    props: InternalTableProps<T>;
-    sort: Sort[];
-    selection: Set<Id>;
-    expanded: Set<Id>;
-    rowHeights: Map<Id, number>;
-    filters: Map<Id, MemoizedFunctions<FilterImplementation<T, any, any, any>>>;
-    filterValues: Map<Id, any>;
-    hiddenColumns: Set<Id>;
-    columnWidths: Map<Id, string>;
-    columnOrder: Id[];
-    columnStyleOverride: Map<Id, CSSInterpolation>;
-    activeColumns: InternalColumn<T, unknown>[];
-    items: TableItem<T>[];
-    itemsById: Map<Id, TableItem<T>>;
-    activeItems: TableItem<T>[];
-    activeItemsById: Map<Id, TableItem<T>>;
-    lastSelectedId?: Id;
-};
-export declare type CommonFilterProps<T, V, F, S extends SerializableValue> = {
-    /** Filter by? By default the column value will be used. If filterBy returns an array, an items will be active if at least one entry matches the active filter. */
-    filterBy?: FunctionWithDeps<(value: V, item: T) => F | F[]>;
-    /** Preselected filter value. */
-    defaultValue?: S;
-    /** Controlled filter value. */
-    value?: S;
-    /** Notifies on filter change. */
-    onChange?: (value?: S) => void;
-    /** Whether to persist filter value (given that filter persitance is enabled for the table).
-     * @default true
-     */
-    persist?: boolean;
-};
-export declare type FilterImplementation<T, V, F, S extends SerializableValue> = CommonFilterProps<T, V, F, S> & {
-    /** Unique filter id. Used to persist filter values. */
-    id: string;
-    /** Whether the filter is active currently. */
-    isActive: (filterValue: S) => boolean;
-    /** When the filter is active, this function is used to filter the items to be displayed. */
-    test: (filterValue: S, value: F) => boolean;
-};
-export declare type SerializableValue = string | number | boolean | null | Date | SerializableArray | SerializableObject | SerializableSet | SerializableMap;
-export declare type SerializableObject = {
-    [key: string]: SerializableValue;
-};
-export declare type SerializableArray = SerializableValue[];
-export declare type SerializableSet = Set<SerializableValue>;
-export declare type SerializableMap = Map<SerializableValue, SerializableValue>;
-export {};