Skip to content

Commit

Permalink
feat(editors): add target to onBeforeEditCell w/called by composi…
Browse files Browse the repository at this point in the history 
…te (#301)

- we need a way to identify when the `onBeforeEditCell` is called by the Composite Editor modal or by the inline editors, we can simply add a `target` ("grid" or "composite") to identify where it was called. This will allow us to potentially disable some fields while doing inline editing but leave the same field enable when opening the Mass Update window from composite
- might as well also add the `compositeEditorOptions` in case we need to know if the Composite Modal is of type Mass Update, Edit, ...
  • Loading branch information
@ghiscoding
ghiscoding authored Mar 30, 2021
1 parent f1431f6 commit 7440ff5
Show file tree
Hide file tree
Showing 24 changed files with 80 additions and 58 deletions.
8 changes: 4 additions & 4 deletions packages/common/src/editors/__tests__/autoCompleteEditor.spec.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -849,7 +849,7 @@ describe('AutoCompleteEditor', () => {
editor.show();

expect(getCellSpy).toHaveBeenCalled();
expect(onBeforeEditSpy).toHaveBeenCalledWith({ ...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub });
expect(onBeforeEditSpy).toHaveBeenCalledWith({ ...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub, target: 'composite', compositeEditorOptions: editorArguments.compositeEditorOptions });
expect(disableSpy).toHaveBeenCalledWith(false);
});

Expand All @@ -865,7 +865,7 @@ describe('AutoCompleteEditor', () => {
editor.show();

expect(getCellSpy).toHaveBeenCalled();
expect(onBeforeEditSpy).toHaveBeenCalledWith({ ...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub });
expect(onBeforeEditSpy).toHaveBeenCalledWith({ ...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub, target: 'composite', compositeEditorOptions: editorArguments.compositeEditorOptions });
expect(onCompositeEditorSpy).toHaveBeenCalledWith({
...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub,
formValues: { gender: '' }, editors: {}, triggeredBy: 'user',
Expand All @@ -890,7 +890,7 @@ describe('AutoCompleteEditor', () => {
editor.show();

expect(getCellSpy).toHaveBeenCalled();
expect(onBeforeEditSpy).toHaveBeenCalledWith({ ...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub });
expect(onBeforeEditSpy).toHaveBeenCalledWith({ ...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub, target: 'composite', compositeEditorOptions: editorArguments.compositeEditorOptions });
expect(onCompositeEditorSpy).not.toHaveBeenCalled();
expect(disableSpy).toHaveBeenCalledWith(true);
expect(editor.editorDomElement.attr('disabled')).toEqual('disabled');
Expand Down Expand Up @@ -957,7 +957,7 @@ describe('AutoCompleteEditor', () => {
expect(output).toBe(false);
expect(spySetValue).toHaveBeenCalledWith('female');
expect(getCellSpy).toHaveBeenCalled();
expect(onBeforeEditSpy).toHaveBeenCalledWith({ ...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub });
expect(onBeforeEditSpy).toHaveBeenCalledWith({ ...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub, target: 'composite', compositeEditorOptions: editorArguments.compositeEditorOptions });
expect(onCompositeEditorSpy).toHaveBeenCalledWith({
...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub,
formValues: { gender: 'female' }, editors: {}, triggeredBy: 'user',
Expand Down
8 changes: 4 additions & 4 deletions packages/common/src/editors/__tests__/checkboxEditor.spec.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -420,7 +420,7 @@ describe('CheckboxEditor', () => {
editor.show();

expect(getCellSpy).toHaveBeenCalled();
expect(onBeforeEditSpy).toHaveBeenCalledWith({ ...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub });
expect(onBeforeEditSpy).toHaveBeenCalledWith({ ...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub, target: 'composite', compositeEditorOptions: editorArguments.compositeEditorOptions });
expect(disableSpy).toHaveBeenCalledWith(false);
});

Expand All @@ -436,7 +436,7 @@ describe('CheckboxEditor', () => {
editor.show();

expect(getCellSpy).toHaveBeenCalled();
expect(onBeforeEditSpy).toHaveBeenCalledWith({ ...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub });
expect(onBeforeEditSpy).toHaveBeenCalledWith({ ...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub, target: 'composite', compositeEditorOptions: editorArguments.compositeEditorOptions });
expect(onCompositeEditorSpy).toHaveBeenCalledWith({
...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub,
formValues: { isActive: false }, editors: {}, triggeredBy: 'user',
Expand All @@ -461,7 +461,7 @@ describe('CheckboxEditor', () => {
editor.show();

expect(getCellSpy).toHaveBeenCalled();
expect(onBeforeEditSpy).toHaveBeenCalledWith({ ...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub });
expect(onBeforeEditSpy).toHaveBeenCalledWith({ ...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub, target: 'composite', compositeEditorOptions: editorArguments.compositeEditorOptions });
expect(onCompositeEditorSpy).not.toHaveBeenCalled;
expect(disableSpy).toHaveBeenCalledWith(true);
expect(editor.editorDomElement.disabled).toEqual(true);
Expand Down Expand Up @@ -507,7 +507,7 @@ describe('CheckboxEditor', () => {

expect(getCellSpy).toHaveBeenCalled();
expect(editor.isValueTouched()).toBe(true);
expect(onBeforeEditSpy).toHaveBeenCalledWith({ ...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub });
expect(onBeforeEditSpy).toHaveBeenCalledWith({ ...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub, target: 'composite', compositeEditorOptions: editorArguments.compositeEditorOptions });
expect(onCompositeEditorSpy).toHaveBeenCalledWith({
...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub,
formValues: { isActive: true }, editors: {}, triggeredBy: 'user',
Expand Down
8 changes: 4 additions & 4 deletions packages/common/src/editors/__tests__/dateEditor.spec.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -543,7 +543,7 @@ describe('DateEditor', () => {
editor.show();

expect(getCellSpy).toHaveBeenCalled();
expect(onBeforeEditSpy).toHaveBeenCalledWith({ ...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub });
expect(onBeforeEditSpy).toHaveBeenCalledWith({ ...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub, target: 'composite', compositeEditorOptions: editorArguments.compositeEditorOptions });
expect(disableSpy).toHaveBeenCalledWith(false);
});

Expand All @@ -559,7 +559,7 @@ describe('DateEditor', () => {
editor.show();

expect(getCellSpy).toHaveBeenCalled();
expect(onBeforeEditSpy).toHaveBeenCalledWith({ ...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub });
expect(onBeforeEditSpy).toHaveBeenCalledWith({ ...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub, target: 'composite', compositeEditorOptions: editorArguments.compositeEditorOptions });
expect(onCompositeEditorSpy).toHaveBeenCalledWith({
...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub,
formValues: { startDate: '' }, editors: {}, triggeredBy: 'user',
Expand All @@ -584,7 +584,7 @@ describe('DateEditor', () => {
editor.show();

expect(getCellSpy).toHaveBeenCalled();
expect(onBeforeEditSpy).toHaveBeenCalledWith({ ...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub });
expect(onBeforeEditSpy).toHaveBeenCalledWith({ ...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub, target: 'composite', compositeEditorOptions: editorArguments.compositeEditorOptions });
expect(onCompositeEditorSpy).not.toHaveBeenCalled();
expect(disableSpy).toHaveBeenCalledWith(true);
expect(editor.flatInstance._input.disabled).toEqual(true);
Expand Down Expand Up @@ -631,7 +631,7 @@ describe('DateEditor', () => {
editorInputElm.dispatchEvent(new (window.window as any).KeyboardEvent('keydown', { keyCode: 13, bubbles: true, cancelable: true }));

expect(getCellSpy).toHaveBeenCalled();
expect(onBeforeEditSpy).toHaveBeenCalledWith({ ...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub });
expect(onBeforeEditSpy).toHaveBeenCalledWith({ ...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub, target: 'composite', compositeEditorOptions: editorArguments.compositeEditorOptions });
expect(onCompositeEditorSpy).toHaveBeenCalledWith({
...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub,
formValues: { startDate: '2001-01-02' }, editors: {}, triggeredBy: 'user',
Expand Down
10 changes: 5 additions & 5 deletions packages/common/src/editors/__tests__/dualInputEditor.spec.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -862,7 +862,7 @@ describe('DualInputEditor', () => {
editor.show();

expect(getCellSpy).toHaveBeenCalled();
expect(onBeforeEditSpy).toHaveBeenCalledWith({ ...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub });
expect(onBeforeEditSpy).toHaveBeenCalledWith({ ...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub, target: 'composite', compositeEditorOptions: editorArguments.compositeEditorOptions });
expect(disableSpy).toHaveBeenCalledWith(false);
});

Expand All @@ -878,7 +878,7 @@ describe('DualInputEditor', () => {
editor.show();

expect(getCellSpy).toHaveBeenCalled();
expect(onBeforeEditSpy).toHaveBeenCalledWith({ ...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub });
expect(onBeforeEditSpy).toHaveBeenCalledWith({ ...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub, target: 'composite', compositeEditorOptions: editorArguments.compositeEditorOptions });
expect(onCompositeEditorSpy).toHaveBeenCalledWith({
...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub,
formValues: { from: '', to: '' }, editors: {}, triggeredBy: 'user',
Expand All @@ -905,7 +905,7 @@ describe('DualInputEditor', () => {
editor.show();

expect(getCellSpy).toHaveBeenCalled();
expect(onBeforeEditSpy).toHaveBeenCalledWith({ ...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub });
expect(onBeforeEditSpy).toHaveBeenCalledWith({ ...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub, target: 'composite', compositeEditorOptions: editorArguments.compositeEditorOptions });
expect(onCompositeEditorSpy).toHaveBeenCalledWith({
...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub,
formValues: {}, editors: {}, triggeredBy: 'user',
Expand Down Expand Up @@ -934,7 +934,7 @@ describe('DualInputEditor', () => {
jest.runTimersToTime(50);

expect(getCellSpy).toHaveBeenCalled();
expect(onBeforeEditSpy).toHaveBeenCalledWith({ ...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub });
expect(onBeforeEditSpy).toHaveBeenCalledWith({ ...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub, target: 'composite', compositeEditorOptions: editorArguments.compositeEditorOptions });
expect(onCompositeEditorSpy).toHaveBeenCalledWith({
...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub,
formValues: { from: 4, to: 5 }, editors: {}, triggeredBy: 'user',
Expand All @@ -959,7 +959,7 @@ describe('DualInputEditor', () => {
editor.destroy();

expect(getCellSpy).toHaveBeenCalled();
expect(onBeforeEditSpy).toHaveBeenCalledWith({ ...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub });
expect(onBeforeEditSpy).toHaveBeenCalledWith({ ...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub, target: 'composite', compositeEditorOptions: editorArguments.compositeEditorOptions });
expect(onCompositeEditorSpy).toHaveBeenCalledWith({
...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub,
formValues: { from: 4, to: 5 }, editors: {}, triggeredBy: 'user',
Expand Down
12 changes: 6 additions & 6 deletions packages/common/src/editors/__tests__/floatEditor.spec.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -657,7 +657,7 @@ describe('FloatEditor', () => {
editor.show();

expect(getCellSpy).toHaveBeenCalled();
expect(onBeforeEditSpy).toHaveBeenCalledWith({ ...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub });
expect(onBeforeEditSpy).toHaveBeenCalledWith({ ...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub, target: 'composite', compositeEditorOptions: editorArguments.compositeEditorOptions });
expect(disableSpy).toHaveBeenCalledWith(false);
});

Expand All @@ -673,7 +673,7 @@ describe('FloatEditor', () => {
editor.show();

expect(getCellSpy).toHaveBeenCalled();
expect(onBeforeEditSpy).toHaveBeenCalledWith({ ...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub });
expect(onBeforeEditSpy).toHaveBeenCalledWith({ ...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub, target: 'composite', compositeEditorOptions: editorArguments.compositeEditorOptions });
expect(onCompositeEditorSpy).toHaveBeenCalledWith({
...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub,
formValues: { price: '' }, editors: {}, triggeredBy: 'user',
Expand All @@ -698,7 +698,7 @@ describe('FloatEditor', () => {
editor.show();

expect(getCellSpy).toHaveBeenCalled();
expect(onBeforeEditSpy).toHaveBeenCalledWith({ ...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub });
expect(onBeforeEditSpy).toHaveBeenCalledWith({ ...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub, target: 'composite', compositeEditorOptions: editorArguments.compositeEditorOptions });
expect(onCompositeEditorSpy).not.toHaveBeenCalled;
expect(disableSpy).toHaveBeenCalledWith(true);
expect(editor.editorDomElement.disabled).toEqual(true);
Expand Down Expand Up @@ -744,7 +744,7 @@ describe('FloatEditor', () => {
jest.runTimersToTime(50);

expect(getCellSpy).toHaveBeenCalled();
expect(onBeforeEditSpy).toHaveBeenCalledWith({ ...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub });
expect(onBeforeEditSpy).toHaveBeenCalledWith({ ...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub, target: 'composite', compositeEditorOptions: editorArguments.compositeEditorOptions });
expect(onCompositeEditorSpy).toHaveBeenCalledWith({
...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub,
formValues: { price: 35 }, editors: {}, triggeredBy: 'user',
Expand All @@ -769,7 +769,7 @@ describe('FloatEditor', () => {

expect(getCellSpy).toHaveBeenCalled();
expect(editor.isValueTouched()).toBe(true);
expect(onBeforeEditSpy).toHaveBeenCalledWith({ ...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub });
expect(onBeforeEditSpy).toHaveBeenCalledWith({ ...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub, target: 'composite', compositeEditorOptions: editorArguments.compositeEditorOptions });
expect(onCompositeEditorSpy).toHaveBeenCalledWith({
...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub,
formValues: { price: 35 }, editors: {}, triggeredBy: 'user',
Expand All @@ -794,7 +794,7 @@ describe('FloatEditor', () => {

expect(getCellSpy).toHaveBeenCalled();
expect(editor.isValueTouched()).toBe(true);
expect(onBeforeEditSpy).toHaveBeenCalledWith({ ...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub });
expect(onBeforeEditSpy).toHaveBeenCalledWith({ ...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub, target: 'composite', compositeEditorOptions: editorArguments.compositeEditorOptions });
expect(onCompositeEditorSpy).toHaveBeenCalledWith({
...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub,
formValues: { price: 35 }, editors: {}, triggeredBy: 'user',
Expand Down
8 changes: 4 additions & 4 deletions packages/common/src/editors/__tests__/integerEditor.spec.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -587,7 +587,7 @@ describe('IntegerEditor', () => {
editor.show();

expect(getCellSpy).toHaveBeenCalled();
expect(onBeforeEditSpy).toHaveBeenCalledWith({ ...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub });
expect(onBeforeEditSpy).toHaveBeenCalledWith({ ...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub, target: 'composite', compositeEditorOptions: editorArguments.compositeEditorOptions });
expect(disableSpy).toHaveBeenCalledWith(false);
});

Expand All @@ -603,7 +603,7 @@ describe('IntegerEditor', () => {
editor.show();

expect(getCellSpy).toHaveBeenCalled();
expect(onBeforeEditSpy).toHaveBeenCalledWith({ ...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub });
expect(onBeforeEditSpy).toHaveBeenCalledWith({ ...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub, target: 'composite', compositeEditorOptions: editorArguments.compositeEditorOptions });
expect(onCompositeEditorSpy).toHaveBeenCalledWith({
...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub,
formValues: { price: '' }, editors: {}, triggeredBy: 'user',
Expand Down Expand Up @@ -675,7 +675,7 @@ describe('IntegerEditor', () => {

expect(getCellSpy).toHaveBeenCalled();
expect(editor.isValueTouched()).toBe(true);
expect(onBeforeEditSpy).toHaveBeenCalledWith({ ...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub });
expect(onBeforeEditSpy).toHaveBeenCalledWith({ ...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub, target: 'composite', compositeEditorOptions: editorArguments.compositeEditorOptions });
expect(onCompositeEditorSpy).toHaveBeenCalledWith({
...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub,
formValues: { price: 35 }, editors: {}, triggeredBy: 'user',
Expand All @@ -700,7 +700,7 @@ describe('IntegerEditor', () => {

expect(getCellSpy).toHaveBeenCalled();
expect(editor.isValueTouched()).toBe(true);
expect(onBeforeEditSpy).toHaveBeenCalledWith({ ...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub });
expect(onBeforeEditSpy).toHaveBeenCalledWith({ ...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub, target: 'composite', compositeEditorOptions: editorArguments.compositeEditorOptions });
expect(onCompositeEditorSpy).toHaveBeenCalledWith({
...activeCellMock, column: mockColumn, item: mockItemData, grid: gridStub,
formValues: { price: 35 }, editors: {}, triggeredBy: 'user',
Expand Down
Loading

0 comments on commit 7440ff5

Please sign in to comment.