@promoboxx/use-filter 1.8.1 → 1.8.2

package/README.md

@@ -7,6 +7,8 @@ A React hook to easily build filter views, with features like:
 - cursor based pagination
 - offset / page based pagination
 
+[Demo](https://stackblitz.com/edit/github-8ssor8)
+
 ## What's Included
 
 The filter system providers you with a few things:
@@ -42,7 +44,7 @@ const { filterInfo, updateFilter, setPage, resetFilter, isLoading } = useFilter(
     async onChange(
       filterInfo,
       // If this is called as a result of the filter changing, the reason will
-      // be 'filter', If it.s due to the page changing, it will be 'pagination'.
+      // be 'filter', If it's due to the page changing, it will be 'pagination'.
       updateReason,
     ) {
       const { data } = await runQuery({
@@ -373,3 +375,39 @@ interface SimpleFilterInfo<TFilter> {
   shouldRunImmediately: boolean
 }
 ```
+
+## Stores
+
+Persistence is provided by "stores". use-filter comes with a few included:
+
+- `memoryStore`: For when you want persistence across page views in your app, but not refreshes.
+- `localStorageStore`: For when you want full persistence of filters.
+- `reduxStore`: For when you want full persistence of filters and any extra goodies your redux middleware might bring you.
+
+To use a store, simply:
+
+```tsx
+import { setFilterStore } from '@promoboxx/use-filter/dist/store'
+import localStorageStore from '@promoboxx/use-filter/dist/store/localStorageStore'
+
+setFilterStore(localStorageStore)
+```
+
+### Creating a store
+
+If you would like to build your own, a store must match this interface:
+
+```tsx
+interface FilterStore {
+  getFilter<TFilter = any>(
+    namespace: string,
+  ): FilterInfo<TFilter> | null | undefined
+  saveFilter<TFilter = any>(
+    namespace: string,
+    filter: FilterInfo<TFilter>,
+  ): void
+  getData<TResult = any>(namespace: string): TResult | null | undefined
+  saveData<TResult = any>(namespace: string, data: TResult): void
+  clear(): void
+}
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@promoboxx/use-filter",
-  "version": "1.8.1",
+  "version": "1.8.2",
   "description": "",
   "main": "dist/useFilter.js",
   "keywords": [],