Skip to content
Snippets Groups Projects
Commit ebceb81d authored by Clément's avatar Clément
Browse files

update: add solid-form-search

parent 54c6fd1f
No related branches found
No related tags found
No related merge requests found
solid-form-search
=================
Allows you to filter the contents of a component that uses the ``filter-mixin`` such as ``solid-display`` or ``solid-map``.
This must have a ``filtered-by`` attribute set to the id of the current ``solid-form-search``.
.. code:: html
<solid-form-search
id="my-filter"
fields="email"
label-email="search by email"
></solid-form-search>
<solid-display
data-src="http://example.com/users"
fields="username, last_name, email"
filtered-by="my-filter"
></solid-display>
Mixins
------
This component uses the following mixins:
- `widget-mixin <https://docs.startinblox.com/import_documentation/Mixins/widget-mixin.html>`__
Please check their documentation to know more about their capabilities.
Attributes
----------
``fields``
~~~~~~~~~~
List of fields used to perform the search.
``label-xyz``
~~~~~~~~~~~~~
When displaying a form, the default labels are the fields names of the model.
If you want something fancier, you can set this attribute.
i.e. ``label-username="Your name"``
``range-xyz``
~~~~~~~~~~~~~
URL of a container which list the accepted values
for the field ``xyz``. It’s particularly useful with a dropdown
field.
Widgets
-------
By default, the widget used is ``<solid-form-label-text>``. Cf the
`Widget Form <https://docs.startinblox.com/import_documentation/Widgets/form-widgets.html>`__ page for more info.
Events
-------
``formChange``
~~~~~~~~~~~~~~
Triggered when the form values change
...@@ -14,8 +14,34 @@ Used by: ...@@ -14,8 +14,34 @@ Used by:
Attributes Attributes
---------- ----------
``search-fields`` ``filtered-by``
~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~
Target a `<sib-form-search>` used to filter current list of resource.
example:
.. code:: html
<solid-form-search
id="my-filter"
fields="email"
label-email="search by email"
></solid-form-search>
<solid-display
data-src="http://example.com/users"
fields="username, last_name, email"
filtered-by="my-filter"
></solid-display>
``search-fields`` **deprecated**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The properties you want to use to filter the list of resources. The properties you want to use to filter the list of resources.
You can add multiple fields, separated by a comma. You can add multiple fields, separated by a comma.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment