{"id":13721576,"url":"https://github.com/meilisearch/meilisearch-react","last_synced_at":"2025-05-07T13:33:16.249Z","repository":{"id":40388712,"uuid":"277836190","full_name":"meilisearch/meilisearch-react","owner":"meilisearch","description":null,"archived":false,"fork":false,"pushed_at":"2024-03-20T13:14:49.000Z","size":39,"stargazers_count":190,"open_issues_count":1,"forks_count":9,"subscribers_count":6,"default_branch":"main","last_synced_at":"2024-08-04T01:15:24.087Z","etag":null,"topics":["client","instantsearch","meilisearch","react-search","react-search-component"],"latest_commit_sha":null,"homepage":"https://www.meilisearch.com/","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/meilisearch.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2020-07-07T14:16:34.000Z","updated_at":"2024-08-01T06:20:38.000Z","dependencies_parsed_at":"2024-01-03T14:50:30.135Z","dependency_job_id":null,"html_url":"https://github.com/meilisearch/meilisearch-react","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/meilisearch%2Fmeilisearch-react","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/meilisearch%2Fmeilisearch-react/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/meilisearch%2Fmeilisearch-react/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/meilisearch%2Fmeilisearch-react/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/meilisearch","download_url":"https://codeload.github.com/meilisearch/meilisearch-react/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224605035,"owners_count":17339249,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["client","instantsearch","meilisearch","react-search","react-search-component"],"created_at":"2024-08-03T01:01:18.801Z","updated_at":"2024-11-14T10:31:45.037Z","avatar_url":"https://github.com/meilisearch.png","language":null,"funding_links":[],"categories":["Others","Integrations"],"sub_categories":["Official Integrations"],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/meilisearch/integration-guides/main/assets/logos/meilisearch_react.svg\" alt=\"Meilisearch-React\" width=\"200\" height=\"200\" /\u003e\n\u003c/p\u003e\n\n\u003ch1 align=\"center\"\u003eMeilisearch React\u003c/h1\u003e\n\n\u003ch4 align=\"center\"\u003e\n  \u003ca href=\"https://github.com/meilisearch/meilisearch\"\u003eMeilisearch\u003c/a\u003e |\n  \u003ca href=\"https://www.meilisearch.com/cloud?utm_campaign=oss\u0026utm_source=github\u0026utm_medium=meilisearch-react\"\u003eMeilisearch Cloud\u003c/a\u003e |\n  \u003ca href=\"https://www.meilisearch.com/docs\"\u003eDocumentation\u003c/a\u003e |\n  \u003ca href=\"https://discord.meilisearch.com\"\u003eDiscord\u003c/a\u003e |\n  \u003ca href=\"https://roadmap.meilisearch.com/tabs/1-under-consideration\"\u003eRoadmap\u003c/a\u003e |\n  \u003ca href=\"https://www.meilisearch.com\"\u003eWebsite\u003c/a\u003e |\n  \u003ca href=\"https://www.meilisearch.com/docs/faq\"\u003eFAQ\u003c/a\u003e\n\u003c/h4\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/meilisearch/meilisearch-react/blob/main/LICENSE\"\u003e\u003cimg src=\"https://img.shields.io/badge/license-MIT-informational\" alt=\"License\"\u003e\u003c/a\u003e\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e⚡ How to integrate a front-end search bar in your React application using Meilisearch\u003c/p\u003e\n\n**Meilisearch** is an open-source search engine. [Discover what Meilisearch is!](https://github.com/meilisearch/meilisearch)\n\nThis repository describes the steps to integrate a relevant front-end search bar with a search-as-you-type experience!\n\n## ⚡ Supercharge your Meilisearch experience\n\nSay goodbye to server deployment and manual updates with [Meilisearch Cloud](https://www.meilisearch.com/cloud?utm_campaign=oss\u0026utm_source=github\u0026utm_medium=meilisearch-ruby). Get started with a 14-day free trial! No credit card required.\n\n## Installation\n\nTo integrate a front-end search bar, you need to install two packages:\n- the open-source [React InstantSearch](https://github.com/algolia/instantsearch/) library powered by Algolia that provides all the front-end tools you need to highly customize your search bar environment.\n- the Meilisearch client [instant-meilisearch](https://github.com/meilisearch/meilisearch-js-plugins/tree/main/packages/instant-meilisearch) to establish the communication between your Meilisearch instance and the React InstantSearch library.\u003cbr\u003e\n_Instead of reinventing the wheel, we have opted to reuse the InstantSearch library for our own front-end tooling. We will contribute upstream any improvements that may result from our adoption of InstantSearch._\n\nRun:\n\n```bash\nyarn add react-instantsearch @meilisearch/instant-meilisearch\n# or\nnpm install react-instantsearch @meilisearch/instant-meilisearch\n# or\npnpm add react-instantsearch @meilisearch/instant-meilisearch\n```\n\nNB: If you don't have any Meilisearch instance running and containing your data, you should take a look at this [getting started page](https://www.meilisearch.com/docs/learn/getting_started/installation).\n\n## Getting Started\n\nThanks to the open-source React InstantSearch library, you can add these components to your application:\n\n```js\nimport React from 'react';\nimport { InstantSearch, SearchBox, Hits, Highlight } from 'react-instantsearch';\nimport { instantMeiliSearch } from '@meilisearch/instant-meilisearch';\n\nconst { searchClient } = instantMeiliSearch(\n  'https://ms-adf78ae33284-106.lon.meilisearch.io',\n  'a63da4928426f12639e19d62886f621130f3fa9ff3c7534c5d179f0f51c4f303'\n);\n\nconst App = () =\u003e (\n  \u003cInstantSearch\n    indexName=\"steam-video-games\"\n    searchClient={searchClient}\n  \u003e\n    \u003cSearchBox /\u003e\n    \u003cHits hitComponent={Hit} /\u003e\n  \u003c/InstantSearch\u003e\n);\n\nconst Hit = ({ hit }) =\u003e \u003cHighlight attribute=\"name\" hit={hit} /\u003e;\n\nexport default App\n```\n\n🚀 For a full getting started example, please take a look at this CodeSandbox:\n\n[![Edit MS + React-IS](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/p/sandbox/eager-dust-f98w2w)\n\n💡 If you have never used React InstantSearch before, we recommend reading this [getting started documentation](https://www.algolia.com/doc/guides/building-search-ui/what-is-instantsearch/react/).\n\n## Customization and Documentation\n\n- The open-source React InstantSearch library is widely used and well documented in the [Algolia documentation](https://www.algolia.com/doc/api-reference/widgets/react/). It provides all the widgets to customize and improve your search bar environment in your React application.\n- The [instant-meilisearch documentation](https://github.com/meilisearch/meilisearch-js-plugins/tree/main/packages/instant-meilisearch) to add some customization.\n- The [Meilisearch documentation](https://www.meilisearch.com/docs/).\n\n\u003chr\u003e\n\n**Meilisearch** provides and maintains many **SDKs and Integration tools** like this one. We want to provide everyone with an **amazing search experience for any kind of project**. If you want to contribute, make suggestions, or just know what's going on right now, visit us in the [integration-guides](https://github.com/meilisearch/integration-guides) repository.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmeilisearch%2Fmeilisearch-react","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmeilisearch%2Fmeilisearch-react","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmeilisearch%2Fmeilisearch-react/lists"}