add doc for value caption disabling alphabetical sort #459
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
src/ui/Facet/Facet.ts
Outdated
| * > or before the `init` call, using the `options` top-level function (see | ||
| * > [Components - Passing Component Options Before the init Call](https://developers.coveo.com/x/PoGfAQ#Components-PassingComponentOptionsBeforetheinitCall)). | ||
| * | ||
| * > * Using value captions will disable alphabetical sorts. |
There was a problem hiding this comment.
I think it would be a good idea to add a link to the availableSorts option:
- Using value captions will disable alphabetical sorts (see the [
availableSorts]{@link Facet.options.availableSorts} option).
src/ui/Facet/Facet.ts
Outdated
| * **Notes:** | ||
| * > * The [`FacetRange`]{@link FacetRange} component does not support this option. | ||
| * | ||
| * > * Using value captions will disable alphabetical sorts. |
There was a problem hiding this comment.
I would add a link to the valueCaption option:
- Using value captions will disable alphabetical sorts (see the [
valueCaption]{@link Facet.options.valueCaption} option).
fbeaudoincoveo
requested changes
May 11, 2017
fbeaudoincoveo
approved these changes
May 11, 2017
olamothe
approved these changes
May 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.
https://coveord.atlassian.net/browse/JSUI-1578
This change is