Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updating the quick-search widget documentation #5182

Merged
merged 5 commits into from Aug 14, 2019

Conversation

@eduard13
Copy link
Contributor

commented Aug 14, 2019

Purpose of this pull request

This pull request (PR) adds more information about quickSearch widget's options, and provides a sample code of how the widget can be initiated.

Affected DevDocs pages

Links to Magento source code

whatsnew
Added a code sample and updated the API reference in the QuickSearch Widget topic.

@devops-devdocs

This comment has been minimized.

Copy link

commented Aug 14, 2019

An admin must run tests on this PR before it can be merged.

@rogyar rogyar self-assigned this Aug 14, 2019

@m2-community-project m2-community-project bot moved this from Ready for Review to Review in Progress in Pull Request Progress Aug 14, 2019

### `destinationSelector` {#q_destinationSelector}
The element's selector where the results will be added.

**Type**: String

This comment has been minimized.

Copy link
@rogyar

rogyar Aug 14, 2019

Contributor

Please, provide the default value as well. Since it's not specified in the default options, it's supposed to be null.

This comment has been minimized.

Copy link
@rogyar

rogyar Aug 14, 2019

Contributor

Also, make sure that we provide the default value for all entries. Thank you!

@@ -79,6 +95,14 @@ Disable the submit button.

**Default value**: `button[type="submit"]`

### `suggestionDelay` {#q_suggestionDelay}

The suggestionDelay option prevents spamming the server with requests by waiting till the user has stopped typing for period of time.

This comment has been minimized.

Copy link
@rogyar

rogyar Aug 14, 2019

Contributor

Please, adjust

Suggested change
The suggestionDelay option prevents spamming the server with requests by waiting till the user has stopped typing for period of time.
The suggestionDelay option prevents spamming the server with requests by waiting till the user has stopped typing for the specified period of time.
@@ -97,21 +121,50 @@ Template responsible for rendering returned data (suggested terms).
</li>
```

### `isExpandable` {#q_isExpandable}
### `url` {#q_url}
The responsible url for processing the search query.

This comment has been minimized.

Copy link
@rogyar

rogyar Aug 14, 2019

Contributor

I would suggest using the endpoint URL definition here

Suggested change
The responsible url for processing the search query.
The endpoint URL for processing the search query.
@eduard13

This comment has been minimized.

Copy link
Contributor Author

commented Aug 14, 2019

Thank you @rogyar for suggestions 👏, please check the updated changes.

@rogyar
rogyar approved these changes Aug 14, 2019

@m2-community-project m2-community-project bot moved this from Review in Progress to Reviewer Approved in Pull Request Progress Aug 14, 2019

@dobooth

This comment has been minimized.

Copy link
Contributor

commented Aug 14, 2019

running tests

@dobooth

This comment has been minimized.

Copy link
Contributor

commented Aug 14, 2019

running tests

@dobooth dobooth merged commit 3df0f79 into magento:master Aug 14, 2019

2 checks passed

Jenkins Tests passed
Details
licence/cla Contributor License Agreement is signed.
Details
@contribution-survey

This comment has been minimized.

Copy link

commented Aug 14, 2019

Hi @eduard13, thank you for your contribution!
Please, complete Contribution Survey, it will take less than a minute.
Your feedback will help us to improve contribution process.

@m2-community-project m2-community-project bot moved this from Reviewer Approved to Done in Pull Request Progress Aug 14, 2019

@meker12 meker12 removed the Technical label Aug 19, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.