Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: recommend dynamic facets #1987

Merged
merged 1 commit into from
Sep 10, 2024
Merged

doc: recommend dynamic facets #1987

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions src/ui/Facet/Facet.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,9 @@ export interface IFacetOptions extends IResponsiveComponentOptions, IDependsOnCo
}

/**
* **Note:**
* > We recommend using the simpler and more powerful [`DynamicFacet`]{@link DynamicFacet} component instead.
*
* The `Facet` component displays a *facet* of the results for the current query. A facet is a list of values for a
* certain field occurring in the results, ordered using a configurable criteria (e.g., number of occurrences).
*
Expand Down