Skip to content

Update README.md #1384

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Update README.md #1384

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9eeafdd
Update README.md
KrunchMuffin Apr 10, 2025
bac511d
Update packages/instant-meilisearch/README.md
KrunchMuffin Apr 14, 2025
8f321f7
Update packages/instant-meilisearch/README.md
KrunchMuffin Apr 14, 2025
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
7 changes: 4 additions & 3 deletions packages/instant-meilisearch/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -816,9 +816,10 @@ The `refinementList` widget is one of the most common widgets you can find in a
- ✅ limit: How many facet values to retrieve.
- ✅ showMore: Whether to display a button that expands the number of items.
- ✅ showMoreLimit: The maximum number of displayed items. Does not work when showMoreLimit > limit.
- ✅ searchable: Whether to add a search input to let the user search for more facet values. Not supported by Meilisearch. If you'd like to see it implemented [please vote](https://roadmap.meilisearch.com/c/64-search-for-facet-values?utm_medium=social&utm_source=portal_share).
- ✅ searchablePlaceholder: The value of the search input’s placeholder. Not supported, see `searchable`.
- ✅ searchableIsAlwaysActive: When false, disables the facet search input. Not supported, see `searchable`.
- ✅ searchable: Whether to add a search input to let the user search for more facet values. [added in 1.3](https://www.meilisearch.com/blog/v1-3-release).
**Note:** The `searchable` feature is supported in a limited capacity. However, its associated options (`searchablePlaceholder`, `searchableIsAlwaysActive`, and `searchableEscapeFacetValues`) are not supported due to current technical constraints.
- ❌ searchablePlaceholder: The value of the search input’s placeholder. Not supported, see `searchable`.
- ❌ searchableIsAlwaysActive: When false, disables the facet search input. Not supported and unrelated to `searchable`.
- ❌ searchableEscapeFacetValues: When true, escapes the facet values.
- ❌ sortBy: Not supported but can be implemented manually using `transformItems` options.
- ✅ transformItems: A function to transform the items passed to the templates.
Expand Down