包详细信息

typesense-docsearch-react

typesense39.9kMIT3.4.1

React package for DocSearch, customized to work with Typesense

自述文件

Typesense Docsearch React

This is a fork of Algolia's awesome React-DocSearch library, customized to send queries to Typesense.

To be able to use this, you'd first need to setup and run the Typesense DocSearch Scraper.

What is Typesense?

If you're new to Typesense, it is an open source search engine that is simple to use, run and scale, with clean APIs and documentation.

Think of it as an open source alternative to Algolia and an easier-to-use, batteries-included alternative to ElasticSearch. Get a quick overview from this guide.

Usage

yarn add typesense-docsearch-react
# or
npm install typesense-docsearch-react

Documentation

Read detailed step-by-step instructions on how to configure and setup this version of DocSearch on Typesense's dedicated documentation site: https://typesense.org/docs/latest/guide/docsearch.html.

Help

If you have any questions or run into any problems, please create a Github issue and we'll try our best to help.

更新日志

2.6.3 (2019-05-13)

Bug Fixes

  • deps: update dependency autocomplete.js to v0.35.0 (2d67a21)
  • deps: update dependency autocomplete.js to v0.36.0 (bbd4ef5)
  • security: Fix dependencies to avoid infected event-stream (9f93ffb)
  • docsearch input should have aria-label (a11y) (#687) (59d21f5)
  • search input a11y issue (#679) (a68d2a4)

2.6.2 (2018-11-22)

Features

  • ctrl-click: Enable Ctrl-Click on suggestions (#542) (a470c48)

2.6.1 (2018-11-07)

2.6.0 (2018-11-07)

Bug Fixes

  • deps: update dependency algolia-aerial to v1.3.4 (7e72fe0)
  • deps: update dependency algolia-aerial to v1.5.3 (665438e)
  • deps: update dependency algolia-frontend-components to v0.0.35 (bd5c03f)
  • deps: update dependency autocomplete.js to ^0.30.0 (21eb76a)
  • deps: update dependency autocomplete.js to ^0.31.0 (6c65eb2)
  • deps: update dependency chalk to v2 (#323) (f8962bd)
  • deps: update dependency deepmerge to v2 (#324) (db212d0)
  • deps: update dependency progress to v2 (#325) (a99347a)
  • wording: fixed case of DocSearch (#262) (d451545)

Features

  • css: Update menu on small screen (b5733d2)
  • docsearch: Add custom classes on titles for better crawling (fc79098)

2.5.2 (2017-12-07)

2.5.1 (2017-11-28)

2.5.0 (2017-11-28)

Bug Fixes

  • autocompleteOptions: allow cssClasses options (#246) (6de70c3)

Features

  • global: Add responsive feature to the dropdown (777d2d4)

2.4.1 (2017-08-08)

2.4.0 (2017-08-08)

2.3.3 (2017-03-27)

Bug Fixes

  • build: fix badly handled webpack upgrade (3cbfbb1)

2.3.2 (2017-03-27)

2.3.1 (2017-02-23)

2.3.0 (2017-02-08)

2.2.1 (2017-01-11)

2.2.0 (2016-12-13)

2.1.8 (2016-10-04)

2.1.7 (2016-10-03)

Bug Fixes

2.1.6 (2016-10-02)

2.1.5 (2016-09-15)

Bug Fixes

  • empty: query should be escaped (self-XSS) (#147) (3aed41b)

2.1.4 (2016-08-03)

2.1.3 (2016-08-03)

2.1.2 (2016-07-22)

2.1.1 (2016-07-22)

2.1.0 (2016-07-07)

Bug Fixes

2.0.7 (2016-06-28)

2.0.6 (2016-06-28)

Bug Fixes

Features

2.0.5 (2016-06-21)

Bug Fixes

  • DOM: potential issue with simple layout if there is lvl0, lvl2 but no lvl1 (57c0101)

2.0.4 (2016-06-21)

Features

  • DOM: split simple and collumns template (2a3b7eb)

2.0.3 (2016-06-20)

2.0.2 (2016-06-14)

Features

  • dom: better handling of simple design (6bba640)

2.0.1 (2016-06-14)

2.0.0 (2016-06-14)

Features

1.3.0 (2016-06-12)

1.2.0 (2016-06-10)

Features

1.1.3 (2016-04-04)

Bug Fixes

  • autocomplete.js: upgrade the underlying autocomplete.js to ensur… (4d7022e), closes #89

1.1.2 (2016-03-24)

Features

  • website: React :raised_hands:, popped out on the top with React (db9c100)

1.1.1 (2016-03-16)

Bug Fixes

  • algoliaOptions: ensure we keep default options (b284dda), closes #78
  • autocomplete: auto select top result (473824a), closes #81
  • dev: Fixed the dev example, targeting an existing index (df13e34)
  • website: responsive logo (b856d67)

Features

  • serve: Add npm run serve to expose js and css locally (31e5d13)
  • website: community header (366cc0d)
  • website: Logo Update - Og screen + favicon (c7eb54a)
  • website: removed demos (6d8eb34)
  • website: update (9498e3b)
  • website: updated logo (fa413d9)

1.1.0 (2016-02-01)

Bug Fixes

  • dropdown: Visually group suggestions together (592c8f2)

Features

  • website: ensure the inputs are mandatory (e59d132)

1.0.2 (2015-12-28)

Bug Fixes

  • debut: do not enable debug by default (188f49e)
  • url: Removes concatenation of URL with hash if it contains a hash (348df1c), closes #53
  • usage: fixed usage to match the latest prototype version (f6edc9e)

1.0.1 (2015-12-24)

Bug Fixes

  • handleSelected: ensure we're calling setVal on the right object (31abbd7), closes #51

1.0.0 (2015-12-24)

Bug Fixes

  • isSubCategoryHeader: ensure we hide the content of the left column if this flag is not set (0e04ce4), closes #47

0.0.7 (2015-12-22)

Bug Fixes

  • appId: Allow passing a custom appId (e1777d3), closes #21
  • css: Renaming all ads- prefix to algolia-docsearch- (c6fc53f)

0.0.6 (2015-12-16)

0.0.5 (2015-12-16)

0.0.4 (2015-12-16)

0.0.3 (2015-12-16)

0.0.2 (2015-12-16)

Bug Fixes

  • colors: Reduce number of colors (125d1c7)
  • snippet: Fix typo in method name (751dfdb)

Features

  • gh-pages: Add gh-pages deploy script (ab1a299)
  • main: Add main wrapper (bdac9dd)
  • styling: Set grayscale as default, add styling as external file (5d8cca8)