@filter-enginez/react-signals
v0.0.6
Published
React hooks for faceted search and filtering: useResults, useResultCount, useRule and more over the Filter EngineZ engine, powered by signals.
Maintainers
Readme
@filter-enginez/react-signals
React hooks over @filter-enginez/reactive-signals. Browser-only. Uses useSyncExternalStore for concurrent-mode-safe
consumption of signal state. Keyboard handlers (Cmd/Ctrl-Z for undo; Cmd/Ctrl-Shift-Z and Cmd/Ctrl-Y for redo) live in
the ./keyboard sub-export.
Install
pnpm add @filter-enginez/react-signalsPeer dependencies: react@^19.0.0 — supplied by your app.
Sub-exports: @filter-enginez/react-signals/keyboard.
Errors
useFilterEngine() outside a <FilterEngineProvider> throws FilterEngineConfigError with code
BINDING_ENGINE_NOT_PROVIDED.
Documentation
Consumer guides live in the engine repository under docs/guides/:
extending_rules.md— writing a customFilterRulethat survives serializationjson_config.md— declaring filters as data, and why the format is safe to accept from a tenantacceleration_tuning.md— what the fiveaccelerationtoggles are worth, measuredworker_offload.md— running the engine in a Web Worker
Project home, with six live demos: https://filterenginez.com. Documentation site: https://docs.filterenginez.com.
Apache-2.0. See LICENSE.md and NOTICE.md, both included in this package.
