-
Notifications
You must be signed in to change notification settings - Fork 332
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
docs: switch core usage with autocomplete-js #401
docs: switch core usage with autocomplete-js #401
Conversation
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit 5de5926:
|
@@ -52,7 +52,8 @@ You can also manually update the state using setters. It's useful to implement c | |||
For example, let's say you want to let users fill the search input with the value of a suggestion by clicking or tapping it. You can use the [`setQuery`](state#setquery) setter provided by [`getSources`](sources#getsources) to attach an event when clicking the tap-ahead button and manually set the query. | |||
|
|||
```js | |||
const autocomplete = createAutocomplete({ | |||
autocomplete({ | |||
// ... | |||
getSources({ query, setQuery, refresh }) { | |||
return [ | |||
{ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not directly related to this PR but we don't support DOM anymore so the example below won't work anymore.
autocomplete({
// ...
getSources({ setQuery, refresh }) {
return [
{
// ...
templates: {
item({ item }) {
return (
<div className="ItemContent">
<div className="aa-aa-ItemSourceIcon">Icon</div>
<div className="aa-ItemTitle">{item.query}</div>
<button
className="aa-ItemActionButton"
onClick={(event) => {
event.stopPropagation();
setQuery(item.query);
refresh();
}}
>
Fill query
</button>
</div>
);
},
},
},
];
},
});
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is JSX, so this does work with adding h
and turning the snippet into jsx
no?
/** @jsx h */
import { h } from 'preact';
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yep
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Handled in a725011.
* docs(website): bootstrap new doc structure * docs(website): add doc for `createAlgoliaInsightsPlugin` * docs(website): add draft sections * docs: rewrite "Integrating keyboard navigation" (#389) * feat: add intro * Apply suggestions from code review Co-authored-by: Sarah Dayan <[email protected]> * fix: remove conflicting sentence * docs: rewrite "Accessing data with Context" (#390) * docs: rewrote "Controlling behavior with State" (#391) * fix: bold and underline text * docs: rewrite "Populating autocomplete with Sources" (#396) * docs: write "Displaying items with Templates" (#397) * fix(core): update query conditions * chore(test): add tests for getEnvironmentProps onTouchMove (#398) * feat(emptyStates): implements empty source template and renderEmpty method (#395) * Implements `empty` template and `renderEmpty` method * Add wait function to `test/utils` folder Co-authored-by: François Chalifour <[email protected]> * Add tests for `onActive` and `onSelect` on plugins (#400) * feat(js): change renderer implementation to virtual DOM (#381) * feat(js): change renderer implementation to virtual DOM * feat(highlighting): revamp highlighting system to VDOM (#399) * fix: fix code example (#403) * docs: switch core usage with autocomplete-js (#401) * docs: write "Basic configuration options" (#402) * docs: write "help and discussion" page (#394) * docs: add help page * Apply suggestions from code review Co-authored-by: François Chalifour <[email protected]> Co-authored-by: François Chalifour <[email protected]> * feat: put in a placeholder input * fix: update links * fix: links * fix: merge conflict * fix: merge conflict * feat: add AutocompleteExample * feat: add AutocompleteItem * fix: remove htm package * fix: remove htm package * fix: rename AutocompleteItem -> AutocompleteDocSearchItem * fix(website): use React renderer in `AutocompleteExample` * fix(website): support content record types Co-authored-by: François Chalifour <[email protected]> Co-authored-by: Sarah Dayan <[email protected]> Co-authored-by: Yannick Croissant <[email protected]> Co-authored-by: Clément Vannicatte <[email protected]> Co-authored-by: François Chalifour <[email protected]>
* docs(website): bootstrap new doc structure * docs(website): add doc for `createAlgoliaInsightsPlugin` * docs(website): add draft sections * docs: rewrite "Integrating keyboard navigation" (#389) * docs: rewrite "Accessing data with Context" (#390) * docs: rewrote "Controlling behavior with State" (#391) * docs: rewrite "Populating autocomplete with Sources" (#396) * docs: write "Displaying items with Templates" (#397) * fix(core): update query conditions * chore(test): add tests for getEnvironmentProps onTouchMove (#398) * feat(emptyStates): implements empty source template and renderEmpty method (#395) * Implements `empty` template and `renderEmpty` method * Add wait function to `test/utils` folder Co-authored-by: François Chalifour <[email protected]> * Add tests for `onActive` and `onSelect` on plugins (#400) * feat(js): change renderer implementation to virtual DOM (#381) * feat(js): change renderer implementation to virtual DOM * feat(highlighting): revamp highlighting system to VDOM (#399) * fix: fix code example (#403) * docs: switch core usage with autocomplete-js (#401) * docs: write "Basic configuration options" (#402) * docs: write "help and discussion" page (#394) * docs: add help page * Apply suggestions from code review Co-authored-by: François Chalifour <[email protected]> Co-authored-by: François Chalifour <[email protected]> * feat: getting started first draft * Apply suggestions from code review Co-authored-by: François Chalifour <[email protected]> * feat: update code example * fix: copy-edit * feat: add placeholders * fix: remove unnecessary code snippets * fix: links * fix: add record example * fix: rename titles to be more user focused * fix: correct URL * fix: update links * Apply suggestions from code review Co-authored-by: Sarah Dayan <[email protected]> * fix: update installation headers and add note * fix: remove headless installation and add 3rd party caveat * Update packages/website/docs/getting-started.md Co-authored-by: François Chalifour <[email protected]> * fix: remove CDNJS * Update packages/website/docs/getting-started.md Co-authored-by: François Chalifour <[email protected]> * Update packages/website/docs/getting-started.md * Update packages/website/docs/getting-started.md Co-authored-by: Sarah Dayan <[email protected]> * feat: add AutocompleteExample * fix: merge docs-1 Co-authored-by: François Chalifour <[email protected]> Co-authored-by: Sarah Dayan <[email protected]> Co-authored-by: Yannick Croissant <[email protected]> Co-authored-by: Clément Vannicatte <[email protected]> Co-authored-by: François Chalifour <[email protected]>
This switches references to
autocomplete-core
withautocomplete-js
in the core concepts.