@popmenu/table 0.126.1 → 0.126.2

package/build/cjs/components/ColumnFilterChip/ColumnFilterChip.d.ts

@@ -0,0 +1,9 @@
+/// <reference types="react" />
+import { ColumnFilter } from '@tanstack/react-table';
+interface ColumnFilterChipProps {
+    columnFilter: ColumnFilter;
+    label: [string, string];
+    onClick: (columnFilter: ColumnFilter) => void;
+}
+export declare const ColumnFilterChip: (props: ColumnFilterChipProps) => JSX.Element;
+export {};

package/build/cjs/components/ColumnFilterChip/ColumnFilterChipStyles.d.ts

@@ -0,0 +1 @@
+export declare const useStyles: (props?: any) => import("@material-ui/styles").ClassNameMap<"label" | "chip">;

package/build/cjs/components/ColumnFilterChip/index.d.ts

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

package/build/cjs/components/ColumnFilterResetButton/ColumnFilterResetButton.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+import { ButtonProps } from '@popmenu/admin-ui';
+export declare const ColumnFilterResetButton: (props: ButtonProps) => JSX.Element;

package/build/cjs/components/ColumnFilterResetButton/index.d.ts

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

package/build/cjs/components/FilterPanel/FilterControl/FilterControl.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+import { ColumnFilter } from '../FilterPanelProps';
+export declare const FilterControl: (props: ColumnFilter) => JSX.Element;

package/build/cjs/components/FilterPanel/FilterControl/SelectFilter/SelectFilter.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="react" />
+import { ColumnFilter } from '../../FilterPanelProps';
+export declare const SelectFilter: (props: Pick<ColumnFilter, "options" | "columnId"> & {
+    multiple: boolean;
+}) => JSX.Element;

package/build/cjs/components/FilterPanel/FilterControl/SelectFilter/SelectFilterStyles.d.ts

@@ -0,0 +1 @@
+export declare const useStyles: (props?: any) => import("@material-ui/styles").ClassNameMap<string>;

package/build/cjs/components/FilterPanel/FilterControl/SelectFilter/index.d.ts

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

package/build/cjs/components/FilterPanel/FilterControl/ToggleFilter/ToggleFilter.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="react" />
+export declare const ToggleFilter: (props: {
+    columnId: string;
+}) => JSX.Element;

package/build/cjs/components/FilterPanel/FilterControl/ToggleFilter/index.d.ts

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

package/build/cjs/components/FilterPanel/FilterControl/index.d.ts

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

package/build/cjs/components/FilterPanel/FilterPanel.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="react" />
+export declare const FilterPanel: () => JSX.Element;

package/build/cjs/components/FilterPanel/FilterPanelContext/FilterPanelContext.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+declare type FilterPanelContextValue = {
+    anchorState: [Element | null, React.Dispatch<React.SetStateAction<Element | null>>];
+};
+export declare const FilterPanelContext: React.Context<FilterPanelContextValue | null>;
+export declare const useFilterPanelContext: () => FilterPanelContextValue;
+export {};

package/build/cjs/components/FilterPanel/FilterPanelContext/index.d.ts

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

package/build/cjs/components/FilterPanel/FilterPanelProps.d.ts

@@ -0,0 +1,11 @@
+export declare type ColumnFilterInput = 'text' | 'number' | 'radio' | 'select' | 'multi-select';
+export declare type ColumnFilter = {
+    columnId: string;
+    input: ColumnFilterInput;
+    min?: number;
+    max?: number;
+    options: Array<{
+        label: string;
+        value: string | number;
+    }>;
+};

package/build/cjs/components/FilterPanel/Panel/Panel.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+declare type PanelProps = {
+    anchorEl: null | Element;
+    onClose: () => void;
+};
+export declare const Panel: (props: PanelProps) => JSX.Element;
+export {};

package/build/cjs/components/FilterPanel/Panel/PanelStyles.d.ts

@@ -0,0 +1 @@
+export declare const useStyles: (props?: any) => import("@material-ui/styles").ClassNameMap<string>;

package/build/cjs/components/FilterPanel/Panel/index.d.ts

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

package/build/cjs/components/FilterPanel/Trigger/Trigger.d.ts

@@ -0,0 +1,7 @@
+import { SyntheticEvent } from 'react';
+declare type FitlerPanelTriggerProps = {
+    onClick: (event: SyntheticEvent) => void;
+    label?: string;
+};
+export declare const Trigger: (props: FitlerPanelTriggerProps) => JSX.Element;
+export {};

package/build/cjs/components/FilterPanel/Trigger/TriggerStyles.d.ts

@@ -0,0 +1 @@
+export declare const useStyles: (props?: any) => import("@material-ui/styles").ClassNameMap<"root">;

package/build/cjs/components/FilterPanel/Trigger/index.d.ts

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

package/build/cjs/components/FilterPanel/index.d.ts

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

package/build/cjs/components/GlobalFilter/GlobalFilter.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+import { GlobalFilterProps } from './GlobalFilterProps';
+export declare const GlobalFilter: (props: GlobalFilterProps) => JSX.Element;

package/build/cjs/components/GlobalFilter/GlobalFilterProps.d.ts

@@ -0,0 +1,7 @@
+import { OutlinedTextFieldProps } from '@material-ui/core';
+export interface GlobalFilterProps extends Omit<OutlinedTextFieldProps, 'variant'> {
+    /** the value of global filter from table instance */
+    value: string;
+    /** the setter for value of global filter from table instance */
+    setValue: (value: string) => void;
+}

package/build/cjs/components/GlobalFilter/GlobalFilterStyles.d.ts

@@ -0,0 +1 @@
+export declare const useStyles: (props?: any) => import("@material-ui/styles").ClassNameMap<"root">;

package/build/cjs/components/GlobalFilter/index.d.ts

@@ -0,0 +1,2 @@
+export { GlobalFilter } from './GlobalFilter';
+export { GlobalFilterProps } from './GlobalFilterProps';

package/build/cjs/components/RowActions/RowActions.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+import { RowActionsProps } from './RowActionsProps';
+export declare const RowActions: (props: RowActionsProps) => JSX.Element;

package/build/cjs/components/RowActions/RowActionsProps.d.ts

@@ -0,0 +1,13 @@
+import { FC, SVGProps } from 'react';
+import { CellContext } from '@tanstack/react-table';
+export interface RowAction {
+    icon: FC<SVGProps<SVGSVGElement>>;
+    label: string;
+    onClick: (props: CellContext<any, any>) => void;
+}
+export interface RowActionsProps {
+    /** Expects cellContext from react-table and is passed through to action components */
+    context: CellContext<any, any>;
+    /** List of actions for a given row */
+    actions: Array<RowAction>;
+}

package/build/cjs/components/RowActions/index.d.ts

@@ -0,0 +1,2 @@
+export { RowActions } from './RowActions';
+export { RowActionsProps } from './RowActionsProps';

package/build/cjs/components/Table/Table.d.ts

@@ -0,0 +1,21 @@
+/// <reference types="react" />
+import { TableProps } from './TableProps';
+declare const defaultTableProps: {
+    enableSortingRemoval: boolean;
+    fullWidth: boolean;
+    paginated: boolean;
+    sortable: boolean;
+    searchable: boolean;
+};
+declare type DefaultTableProps<T> = TableProps<T> & typeof defaultTableProps;
+export declare const Table: {
+    <T>(props: DefaultTableProps<T>): JSX.Element;
+    defaultProps: {
+        enableSortingRemoval: boolean;
+        fullWidth: boolean;
+        paginated: boolean;
+        sortable: boolean;
+        searchable: boolean;
+    };
+};
+export {};

package/build/cjs/components/Table/TableProps.d.ts

@@ -0,0 +1,47 @@
+import { TextFieldProps } from '@material-ui/core';
+import { ColumnDef, ColumnFiltersState, PaginationState, SortingState } from '@tanstack/react-table';
+import { Dispatch, SetStateAction } from 'react';
+export interface ColumnFilter {
+    id: string;
+    value: unknown;
+}
+export interface TableProps<T = unknown> {
+    /** The table's title. */
+    title?: string;
+    /** List of objects representing the rows of a Table. */
+    data: Array<T>;
+    /** List of column definitions. */
+    columns: Array<ColumnDef<T, any>>;
+    /** Change column sorting change pattern - true: 'none' -> 'desc' -> 'asc' -> 'none' -> ..., false: 'none' -> 'desc' -> 'asc' -> 'desc' -> 'asc' -> ... */
+    enableSortingRemoval?: boolean;
+    /** Controls table loading state. */
+    loading?: boolean;
+    /** Forces a table to take up the width of its container when true. */
+    fullWidth?: boolean;
+    /** Adds a global filter to the table. for uncontrolled global filtering only. */
+    searchable?: boolean;
+    /** Makes columns sortable. For uncontrolled sorting only. */
+    sortable?: boolean;
+    /** Enables and disables pagination all together for the table. */
+    paginated?: boolean;
+    /** Sorting state. Expects the result of a React useState hook. Used only for manual sorting. */
+    sortingState?: [SortingState, Dispatch<SetStateAction<SortingState>>];
+    /** Pagination state. Expects the result of a React useState hook. Used only for manual pagination. */
+    paginationState?: [PaginationState, Dispatch<SetStateAction<PaginationState>>];
+    /** GlobalFiltering state. Expects the result of a React useState hook. Used only for manual filtering. */
+    globalFilterState?: [string, Dispatch<SetStateAction<string>>];
+    /** Props applied to the TextField for global filtering. */
+    GlobalFilterProps?: TextFieldProps;
+    /** Filtering state. Expects the result of a React useState hook. Used only for manual filtering. */
+    filterState?: [ColumnFiltersState, Dispatch<SetStateAction<Array<ColumnFilter>>>];
+    /** Filtering state. Expects the result of a React useState hook. Used only for manual filtering. */
+    visibilityState?: [Record<string, boolean>, Dispatch<SetStateAction<Record<string, boolean>>>];
+    /** Number of pages. Used only for manual pagination. */
+    pageCount?: number;
+    /** A React Component to be rendered when the data set is empty. */
+    Empty?: () => JSX.Element;
+    /** A string used to construct ids and tags used throughout the table for tagging inner elements. ie: data-tour-id. */
+    idBase?: string;
+    /** Controls which filter should be used for the application, automatic or manual. */
+    stageFilterSelections?: boolean;
+}

package/build/cjs/components/Table/TableStyles.d.ts

@@ -0,0 +1,2 @@
+import { TableProps } from './TableProps';
+export declare const useStyles: (props: TableProps<any>) => import("@material-ui/styles").ClassNameMap<string>;

package/build/cjs/components/Table/index.d.ts

@@ -0,0 +1,2 @@
+export { Table } from './Table';
+export { TableProps } from './TableProps';

package/build/cjs/components/TableBody/TableBody.d.ts

@@ -0,0 +1,4 @@
+import { HTMLAttributes, PropsWithChildren } from 'react';
+declare type TableBodyProps = PropsWithChildren<HTMLAttributes<HTMLTableSectionElement>>;
+export declare const TableBody: (props: TableBodyProps) => JSX.Element;
+export {};

package/build/cjs/components/TableBody/index.d.ts

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

package/build/cjs/components/TableCell/TableCell.d.ts

@@ -0,0 +1,4 @@
+import { HTMLAttributes, PropsWithChildren } from 'react';
+declare type TableCellProps = PropsWithChildren<HTMLAttributes<HTMLTableCellElement>>;
+export declare const TableCell: (props: TableCellProps) => JSX.Element;
+export {};

package/build/cjs/components/TableCell/TableCellStyles.d.ts

@@ -0,0 +1 @@
+export declare const useTableCellStyles: (props?: any) => import("@material-ui/styles").ClassNameMap<"root">;

package/build/cjs/components/TableCell/index.d.ts

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

package/build/cjs/components/TableContext/index.d.ts

@@ -0,0 +1,16 @@
+/// <reference types="react" />
+import { ColumnFilter, Table } from '@tanstack/react-table';
+export declare type StagedColumnFilter = {
+    update: (columnId: string, value: string | Array<string>) => void;
+    get: (columnId: string) => string | Array<string> | undefined;
+    clear: () => void;
+    delete: (columnFilter: ColumnFilter) => void;
+    exist: () => boolean;
+};
+declare type TabelContextValue = {
+    table: Table<any>;
+    stagedColumnFilters: StagedColumnFilter;
+    stageFilterSelections: boolean | undefined;
+};
+export declare const TableContext: import("react").Context<TabelContextValue>;
+export {};

package/build/cjs/components/TableControlsContainer/TableControlsContainer.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+import { TableControlsContainerProps } from './TableControlsContainerProps';
+export declare const TableControlsContainer: (props: TableControlsContainerProps) => JSX.Element;

package/build/cjs/components/TableControlsContainer/TableControlsContainerProps.d.ts

@@ -0,0 +1,6 @@
+import { PropsWithChildren } from 'react';
+export declare type TableControlsContainerProps = PropsWithChildren<{
+    showTitle: boolean;
+    showGlobalSearch: boolean;
+    showColumnFilter: boolean;
+}>;

package/build/cjs/components/TableControlsContainer/index.d.ts

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

package/build/cjs/components/TableFooter/TableFooter.d.ts

@@ -0,0 +1,4 @@
+import { HTMLAttributes, PropsWithChildren } from 'react';
+declare type TableFooterProps = PropsWithChildren<HTMLAttributes<HTMLDivElement>>;
+export declare const TableFooter: (props: TableFooterProps) => JSX.Element;
+export {};

package/build/cjs/components/TableFooter/index.d.ts

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

package/build/cjs/components/TableHeader/TableHeader.d.ts

@@ -0,0 +1,4 @@
+import { HTMLAttributes, PropsWithChildren } from 'react';
+declare type TableHeadProps = PropsWithChildren<HTMLAttributes<HTMLTableSectionElement>>;
+export declare const TableHeader: (props: TableHeadProps) => JSX.Element;
+export {};

package/build/cjs/components/TableHeader/index.d.ts

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

package/build/cjs/components/TableHeaderCell/TableHeaderCell.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+import { TableHeaderCellProps } from './TableHeaderCellProps';
+export declare const TableHeaderCell: (props: TableHeaderCellProps) => JSX.Element;

package/build/cjs/components/TableHeaderCell/TableHeaderCellProps.d.ts

@@ -0,0 +1,6 @@
+import { HeaderContext } from '@tanstack/react-table';
+import { PropsWithChildren, HTMLAttributes } from 'react';
+export declare type ChildrenAndAttributes = PropsWithChildren<HTMLAttributes<HTMLTableCellElement>>;
+export interface TableHeaderCellProps extends ChildrenAndAttributes {
+    context: HeaderContext<unknown, unknown>;
+}

package/build/cjs/components/TableHeaderCell/TableHeaderCellStyles.d.ts

@@ -0,0 +1,4 @@
+import { TableHeaderCellProps } from './TableHeaderCellProps';
+export declare const useStyles: (props: TableHeaderCellProps & {
+    sortable: boolean;
+}) => import("@material-ui/styles").ClassNameMap<string>;

package/build/cjs/components/TableHeaderCell/index.d.ts

@@ -0,0 +1,2 @@
+export { TableHeaderCell } from './TableHeaderCell';
+export { TableHeaderCellProps } from './TableHeaderCellProps';

package/build/cjs/components/TableHeaderRow/TableHeaderRow.d.ts

@@ -0,0 +1,4 @@
+import { PropsWithChildren, HTMLAttributes } from 'react';
+declare type TableHaderRowProps = PropsWithChildren<HTMLAttributes<HTMLTableRowElement>>;
+export declare const TableHeaderRow: (props: TableHaderRowProps) => JSX.Element;
+export {};

package/build/cjs/components/TableHeaderRow/index.d.ts

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

package/build/cjs/components/TableRow/TableRow.d.ts

@@ -0,0 +1,4 @@
+import { HTMLAttributes, PropsWithChildren } from 'react';
+declare type TableRowProps = PropsWithChildren<HTMLAttributes<HTMLTableRowElement>>;
+export declare const TableRow: (props: TableRowProps) => JSX.Element;
+export {};

package/build/cjs/components/TableRow/TableRowStyles.d.ts

@@ -0,0 +1 @@
+export declare const useTableRowStyles: (props?: any) => import("@material-ui/styles").ClassNameMap<"root">;

package/build/cjs/components/TableRow/index.d.ts

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

package/build/cjs/components/index.d.ts

@@ -0,0 +1,10 @@
+export { Table, TableProps } from './Table';
+export { RowActions, RowActionsProps } from './RowActions';
+export { GlobalFilter } from './GlobalFilter';
+export { TableBody } from './TableBody';
+export { TableCell } from './TableCell';
+export { TableFooter } from './TableFooter';
+export { TableHeader } from './TableHeader';
+export { TableHeaderCell, TableHeaderCellProps } from './TableHeaderCell';
+export { TableHeaderRow } from './TableHeaderRow';
+export { TableRow } from './TableRow';

package/build/cjs/hooks/index.d.ts

@@ -0,0 +1,2 @@
+export { useColumnFilters } from './useColumnFilters';
+export { useStagedColumnFilters } from './useStagedColumnFilters';

package/build/cjs/hooks/useColumnFilters.d.ts

@@ -0,0 +1,9 @@
+import { ColumnFilter, Table } from '@tanstack/react-table';
+export declare const useColumnFilters: (table: Table<unknown>) => {
+    selectedColumnFilters: ColumnFilter[];
+    columnFilters: any[];
+    hasColumnFilters: boolean;
+    deselectColumnFilter: (columnFilter: ColumnFilter) => void;
+    formatSelectedFilterText: (columnFilter: ColumnFilter) => [string, string];
+    resetColumnFilters: (defaultState?: boolean | undefined) => void;
+};

package/build/cjs/hooks/useStagedColumnFilters.d.ts

@@ -0,0 +1,8 @@
+import { ColumnFilter } from '@tanstack/react-table';
+export declare const useStagedColumnFilters: (selectedColumnFilters: ColumnFilter[]) => {
+    update: (columnId: string, value: string | Array<string>) => void;
+    get: (columnId: string) => string | string[] | undefined;
+    clear: () => void;
+    delete: (columnFilter: ColumnFilter) => void;
+    exist: () => boolean;
+};

package/build/cjs/index.d.ts

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