https://github.com/betagouv/react-elasticsearch

🛁 React + Elasticsearch - UI components for building data-driven search experiences
https://github.com/betagouv/react-elasticsearch

components elasticsearch library react ui

Last synced: 12 days ago
JSON representation

🛁 React + Elasticsearch - UI components for building data-driven search experiences

• Host: GitHub
• URL: https://github.com/betagouv/react-elasticsearch
• Owner: betagouv
• License: mit
• Created: 2019-04-19T09:54:22.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-08T08:45:18.000Z (almost 2 years ago)
• Last Synced: 2024-08-29T18:35:08.721Z (4 months ago)
• Topics: components, elasticsearch, library, react, ui
• Language: JavaScript
• Homepage: https://react-elasticsearch.raph.site/
• Size: 3.71 MB
• Stars: 153
• Watchers: 7
• Forks: 35
• Open Issues: 23
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# React Elasticsearch

[![Version](https://img.shields.io/npm/v/react-elasticsearch.svg)](https://npmjs.org/package/react-elasticsearch)

[![Downloads](https://img.shields.io/npm/dt/react-elasticsearch.svg)](https://npmjs.org/package/react-elasticsearch)

[![License](https://img.shields.io/npm/l/react-elasticsearch.svg)](https://github.com/rap2hpoutre/react-elasticsearch/blob/master/package.json)

UI components for React + Elasticsearch. Create search applications using declarative components.

## Usage

**👉 [Documentation and playable demo available here](https://react-elasticsearch.raph.site/).**

```jsx

const MySearchComponent = () => (

  

    

    

    

    

        // Map on result hits and display whatever you want.

        data.map(item => )

      }

    />

  

);

```

## Install

```

npm i react-elasticsearch

yarn add react-elasticsearch

```

## Develop

You can test components with storybook (20+ examples).

```

npm run storybook

```

## Main features

- 🏝 Released under **MIT licence**.

- 👩‍🎨 Each component is built with React and is **customisable**. Not too much extra features nor magic.

- 💅 It comes with **no style** so it's the developers responsibility to implement their own.

- 🐿 **35.32KB gzipped** for the whole lib, compatible with old browsers: >0.03% usage.

- 🔮 No legacy: **created in 2019**, **updated in 2021** with hooks.

## Why?

We started building the search experience

of the french [Cultural Heritage Open Platform](https://www.pop.culture.gouv.fr/)

with [ReactiveSearch](https://opensource.appbase.io/reactivesearch/), a well-known

search UI components lib for React.

After some weeks, we realized we had spent a lot of time tweaking and hacking the lib;

we had rewrote almost every components ourselves. We opened issues and pull requests on the repository,

but it seemed the lib was a bit stuck in a rewrite process.

We found out that we need a simple lib that can be easily extended with a similar API,

we created this one. This lib has many less feature than others, it's not even a decent competitor.

But since it helped us building a search experiences, it has been released. Hope it could help you!

## Contributing

Open issues and PR here: https://github.com/betagouv/react-elasticsearch