@apia/table 4.0.18 → 4.0.19
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.ts +76 -52
- package/dist/index.js.map +1 -1
- package/package.json +7 -7
package/dist/index.d.ts
CHANGED
|
@@ -3,11 +3,9 @@ import React__default, { FunctionComponent, ReactNode, FC } from 'react';
|
|
|
3
3
|
import { BoxProps } from '@apia/theme';
|
|
4
4
|
import { IconType } from '@meronex/icons';
|
|
5
5
|
import * as _apia_util from '@apia/util';
|
|
6
|
-
import { TApiaFilter, TModify, TId,
|
|
6
|
+
import { TApiaFilter, TModify, TId, EventEmitter } from '@apia/util';
|
|
7
7
|
import * as _reduxjs_toolkit from '@reduxjs/toolkit';
|
|
8
8
|
import { PayloadAction } from '@reduxjs/toolkit';
|
|
9
|
-
import * as _apia_store from '@apia/store';
|
|
10
|
-
import { PayloadAction as PayloadAction$1 } from '@apia/store';
|
|
11
9
|
import * as immer_dist_internal from 'immer/dist/internal';
|
|
12
10
|
import * as _reduxjs_toolkit_dist_configureStore from '@reduxjs/toolkit/dist/configureStore';
|
|
13
11
|
import * as redux_thunk from 'redux-thunk';
|
|
@@ -533,15 +531,15 @@ type TKeyHandlerProps = BoxProps & {
|
|
|
533
531
|
declare const ResponsiveTable: React__default.MemoExoticComponent<React__default.ForwardRefExoticComponent<BoxProps & React__default.RefAttributes<HTMLDivElement>>>;
|
|
534
532
|
|
|
535
533
|
declare const Sort: React__default.MemoExoticComponent<({ tableName }: {
|
|
536
|
-
tableName?: string;
|
|
534
|
+
tableName?: string | undefined;
|
|
537
535
|
}) => React__default.JSX.Element>;
|
|
538
536
|
|
|
539
537
|
declare const Additional: React__default.MemoExoticComponent<({ tableName }: {
|
|
540
|
-
tableName?: string;
|
|
538
|
+
tableName?: string | undefined;
|
|
541
539
|
}) => React__default.JSX.Element>;
|
|
542
540
|
|
|
543
541
|
declare const Responsive: React__default.MemoExoticComponent<({ tableName }: {
|
|
544
|
-
tableName?: string;
|
|
542
|
+
tableName?: string | undefined;
|
|
545
543
|
}) => React__default.JSX.Element>;
|
|
546
544
|
|
|
547
545
|
interface IPagination {
|
|
@@ -591,24 +589,6 @@ declare function getResponsiveTableContext(tableName: string): TResponsiveTableC
|
|
|
591
589
|
declare function useResponsiveTableContext(tableName?: string): TResponsiveTableContext;
|
|
592
590
|
declare const ResponsiveTableContext: React__default.MemoExoticComponent<({ allowEdition, allowRowsKeyboardSorting, avoidAutoEllipsis, allowSelection, allowSorting, avoidReparseSelectionOnRowChange, children, className, currentBreakPoint, customLabels, columns, filters, FiltersRenderer, rows, label, isMultiple, name, onChangeSelection, onFilterBlur, onFilterChange, onFilterPressEnter, onRowClick, onSelectRows, onSortChange, reserveColumnsForStates, SelectionHandler, variant, }: TResponsiveTableContextProps) => React__default.JSX.Element>;
|
|
593
591
|
|
|
594
|
-
type TPayloadWithId$1<P = Record<string, unknown>, T extends string = string, M = never, E = never> = PayloadAction$1<P & {
|
|
595
|
-
id: string;
|
|
596
|
-
}, T, M, E>;
|
|
597
|
-
type THandleKeyPayload = TPayloadWithId$1<THandleKey>;
|
|
598
|
-
type TSelectionStateUpdatePayload = TPayloadWithId$1<Partial<ISelectableState>>;
|
|
599
|
-
type TSetNewFocusedPayload = TPayloadWithId$1<INewFocus>;
|
|
600
|
-
type TUpdateByClickPayload = TPayloadWithId$1<TRequireOnlyOne<{
|
|
601
|
-
ariaRowIndex: number;
|
|
602
|
-
rowIndex: number;
|
|
603
|
-
}> & TRequireOnlyOne<{
|
|
604
|
-
ariaColIndex?: number;
|
|
605
|
-
colIndex: number;
|
|
606
|
-
}> & Pick<INewFocus, 'altKey' | 'ctrlKey' | 'shiftKey' | 'isFocused'>>;
|
|
607
|
-
|
|
608
|
-
type TPayloadWithId<P = Record<string, unknown>, T extends string = string, M = never, E = never> = PayloadAction$1<P & {
|
|
609
|
-
tableName: string;
|
|
610
|
-
}, T, M, E>;
|
|
611
|
-
|
|
612
592
|
type TypedUseSelectorHook<TState> = <TSelected>(selector: (state: TState) => TSelected, equalityFn?: (a: TSelected, b: TSelected) => boolean) => TSelected;
|
|
613
593
|
declare const responsiveTableStore: _reduxjs_toolkit_dist_configureStore.ToolkitStore<{
|
|
614
594
|
responsiveTableSlice: TResponsiveTableSlice;
|
|
@@ -620,15 +600,51 @@ declare const useResponsiveTable: TypedUseSelectorHook<{
|
|
|
620
600
|
}>;
|
|
621
601
|
|
|
622
602
|
declare const responsiveTableActions: _reduxjs_toolkit.CaseReducerActions<{
|
|
623
|
-
controller2UpdateSelectionState(state:
|
|
624
|
-
|
|
625
|
-
|
|
626
|
-
|
|
627
|
-
|
|
628
|
-
|
|
629
|
-
|
|
630
|
-
|
|
631
|
-
|
|
603
|
+
controller2UpdateSelectionState(state: immer_dist_internal.WritableDraft<TResponsiveTableSlice>, { payload: { tableName, ...payload }, }: {
|
|
604
|
+
payload: Partial<TResponsiveTableState> & {
|
|
605
|
+
tableName: string;
|
|
606
|
+
};
|
|
607
|
+
type: string;
|
|
608
|
+
}): void;
|
|
609
|
+
handleKey(state: immer_dist_internal.WritableDraft<Record<string, ISelectableState<IBasicColumn, IBasicFilter, string | TBasicRow>>>, { payload }: {
|
|
610
|
+
payload: THandleKey & {
|
|
611
|
+
id: string;
|
|
612
|
+
};
|
|
613
|
+
type: string;
|
|
614
|
+
}): void;
|
|
615
|
+
selectionStateUpdate(state: immer_dist_internal.WritableDraft<Record<string, ISelectableState<IBasicColumn, IBasicFilter, string | TBasicRow>>>, { payload: { id, ...payload } }: {
|
|
616
|
+
payload: Partial<ISelectableState<IBasicColumn, IBasicFilter, string | TBasicRow>> & {
|
|
617
|
+
id: string;
|
|
618
|
+
};
|
|
619
|
+
type: string;
|
|
620
|
+
}): void;
|
|
621
|
+
setNewFocused(state: immer_dist_internal.WritableDraft<Record<string, ISelectableState<IBasicColumn, IBasicFilter, string | TBasicRow>>>, { payload: { id, ...payload } }: {
|
|
622
|
+
payload: INewFocus & {
|
|
623
|
+
id: string;
|
|
624
|
+
};
|
|
625
|
+
type: string;
|
|
626
|
+
}): void;
|
|
627
|
+
updateByClick(state: immer_dist_internal.WritableDraft<Record<string, ISelectableState<IBasicColumn, IBasicFilter, string | TBasicRow>>>, { payload: { id, colIndex, rowIndex, ariaColIndex, ariaRowIndex, isFocused, ...payload }, }: {
|
|
628
|
+
payload: (_apia_util.TRequireOnlyOne<{
|
|
629
|
+
ariaRowIndex: number;
|
|
630
|
+
rowIndex: number;
|
|
631
|
+
}> & _apia_util.TRequireOnlyOne<{
|
|
632
|
+
ariaColIndex?: number | undefined;
|
|
633
|
+
colIndex: number;
|
|
634
|
+
}> & Pick<INewFocus, "isFocused" | "altKey" | "ctrlKey" | "shiftKey">) & {
|
|
635
|
+
id: string;
|
|
636
|
+
};
|
|
637
|
+
type: string;
|
|
638
|
+
}): void;
|
|
639
|
+
update(state: immer_dist_internal.WritableDraft<TResponsiveTableSlice>, { payload: { tableName, handleFocus, ...rest }, }: {
|
|
640
|
+
payload: Partial<TResponsiveTableState> & {
|
|
641
|
+
isFocused?: boolean | undefined;
|
|
642
|
+
handleFocus?: boolean | undefined;
|
|
643
|
+
} & {
|
|
644
|
+
tableName: string;
|
|
645
|
+
};
|
|
646
|
+
type: string;
|
|
647
|
+
}): void;
|
|
632
648
|
addRows(state: immer_dist_internal.WritableDraft<TResponsiveTableSlice>, { payload }: TResponsiveTableAction<{
|
|
633
649
|
newRows: TResponsiveTableRow[];
|
|
634
650
|
}>): void;
|
|
@@ -636,9 +652,14 @@ declare const responsiveTableActions: _reduxjs_toolkit.CaseReducerActions<{
|
|
|
636
652
|
rowIndices: number[];
|
|
637
653
|
}>): void;
|
|
638
654
|
destroy(state: immer_dist_internal.WritableDraft<TResponsiveTableSlice>, { payload: { tableName } }: TResponsiveTableAction): void;
|
|
639
|
-
swapFocusedRow(state: immer_dist_internal.WritableDraft<TResponsiveTableSlice>, { payload: { newIndex, tableName }, }:
|
|
640
|
-
|
|
641
|
-
|
|
655
|
+
swapFocusedRow(state: immer_dist_internal.WritableDraft<TResponsiveTableSlice>, { payload: { newIndex, tableName }, }: {
|
|
656
|
+
payload: {
|
|
657
|
+
newIndex: number;
|
|
658
|
+
} & {
|
|
659
|
+
tableName: string;
|
|
660
|
+
};
|
|
661
|
+
type: string;
|
|
662
|
+
}): void;
|
|
642
663
|
}, "responsiveTableSlice">;
|
|
643
664
|
|
|
644
665
|
/**
|
|
@@ -651,9 +672,12 @@ declare class Controller2 {
|
|
|
651
672
|
readonly tableName: string;
|
|
652
673
|
constructor(tableName: string);
|
|
653
674
|
events: EventEmitter<{
|
|
654
|
-
onRowClick:
|
|
655
|
-
|
|
656
|
-
|
|
675
|
+
onRowClick: [row: {
|
|
676
|
+
index: number;
|
|
677
|
+
row: TResponsiveTableRow<Record<string, unknown>>;
|
|
678
|
+
}, focusedIndex: number];
|
|
679
|
+
onSelectRows: [newRows: TResponsiveTableRowsSelectionEvent, focusedIndex: number];
|
|
680
|
+
onChangeSelection: Parameters<NonNullable<TKeyHandlerProps['onChangeSelection']>>;
|
|
657
681
|
}>;
|
|
658
682
|
setResponsiveTableContextEvents(evs: Pick<TKeyHandlerProps, 'onRowClick' | 'onSelectRows' | 'onChangeSelection'>): void;
|
|
659
683
|
private unsubscribe;
|
|
@@ -666,25 +690,25 @@ declare class Controller2 {
|
|
|
666
690
|
* Returns a copy of the current state object
|
|
667
691
|
*/
|
|
668
692
|
getState(): {
|
|
669
|
-
label?: string | undefined;
|
|
670
693
|
allowSorting?: boolean | undefined;
|
|
671
|
-
isMultiple?: boolean;
|
|
694
|
+
isMultiple?: boolean | undefined;
|
|
695
|
+
label?: string | undefined;
|
|
672
696
|
reserveColumnsForStates?: number | undefined;
|
|
673
|
-
allowEdition?: boolean;
|
|
674
|
-
allowRowsKeyboardSorting?: boolean;
|
|
675
|
-
allowSelection?: boolean;
|
|
697
|
+
allowEdition?: boolean | undefined;
|
|
698
|
+
allowRowsKeyboardSorting?: boolean | undefined;
|
|
699
|
+
allowSelection?: boolean | undefined;
|
|
676
700
|
columns: TResponsiveTableColumn[];
|
|
677
|
-
draggingRow?: number;
|
|
701
|
+
draggingRow?: number | undefined;
|
|
678
702
|
expandedRows: number[];
|
|
679
703
|
filters: _apia_util.TApiaFilter[];
|
|
680
704
|
focusedRow: number;
|
|
681
705
|
focusedColumn: number;
|
|
682
706
|
hasNonAdditionalFilters: boolean;
|
|
683
|
-
isEditionMode?: boolean;
|
|
707
|
+
isEditionMode?: boolean | undefined;
|
|
684
708
|
isFocused: boolean;
|
|
685
709
|
nonAdditionalColumnsCount: number;
|
|
686
710
|
rows: TResponsiveTableRow<any>[];
|
|
687
|
-
scrollIntoViewRow?: number;
|
|
711
|
+
scrollIntoViewRow?: number | undefined;
|
|
688
712
|
selectedRows: number[];
|
|
689
713
|
statesColumns: number;
|
|
690
714
|
accordionIndexColumns: TResponsiveTableIndexColumns;
|
|
@@ -698,8 +722,8 @@ declare function makeController2(tableName: string): [Controller2, FC<TKeyHandle
|
|
|
698
722
|
|
|
699
723
|
declare const RangeFilter: ({ filter, tableName, className, }: {
|
|
700
724
|
filter: TApiaFilter;
|
|
701
|
-
tableName?: string;
|
|
702
|
-
className?: string;
|
|
725
|
+
tableName?: string | undefined;
|
|
726
|
+
className?: string | undefined;
|
|
703
727
|
}) => React.JSX.Element;
|
|
704
728
|
|
|
705
729
|
declare const TableContextReproducer: ({ children, tableName, }: {
|
|
@@ -737,7 +761,7 @@ declare const AdditionalColumnDefaultRenderer: React__default.MemoExoticComponen
|
|
|
737
761
|
declare const DefaultCellRenderer: React__default.ForwardRefExoticComponent<{
|
|
738
762
|
cell: TResponsiveTableCell<Record<string, unknown>>;
|
|
739
763
|
column: TResponsiveTableColumn;
|
|
740
|
-
row: TResponsiveTableRow
|
|
764
|
+
row: TResponsiveTableRow<Record<string, unknown>>;
|
|
741
765
|
} & React__default.AllHTMLAttributes<HTMLTableCellElement> & React__default.RefAttributes<HTMLTableCellElement>>;
|
|
742
766
|
|
|
743
767
|
declare const DefaultRowRenderer: TResponsiveTableRowRenderer;
|
|
@@ -762,7 +786,7 @@ declare function makeAsyncRenderer(additionalInfoGetter: (row: TResponsiveTableR
|
|
|
762
786
|
declare const NoEllipsisCellRenderer: React__default.MemoExoticComponent<React__default.ForwardRefExoticComponent<{
|
|
763
787
|
cell: TResponsiveTableCell<Record<string, unknown>>;
|
|
764
788
|
column: TResponsiveTableColumn;
|
|
765
|
-
row: TResponsiveTableRow
|
|
789
|
+
row: TResponsiveTableRow<Record<string, unknown>>;
|
|
766
790
|
} & React__default.AllHTMLAttributes<HTMLTableCellElement> & React__default.RefAttributes<HTMLTableCellElement>>>;
|
|
767
791
|
|
|
768
792
|
declare const NoRegistersRenderer: () => React.JSX.Element;
|
|
@@ -786,7 +810,7 @@ declare const StatusRenderer: TResponsiveTableCellRenderer<{
|
|
|
786
810
|
}>;
|
|
787
811
|
|
|
788
812
|
declare const TableRenderer: React__default.MemoExoticComponent<({ variant }: {
|
|
789
|
-
variant?: string;
|
|
813
|
+
variant?: string | undefined;
|
|
790
814
|
}) => React__default.JSX.Element>;
|
|
791
815
|
|
|
792
816
|
export { AccordionCell, AccordionDocNameCellRenderer, AccordionElement, AccordionHTMLCellRenderer, AccordionRenderer, Additional, AdditionalColumnDefaultRenderer, Controller2, DefaultCellRenderer, DefaultRowRenderer, DocNameCellRenderer, HTMLCellRenderer, type IAccordionElement, IsLoadingRenderer, NoEllipsisCellRenderer, NoRegistersRenderer, Pagination, PriorityAccordionRenderer, PriorityRenderer, RangeFilter, Responsive, ResponsiveTable, ResponsiveTableContext, RowStatesRenderer, Sort, StatusAccordionRenderer, StatusRenderer, type TAccordionCellRenderer, type TAccordionCellRendererProps, type TColoredElement, type TDocNameCellRenderer, type TDocNameCellRendererProps, type TResponsiveTableCell, type TResponsiveTableCellRenderer, type TResponsiveTableCellRendererProps, type TResponsiveTableColumn, type TResponsiveTableContext, type TResponsiveTableContextProps, type TResponsiveTableRow, type TResponsiveTableRowRenderer, type TResponsiveTableRowRendererProps, type TResponsiveTableRowState, type TResponsiveTableRowsSelectionEvent, type TResponsiveTableSortChangeEvent, type TResponsiveTableSortValue, type TResponsiveTableStoreProps, type TResponsiveTableWithRendererElement, TableContextReproducer, TableRenderer, defaultLabels, getPriorityHandler, getResponsiveTableContext, getStatusRendererClassName, makeAccordionAsyncRenderer, makeAsyncRenderer, makeController2, responsiveTableActions, responsiveTableStore, useResponsiveTable, useResponsiveTableContext };
|