react-sfs

Index

Interfaces

Type aliases

Functions

Type aliases

UseFacet

UseFacet<Value>: (facet: Facet<Value>) => UseFacetResult<Value>

Type parameters

Value

Type declaration

- (facet: Facet<Value>): UseFacetResult<Value>
- Parameters
  - facet: Facet<Value>
  Returns UseFacetResult<Value>

UseFacetSearch

UseFacetSearch: (sfsApi: SfsApi) => UseFacetSearchResult

Type declaration

- (sfsApi: SfsApi): UseFacetSearchResult
- Parameters
  - sfsApi: SfsApi
  Returns UseFacetSearchResult

Functions

useFacet

useFacet<Value>(facet: Facet<Value>): UseFacetResult<Value>

- Defined in useFacet.ts:36
React hook for using facet state.

Type parameters
- Value
Parameters
- facet: Facet<Value>
  
  facet to subscribe
Returns UseFacetResult<Value>

useFacetSearch

useFacetSearch(sfsApi: SfsApi): UseFacetSearchResult

- Defined in useFacetSearch.ts:31
React hook for using facet search state.

Parameters
- sfsApi: SfsApi
  
  {@link SfsApi} to subscribe
Returns UseFacetSearchResult

Generated using TypeDoc