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.

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

Jump to bottom

[Doc] Fix typos in Search documentation #8024

Merged
merged 1 commit into from
Jul 30, 2022
Merged

[Doc] Fix typos in Search documentation #8024

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 3 additions & 3 deletions docs/Search.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This [Enterprise Edition](https://marmelab.com/ra-enterprise)<img class="icon" s

![ra-search](https://marmelab.com/ra-enterprise/modules/assets/ra-search-demo.gif)

`<Search>` renders a global search input. It's designed to be integrated into the top `<AppBar>`.
`<Search>` renders a global search input. It's designed to be integrated into the top `<AppBar>`.

It relies on the `dataProvider` to provide a `search()` method, so you can use it with any search engine (Lucene, ElasticSearch, Solr, Algolia, Google Cloud Search, and many others). And if you don't have a search engine, no problem! `<Search>` can also do the search across several resources via parallel `dataProvider.getList()` queries.

Expand Down Expand Up @@ -53,7 +53,7 @@ import { MyAppbar } from "./MyAppBar";
export const MyLayout = (props) => <Layout {...props} appBar={MyAppbar} />;
```

Finally, include that custom layout in the `<Admin>`. You'll also need to setup the ì18nProvider`, as the `ra-search` package comes with some new translations.
Finally, include that custom layout in the `<Admin>`. You'll also need to setup the `i18nProvider`, as the `ra-search` package comes with some new translations.

```jsx
// in src/Admin.ts
Expand All @@ -72,7 +72,7 @@ export const App = () => (
);
```

Your `dataProvider` should support the `search()` method. Check [the `ra-search` documentation](https://marmelab.com/ra-enterprise/modules/ra-search) to learn its i,nput and output interface, as well as tricks to use `dataProvider.search()` without a search engine.
Your `dataProvider` should support the `search()` method. Check [the `ra-search` documentation](https://marmelab.com/ra-enterprise/modules/ra-search) to learn its input and output interface, as well as tricks to use `dataProvider.search()` without a search engine.

## Props

Expand Down