gantri-components 2.90.0-beta.10 → 2.90.0-beta.11

package/dist/components/table/components/table-actions-wrapper/components/clear-selected-rows/clear-selected-rows.constants.d.ts

@@ -0,0 +1 @@
+export declare const dataAttrClearSelected = "data-clear-selected";

package/dist/components/table/components/table-actions-wrapper/components/clear-selected-rows/clear-selected-rows.d.ts

@@ -0,0 +1 @@
+export declare const ClearSelectedRows: () => JSX.Element;

package/dist/components/table/components/table-actions-wrapper/components/clear-selected-rows/clear-selected-rows.styles.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="react" />
+export declare const StyledPointerFlex: import("styled-components").StyledComponent<import("react").ForwardRefExoticComponent<import("../../../../../flex/flex.types").FlexProps & import("react").RefAttributes<import("../../../../../flex/flex.types").FlexProps>>, import("styled-components").DefaultTheme, {}, never>;

package/dist/components/table/components/table-actions-wrapper/components/clear-selected-rows/index.d.ts

@@ -0,0 +1 @@
+export * from './clear-selected-rows';

package/dist/components/table/components/table-footer/components/selectable-row-footer-wrapper/index.d.ts

@@ -0,0 +1 @@
+export * from './selectable-row-footer-wrapper';

package/dist/components/table/components/table-footer/components/selectable-row-footer-wrapper/selectable-row-footer-wrapper.d.ts

@@ -0,0 +1,3 @@
+import { PropsWithChildren } from 'react';
+import { SelectableRowFooterWrapperProps } from './selectable-row-footer-wrapper.types';
+export declare const SelectableRowFooterWrapper: (props: PropsWithChildren<SelectableRowFooterWrapperProps>) => JSX.Element;

package/dist/components/table/components/table-footer/components/selectable-row-footer-wrapper/selectable-row-footer-wrapper.types.d.ts

@@ -0,0 +1,3 @@
+export interface SelectableRowFooterWrapperProps {
+    index: number;
+}

package/dist/components/table/components/table-header/components/selectable-row-header-wrapper/index.d.ts

@@ -0,0 +1 @@
+export * from './selectable-row-header-wrapper';

package/dist/components/table/components/table-header/components/selectable-row-header-wrapper/selectable-row-header-wrapper.d.ts

@@ -0,0 +1,4 @@
+import React, { PropsWithChildren } from 'react';
+import { RowData } from '@tanstack/react-table';
+import { SelectableRowHeaderWrapperProps } from './selectable-row-header-wrapper.types';
+export declare const SelectableRowHeaderWrapper: <TData extends RowData<import("../../../..").CustomTData>>(props: React.PropsWithChildren<SelectableRowHeaderWrapperProps<TData>>) => JSX.Element;

package/dist/components/table/components/table-header/components/selectable-row-header-wrapper/selectable-row-header-wrapper.types.d.ts

@@ -0,0 +1,5 @@
+import { RowData, Table } from '@tanstack/react-table';
+export interface SelectableRowHeaderWrapperProps<TData extends RowData> {
+    index: number;
+    table: Table<TData>;
+}

package/dist/components/table/components/table-row-cells/components/selectable-row-cell-wrapper/helpers/get-row-range/get-row-range.d.ts

@@ -0,0 +1,3 @@
+import { Row, RowData } from '@tanstack/react-table';
+import { GetRowRangeProps } from './get-row-range.types';
+export declare const getRowRange: <TData extends RowData<import("../../../../../..").CustomTData>>(props: GetRowRangeProps<TData>) => Row<TData>[];

package/dist/components/table/components/table-row-cells/components/selectable-row-cell-wrapper/helpers/get-row-range/get-row-range.types.d.ts

@@ -0,0 +1,6 @@
+import { Row, RowData } from '@tanstack/react-table';
+export interface GetRowRangeProps<TData extends RowData> {
+    currentIndex: number;
+    prevIndex: number;
+    rows: Row<TData>[];
+}

package/dist/components/table/components/table-row-cells/components/selectable-row-cell-wrapper/helpers/get-row-range/index.d.ts

@@ -0,0 +1 @@
+export * from './get-row-range';

package/dist/components/table/components/table-row-cells/components/selectable-row-cell-wrapper/index.d.ts

@@ -0,0 +1 @@
+export * from './selectable-row-cell-wrapper';

package/dist/components/table/components/table-row-cells/components/selectable-row-cell-wrapper/selectable-row-cell-wrapper.d.ts

@@ -0,0 +1,4 @@
+import React, { PropsWithChildren } from 'react';
+import { RowData } from '@tanstack/react-table';
+import { SelectableRowCellWrapperProps } from './selectable-row-cell-wrapper.types';
+export declare const SelectableRowCellWrapper: <TData extends RowData<import("../../../..").CustomTData>>(props: React.PropsWithChildren<SelectableRowCellWrapperProps<TData>>) => JSX.Element;

package/dist/components/table/components/table-row-cells/components/selectable-row-cell-wrapper/selectable-row-cell-wrapper.styles.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="react" />
+export declare const StyledCheckboxCell: import("styled-components").StyledComponent<import("react").ForwardRefExoticComponent<import("../../../../../cell/cell.types").CellProps & import("react").RefAttributes<import("../../../../../cell/cell.types").CellProps>>, import("styled-components").DefaultTheme, {}, never>;

package/dist/components/table/components/table-row-cells/components/selectable-row-cell-wrapper/selectable-row-cell-wrapper.types.d.ts

@@ -0,0 +1,6 @@
+import { Row, RowData, Table } from '@tanstack/react-table';
+export interface SelectableRowCellWrapperProps<TData extends RowData> {
+    index: number;
+    row: Row<TData>;
+    table: Table<TData>;
+}

package/dist/components/table/hooks/use-get-selected-table-rows-data/index.d.ts

@@ -0,0 +1 @@
+export * from './use-get-selected-table-rows-data';

package/dist/components/table/hooks/use-get-selected-table-rows-data/use-get-selected-table-rows-data.d.ts

@@ -0,0 +1,7 @@
+import { RowData } from '@tanstack/react-table';
+export declare const useGetSelectedRowsData: () => {
+    getSelectedRowsData: <TData extends RowData<import("../..").CustomTData>>(props: {
+        idProperty: keyof TData | undefined;
+        records: TData[];
+    }) => TData[];
+};

package/dist/components/table/hooks/use-row-selection/index.d.ts

@@ -0,0 +1 @@
+export * from './use-row-selection';

package/dist/components/table/hooks/use-row-selection/use-row-selection.constants.d.ts

@@ -0,0 +1,6 @@
+export declare const selectableRowsCheckboxSize = "2rem";
+export declare const dataAttrIsRowSelected = "data-is-row-selected";
+export declare const rowSelectionTypes: {
+    readonly checkboxes: "checkboxes";
+    readonly custom: "custom";
+};

package/dist/components/table/hooks/use-row-selection/use-row-selection.d.ts

@@ -0,0 +1,8 @@
+export declare const useRowSelection: () => {
+    clearSelectedRows: () => void;
+    /** Can be used to deselect rows outside of the default behavior. */
+    deselectRows: (rowIds: (string | number)[]) => void;
+    getIsRowSelected: (rowId: number | string) => boolean;
+    /** Can be used to select rows outside of the default behavior. */
+    selectRows: (rowIds: (string | number)[]) => void;
+};

package/dist/components/table/hooks/use-row-selection/use-row-selection.types.d.ts

@@ -0,0 +1,9 @@
+import { RowData } from '@tanstack/react-table';
+import { rowSelectionTypes } from './use-row-selection.constants';
+export interface RowSelection<TData extends RowData> {
+    disabled?: boolean;
+    idProperty?: keyof TData;
+    onSelect?: (selectedRecords: TData[]) => void;
+    type: RowSelectionType;
+}
+export type RowSelectionType = typeof rowSelectionTypes[keyof typeof rowSelectionTypes];

package/dist/components/table/index.d.ts

@@ -1,6 +1,7 @@
 export type { GetAfterRowComponentDef, AfterRowComponentDef, } from './components/after-row-component/after-row-component.types';
 export * from './table';
+export * from './table.providers';
 export * from './table.types';
 export * from './components/table-row/table-row.constants';
 export * from './components/table-actions-wrapper/table-actions-wrapper.types';
-export * from './table.context';
+export * from './hooks/use-row-selection';

package/dist/components/table/table.context.d.ts

@@ -1,29 +1,21 @@
-import { RowData, RowSelectionState } from '@tanstack/react-table';
-import React, { PropsWithChildren } from 'react';
-import { GenericContextValue } from '../../hooks/use-provider/use-provider.types';
-export declare const RowSelectionContext: React.Context<GenericContextValue<RowSelectionState>>;
-export declare const LastSelectedIdContext: React.Context<GenericContextValue<string>>;
-export declare const IsRowSelectionDisabledContext: React.Context<GenericContextValue<boolean>>;
-export declare const IsRowSelectionCheckboxesContext: React.Context<GenericContextValue<boolean>>;
-export declare const RowSelectionProviders: React.MemoExoticComponent<({ children }: PropsWithChildren<Record<never, never>>) => JSX.Element>;
-/** If you need to call any of these helpers outside of the `Table` component, you must wrap your code in `RowSelectionProviders` at a higher level */
+import { RowSelectionState } from '@tanstack/react-table';
+import { Dispatch, SetStateAction } from 'react';
+export type GenericContextValue<Type> = [Type, Dispatch<SetStateAction<Type>>];
+export declare const defaultRowSelectionState: RowSelectionState;
+export declare const defaultLastSelectedId: string;
+export declare const defaultIsRowSelectionDisabled: boolean;
+export declare const defaultIsRowSelectionCheckboxes: boolean;
+export declare const RowSelectionContext: import("react").Context<GenericContextValue<RowSelectionState>>;
+export declare const LastSelectedIdContext: import("react").Context<GenericContextValue<string>>;
+export declare const IsRowSelectionDisabledContext: import("react").Context<GenericContextValue<boolean>>;
+export declare const IsRowSelectionCheckboxesContext: import("react").Context<GenericContextValue<boolean>>;
 export declare const useTableContext: () => {
     isRowSelectionCheckboxes: boolean;
     isRowSelectionDisabled: boolean;
     lastSelectedId: string;
     rowSelectionState: RowSelectionState;
-    setIsRowSelectionCheckboxes: React.Dispatch<React.SetStateAction<boolean>>;
-    setIsRowSelectionDisabled: React.Dispatch<React.SetStateAction<boolean>>;
-    setLastSelectedId: React.Dispatch<React.SetStateAction<string>>;
-    setRowSelectionState: React.Dispatch<React.SetStateAction<RowSelectionState>>;
-};
-export declare const useRowSelection: () => {
-    clearSelectedRows: () => void;
-    deselectRows: (rowIds: (string | number)[]) => void;
-    getIsRowSelected: (rowId: number | string) => boolean;
-    getSelectedRowsData: <TData extends RowData<import("./table.types").CustomTData>>(props: {
-        idProperty: keyof TData | undefined;
-        records: TData[];
-    }) => TData[];
-    selectRows: (rowIds: (string | number)[]) => void;
+    setIsRowSelectionCheckboxes: Dispatch<SetStateAction<boolean>>;
+    setIsRowSelectionDisabled: Dispatch<SetStateAction<boolean>>;
+    setLastSelectedId: Dispatch<SetStateAction<string>>;
+    setRowSelectionState: Dispatch<SetStateAction<RowSelectionState>>;
 };

package/dist/components/table/table.providers.d.ts

@@ -1,3 +1,2 @@
-import { RowData } from '@tanstack/react-table';
-import { TableProps } from './table.types';
-export declare const Table: <TData extends RowData<import("./table.types").CustomTData>>(props: TableProps<TData>) => JSX.Element;
+import { PropsWithChildren } from 'react';
+export declare const RowSelectionProviders: ({ children, }: PropsWithChildren<Record<never, never>>) => JSX.Element;

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

@@ -6,7 +6,7 @@ import { CustomActionProps, FiltersProps, SearchProps } from './components/table
 import { SortProps } from './components/table-actions-wrapper/components/sort/sort.types';
 import { OverlayPosition } from '../overlay/overlay.types';
 import { GetAfterRowComponentDef } from './components/after-row-component/after-row-component.types';
-import { RowSelection } from './hooks/use-selectable-table-rows/use-selectable-table-rows.types';
+import { RowSelection } from './hooks/use-row-selection/use-row-selection.types';
 export interface RowReorderingProps<TData extends RowData> {
     disabled?: boolean;
     getDisableSortableRow?: (row: Row<TData>) => boolean;
@@ -64,6 +64,7 @@ export interface TableProps<TData extends RowData> extends Partial<TableDefaultP
     options?: Partial<TableOptions<TData>>;
     paging?: PagingProps;
     reordering?: RowReorderingProps<TData>;
+    /** If using row selection, you must wrap your component in `RowSelectionProviders`. This should be done outside the parent the component using the `Table`. `useRowSelection` provides additional helpful functions you may wish to utilize. */
     rowSelection?: RowSelection<TData>;
     search?: SearchProps;
     sorting?: SortProps;