Type Alias UseFacetedSearchParams<R>

UseFacetedSearchParams: {
    baseFilters?: FacetFilter[];
    descriptors: FacetDescriptor[];
    enabled?: boolean;
    hydrate?: boolean;
    limit: number;
    onPageChange: (page: number) => void;
    page: number;
    q: string;
    selection: FacetSelection;
    store: FacetedSearchStore<R> | null;
    typeNames: (keyof R & string)[];
    visibleScopes: string[];
}

Type Parameters

  • R extends SchemaRegistry = SchemaRegistry

Type declaration

  • OptionalbaseFilters?: FacetFilter[]

    Always-on filters ANDed with the facet selection and not shown as active facets. Use for a discriminator when several types share one index (e.g. __type), or for a fixed scope such as one folder subtree.

  • descriptors: FacetDescriptor[]
  • Optionalenabled?: boolean
  • Optionalhydrate?: boolean
  • limit: number
  • onPageChange: (page: number) => void
  • page: number
  • q: string
  • selection: FacetSelection
  • store: FacetedSearchStore<R> | null
  • typeNames: (keyof R & string)[]
  • visibleScopes: string[]

    Scopes to request in-band (quick row + expanded drawer sections)

Settings

Member Visibility