@revolist/revogrid 3.3.0 → 3.3.2

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.
@@ -1,4 +1,9 @@
1
1
  import { Edition, RevoGrid } from '../../../interfaces';
2
+ /**
3
+ * Callback triggered on cell editor save
4
+ * Closes editor when called
5
+ * @param preventFocus - if true editor will not be closed and next cell will not be focused
6
+ */
2
7
  export declare type SaveCallback = (value: Edition.SaveData, preventFocus: boolean) => void;
3
8
  export declare class TextEditor implements Edition.EditorBase {
4
9
  column: RevoGrid.ColumnRegular;
@@ -4,7 +4,8 @@ import { EventData } from './selection.utils';
4
4
  declare type Config = {
5
5
  selectionStoreService: SelectionStoreService;
6
6
  selectionStore: Observable<Selection.SelectionStoreState>;
7
- doEdit(val?: any, isCancel?: boolean): void;
7
+ doEdit(val?: any): void;
8
+ cancelEdit(): void;
8
9
  clearCell(): void;
9
10
  getData(): any;
10
11
  internalPaste(): void;
@@ -8,9 +8,16 @@ export declare class Edit {
8
8
  /** Custom editors register */
9
9
  editor: Edition.EditorCtr | null;
10
10
  cellEdit: EventEmitter<Edition.SaveDataDetails>;
11
- /** Close editor event */
11
+ /**
12
+ * Close editor event
13
+ * pass true if requires focus next
14
+ */
12
15
  closeEdit: EventEmitter<boolean | undefined>;
13
- /** Callback triggered on cell editor save */
16
+ /**
17
+ * Callback triggered on cell editor save
18
+ * Closes editor when called
19
+ * @param preventFocus - if true editor will not be closed and next cell will not be focused
20
+ */
14
21
  onSave(val: Edition.SaveData, preventFocus?: boolean): void;
15
22
  componentWillRender(): void;
16
23
  componentDidRender(): void;
@@ -31,6 +31,10 @@ export declare class OverlaySelection {
31
31
  internalCellEdit: EventEmitter<Edition.BeforeSaveDataDetails>;
32
32
  internalFocusCell: EventEmitter<Edition.BeforeSaveDataDetails>;
33
33
  setEdit: EventEmitter<Edition.BeforeEdit>;
34
+ /**
35
+ * Used for editors support when close requested
36
+ */
37
+ cancelEdit: EventEmitter;
34
38
  setRange: EventEmitter<Selection.RangeArea>;
35
39
  setTempRange: EventEmitter<Selection.TempRange | null>;
36
40
  focusCell: EventEmitter<Selection.FocusedCells>;
@@ -60,7 +64,11 @@ export declare class OverlaySelection {
60
64
  private renderEditCell;
61
65
  render(): any;
62
66
  protected onElementMouseDown(e: MouseEvent): void;
63
- protected doEdit(val?: string, isCancel?: boolean): void;
67
+ protected doEdit(val?: string): void;
68
+ /**
69
+ * Close editor event triggered
70
+ * @param details - if requires focus next
71
+ */
64
72
  private closeEdit;
65
73
  private focusNext;
66
74
  protected clearCell(): void;
@@ -12,6 +12,7 @@ declare type Props = {
12
12
  columns: ViewportProps[];
13
13
  columnFilter: boolean;
14
14
  onScroll(e: RevoGrid.ViewPortScrollEvent, key?: RevoGrid.DimensionColPin | string): void;
15
+ onCancelEdit(): void;
15
16
  onEdit(edit: Edition.BeforeEdit): void;
16
17
  registerElement(el: ElementScroll | null, key: string): void;
17
18
  };
@@ -20,5 +21,5 @@ declare type Props = {
20
21
  * First we render vertical parts - pinned start, data, pinned end
21
22
  * Per each column we render data collections: headers, pinned top, center data, pinned bottom
22
23
  */
23
- export declare const ViewPortSections: ({ resize, editors, rowClass, readonly, range, columns, useClipboard, columnFilter, registerElement, onEdit, onScroll }: Props) => VNode[];
24
+ export declare const ViewPortSections: ({ resize, editors, rowClass, readonly, range, columns, useClipboard, columnFilter, registerElement, onEdit, onCancelEdit, onScroll }: Props) => VNode[];
24
25
  export {};
@@ -753,7 +753,7 @@ declare namespace LocalJSX {
753
753
  "editor"?: Edition.EditorCtr | null;
754
754
  "onCellEdit"?: (event: RevogrEditCustomEvent<Edition.SaveDataDetails>) => void;
755
755
  /**
756
- * Close editor event
756
+ * Close editor event pass true if requires focus next
757
757
  */
758
758
  "onCloseEdit"?: (event: RevogrEditCustomEvent<boolean | undefined>) => void;
759
759
  }
@@ -846,6 +846,10 @@ declare namespace LocalJSX {
846
846
  * Last cell position
847
847
  */
848
848
  "lastCell"?: Selection.Cell;
849
+ /**
850
+ * Used for editors support when close requested
851
+ */
852
+ "onCancelEdit"?: (event: RevogrOverlaySelectionCustomEvent<any>) => void;
849
853
  "onFocusCell"?: (event: RevogrOverlaySelectionCustomEvent<Selection.FocusedCells>) => void;
850
854
  "onInternalCellEdit"?: (event: RevogrOverlaySelectionCustomEvent<Edition.BeforeSaveDataDetails>) => void;
851
855
  "onInternalCopy"?: (event: RevogrOverlaySelectionCustomEvent<any>) => void;
@@ -351,9 +351,7 @@ export declare namespace Edition {
351
351
  preventFocus?: boolean;
352
352
  };
353
353
 
354
- type BeforeEdit = {
355
- isCancel: boolean;
356
- } & Edition.BeforeSaveDataDetails;
354
+ type BeforeEdit = Edition.BeforeSaveDataDetails;
357
355
 
358
356
  type BeforeSaveDataDetails = {
359
357
  prop: RevoGrid.ColumnProp;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@revolist/revogrid",
3
- "version": "3.3.0",
3
+ "version": "3.3.2",
4
4
  "description": "Virtual reactive data grid component - RevoGrid.",
5
5
  "license": "MIT",
6
6
  "directories": {