Skip to content

Commit

Permalink
JSUI-1418 (DOC) - Added some information about the option behavior wh…
Browse files Browse the repository at this point in the history
…en a search page contains a ResultsPreferences component

- Fixed some link spelling mistakes in Omnibox
- Made option names "prettier" in generated doc site for ResultLink component

https://coveord.atlassian.net/browse/JSUI-1418
  • Loading branch information
fbeaudoincoveo committed Mar 8, 2017
1 parent 8246c97 commit ae2416a
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 5 deletions.
6 changes: 3 additions & 3 deletions src/ui/Omnibox/Omnibox.ts
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ export class Omnibox extends Component {
* results.
*
* Set this option as well as {@link Omnibox.options.enableSearchAsYouType} and
* {@link Omnibox.options.RevealQuerySuggestAddon} to `true` for a cool effect!
* {@link Omnibox.options.enableRevealQuerySuggestAddon} to `true` for a cool effect!
*
* Default value is `false`.
*/
Expand All @@ -92,8 +92,8 @@ export class Omnibox extends Component {
/**
* Specifies whether to automatically trigger a new query whenever the end user types new text inside the Omnibox.
*
* Set this option as well a {@link Omnibox.options.inline} and {@link Omnibox.options.RevealQuerySuggestAddon} to
* `true` for a cool effect!
* Set this option as well a {@link Omnibox.options.inline} and
* {@link Omnibox.options.enableRevealQuerySuggestAddon} to `true` for a cool effect!
*
* Default value is `false`.
*/
Expand Down
10 changes: 8 additions & 2 deletions src/ui/ResultLink/ResultLink.ts
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ export class ResultLink extends Component {
* </script>
* ```
*
* See also {@link ResultLink.options.hrefTemplate}, which can override this option.
* See also [hrefTemplate]{@link ResultLink.options.hrefTemplate}, which can override this option.
*/
field: ComponentOptions.buildFieldOption(),

Expand Down Expand Up @@ -98,6 +98,12 @@ export class ResultLink extends Component {
* If this option is `true`, clicking the ResultLink will call the {@link ResultLink.openLinkInNewWindow} method
* instead of the {@link ResultLink.openLink} method.
*
* **Note:**
* > If a search page contains a {@link ResultsPreferences} component whose
* > [enableOpenInNewWindow]{@link ResultsPreferences.options.enableOpenInNewWindow} option is `true`, and the end
* > user checks the <b>Always open results in new window</b> box, then ResultLink components will always open in
* > a new window when the user clicks them, no matter what the value of their alwaysOpenInNewWindow option is.
*
* Default value is `false`.
*/
alwaysOpenInNewWindow: ComponentOptions.buildBooleanOption({ defaultValue: false }),
Expand All @@ -106,7 +112,7 @@ export class ResultLink extends Component {
* Specifies a template literal from which to generate the ResultLink `href` attribute (see
* [Template literals](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Template_literals)).
*
* This option overrides the value of {@link ResultLink.options.field}.
* This option overrides the value of the [field]{@link ResultLink.options.field} option.
*
* The template literal can reference any number of fields from the parent result. It can also reference global
* scope properties.
Expand Down

0 comments on commit ae2416a

Please sign in to comment.