DOC-458 OmniboxResultList documentation revision #345
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 13, 2017
fbeaudoincoveo
commented
fbeaudoincoveo
commented
Feb 13, 2017
| @@ -108,8 +129,8 @@ export class OmniboxResultList extends ResultList implements IComponentBindings | |||
| } | |||
|
|
|||
There was a problem hiding this comment.
Would you like me to expose the renderResults public method in the doc?
fbeaudoincoveo
commented
Feb 13, 2017
| * This component is exactly like a normal ResultList Component, except that it will render itself inside the Omnibox component. | ||
| * This will provide a kind of search as you type functionnality, allowing you to easily render complex Result Templates inside the Omnibox component. | ||
| * The OmniboxResultList component acts exactly like a normal {@link ResultList} component, except that it renders itself | ||
| * inside the {@link Omnibox} component. | ||
| * |
There was a problem hiding this comment.
I considered mentioning that this component actually inherits from the ResultList component... However, since most of the ResultList options don't really seem to apply to the OmniboxResultList, I finally decided against it. What do you think?
olamothe
approved these changes
Feb 13, 2017
| @@ -108,8 +129,8 @@ export class OmniboxResultList extends ResultList implements IComponentBindings | |||
| } | |||
|
|
|||
- Mentioned that OmniboxResultList extends ResultList - Exposed RenderResults method - Several other minor fixes in public documentation
fbeaudoincoveo
commented
Feb 14, 2017
| * appends to the result container, this method triggers a `newResultDisplayed` event. Once all items have been | ||
| * appended to the result container, the method triggers a `newResultsDisplayed` event. | ||
| * @param resultsElement The array of `HTMLElement` to render. | ||
| * @param append |
There was a problem hiding this comment.
The append parameter is not used in the method, do we need to keep it?
- Fixed typo in public doc
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.