DOC-458 FieldTable documentation revision #356
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
| @@ -12,6 +12,9 @@ export interface IBadgeOptions extends IFieldValueOptions { | |||
| colors: IBadgeColors; | |||
There was a problem hiding this comment.
Since the IBadgeColors / IBadgeColor is used to specify the colors options as well as in the parseColors, getColor(), and renderOneValue() public methods, do you think it would be a good idea to expose these interfaces in the public doc?
fbeaudoincoveo
commented
Feb 14, 2017
| */ | ||
| separator: ComponentOptions.buildStringOption({ defaultValue: ';' }), | ||
| separator: ComponentOptions.buildStringOption({ depend: 'splitValues', defaultValue: ';' }), |
There was a problem hiding this comment.
I made this depend of splitValues being true because it seems to make sense. Please make sure this is correct.
fbeaudoincoveo
commented
Feb 14, 2017
| */ | ||
| displaySeparator: ComponentOptions.buildStringOption({ defaultValue: ', ' }), | ||
| displaySeparator: ComponentOptions.buildStringOption({ depend: 'splitValues', defaultValue: ', ' }), |
There was a problem hiding this comment.
See previous comment.
fbeaudoincoveo
commented
Feb 14, 2017
| * Specifies whether the table is minimized by default. | ||
| * If {@link FieldTable.options.allowMinimization} is `true`, specifies whether to minimize the table by default. | ||
| * | ||
| * Default value is `undefined`, and the FieldTable will collapse by default if the result it is associated with has |
There was a problem hiding this comment.
Please make sure this information is correct :)
olamothe
approved these changes
Feb 15, 2017
| @@ -12,6 +12,9 @@ export interface IBadgeOptions extends IFieldValueOptions { | |||
| colors: IBadgeColors; | |||
| */ | ||
| separator: ComponentOptions.buildStringOption({ defaultValue: ';' }), | ||
| separator: ComponentOptions.buildStringOption({ depend: 'splitValues', defaultValue: ';' }), |
| */ | ||
| displaySeparator: ComponentOptions.buildStringOption({ defaultValue: ', ' }), | ||
| displaySeparator: ComponentOptions.buildStringOption({ depend: 'splitValues', defaultValue: ', ' }), |
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.