schummar-table 0.5.2 → 0.5.5

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

@@ -2,8 +2,11 @@
 import { CommonFilterProps } from '../types';
 import { DatePickerProps, DateRange } from './datePicker';
 export declare function DateFilter<T, V>({ locale, firstDayOfWeek, singleSelect, filterBy, ...props }: {
+    /** Which locale to use to render the calendar. */
     locale?: string;
+    /** Which day of the week should be in the first column. */
     firstDayOfWeek?: DatePickerProps['firstDayOfWeek'];
+    /** If enabled, only single days can be selected. Ranges otherwise. */
     singleSelect?: boolean;
 } & CommonFilterProps<T, V, Date | DateRange | null, Date | DateRange | null>): JSX.Element;
 export declare const today: () => DateRange;

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

@@ -3,13 +3,21 @@ export declare type DateRange = {
     max: Date;
 };
 export declare type DatePickerProps = {
+    /** Currently selected day or range of days. */
     value: Date | DateRange | null;
+    /** Callback for when the day (range) changes. */
     onChange: (value: Date | DateRange | null) => void;
+    /** If enabled, ranges can be selected. */
     rangeSelect?: boolean;
+    /** Which locale to use to render the calendar. */
     locale?: string;
+    /** Which day of the week should be in the first column. */
     firstDayOfWeek?: 0 | 1 | 2 | 3 | 4 | 5 | 6;
 };
+/** Rounds a date down to the start of the day. */
 export declare const startOfDay: (d: Date) => Date;
+/** Rounds a date up to the end of the day. */
 export declare const endOfDay: (d: Date) => Date;
+/** Returns whether two dates and/or date ranges intersect. Intersection is considered per day. */
 export declare function dateIntersect(a: Date | null | DateRange, b: Date | null | DateRange): boolean;
 export declare function DatePicker({ value, onChange, rangeSelect, locale, firstDayOfWeek }: DatePickerProps): import("@emotion/react/jsx-runtime").JSX.Element;

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

@@ -1,8 +1,12 @@
 import { ReactNode } from 'react';
 import { CommonFilterProps, SerializableValue } from '../types';
 export declare function SelectFilter<T, V, F extends SerializableValue>({ options: providedOptions, stringValue, render, singleSelect, ...props }: {
+    /** Which options are provided to select. By default all unique item values are used. */
     options?: F[];
+    /** String representation of a value. Used to filter options via the text field. */
     stringValue?: (value: F) => string;
+    /** Render values. By default a string representation of the value is used. */
     render?: (value: F) => ReactNode;
+    /** If enabled, only one option can be selected at a time. */
     singleSelect?: boolean;
 } & CommonFilterProps<T, V, F, Set<F>>): JSX.Element;

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

@@ -1,5 +1,8 @@
 /// <reference types="react" />
 import { CommonFilterProps } from '../types';
 export declare function TextFilter<T, V>({ compare, filterBy, ...props }: {
-    compare?: (a: string, b: string) => boolean;
+    /** Custom comparison function. Should return true if an item value matches the current filter value.
+     * By default a fuzzy text comparison is used.
+     */
+    compare?: (itemValue: string, filterValue: string) => boolean;
 } & CommonFilterProps<T, V, string, string>): JSX.Element;

package/dist/types/index.d.ts

@@ -1,5 +1,7 @@
 export { AutoFocusTextField } from './components/autoFocusTextField';
 export { DateFilter } from './components/dateFilter';
+export { dateIntersect, DatePicker, endOfDay, startOfDay } from './components/datePicker';
+export type { DatePickerProps, DateRange } from './components/datePicker';
 export { SelectFilter } from './components/selectFilter';
 export { ColumnContext, Table, TableContext, useColumnContext, useTableContext } from './components/table';
 export { TextFilter } from './components/textFilter';
@@ -8,4 +10,4 @@ export { useTheme } from './hooks/useTheme';
 export type { TableStateStorage } from './internalState/tableStateStorage';
 export { termMatch, textMatch } from './misc/textMatch';
 export { configureTableTheme, mergeThemes, TableThemeContext, TableThemeProvider } from './theme/tableTheme';
-export type { Column, Id, InternalColumn, PartialTableTheme, Rows, Sort, SortDirection, TableProps } from './types';
+export type { Column, Id, InternalColumn, PartialTableTheme, Sort, SortDirection, TableProps } from './types';

package/dist/types/internalState/syncSelections.d.ts

@@ -1,3 +1,3 @@
 import { Store } from 'schummar-state/react';
 import { InternalTableState } from '../types';
-export declare function syncSelections<T>(state: Store<InternalTableState<T>>): void;
+export declare function syncSelections<T>(table: Store<InternalTableState<T>>): void;

package/dist/types/types.d.ts

@@ -1,5 +1,5 @@
 import { CSSInterpolation } from '@emotion/serialize';
-import React, { ComponentType, CSSProperties, ReactNode, Ref } from 'react';
+import React, { ComponentType, ReactNode, Ref } from 'react';
 import { TableStateStorage } from './internalState/tableStateStorage';
 import { CsvExportOptions } from './misc/csvExport';
 export declare type Sort = {
@@ -198,7 +198,7 @@ export interface TableProps<T> extends Partial<TableTheme<T>> {
     /** If enabled, automatically store table state in localStorage, localForage or another compatible storage. */
     persist?: {
         storage: TableStateStorage;
-        id?: string;
+        id: string;
         include?: ('sort' | 'selection' | 'expanded' | 'hiddenColumns' | 'filterValues' | 'columnWidths' | 'columnOrder')[];
         exclude?: ('sort' | 'selection' | 'expanded' | 'hiddenColumns' | 'filterValues' | 'columnWidths' | 'columnOrder')[];
     };
@@ -220,16 +220,29 @@ export declare type TableItem<T = unknown> = T & {
     children: TableItem<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;
+    /** Extract value for this column */
     value: (item: T) => V;
+    /** Render table cell. If not provided, a string representation of the value will be rendered. */
     renderCell?: (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?: ((value: V, item: T) => unknown) | ((value: V) => 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;
-    justifyContent?: CSSProperties['justifyContent'];
+    /** Provide css class names to override columns styles. */
     classes?: TableTheme<T>['classes'];
     /** If the column definition changes, supply parameters that it depends on. If not set, the column will not update */
     dependencies?: any[];
@@ -240,13 +253,6 @@ export declare type InternalColumn<T, V> = Required<Omit<Column<T, V>, 'id'>, 'h
 declare type Required<T, S> = T & {
     [P in keyof T as P extends S ? P : never]-?: T[P];
 };
-export declare type Rows<T, V> = [{
-    value: V;
-    item: T;
-}, ...{
-    value: V;
-    item: T;
-}[]];
 export declare type InternalTableState<T> = {
     props: InternalTableProps<T>;
     theme: TableTheme<T>;
@@ -268,16 +274,25 @@ export declare type InternalTableState<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?: (value: V, item: T) => F | F[];
+    /** Preselected filter value. */
     defaultValue?: S;
+    /** Controlled filter value. */
     value?: S;
+    /** Notifies on filter change. */
     onChange?: (value?: S) => void;
-    dependencies?: any[];
+    /** 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;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "schummar-table",
   "repository": "schummar/schummar-table",
-  "version": "0.5.2",
+  "version": "0.5.5",
   "description": "",
   "type": "module",
   "sideEffects": false,
@@ -84,7 +84,6 @@
   },
   "devDependencies": {
     "@emotion/styled": "^11.8.1",
-    "@fontsource/fira-sans": "^4.5.3",
     "@material-ui/core": "^4.12.3",
     "@mui/material": "^5.5.0",
     "@types/react": "17",
@@ -92,11 +91,8 @@
     "@typescript-eslint/eslint-plugin": "^5.14.0",
     "@typescript-eslint/parser": "^5.14.0",
     "@vitejs/plugin-react": "^1.2.0",
-    "@vitejs/plugin-react-refresh": "^1.3.6",
     "eslint": "^8.10.0",
-    "localforage": "^1.10.0",
     "npm-run-all": "^4.1.5",
-    "nyc": "^15.1.0",
     "prettier": "^2.5.1",
     "react": "17",
     "react-dom": "17",