@digigov/text-search 0.1.0-a131264d

package/README.md

@@ -0,0 +1,70 @@
+# @digigov/text-search
+
+`@digigov/text-search` is a library that provides text search functionality in the form of a React hook. It allows searching through a list of objects by creating an index of the objects' properties. It uses [flexsearch](https://github.com/nextapps-de/flexsearch) under the hood.
+
+The objects in the list can have any structure, but an identifier property must be provided. The hook will use the `id` property (if present) or it will create an `id` property for each object, using the index of the object in the list.
+Alternatively, you may specify which property to use as an identifier by passing it in the `idKey` of the hook's options. Obviously, the identifier property must be unique for each object.
+
+## Installation
+
+```bash
+npm install @digigov/text-search
+```
+
+or
+
+```bash
+yarn add @digigov/text-search
+```
+
+## Usage
+
+Here is a basic example of how to use the hook:
+
+```typescript
+import React from 'react';
+import useSearch from '@digigov/text-search';
+
+const documents = [
+  { name: 'John', address: '123 Main St' },
+  { name: 'Jane', address: '456 Main St' },
+  { name: 'Jack', address: '789 Main St' },
+  { name: 'Jill', address: '101 Main St' },
+];
+
+const MyComponent = () => {
+  const [searchTerm, setSearchTerm] = React.useState('');
+  const { data, loading, search, reset } = useSearch(documents, searchTerm);
+
+  const handleReset = () => {
+    setSearchTerm('');
+    reset();
+  };
+
+  return (
+    <div>
+      <input
+        type="text"
+        value={searchTerm}
+        onChange={(e) => setSearchTerm(e.target.value)}
+        placeholder="Enter search term"
+      />
+      <button onClick={search}>Search</button>
+      <button onClick={handleReset}>Reset</button>
+
+      {loading && <p>Loading...</p>}
+
+      <ul>
+        {data.map((item) => (
+          <li key={item.name}>
+            <p>{item.name}</p>
+            <p>{item.address}</p>
+          </li>
+        ))}
+      </ul>
+    </div>
+  );
+};
+
+export default MyComponent;
+```

package/es/hook.js

@@ -0,0 +1,54 @@
+import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
+import { useCallback, useMemo, useState } from 'react';
+import SearchIndex from "./search";
+
+/**
+ * Hook for searching through a list of documents
+ *
+ * Returns a list of documents that match the search query.
+ * If no query is provided, it returns the original list of documents.
+ *
+ * @param documents - The list of documents to search through
+ * @param options - Options for configuring the search index
+ * @param query - The search query
+ *
+ * @typeParam T - The type of the data in the documents list
+ */
+export default function useSearch(documents, query, options) {
+  var _useState = useState(false),
+      _useState2 = _slicedToArray(_useState, 2),
+      loading = _useState2[0],
+      setLoading = _useState2[1];
+
+  var _useState3 = useState(documents),
+      _useState4 = _slicedToArray(_useState3, 2),
+      data = _useState4[0],
+      setData = _useState4[1];
+
+  var indexing = options === null || options === void 0 ? void 0 : options.indexing;
+  var index = useMemo(function () {
+    return new SearchIndex(documents, indexing);
+  }, [documents, indexing]);
+  var search = useCallback(function () {
+    if (query) {
+      setLoading(true);
+      index.searchAsync(documents, query).then(function (data) {
+        return setData(data);
+      })["finally"](function () {
+        return setLoading(false);
+      });
+    } else {
+      setData(documents);
+    }
+  }, [query, index, documents]);
+  var reset = useCallback(function () {
+    setData(documents);
+    setLoading(false);
+  }, [documents]);
+  return {
+    data: data,
+    loading: loading,
+    search: search,
+    reset: reset
+  };
+}