docs: merge docs-1 into next
#433
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
…ethod (#395) * Implements `empty` template and `renderEmpty` method * Add wait function to `test/utils` folder Co-authored-by: François Chalifour <[email protected]>
* 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]>
…ethod (#395) * Implements `empty` template and `renderEmpty` method * Add wait function to `test/utils` folder Co-authored-by: François Chalifour <[email protected]>
* feat(js): change renderer implementation to virtual DOM * feat(highlighting): revamp highlighting system to VDOM (#399)
In a docs page (either `.md` or `.mdx`), import the component, add it and give it the props you need:
```mdx
import { AutocompleteExample } from '@site/src/components/AutocompleteExample';
Content...
<AutocompleteExample
getSources={({ query }) => {
return [
{
getItems() {
return [{ label: 'Twitter' }, { label: 'GitHub' }];
},
templates: {
item({ item }) {
return item.label;
},
},
},
];
}}
/>
Content...
```
* 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 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 47d876f:
|
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.
This merges the documentation branch into
next, where we'll keep working on from now on.