@popmenu/table 0.45.0 → 0.47.0

package/build/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/components/ColumnFilterChip/index.d.ts

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

package/build/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/components/ColumnFilterResetButton/index.d.ts

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

package/build/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/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/components/FilterPanel/FilterControl/SelectFilter/SelectFilterStyles.d.ts

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

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

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

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

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

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

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

package/build/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/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/components/FilterPanel/Panel/PanelStyles.d.ts

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

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

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

package/build/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/components/FilterPanel/Trigger/TriggerStyles.d.ts

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

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

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

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

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

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

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

package/build/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/components/RowActions/RowActionsProps.d.ts

@@ -0,0 +1,11 @@
+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 {
+    context: CellContext<any, any>;
+    actions: Array<RowAction>;
+}

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

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

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

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

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

@@ -1,44 +1,32 @@
-import React from 'react';
-import { Cell, Column, TableInstance, UsePaginationOptions } from 'react-table';
-import { GlobalFilterProps } from '../GlobalFilter';
-export interface TableProps {
-    /** Configurations for each individual column. */
-    columns: Array<Column & {
-        accessor: string;
-    }>;
-    /** A table's data set. */
-    data: Array<Record<string, unknown>>;
-    /** Actions that can be performed on any given row. */
-    actions?: Record<string, {
-        icon?: string | React.FC<React.SVGProps<SVGSVGElement>>;
-        label: string;
-        action: (cell: Cell) => void;
-    }>;
-    /** Styles the table to maintain the height of a fully populated page (entries in a table, not the window). */
-    fullHeight?: boolean;
-    /** Styles the table to take up its containers full width. */
+import { Column, ColumnFiltersState, PaginationState } from '@tanstack/react-table';
+import { Dispatch, SetStateAction } from 'react';
+export interface ColumnFilter {
+    id: string;
+    value: unknown;
+}
+export interface TableProps<T = unknown> {
+    /** List of objects representing the rows of a Table. */
+    data: Array<T>;
+    /** List of column definitions. */
+    columns: Array<Column<T>>;
+    /** Controls table loading state. */
+    loading?: boolean;
+    /** Forces a table to take up the width of its container when true. */
     fullWidth?: boolean;
-    /** Enables global filter as search. */
+    /** Adds a global filter to the table. for uncontrolled global filtering only. */
     searchable?: boolean;
-    /** Enables sortability for columns. */
+    /** Makes columns sortable. For uncontrolled sorting only. */
     sortable?: boolean;
-    /** Sets loading state. When true, Will render a CircularProgress when true and not rows.  */
-    loading?: boolean;
-    /** A short message for users when the data set does not produce any rows. */
-    emptyMessage?: string;
-    /** An image to be displayed with the empty message. */
-    EmptyImage?: () => React.ReactNode;
-    /** Props applied to the global search input component. Extends [TextField props](https://v4.mui.com/api/text-field/). */
-    GlobalFilterProps?: Omit<GlobalFilterProps, 'value' | 'setValue'>;
-    /** Callback for managing pagination events. */
-    onPaginate?: (pageIndex: number, instance: TableInstance) => void;
-    /** Callback for managing pagination events. */
-    paginationOptions?: UsePaginationOptions<Record<string, unknown>> & Partial<{
-        initialState: Partial<{
-            pageSize: number;
-            pageIndex: number;
-        }>;
-    }>;
-    /** Added to the main parameter of the useTable hook. */
-    tableOptions?: Record<string, unknown>;
+    /** 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>>];
+    /** 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;
 }

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

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

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

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

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

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

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

@@ -1 +1 @@
-export { TableBody as default } from './TableBody';
+export { TableBody } from './TableBody';

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

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

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

@@ -1 +1 @@
-export { TableCell as default } from './TableCell';
+export { TableCell } from './TableCell';

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

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+import { Table } from '@tanstack/react-table';
+export declare const TableContext: import("react").Context<Table<any>>;

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

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

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

@@ -1 +1 @@
-export { TableFooter as default } from './TableFooter';
+export { TableFooter } from './TableFooter';

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

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

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

@@ -1 +1 @@
-export { TableHeader as default } from './TableHeader';
+export { TableHeader } from './TableHeader';

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

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

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

@@ -1,8 +1,6 @@
-import { Column } from 'react-table';
-import { TableProps } from '../Table';
-export interface TableHeaderCellProps {
-    column: Column & {
-        isActionColumn: boolean;
-    };
-    tableProps: TableProps;
+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/components/TableHeaderCell/TableHeaderCellStyles.d.ts

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

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

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

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

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

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

@@ -1 +1 @@
-export { TableHeaderRow as default } from './TableHeaderRow';
+export { TableHeaderRow } from './TableHeaderRow';

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

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

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

@@ -1 +1 @@
-export { TableRow as default } from './TableRow';
+export { TableRow } from './TableRow';

package/build/components/index.d.ts

@@ -1 +1,10 @@
-export { default as Table, TableProps } from './Table';
+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/hooks/index.d.ts

@@ -1 +1 @@
-export { useManualPagination } from './useManualPagination';
+export { useColumnFilters } from './useColumnFilters';

package/build/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/index.d.ts

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