Skip to content

Commit

Permalink
feat(filters): display operator into input text filter from Grid Pres…
Browse files Browse the repository at this point in the history 
…ets (#288)

- a use case that we have with the text InputFilter is that if have a filter that includes an operator inside the search text (e.g.: ">=55") and we save the Grid State in Local Storage or anything else and then we reload them as Grid Presets, the operator won't be showing up (it would only show "55" while keeping the Operator hidden but still in play) that is because the FilterService is doing the split (this is an Operator and these are the SearchTerm) and the Grid State only keeps the split, so in that case this PR adds an extra step that if we're using the `setValues()` method, then we're probably using a Grid Preset or an UpdateFilters and we should display the operator as part of the final displayed search string inside the input value
  • Loading branch information
@ghiscoding
ghiscoding authored Mar 17, 2021
1 parent 2d106d4 commit 3fad4fe
Show file tree
Hide file tree
Showing 4 changed files with 147 additions and 53 deletions.
2 changes: 1 addition & 1 deletion examples/webpack-demo-vanilla-bundle/src/examples/example11.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ export class Example11 {
initializeGrid() {
this.columnDefinitions = [
{
id: 'title', name: 'Title', field: 'title', sortable: true, type: FieldType.string,
id: 'title', name: 'Title', field: 'title', sortable: true,
editor: { model: Editors.text, massUpdate: true, required: true, alwaysSaveOnEnterKey: true, validator: myCustomTitleValidator, },
filterable: true,
formatter: Formatters.multiple, params: { formatters: [Formatters.uppercase, Formatters.bold] },
Expand Down
142 changes: 94 additions & 48 deletions packages/common/src/filters/__tests__/inputFilter.spec.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -69,69 +69,115 @@ describe('InputFilter', () => {
expect(filterElm.placeholder).toBe(testValue);
});

it('should call "setValues" and expect that value to be in the callback when triggered', () => {
const spyCallback = jest.spyOn(filterArguments, 'callback');
describe('setValues method', () => {
afterEach(() => {
filter.destroy();
});

filter.init(filterArguments);
filter.setValues('abc');
const filterElm = divContainer.querySelector('input.filter-duration') as HTMLInputElement;
it('should call "setValues" and expect that value to be in the callback when triggered', () => {
const spyCallback = jest.spyOn(filterArguments, 'callback');

filterElm.focus();
filterElm.dispatchEvent(new (window.window as any).Event('keyup', { key: 'a', keyCode: 97, bubbles: true, cancelable: true }));
const filterFilledElms = divContainer.querySelectorAll<HTMLInputElement>('input.filter-duration.filled');
filter.init(filterArguments);
filter.setValues('abc');
const filterElm = divContainer.querySelector('input.filter-duration') as HTMLInputElement;

expect(filterFilledElms.length).toBe(1);
expect(spyCallback).toHaveBeenCalledWith(expect.anything(), { columnDef: mockColumn, operator: '', searchTerms: ['abc'], shouldTriggerQuery: true });
});
filterElm.focus();
filterElm.dispatchEvent(new (window.window as any).Event('keyup', { key: 'a', keyCode: 97, bubbles: true, cancelable: true }));
const filterFilledElms = divContainer.querySelectorAll<HTMLInputElement>('input.filter-duration.filled');

it('should call "setValues" and expect that value to be in the callback when triggered by ENTER key', () => {
const spyCallback = jest.spyOn(filterArguments, 'callback');
expect(filterFilledElms.length).toBe(1);
expect(spyCallback).toHaveBeenCalledWith(expect.anything(), { columnDef: mockColumn, operator: '', searchTerms: ['abc'], shouldTriggerQuery: true });
});

filter.init(filterArguments);
filter.setValues('abc');
const filterElm = divContainer.querySelector('input.filter-duration') as HTMLInputElement;
it('should call "setValues" and expect that value to be in the callback when triggered by ENTER key', () => {
const spyCallback = jest.spyOn(filterArguments, 'callback');

filterElm.focus();
const event = new (window.window as any).Event('keyup', { bubbles: true, cancelable: true });
event.key = 'Enter';
filterElm.dispatchEvent(event);
const filterFilledElms = divContainer.querySelectorAll<HTMLInputElement>('input.filter-duration.filled');
filter.init(filterArguments);
filter.setValues('abc');
const filterElm = divContainer.querySelector('input.filter-duration') as HTMLInputElement;

expect(filterFilledElms.length).toBe(1);
expect(spyCallback).toHaveBeenCalledWith(expect.anything(), { columnDef: mockColumn, operator: '', searchTerms: ['abc'], shouldTriggerQuery: true });
});
filterElm.focus();
const event = new (window.window as any).Event('keyup', { bubbles: true, cancelable: true });
event.key = 'Enter';
filterElm.dispatchEvent(event);
const filterFilledElms = divContainer.querySelectorAll<HTMLInputElement>('input.filter-duration.filled');

it('should call "setValues" with an operator and with extra spaces at the beginning of the searchTerms and trim value when "enableFilterTrimWhiteSpace" is enabled in grid options', () => {
gridOptionMock.enableFilterTrimWhiteSpace = true;
const spyCallback = jest.spyOn(filterArguments, 'callback');
expect(filterFilledElms.length).toBe(1);
expect(spyCallback).toHaveBeenCalledWith(expect.anything(), { columnDef: mockColumn, operator: '', searchTerms: ['abc'], shouldTriggerQuery: true });
});

filter.init(filterArguments);
filter.setValues(' abc ', 'EQ');
const filterElm = divContainer.querySelector('input.filter-duration') as HTMLInputElement;
it('should call "setValues" with an operator and with extra spaces at the beginning of the searchTerms and trim value when "enableFilterTrimWhiteSpace" is enabled in grid options', () => {
gridOptionMock.enableFilterTrimWhiteSpace = true;
const spyCallback = jest.spyOn(filterArguments, 'callback');

filterElm.focus();
filterElm.dispatchEvent(new (window.window as any).Event('keyup', { key: 'a', keyCode: 97, bubbles: true, cancelable: true }));
const filterFilledElms = divContainer.querySelectorAll<HTMLInputElement>('input.filter-duration.filled');
filter.init(filterArguments);
filter.setValues(' abc ', 'EQ');
const filterElm = divContainer.querySelector('input.filter-duration') as HTMLInputElement;

expect(filterFilledElms.length).toBe(1);
expect(spyCallback).toHaveBeenCalledWith(expect.anything(), { columnDef: mockColumn, operator: 'EQ', searchTerms: ['abc'], shouldTriggerQuery: true });
});
filterElm.focus();
filterElm.dispatchEvent(new (window.window as any).Event('keyup', { key: 'a', keyCode: 97, bubbles: true, cancelable: true }));
const filterFilledElms = divContainer.querySelectorAll<HTMLInputElement>('input.filter-duration.filled');

it('should call "setValues" with extra spaces at the beginning of the searchTerms and trim value when "enableTrimWhiteSpace" is enabled in the column filter', () => {
gridOptionMock.enableFilterTrimWhiteSpace = false;
mockColumn.filter!.enableTrimWhiteSpace = true;
const spyCallback = jest.spyOn(filterArguments, 'callback');
expect(filterFilledElms.length).toBe(1);
expect(spyCallback).toHaveBeenCalledWith(expect.anything(), { columnDef: mockColumn, operator: 'EQ', searchTerms: ['abc'], shouldTriggerQuery: true });
});

filter.init(filterArguments);
filter.setValues(' abc ');
const filterElm = divContainer.querySelector('input.filter-duration') as HTMLInputElement;
it('should call "setValues" with extra spaces at the beginning of the searchTerms and trim value when "enableTrimWhiteSpace" is enabled in the column filter', () => {
gridOptionMock.enableFilterTrimWhiteSpace = false;
mockColumn.filter!.enableTrimWhiteSpace = true;
const spyCallback = jest.spyOn(filterArguments, 'callback');

filterElm.focus();
filterElm.dispatchEvent(new (window.window as any).Event('keyup', { key: 'a', keyCode: 97, bubbles: true, cancelable: true }));
const filterFilledElms = divContainer.querySelectorAll<HTMLInputElement>('input.filter-duration.filled');
filter.init(filterArguments);
filter.setValues(' abc ');
const filterElm = divContainer.querySelector('input.filter-duration') as HTMLInputElement;

filterElm.focus();
filterElm.dispatchEvent(new (window.window as any).Event('keyup', { key: 'a', keyCode: 97, bubbles: true, cancelable: true }));
const filterFilledElms = divContainer.querySelectorAll<HTMLInputElement>('input.filter-duration.filled');

expect(filterFilledElms.length).toBe(1);
expect(spyCallback).toHaveBeenCalledWith(expect.anything(), { columnDef: mockColumn, operator: '', searchTerms: ['abc'], shouldTriggerQuery: true });
});

it('should call "setValues" and include an operator and expect the operator to show up in the output search string shown in the filter input text value', () => {
filter.init(filterArguments);

filter.setValues('abc', '<>');
expect(filter.getValue()).toBe('<>abc');

filter.setValues('abc', '!=');
expect(filter.getValue()).toBe('!=abc');

filter.setValues('abc', '=');
expect(filter.getValue()).toBe('=abc');

filter.setValues('abc', '==');
expect(filter.getValue()).toBe('==abc');

filter.setValues(123, '<');
expect(filter.getValue()).toBe('<123');

filter.setValues(123, '<=');
expect(filter.getValue()).toBe('<=123');

filter.setValues(123, '>');
expect(filter.getValue()).toBe('>123');

filter.setValues(123, '>=');
expect(filter.getValue()).toBe('>=123');

filter.setValues('abc', 'EndsWith');
expect(filter.getValue()).toBe('*abc');

filter.setValues('abc', '*z');
expect(filter.getValue()).toBe('*abc');

filter.setValues('abc', 'StartsWith');
expect(filter.getValue()).toBe('abc*');

expect(filterFilledElms.length).toBe(1);
expect(spyCallback).toHaveBeenCalledWith(expect.anything(), { columnDef: mockColumn, operator: '', searchTerms: ['abc'], shouldTriggerQuery: true });
filter.setValues('abc', 'a*');
expect(filter.getValue()).toBe('abc*');
});
});

it('should trigger the callback method when user types something in the input', () => {
Expand Down
52 changes: 50 additions & 2 deletions packages/common/src/filters/inputFilter.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -115,10 +115,17 @@ export class InputFilter implements Filter {
this.$filterElm = null;
}

getValue() {
return this.$filterElm.val();
}

/** Set value(s) on the DOM element */
setValues(values: SearchTerm | SearchTerm[], operator?: OperatorType | OperatorString) {
if (values) {
this.$filterElm.val(values);
const searchValues = Array.isArray(values) ? values : [values];
let searchValue: SearchTerm = '';
for (const value of searchValues) {
searchValue = operator ? this.addOptionalOperatorIntoSearchString(value, operator) : value;
this.$filterElm.val(searchValue);
}

// set the operator when defined
Expand All @@ -129,6 +136,47 @@ export class InputFilter implements Filter {
// protected functions
// ------------------

/**
* When loading the search string from the outside into the input text field, we should also add the prefix/suffix of the operator.
* We do this so that if it was loaded by a Grid Presets then we should also add the operator into the search string
* Let's take these 3 examples:
* 1. (operator: '>=', searchTerms:[55]) should display as ">=55"
* 2. (operator: 'StartsWith', searchTerms:['John']) should display as "John*"
* 3. (operator: 'EndsWith', searchTerms:['John']) should display as "*John"
* @param operator - operator string
*/
protected addOptionalOperatorIntoSearchString(inputValue: SearchTerm, operator: OperatorType | OperatorString): string {
let searchTermPrefix = '';
let searchTermSuffix = '';
let outputValue = inputValue === undefined || inputValue === null ? '' : `${inputValue}`;

if (operator && outputValue) {
switch (operator) {
case '<>':
case '!=':
case '=':
case '==':
case '>':
case '>=':
case '<':
case '<=':
searchTermPrefix = operator;
break;
case 'EndsWith':
case '*z':
searchTermPrefix = '*';
break;
case 'StartsWith':
case 'a*':
searchTermSuffix = '*';
break;
}
outputValue = `${searchTermPrefix}${outputValue}${searchTermSuffix}`;
}

return outputValue;
}

/**
* Create the HTML template as a string
*/
Expand Down
4 changes: 2 additions & 2 deletions packages/common/src/services/filter.service.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -855,7 +855,7 @@ export class FilterService {
let searchTerms: SearchTerm[] | undefined;
let operator: OperatorString | OperatorType | undefined;
const newFilter: Filter | undefined = this.filterFactory.createFilter(columnDef.filter);
operator = (columnDef && columnDef.filter && columnDef.filter.operator) || (newFilter && newFilter.operator);
operator = columnDef?.filter?.operator ?? newFilter?.operator;

if (this._columnFilters[columnDef.id]) {
searchTerms = this._columnFilters[columnDef.id].searchTerms || undefined;
Expand Down Expand Up @@ -889,7 +889,7 @@ export class FilterService {
// when hiding/showing (with Column Picker or Grid Menu), it will try to re-create yet again the filters (since SlickGrid does a re-render)
// we need to also set again the values in the DOM elements if the values were set by a searchTerm(s)
if (searchTerms && newFilter.setValues) {
newFilter.setValues(searchTerms);
newFilter.setValues(searchTerms, operator);
}
}
}
Expand Down

0 comments on commit 3fad4fe

Please sign in to comment.