Skip to content

Commit

Permalink
docs: add auto-complet components in frontend/README.md (#162)
Browse files Browse the repository at this point in the history
  • Loading branch information
Kout95 authored Jun 13, 2024
1 parent 10bc65d commit 5f0aa65
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions frontend/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,16 @@ The project is currently composed of several widgets
* searchalicious-facet-terms renders the facet for terms (list of entries, with number of docs).
* it must be in a `searchalicious-facets`
* the user can select facets to filter the search
* searchalicious-autocomplete is a component that displays a list of suggestions
* it must be in a `searchalicious-facet`
* it will influence the search adding terms to the search
* searchalicious-checkbox is a simple checkbox
* it can be used to replace the default checkbox
* it allows to keep the state of the checkbox when you change the property
* searchalicious-secondary-button is a button with defined style
* it can be used to replace the default button
* searchalicious-button-transparent is a transparent button with defined style
* it can be used to replace the default button

You can give a specific `name` attribute to your search bar.
Then all other component that needs to connect with this search must use the same value in `search-name` attribute
Expand Down

0 comments on commit 5f0aa65

Please sign in to comment.