@equinor/apollo-components 1.12.2 → 2.0.0

package/dist/index.d.ts

@@ -1,12 +1,11 @@
 import { IconData } from '@equinor/eds-icons';
 import * as react from 'react';
-import { ReactNode, ReactElement, ComponentProps } from 'react';
-import { Cell, CellContext, Table, Row, SortingState, OnChangeFn, ColumnDef, VisibilityState, RowSelectionState, HeaderContext } from '@tanstack/react-table';
+import { ReactNode, ReactElement, HTMLProps, MutableRefObject, Dispatch, SetStateAction } from 'react';
+import { Cell, CellContext, Table, Row, SortingState, OnChangeFn, ColumnDef, RowSelectionState, ExpandedState, VisibilityState, HeaderContext } from '@tanstack/react-table';
 import { ColumnDef as ColumnDef$1 } from '@tanstack/table-core';
+import { SetRequired } from 'type-fest';
 import * as styled_components from 'styled-components';
 import { CellProps, TypographyProps as TypographyProps$1 } from '@equinor/eds-core-react';
-import * as jotai from 'jotai';
-import { Provider } from 'jotai';
 
 interface AppShellProps {
     children?: ReactNode;
@@ -35,17 +34,28 @@ declare type HierarchyCellOptions = {
 };
 declare function HierarchyCell<T>(cell: CellContext<T, any>, options?: HierarchyCellOptions): JSX.Element;
 
+interface ColumnSelectProps<T> {
+    table: Table<T>;
+}
+declare function ColumnSelect<T>({ table }: ColumnSelectProps<T>): JSX.Element;
+
+interface TableHeaderProps<T> {
+    table: Table<T>;
+    sticky?: boolean;
+}
+declare function TableHeader<T>({ table, sticky }: TableHeaderProps<T>): JSX.Element;
+
 interface HeaderConfig {
-    captionPadding?: string;
-    stickyHeader?: boolean;
-    tableCaption?: string;
+    sticky?: boolean;
 }
 interface FilterConfig {
+    enableTableCaption?: boolean;
+    totalRowCount?: number;
     columnSelect?: boolean;
     globalFilter?: boolean;
     globalFilterPlaceholder?: string;
     filterFromLeafRows?: boolean;
-    filterActions?: <T>(table: Table<T>) => ReactNode;
+    customActions?: <T>(table: Table<T>) => ReactNode;
 }
 interface TableRowWrapper<T> {
     (props: TableRowWrapperProps<T>): ReactElement;
@@ -84,8 +94,25 @@ interface CellConfig<T> {
 }
 declare type RowSelectionMode = 'single' | 'multiple';
 declare type TableLayout = 'auto' | 'fixed';
-declare type DataTableConfig<T> = {
+interface HTMLPropsRef<T extends HTMLElement> extends HTMLProps<T> {
+    ref?: MutableRefObject<T | null> | null;
+}
+interface InfiniteScrollConfig {
+    /** Called on scroll below offset. */
+    onBottomScroll: () => void;
+    /** Pixels above bottom. Defines when the onBottomScroll should be called. Defaults to `300`. */
+    offset?: number;
+}
+interface DataTableProps<T> {
+    tableCaption: string;
+    data: T[];
+    columns: ColumnDef<T, any>[];
+    cellConfig?: CellConfig<T>;
+    rowConfig?: RowConfig<T>;
+    headerConfig?: HeaderConfig;
+    isLoading?: boolean;
     height?: string;
+    width?: string;
     /**
      * Defaults to `'auto'`.
      *
@@ -95,65 +122,42 @@ declare type DataTableConfig<T> = {
      * Default size is 150px.
      */
     tableLayout?: TableLayout;
-    /** @deprecated use `cellConfig.enableSorting` instead. This is to align with \@tanstack/react-table types. */
-    sortable?: boolean;
     virtual?: boolean;
-    rowSelectionMode?: RowSelectionMode;
-    width?: string;
-    selectColumn?: 'default' | ((options?: Record<string, any>) => ColumnDef<T, any>);
-    getSubRows?: (originalRow: T) => T[] | undefined;
     getRowId?: (originalRow: T, index: number, parent: Row<T> | undefined) => string;
-} & ExpansionConfig;
-interface ExpansionConfig {
-    expandAllByDefault?: boolean;
-    hideExpandControls?: boolean;
-}
-interface DataTableCommonProps<T> {
-    isLoading?: boolean;
-    className?: string;
-    config?: DataTableConfig<T>;
-    cellConfig?: CellConfig<T>;
-    rowConfig?: RowConfig<T>;
-    sortConfig?: SortConfig;
-    filters?: FilterConfig;
-    header?: HeaderConfig;
-}
-interface DataTableProps<T> extends DataTableCommonProps<T> {
-    data: T[];
-    columns: ColumnDef<T, any>[];
-}
-interface DataTableRawProps<T> extends DataTableCommonProps<T> {
-    table: Table<T>;
+    getSubRows?: (originalRow: T) => T[] | undefined;
+    rowSelection?: Partial<ControlledState<RowSelectionState>> & {
+        mode?: RowSelectionMode;
+        selectColumn?: 'default' | ((options?: Record<string, any>) => ColumnDef<T, any>);
+        includeExpansionButton?: boolean;
+    };
+    expansion?: Partial<ControlledState<ExpandedState>> & {
+        expandAllByDefault?: boolean;
+    };
+    sorting?: Partial<ControlledState<SortingState>> & {
+        enableSorting?: boolean;
+        manualSorting?: boolean;
+    };
+    globalFilter?: ControlledState<string>;
+    columnVisibility?: ControlledState<VisibilityState>;
+    actionsRow?: {
+        enableTableCaption?: boolean;
+        totalRowCount?: number;
+        enableColumnSelect?: boolean;
+        enableGlobalFilterInput?: boolean;
+        globalFilterPlaceholder?: string;
+        filterFromLeafRows?: boolean;
+        customActions?: <T>(table: Table<T>) => ReactNode;
+    };
+    tableContainerProps?: HTMLPropsRef<HTMLDivElement>;
+    infiniteScroll?: InfiniteScrollConfig;
 }
-
-declare function DataTable$1<T>(props: DataTableProps<T>): JSX.Element;
-
-declare type DataTableProviderProps = ComponentProps<typeof Provider>;
-declare function DataTableProvider({ children, ...props }: DataTableProviderProps): JSX.Element;
-
-declare const columnVisibilityAtom: jotai.PrimitiveAtom<VisibilityState> & {
-    init: VisibilityState;
-};
-declare const globalFilterAtom: jotai.PrimitiveAtom<string> & {
-    init: string;
-};
-declare const rowSelectionAtom: jotai.PrimitiveAtom<RowSelectionState> & {
-    init: RowSelectionState;
-};
-declare const tableSortingAtom: jotai.PrimitiveAtom<SortingState> & {
-    init: SortingState;
+declare type ControlledState<T> = {
+    state: T;
+    /** Callback when state chagnes. Using this requires the state to be fully controlled. */
+    onChange?: Dispatch<SetStateAction<T>>;
 };
 
-interface ColumnSelectProps<T> {
-    table: Table<T>;
-}
-declare function ColumnSelect<T>({ table }: ColumnSelectProps<T>): JSX.Element;
-
-interface TableHeaderProps<T> {
-    table: Table<T>;
-    sticky?: boolean;
-}
-declare function TableHeader<T>({ table, sticky }: TableHeaderProps<T>): JSX.Element;
+declare function DataTable<T>(props: DataTableProps<T>): JSX.Element;
 
 /**
  * Capitalize the table header.
@@ -164,14 +168,9 @@ declare function TableHeader<T>({ table, sticky }: TableHeaderProps<T>): JSX.Ele
  */
 declare function capitalizeHeader<T>(context: HeaderContext<T, any>): string;
 /** Prepend a column definition array with a select column. */
-declare function prependSelectColumn<T>(columns: ColumnDef<T>[], config?: DataTableConfig<T>): ColumnDef<T, unknown>[];
-
-declare type DataTableCompoundProps = typeof DataTable$1 & {
-    Provider: typeof DataTableProvider;
-};
-declare const DataTable: DataTableCompoundProps;
+declare function prependSelectColumn<T>(columns: ColumnDef<T>[], config?: DataTableProps<T>['rowSelection']): ColumnDef<T, unknown>[];
 
-declare function SelectColumnDef<T>(props?: DataTableConfig<T>): ColumnDef$1<T, any>;
+declare function SelectColumnDef<T>(props: SetRequired<DataTableProps<T>, 'rowSelection'>['rowSelection']): ColumnDef$1<T, any>;
 
 declare const StickyCell: styled_components.StyledComponent<react.ForwardRefExoticComponent<CellProps & react.RefAttributes<HTMLTableCellElement>>, any, {} & CellProps, never>;
 
@@ -180,4 +179,4 @@ declare type TypographyProps = {
 } & TypographyProps$1;
 declare const TypographyCustom: (props: TypographyProps) => JSX.Element;
 
-export { AppShell, AppSidebar, CellConfig, ChipsCell, ColumnSelect, DataTable, DataTableCommonProps, DataTableConfig, DataTableProps, DataTableRawProps, DynamicCell, FilterConfig, HeaderConfig, HierarchyCell, RowConfig, RowSelectionMode, SelectColumnDef, SortConfig, StickyCell, TableHeader, TableLayout, TableRowWrapper, TableRowWrapperProps, TruncateMode, TypographyCustom, capitalizeHeader, columnVisibilityAtom, globalFilterAtom, prependSelectColumn, rowSelectionAtom, tableSortingAtom };
+export { AppShell, AppSidebar, CellConfig, ChipsCell, ColumnSelect, DataTable, DataTableProps, DynamicCell, FilterConfig, HTMLPropsRef, HeaderConfig, HierarchyCell, InfiniteScrollConfig, RowConfig, RowSelectionMode, SelectColumnDef, SortConfig, StickyCell, TableHeader, TableLayout, TableRowWrapper, TableRowWrapperProps, TruncateMode, TypographyCustom, capitalizeHeader, prependSelectColumn };