Skip to content

[Doc] Update doc for Search and SearchWithResult #9700

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.

Sign up for GitHub

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

Merged
djhi merged 2 commits into from
Mar 5, 2024
Merged

[Doc] Update doc for Search and SearchWithResult #9700

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b748ff1
update doc
erwanMarmelab Mar 4, 2024
7be6d98
surround code snippets
erwanMarmelab Mar 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/Search.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,6 +232,12 @@ An object containing options to apply to the search:
- `targets`:`string[]`: an array of the indices on which to perform the search. Defaults to an empty array.
- `{any}`:`{any}`: any custom option to pass to the search engine.

{% raw %}
```tsx
<Search options={{ foo: 'bar' }} />
```
{% endraw %}

## `wait`

The number of milliseconds to wait before processing the search request, immediately after the user enters their last character.
Expand Down
8 changes: 7 additions & 1 deletion docs/SearchWithResult.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,12 @@ An object containing options to apply to the search:
- `targets`: `string[]`: an array of the indices on which to perform the search. Defaults to an empty array.
- `{any}`: `{any}`: any custom option to pass to the search engine.

{% raw %}
```tsx
<SearchWithResult options={{ foo: 'bar' }} />
```
{% endraw %}

## `wait`

The number of milliseconds to wait before processing the search request, immediately after the user enters their last character.
Expand Down Expand Up @@ -427,4 +433,4 @@ export const App = () => (
</Admin>
);
```
{% endraw %}
{% endraw %}