.. _solid-form-search:
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:

   * :ref:`widget-mixin <widget-mixin>`

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