You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The useFlexSearchhook takes your search query, index, and store and
returns results as an array. Searches are memoized to ensure efficient
searching.
Parameters
Name
Type
Description
query
String
The search query. As this value updates, the return value will be updated.
index
Index | String
The FlexSearch index. This can be an instance of a FlexSearch index or one that has been exported via Index.export.
store
Object
Object mapping a result id to an object of data.
options
Object
Search options passed to Index.search.
Example
The following example renders a text input and queries the FlexSearch index on
form submission.
Note: Formik is used in the following example to handle form state,
but is not required. As long as your query is passed as the first parameter, you
can manage how to store it.
importReact,{useState}from'react'import{useFlexSearch}from'react-use-flexsearch'import{Formik,Form,Field}from'formik'constindex=/* a FlexSearch index */conststore={1: {id: 1,title: 'Document 1'},2: {id: 2,title: 'Document 2'},3: {id: 3,title: 'Document 3'},}constSearchBar=()=>{const[query,setQuery]=useState(null)constresults=useFlexSearch(query,index,store)return(<div><FormikinitialValues={{query: ''}}onSubmit={(values,{ setSubmitting })=>{setQuery(values.query)setSubmitting(false)}}><Form><Fieldname="query"/></Form></Formik><h1>Results</h1><ul>{results.map(result=>(<likey={result.id}>{result.title}</li>))}</ul></div>)}