-
Notifications
You must be signed in to change notification settings - Fork 516
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(numericRefinementList): create numericRefinementList widget usin…
…g refinementList component
- Loading branch information
Showing
12 changed files
with
477 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| | Param | Description | | ||
| | --- | --- | | ||
| | <span class='attr-required'>`options.container`</span> | CSS Selector or DOMElement to insert the widget | | ||
| | <span class='attr-required'>`options.attributeName`</span> | Name of the attribute for filtering | | ||
| | <span class='attr-optional'>`options.cssClasses`</span> | CSS classes to add to the wrapping elements: root, list, item | | ||
| | <span class='attr-optional'>`options.cssClasses.root`</span> | CSS class to add to the root element | | ||
| | <span class='attr-optional'>`options.cssClasses.header`</span> | CSS class to add to the header element | | ||
| | <span class='attr-optional'>`options.cssClasses.body`</span> | CSS class to add to the body element | | ||
| | <span class='attr-optional'>`options.cssClasses.footer`</span> | CSS class to add to the footer element | | ||
| | <span class='attr-optional'>`options.cssClasses.list`</span> | CSS class to add to the list element | | ||
| | <span class='attr-optional'>`options.cssClasses.label`</span> | CSS class to add to each link element | | ||
| | <span class='attr-optional'>`options.cssClasses.item`</span> | CSS class to add to each item element | | ||
| | <span class='attr-optional'>`options.cssClasses.radio`</span> | CSS class to add to each radio element (when using the default template) | | ||
| | <span class='attr-optional'>`options.cssClasses.active`</span> | CSS class to add to each active element | | ||
| | <span class='attr-optional'>`options.templates`</span> | Templates to use for the widget | | ||
| | <span class='attr-optional'>`options.templates.header`</span> | Header template | | ||
| | <span class='attr-optional'>`options.templates.item`</span> | Item template, provided with `name`, `count`, `isRefined` | | ||
| | <span class='attr-optional'>`options.templates.footer`</span> | Footer template | | ||
| | <span class='attr-optional'>`options.transformData`</span> | Function to change the object passed to the item template | | ||
| | <span class='attr-optional'>`hideContainerWhenNoResults`</span> | Hide the container when there's no results | | ||
|
|
||
| <p class="attr-legend">* <span>Required</span></p> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
150 changes: 150 additions & 0 deletions
150
widgets/numeric-refinement-list/__tests__/numeric-refinement-list-test.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,150 @@ | ||
| /* eslint-env mocha */ | ||
|
|
||
| import React from 'react'; | ||
| import expect from 'expect'; | ||
| import sinon from 'sinon'; | ||
| import jsdom from 'mocha-jsdom'; | ||
|
|
||
| import expectJSX from 'expect-jsx'; | ||
| expect.extend(expectJSX); | ||
|
|
||
| describe('numericRefinementList()', () => { | ||
| jsdom({useEach: true}); | ||
|
|
||
| let ReactDOM; | ||
| let container; | ||
| let widget; | ||
| let helper; | ||
|
|
||
| let autoHideContainer; | ||
| let headerFooter; | ||
| let RefinementList; | ||
| let numericRefinementList; | ||
| let options; | ||
|
|
||
| beforeEach(() => { | ||
| numericRefinementList = require('../numeric-refinement-list'); | ||
| RefinementList = require('../../../components/RefinementList/RefinementList'); | ||
| ReactDOM = {render: sinon.spy()}; | ||
| numericRefinementList.__Rewire__('ReactDOM', ReactDOM); | ||
| autoHideContainer = sinon.stub().returns(RefinementList); | ||
| numericRefinementList.__Rewire__('autoHideContainer', autoHideContainer); | ||
| headerFooter = sinon.stub().returns(RefinementList); | ||
| numericRefinementList.__Rewire__('headerFooter', headerFooter); | ||
|
|
||
| options = [ | ||
| {name: 'All'}, | ||
| {end: 4, name: 'less than 4'}, | ||
| {start: 4, end: 4, name: '4'}, | ||
| {start: 5, end: 10, name: 'between 5 and 10'}, | ||
| {start: 10, name: 'more than 10'} | ||
| ]; | ||
|
|
||
| container = document.createElement('div'); | ||
| widget = numericRefinementList({container, attributeName: 'price', options: options}); | ||
| helper = { | ||
| state: { | ||
| getNumericRefinements: sinon.stub().returns([]) | ||
| }, | ||
| addNumericRefinement: sinon.spy(), | ||
| search: sinon.spy(), | ||
| setState: sinon.spy() | ||
| }; | ||
|
|
||
| helper.state.clearRefinements = sinon.stub().returns(helper.state); | ||
| helper.state.addNumericRefinement = sinon.stub().returns(helper.state); | ||
| }); | ||
|
|
||
| it('calls twice ReactDOM.render(<RefinementList props />, container)', () => { | ||
| widget.render({helper}); | ||
| widget.render({helper}); | ||
|
|
||
| let props = { | ||
| cssClasses: { | ||
| active: 'ais-refinement-list--item__active', | ||
| body: 'ais-refinement-list--body', | ||
| footer: 'ais-refinement-list--footer', | ||
| header: 'ais-refinement-list--header', | ||
| item: 'ais-refinement-list--item', | ||
| label: 'ais-refinement-list--label', | ||
| list: 'ais-refinement-list--list', | ||
| radio: 'ais-refinement-list--radio', | ||
| root: 'ais-refinement-list' | ||
| }, | ||
| facetValues: [ | ||
| {attributeName: 'price', isRefined: true, name: 'All'}, | ||
| {attributeName: 'price', end: 4, isRefined: false, name: 'less than 4'}, | ||
| {attributeName: 'price', end: 4, isRefined: false, name: '4', start: 4}, | ||
| {attributeName: 'price', end: 10, isRefined: false, name: 'between 5 and 10', start: 5}, | ||
| {attributeName: 'price', isRefined: false, name: 'more than 10', start: 10} | ||
| ], | ||
| createURL: () => {}, | ||
| toggleRefinement: () => {}, | ||
| shouldAutoHideContainer: false, | ||
| templateProps: { | ||
| templates: {footer: '', header: '', item: '<label class="{{cssClasses.label}}">\n <input type="radio" class="{{cssClasses.checkbox}}" name="{{attributeName}}" {{#isRefined}}checked{{/isRefined}} />{{name}}\n</label>'}, | ||
| templatesConfig: undefined, | ||
| transformData: undefined, | ||
| useCustomCompileOptions: { | ||
| footer: false, | ||
| header: false, | ||
| item: false | ||
| } | ||
| } | ||
| }; | ||
|
|
||
| expect(ReactDOM.render.calledTwice).toBe(true, 'ReactDOM.render called twice'); | ||
| expect(autoHideContainer.calledOnce).toBe(true, 'autoHideContainer called once'); | ||
| expect(headerFooter.calledOnce).toBe(true, 'headerFooter called once'); | ||
| expect(ReactDOM.render.firstCall.args[0]).toEqualJSX(<RefinementList {...props} />); | ||
| expect(ReactDOM.render.firstCall.args[1]).toEqual(container); | ||
| expect(ReactDOM.render.secondCall.args[0]).toEqualJSX(<RefinementList {...props} />); | ||
| expect(ReactDOM.render.secondCall.args[1]).toEqual(container); | ||
| }); | ||
|
|
||
| it('doesn\'t call the refinement functions if not refined', () => { | ||
| widget.render({helper}); | ||
| expect(helper.state.clearRefinements.called).toBe(false, 'clearRefinements called one'); | ||
| expect(helper.state.addNumericRefinement.called).toBe(false, 'addNumericRefinement never called'); | ||
| expect(helper.search.called).toBe(false, 'search never called'); | ||
| }); | ||
|
|
||
| it('calls the refinement functions if refined with "4"', () => { | ||
| widget._toggleRefinement(helper, '4'); | ||
| expect(helper.state.clearRefinements.calledOnce).toBe(true, 'clearRefinements called once'); | ||
| expect(helper.state.addNumericRefinement.calledOnce).toBe(true, 'addNumericRefinement called once'); | ||
| expect(helper.state.addNumericRefinement.getCall(0).args).toEqual(['price', '=', 4]); | ||
| expect(helper.search.calledOnce).toBe(true, 'search called once'); | ||
| }); | ||
|
|
||
| it('calls the refinement functions if refined with "between 5 and 10"', () => { | ||
| widget._toggleRefinement(helper, 'between 5 and 10'); | ||
| expect(helper.state.clearRefinements.calledOnce).toBe(true, 'clearRefinements called once'); | ||
| expect(helper.state.addNumericRefinement.calledTwice).toBe(true, 'addNumericRefinement called twice'); | ||
| expect(helper.state.addNumericRefinement.getCall(0).args).toEqual(['price', '>=', 5]); | ||
| expect(helper.state.addNumericRefinement.getCall(1).args).toEqual(['price', '<=', 10]); | ||
| expect(helper.search.calledOnce).toBe(true, 'search called once'); | ||
| }); | ||
|
|
||
| it('calls two times the refinement functions if refined with "less than 4"', () => { | ||
| widget._toggleRefinement(helper, 'less than 4'); | ||
| expect(helper.state.clearRefinements.calledOnce).toBe(true, 'clearRefinements called once'); | ||
| expect(helper.state.addNumericRefinement.calledOnce).toBe(true, 'addNumericRefinement called once'); | ||
| expect(helper.state.addNumericRefinement.getCall(0).args).toEqual(['price', '<=', 4]); | ||
| expect(helper.search.calledOnce).toBe(true, 'search called once'); | ||
| }); | ||
|
|
||
| it('calls two times the refinement functions if refined with "more than 10"', () => { | ||
| widget._toggleRefinement(helper, 'more than 10'); | ||
| expect(helper.state.clearRefinements.calledOnce).toBe(true, 'clearRefinements called once'); | ||
| expect(helper.state.addNumericRefinement.calledOnce).toBe(true, 'addNumericRefinement called once'); | ||
| expect(helper.state.addNumericRefinement.getCall(0).args).toEqual(['price', '>=', 10]); | ||
| expect(helper.search.calledOnce).toBe(true, 'search called once'); | ||
| }); | ||
|
|
||
| afterEach(() => { | ||
| numericRefinementList.__ResetDependency__('ReactDOM'); | ||
| numericRefinementList.__ResetDependency__('autoHideContainer'); | ||
| numericRefinementList.__ResetDependency__('headerFooter'); | ||
| }); | ||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| module.exports = { | ||
| header: '', | ||
| item: `<label class="{{cssClasses.label}}"> | ||
| <input type="radio" class="{{cssClasses.checkbox}}" name="{{attributeName}}" {{#isRefined}}checked{{/isRefined}} />{{name}} | ||
| </label>`, | ||
| footer: '' | ||
| }; |
Oops, something went wrong.