DOC-458 FacetSlider documentation revision #359
Merged
Conversation
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
Contributor
fbeaudoincoveo
commented
Feb 14, 2017
fbeaudoincoveo
commented
fbeaudoincoveo
commented
Feb 14, 2017
| */ | ||
| responsiveBreakpoint: ComponentOptions.buildNumberOption({ defaultValue: 800 }), | ||
| responsiveBreakpoint: ComponentOptions.buildNumberOption({ defaultValue: 800, min: 0 }), |
There was a problem hiding this comment.
I added a minimum value here; please make sure it's OK.
dms1lva
approved these changes
Feb 14, 2017
src/ui/FacetSlider/FacetSlider.ts
Outdated
| * Specifies whether the field for which you are requesting a range is a date field.<br/> | ||
| * This allows the facet to correctly build the outgoing group by request, as well as render it correctly.<br/> | ||
| * Specifies whether the field for which you are requesting a range is a date field. This allows the FacetSlider to | ||
| * correctly build the outgoing {@link IGroupByRequest} and render itself properly. |
There was a problem hiding this comment.
Here you could do [GroupByRequest]{@link IGroupByRequest} so that it shows up as "GroupByRequest".
There was a problem hiding this comment.
Great idea, I'll eventually do this in other places in the doc, too!
src/ui/FacetSlider/FacetSlider.ts
Outdated
| * Specifies the number of steps to split the slider into. | ||
| * | ||
| * For example, if your range is [ 0 , 100 ] and you specify 10 steps, then the end user can move the slider only to | ||
| * the values [ 0, 10, 20. 30 ... , 100 ]. |
There was a problem hiding this comment.
There's a period instead of a comma after the 20
src/ui/FacetSlider/FacetSlider.ts
Outdated
| * Specifies a function that will generate the steps for the slider. The function receives the slider boundaries and must return an array of number (the steps). | ||
| * Specifies a function to generate the steps for the FacetSlider (see {@link FacetSlider.options.steps}. This | ||
| * function receives the FacetSlider boundaries (see {@link FacetSlider.options.start} and | ||
| * {@link FacetSlider.options.end}) and must return an array of number (the steps). |
There was a problem hiding this comment.
Since "number" is the type, I hesitate to use the plural form. Perhaps I could instead emphasize it, like "array of number". What do you think?
There was a problem hiding this comment.
I discussed it with François Dallaire and he agrees with your idea of using plural when talking about multiple items of the same type, so I'm going to do this after all :)
| */ | ||
| responsiveBreakpoint: ComponentOptions.buildNumberOption({ defaultValue: 800 }), | ||
| responsiveBreakpoint: ComponentOptions.buildNumberOption({ defaultValue: 800, min: 0 }), |
olamothe
requested changes
Feb 15, 2017
src/ui/FacetSlider/FacetSlider.ts
Outdated
| * Coveo.init(document.querySelector('#search'), { | ||
| * FacetSlider: { | ||
| * field: "@size", | ||
| * field: "@syssize", |
src/ui/FacetSlider/FacetSlider.ts
Outdated
| * $('#search').coveo('init', { | ||
| * FacetSlider: { | ||
| * field: "@size", | ||
| * field: "@syssize", |
olamothe
approved these changes
Feb 15, 2017
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.