react-instantsearch

⚡ Lightning-fast search for React and React Native applications, by Algolia.

Github星跟踪图


Version Build Status License Downloads

React InstantSearch is a React library that lets you create an instant-search result experience using Algolia’s search API. It is part of the InstantSearch family:

React InstantSearch, InstantSearch.js, Angular InstantSearch, Vue InstantSearch, InstantSearch Android, InstantSearch iOS

Why

You should be using React InstantSearch if you want to:

  • Design search experiences with best practices
  • Customize your components at will
  • Follow React principles

Installation

React InstantSearch is available on the npm registry. It relies on algoliasearch to communicate with Algolia APIs.

yarn add react-instantsearch-dom algoliasearch
# or
npm install react-instantsearch-dom algoliasearch

Getting started

Using React InstantSearch is as simple as adding these components to your app:

import React from 'react';
import ReactDOM from 'react-dom';
import algoliasearch from 'algoliasearch/lite';
import { InstantSearch, SearchBox, Hits } from 'react-instantsearch-dom';

const searchClient = algoliasearch(
  'latency',
  '6be0576ff61c053d5f9a3225e2a90f76'
);

const App = () => (
  <InstantSearch
    indexName="bestbuy"
    searchClient={searchClient}
  >
    <SearchBox />
    <Hits />
  </InstantSearch>
);

To learn more about the library, follow the getting started guide.

Documentation

The documentation is available on algolia.com/doc.

Demos, E-commerce, Media, Travel, --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------, -----------------------------------------------------------------------------------------------------------------------------------------------------------------------, -----------------------------------------------------------------------------------------------------------------------------------------------------------------------------, , , , See more examples on the website.

Playground

You can get to know React InstantSearch on this playground.

Start by adding components and tweaking the display. Once you get more familiar with the library, you can learn more advanced concepts in our guides.

Contributing

We welcome all contributors, from casual to regular. You are only one command away to start the developer environment, read our CONTRIBUTING guide.

License

React InstantSearch is MIT licensed.

主要指标

概览
名称与所有者algolia/react-instantsearch
主编程语言TypeScript
编程语言JavaScript (语言数: 5)
平台
许可证MIT License
所有者活动
创建于2017-04-04 11:45:29
推送于2022-12-30 12:33:24
最后一次提交2022-12-30 13:33:02
发布数126
最新版本名称v6.38.1 (发布于 )
第一版名称v4.0.0-beta.1 (发布于 2017-04-18 13:09:48)
用户参与
星数2k
关注者数83
派生数381
提交数4.9k
已启用问题?
问题数611
打开的问题数0
拉请求数2483
打开的拉请求数0
关闭的拉请求数458
项目设置
已启用Wiki?
已存档?
是复刻?
已锁定?
是镜像?
是私有?