@apia/table 4.0.17 → 4.0.18

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 CHANGED
@@ -3,9 +3,11 @@ 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, EventEmitter } from '@apia/util';
6
+ import { TApiaFilter, TModify, TId, TRequireOnlyOne, 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';
9
11
  import * as immer_dist_internal from 'immer/dist/internal';
10
12
  import * as _reduxjs_toolkit_dist_configureStore from '@reduxjs/toolkit/dist/configureStore';
11
13
  import * as redux_thunk from 'redux-thunk';
@@ -531,15 +533,15 @@ type TKeyHandlerProps = BoxProps & {
531
533
  declare const ResponsiveTable: React__default.MemoExoticComponent<React__default.ForwardRefExoticComponent<BoxProps & React__default.RefAttributes<HTMLDivElement>>>;
532
534
 
533
535
  declare const Sort: React__default.MemoExoticComponent<({ tableName }: {
534
- tableName?: string | undefined;
536
+ tableName?: string;
535
537
  }) => React__default.JSX.Element>;
536
538
 
537
539
  declare const Additional: React__default.MemoExoticComponent<({ tableName }: {
538
- tableName?: string | undefined;
540
+ tableName?: string;
539
541
  }) => React__default.JSX.Element>;
540
542
 
541
543
  declare const Responsive: React__default.MemoExoticComponent<({ tableName }: {
542
- tableName?: string | undefined;
544
+ tableName?: string;
543
545
  }) => React__default.JSX.Element>;
544
546
 
545
547
  interface IPagination {
@@ -589,6 +591,24 @@ declare function getResponsiveTableContext(tableName: string): TResponsiveTableC
589
591
  declare function useResponsiveTableContext(tableName?: string): TResponsiveTableContext;
590
592
  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>;
591
593
 
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
+
592
612
  type TypedUseSelectorHook<TState> = <TSelected>(selector: (state: TState) => TSelected, equalityFn?: (a: TSelected, b: TSelected) => boolean) => TSelected;
593
613
  declare const responsiveTableStore: _reduxjs_toolkit_dist_configureStore.ToolkitStore<{
594
614
  responsiveTableSlice: TResponsiveTableSlice;
@@ -600,51 +620,15 @@ declare const useResponsiveTable: TypedUseSelectorHook<{
600
620
  }>;
601
621
 
602
622
  declare const responsiveTableActions: _reduxjs_toolkit.CaseReducerActions<{
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;
623
+ controller2UpdateSelectionState(state: _apia_store.Draft<TResponsiveTableSlice>, { payload: { tableName, ...payload }, }: TPayloadWithId<Partial<TResponsiveTableState>>): void;
624
+ handleKey(state: immer_dist_internal.WritableDraft<Record<string, ISelectableState<IBasicColumn, IBasicFilter, string | TBasicRow>>>, { payload }: THandleKeyPayload): void;
625
+ selectionStateUpdate(state: immer_dist_internal.WritableDraft<Record<string, ISelectableState<IBasicColumn, IBasicFilter, string | TBasicRow>>>, { payload: { id, ...payload } }: TSelectionStateUpdatePayload): void;
626
+ setNewFocused(state: immer_dist_internal.WritableDraft<Record<string, ISelectableState<IBasicColumn, IBasicFilter, string | TBasicRow>>>, { payload: { id, ...payload } }: TSetNewFocusedPayload): void;
627
+ updateByClick(state: immer_dist_internal.WritableDraft<Record<string, ISelectableState<IBasicColumn, IBasicFilter, string | TBasicRow>>>, { payload: { id, colIndex, rowIndex, ariaColIndex, ariaRowIndex, isFocused, ...payload }, }: TUpdateByClickPayload): void;
628
+ update(state: immer_dist_internal.WritableDraft<TResponsiveTableSlice>, { payload: { tableName, handleFocus, ...rest }, }: TResponsiveTableAction<Partial<TResponsiveTableState> & {
629
+ isFocused?: boolean;
630
+ handleFocus?: boolean;
631
+ }>): void;
648
632
  addRows(state: immer_dist_internal.WritableDraft<TResponsiveTableSlice>, { payload }: TResponsiveTableAction<{
649
633
  newRows: TResponsiveTableRow[];
650
634
  }>): void;
@@ -652,14 +636,9 @@ declare const responsiveTableActions: _reduxjs_toolkit.CaseReducerActions<{
652
636
  rowIndices: number[];
653
637
  }>): void;
654
638
  destroy(state: immer_dist_internal.WritableDraft<TResponsiveTableSlice>, { payload: { tableName } }: TResponsiveTableAction): void;
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;
639
+ swapFocusedRow(state: immer_dist_internal.WritableDraft<TResponsiveTableSlice>, { payload: { newIndex, tableName }, }: TResponsiveTableAction<{
640
+ newIndex: number;
641
+ }>): void;
663
642
  }, "responsiveTableSlice">;
664
643
 
665
644
  /**
@@ -672,12 +651,9 @@ declare class Controller2 {
672
651
  readonly tableName: string;
673
652
  constructor(tableName: string);
674
653
  events: EventEmitter<{
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']>>;
654
+ onRowClick: Parameters<NonNullable<TKeyHandlerProps["onRowClick"]>>;
655
+ onSelectRows: Parameters<NonNullable<TKeyHandlerProps["onSelectRows"]>>;
656
+ onChangeSelection: Parameters<NonNullable<TKeyHandlerProps["onChangeSelection"]>>;
681
657
  }>;
682
658
  setResponsiveTableContextEvents(evs: Pick<TKeyHandlerProps, 'onRowClick' | 'onSelectRows' | 'onChangeSelection'>): void;
683
659
  private unsubscribe;
@@ -690,25 +666,25 @@ declare class Controller2 {
690
666
  * Returns a copy of the current state object
691
667
  */
692
668
  getState(): {
693
- allowSorting?: boolean | undefined;
694
- isMultiple?: boolean | undefined;
695
669
  label?: string | undefined;
670
+ allowSorting?: boolean | undefined;
671
+ isMultiple?: boolean;
696
672
  reserveColumnsForStates?: number | undefined;
697
- allowEdition?: boolean | undefined;
698
- allowRowsKeyboardSorting?: boolean | undefined;
699
- allowSelection?: boolean | undefined;
673
+ allowEdition?: boolean;
674
+ allowRowsKeyboardSorting?: boolean;
675
+ allowSelection?: boolean;
700
676
  columns: TResponsiveTableColumn[];
701
- draggingRow?: number | undefined;
677
+ draggingRow?: number;
702
678
  expandedRows: number[];
703
679
  filters: _apia_util.TApiaFilter[];
704
680
  focusedRow: number;
705
681
  focusedColumn: number;
706
682
  hasNonAdditionalFilters: boolean;
707
- isEditionMode?: boolean | undefined;
683
+ isEditionMode?: boolean;
708
684
  isFocused: boolean;
709
685
  nonAdditionalColumnsCount: number;
710
686
  rows: TResponsiveTableRow<any>[];
711
- scrollIntoViewRow?: number | undefined;
687
+ scrollIntoViewRow?: number;
712
688
  selectedRows: number[];
713
689
  statesColumns: number;
714
690
  accordionIndexColumns: TResponsiveTableIndexColumns;
@@ -722,8 +698,8 @@ declare function makeController2(tableName: string): [Controller2, FC<TKeyHandle
722
698
 
723
699
  declare const RangeFilter: ({ filter, tableName, className, }: {
724
700
  filter: TApiaFilter;
725
- tableName?: string | undefined;
726
- className?: string | undefined;
701
+ tableName?: string;
702
+ className?: string;
727
703
  }) => React.JSX.Element;
728
704
 
729
705
  declare const TableContextReproducer: ({ children, tableName, }: {
@@ -761,7 +737,7 @@ declare const AdditionalColumnDefaultRenderer: React__default.MemoExoticComponen
761
737
  declare const DefaultCellRenderer: React__default.ForwardRefExoticComponent<{
762
738
  cell: TResponsiveTableCell<Record<string, unknown>>;
763
739
  column: TResponsiveTableColumn;
764
- row: TResponsiveTableRow<Record<string, unknown>>;
740
+ row: TResponsiveTableRow;
765
741
  } & React__default.AllHTMLAttributes<HTMLTableCellElement> & React__default.RefAttributes<HTMLTableCellElement>>;
766
742
 
767
743
  declare const DefaultRowRenderer: TResponsiveTableRowRenderer;
@@ -786,7 +762,7 @@ declare function makeAsyncRenderer(additionalInfoGetter: (row: TResponsiveTableR
786
762
  declare const NoEllipsisCellRenderer: React__default.MemoExoticComponent<React__default.ForwardRefExoticComponent<{
787
763
  cell: TResponsiveTableCell<Record<string, unknown>>;
788
764
  column: TResponsiveTableColumn;
789
- row: TResponsiveTableRow<Record<string, unknown>>;
765
+ row: TResponsiveTableRow;
790
766
  } & React__default.AllHTMLAttributes<HTMLTableCellElement> & React__default.RefAttributes<HTMLTableCellElement>>>;
791
767
 
792
768
  declare const NoRegistersRenderer: () => React.JSX.Element;
@@ -810,7 +786,7 @@ declare const StatusRenderer: TResponsiveTableCellRenderer<{
810
786
  }>;
811
787
 
812
788
  declare const TableRenderer: React__default.MemoExoticComponent<({ variant }: {
813
- variant?: string | undefined;
789
+ variant?: string;
814
790
  }) => React__default.JSX.Element>;
815
791
 
816
792
  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 };