Skip to content
Snippets Groups Projects

Compare revisions

Changes are shown as if the source revision was being merged into the target revision. Learn more about comparing revisions.

Source

Select target project
No results found

Target

Select target project
  • documentation/doc
  • PhilH/doc
  • louis.csn/doc
  • fabien4vo/doc
  • rngadam/doc
  • anastasia/doc
6 results
Show changes
Showing
with 419 additions and 159 deletions
...@@ -32,6 +32,7 @@ templates_path = [] ...@@ -32,6 +32,7 @@ templates_path = []
exclude_patterns = [] exclude_patterns = []
autosectionlabel_prefix_document = True
# -- Options for HTML output ------------------------------------------------- # -- Options for HTML output -------------------------------------------------
......
...@@ -23,8 +23,9 @@ This component uses the following mixins: ...@@ -23,8 +23,9 @@ This component uses the following mixins:
Please check their documentation to know more about their capabilities. Please check their documentation to know more about their capabilities.
Attributes
---------- Specific attributes
-------------------
``permission`` ``permission``
~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~
...@@ -35,10 +36,19 @@ Attributes ...@@ -35,10 +36,19 @@ Attributes
Displays the element if the user has not the specified right Displays the element if the user has not the specified right
Possible values: Possible values:
- `acl:Read <https://github.com/solid/web-access-control-spec#aclread>`__ - `acl:Read <https://github.com/solid/web-access-control-spec#aclread>`__
- `acl:Write <https://github.com/solid/web-access-control-spec#aclwrite>`__ - `acl:Write <https://github.com/solid/web-access-control-spec#aclwrite>`__
- `acl:Append <https://github.com/solid/web-access-control-spec#aclappend>`__ - `acl:Append <https://github.com/solid/web-access-control-spec#aclappend>`__
- `acl:Control <https://github.com/solid/web-access-control-spec#aclcontrol>`__ - `acl:Control <https://github.com/solid/web-access-control-spec#aclcontrol>`__
Mixin attributes
-----------------
**From store-mixin :**
.. include:: ../Mixins/store-mixin.rst
:start-line: 21
:end-before: Events
\ No newline at end of file
...@@ -6,7 +6,7 @@ Allows your users to login via a given OIDC provider. ...@@ -6,7 +6,7 @@ Allows your users to login via a given OIDC provider.
Installation Installation
-------------- --------------
Initialize ``sib-auth`` in your HTML file: Initialize ``sib-auth`` in your HTML file :
.. code:: html .. code:: html
...@@ -19,7 +19,7 @@ Installation ...@@ -19,7 +19,7 @@ Installation
</sib-auth> </sib-auth>
`You'll find here the detail of the attributes configuration. <https://github.com/IdentityModel/oidc-client-js/wiki#usermanager>`__ `You'll find here the detail of the attributes configuration. <https://github.com/IdentityModel/oidc-client-js/wiki#usermanager>`__
Set an OIDC provider to your server Set an OIDC provider to your server
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
...@@ -90,7 +90,7 @@ Example: ...@@ -90,7 +90,7 @@ Example:
</sib-auth> </sib-auth>
Methods Methods
------------------ -------
``login`` ``login``
~~~~~~~~~ ~~~~~~~~~
......
...@@ -23,6 +23,27 @@ This component uses the following mixins: ...@@ -23,6 +23,27 @@ This component uses the following mixins:
Please check their documentation to know more about their capabilities. Please check their documentation to know more about their capabilities.
Mixin attributes
-----------------
**From list-mixin :**
.. include:: ../Mixins/list-mixin.rst
:start-line: 25
**From next-mixin :**
.. include:: ../Mixins/next-mixin.rst
:start-line: 21
**From store-mixin :**
.. include:: ../Mixins/store-mixin.rst
:start-line: 21
:end-before: Events
Events Events
------- -------
......
...@@ -21,8 +21,8 @@ This component uses the following mixin: ...@@ -21,8 +21,8 @@ This component uses the following mixin:
Please check their documentation to know more about its capabilities. Please check their documentation to know more about its capabilities.
Attributes Specific attributes
---------- -------------------
``data-src`` ``data-src``
~~~~~~~~~~~~ ~~~~~~~~~~~~
...@@ -32,9 +32,20 @@ Attributes ...@@ -32,9 +32,20 @@ Attributes
~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~
The text to display on the delete button. The text to display on the delete button.
``confirmation-message``
~~~~~~~~~~~~~~~~~~~~~~~~~ Mixin attributes
**Migrated to the :ref:`validation-mixin <validation-mixin>` page in version 0.16** -----------------
**From next-mixin :**
.. include:: ../Mixins/next-mixin.rst
:start-line: 21
**From validation-mixin :**
.. include:: ../Mixins/validation-mixin.rst
:start-line: 17
Events Events
------- -------
......
...@@ -29,7 +29,6 @@ Mixins ...@@ -29,7 +29,6 @@ Mixins
------ ------
This component uses the following mixins: This component uses the following mixins:
* :ref:`required-mixin <required-mixin>`
* :ref:`counter-mixin <counter-mixin>` * :ref:`counter-mixin <counter-mixin>`
* :ref:`federation-mixin <federation-mixin>` * :ref:`federation-mixin <federation-mixin>`
* :ref:`filter-mixin <filter-mixin>` * :ref:`filter-mixin <filter-mixin>`
...@@ -38,6 +37,8 @@ This component uses the following mixins: ...@@ -38,6 +37,8 @@ This component uses the following mixins:
* :ref:`list-mixin <list-mixin>` * :ref:`list-mixin <list-mixin>`
* :ref:`next-mixin <next-mixin>` * :ref:`next-mixin <next-mixin>`
* :ref:`paginate-mixin <paginate-mixin>` * :ref:`paginate-mixin <paginate-mixin>`
* :ref:`required-mixin <required-mixin>`
* :ref:`paginate-mixin <server-pagination-mixin>`
* :ref:`sorter-mixin <sorter-mixin>` * :ref:`sorter-mixin <sorter-mixin>`
* :ref:`store-mixin <store-mixin>` * :ref:`store-mixin <store-mixin>`
* :ref:`widget-mixin <widget-mixin>` * :ref:`widget-mixin <widget-mixin>`
...@@ -45,22 +46,86 @@ This component uses the following mixins: ...@@ -45,22 +46,86 @@ This component uses the following mixins:
Please check their documentation to know more about their capabilities. Please check their documentation to know more about their capabilities.
Attributes Specific attributes
---------- -------------------
``fields`` ``fields``
~~~~~~~~~~ ~~~~~~~~~~
By default, all displayed fields are direct children of List of fields displayed.
``<solid-display>``. Make sure you don’t give your set the same name as
a field as it would result in an infinite loop. By default, all displayed fields are direct children of ``<solid-display>``.
More details on its use below (in **widget-mixin attributes**).
``child-[field]`` ``child-[field]``
~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~
Add attribute ``[field]`` to all children. Add attribute ``[field]`` to all children.
Mixin attributes
-----------------
**From counter-mixin :**
.. include:: ../Mixins/counter-mixin.rst
:start-line: 17
**From filter-mixin :**
.. include:: ../Mixins/filter-mixin.rst
:start-line: 18
**From grouper-mixin :**
.. include:: ../Mixins/grouper-mixin.rst
:start-line: 18
**From highlighter-mixin :**
.. include:: ../Mixins/highlighter-mixin.rst
:start-line: 17
**From list-mixin :**
.. include:: ../Mixins/list-mixin.rst
:start-line: 25
**From next-mixin :**
.. include:: ../Mixins/next-mixin.rst
:start-line: 21
**From paginate-mixin :**
.. include:: ../Mixins/paginate-mixin.rst
:start-line: 17
**From required-mixin :**
.. include:: ../Mixins/required-mixin.rst
:start-line: 17
**From sorter-mixin :**
.. include:: ../Mixins/sorter-mixin.rst
:start-line: 17
**From store-mixin :**
.. include:: ../Mixins/store-mixin.rst
:start-line: 21
:end-before: Events
**From widget-mixin :**
.. include:: ../Mixins/widget-mixin.rst
:start-line: 18
Widgets Widgets
------- -------
By default, the widget used is ``<solid-display-div>``. Cf the By default, the widget used is ``<solid-display-div>``. Cf the
:ref:`Widget <reference>` page for more info. :ref:`Widget <reference>` page for more info.
......
...@@ -29,13 +29,16 @@ This component uses the following mixins: ...@@ -29,13 +29,16 @@ This component uses the following mixins:
Please check their documentation to know more about their capabilities. Please check their documentation to know more about their capabilities.
Attributes
---------- Specific attributes
-------------------
``fields`` ``fields``
~~~~~~~~~~ ~~~~~~~~~~
List of fields used to perform the search. List of fields used to perform the search.
More details on its use below (in **widget-mixin attributes**).
.. _label-field-sfs: .. _label-field-sfs:
``label-[field]`` ``label-[field]``
~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~
...@@ -112,7 +115,7 @@ Attributes ...@@ -112,7 +115,7 @@ Attributes
Allows to modify "searchPlaceholder" displayed in the search bar (from SlimSelect plugin). Allows to modify "searchPlaceholder" displayed in the search bar (from SlimSelect plugin).
Its value by default is "Search" in English, "Rechercher" in French. Its value by default is "Search" in English, "Rechercher" in French.
**It works only with the ``autocompletion`` feature.** **It works only with the autocompletion feature.**
.. _search-text-field: .. _search-text-field:
``search-text-[field]`` ``search-text-[field]``
...@@ -121,7 +124,7 @@ Attributes ...@@ -121,7 +124,7 @@ Attributes
Allows to modify "searchText" displayed when no value is found (from SlimSelect plugin). Allows to modify "searchText" displayed when no value is found (from SlimSelect plugin).
Its value by default is "No result" in English, "Aucun résultat" in French. Its value by default is "No result" in English, "Aucun résultat" in French.
**It works only with the ``autocompletion`` feature.** **It works only with the autocompletion feature.**
.. code:: html .. code:: html
...@@ -140,7 +143,6 @@ Attributes ...@@ -140,7 +143,6 @@ Attributes
filtered-by="filter-multiselectautocomp" filtered-by="filter-multiselectautocomp"
></solid-display> ></solid-display>
.. _auto-range-field: .. _auto-range-field:
``auto-range-[field]`` ``auto-range-[field]``
~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~
...@@ -152,6 +154,7 @@ Attributes ...@@ -152,6 +154,7 @@ Attributes
``field`` can target a ``container`` or a ``resource``. ``field`` can target a ``container`` or a ``resource``.
In this example below, ``auto-range-skills ``attribute catches all skill values for all users in the ``data-src`` `data/list/users` and displays in the dropdown all skills once : In this example below, ``auto-range-skills ``attribute catches all skill values for all users in the ``data-src`` `data/list/users` and displays in the dropdown all skills once :
.. code:: html .. code:: html
<solid-form-search <solid-form-search
...@@ -167,6 +170,15 @@ Attributes ...@@ -167,6 +170,15 @@ Attributes
></solid-display> ></solid-display>
Mixin attributes
-----------------
**From widget-mixin :**
.. include:: ../Mixins/widget-mixin.rst
:start-line: 18
Widgets Widgets
------- -------
By default, the widget used is ``<solid-form-label-text>``. Cf the By default, the widget used is ``<solid-form-label-text>``. Cf the
......
...@@ -2,14 +2,31 @@ ...@@ -2,14 +2,31 @@
solid-form solid-form
========== ==========
Receives the URL of a ressource via its ``data-src`` attribute, and The `solid-form` component serves dual purposes: editing existing resources
displays a form to edit the resource. If given the URL of a container of and creating new resources within a container.
ressources, and displays a creation form to add a resource to the
container.
Editing a Resource
-------------------
The `solid-form` component receives the URL of a resource via its `data-src` attribute
and displays a form for editing the resource.
.. code:: html
<solid-form data-src="http://example.com/resource/123/"></solid-form>
Creating a Resource
-------------------
If provided with the URL of a container of resources, the `solid-form` component displays
a form for creating a new resource and adding it to the container.
.. code:: html .. code:: html
<solid-form data-src="http://server/todos/"></solid-form> <solid-form data-src="http://example.com/container/"></solid-form>
Mixins Mixins
------ ------
...@@ -20,61 +37,44 @@ This component uses the following mixins: ...@@ -20,61 +37,44 @@ This component uses the following mixins:
* :ref:`validation-mixin <validation-mixin>` * :ref:`validation-mixin <validation-mixin>`
* :ref:`widget-mixin <widget-mixin>` * :ref:`widget-mixin <widget-mixin>`
Please check their documentation to know more about their capabilities. Please refer to their documentation for more details about their capabilities.
Attributes
----------
``fields`` Specific attributes
~~~~~~~~~~ -------------------
List of the fields used to create the form (by default, all of them are used).
.. _label-field-sf: .. _autocomplete-field-sf:
``label-[field]`` ``autocomplete-[field]``
~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~
When displaying a form, the default labels are the fields names of the model. *Available from version 0.15*
If you want something fancier, you can set this attribute.
i.e. ``label-username="Your name"``
.. _naked: When set to ``off``, it disables the automatic entry of values in the specified ``[field]``.
``naked`` This attribute can be added to ``inputs``, ``textarea`` and ``select``.
~~~~~~~~~
When the attribute is set, the submit button will be
removed. It’s particularly useful to prevent the nested forms to
display their own submit button.
.. _upload-url-field:
``upload-url-[field]``
~~~~~~~~~~~~~~~~~~~~~~
URL to upload file for field ``[field]``, it
automatically set ``widget-[field]`` to ``solid-form-file`` if net defined.
It’s particularly useful with a dropdown field.
.. _submit-button-sf: .. _autosave:
``submit-button`` ``autosave``
~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~
Text of the submit button of the form. *Available from version 0.16*
If this attribute is defined, each change in an input will trigger a request to update the resource.
This attribute works only when editing resources, not creating them.
.. _class-submit-button-sf: .. _class-submit-button-sf:
``class-submit-button`` ``class-submit-button``
~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~
Define the ``class`` of the ``div`` containing the submit button. Define the ``class`` of the ``div`` containing the submit button.
.. _range-field-sf:
``range-[field]``
~~~~~~~~~~~~~~~~~
URL of a container which list the accepted values
for the field ``[field]``. It’s particularly useful with a dropdown
field.
.. _enum-field-sf: .. _enum-field-sf:
``enum-[field]`` ``enum-[field]``
~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~
*Available from version 0.13* *Available from version 0.13*
List of values of your choice for the field ``[field]``. Specifies a list of values for the specified ``[field]``.
They have to be filled manually and must be separated by commas. These values must be be filled manually and separated by commas.
It’s particularly useful with a dropdown or radio field. This is particularly useful for dropdown or radio fields.
Two formats are possible: Two formats are possible:
* ``enum-[field]="value 1, value 2, value 3"`` : each value will be displayed * ``enum-[field]="value 1, value 2, value 3"`` : each value will be displayed
...@@ -83,99 +83,153 @@ Define the ``class`` of the ``div`` containing the submit button. ...@@ -83,99 +83,153 @@ Define the ``class`` of the ``div`` containing the submit button.
* ``enum-[field]="value1 = a, value2 = b, value3 = c"``: each value will be displayed * ``enum-[field]="value1 = a, value2 = b, value3 = c"``: each value will be displayed
and "a", "b", "c" will be loaded in value attribute. and "a", "b", "c" will be loaded in value attribute.
``fields``
~~~~~~~~~~
Specifies the list of fields used to create the form. By default, all fields are used.
More details can be found in the **widget-mixin attributes** section
.. _label-field-sf:
``label-[field]``
~~~~~~~~~~~~~~~~~
When displaying a form, the default labels are the field names of the model.
To customize a label, use this attribute, i.e. ``label-username="Your name"``
.. _max-field:
``max-[field]``
~~~~~~~~~~~~~~~
Specifies the maximum value for the specified ``[field]``.
This attribute works only with ``solid-form-number`` and ``solid-form-time`` widgets.
.. _maxlength-field:
``maxlength-[field]``
~~~~~~~~~~~~~~~~~~~~~
*Available from version 0.16*
Specifies the maximum number of characters that can be typed for the specified ``[field]``.
This attribute works only with ``solid-form-text``, ``solid-form-email`` or ``solid-form-password`` and ``solid-form-textarea`` widgets.
.. _min-field:
``min-[field]``
~~~~~~~~~~~~~~~
Specifies the minimum value for the specified ``[field]``.
This attribute works only with ``solid-form-number`` and ``solid-form-time`` widgets.
.. _minlength-field:
``minlength-[field]``
~~~~~~~~~~~~~~~~~~~~~
*Available from version 0.16*
Specifies the minimum number of characters that can be typed for the specified ``[field]``.
This attribute works only with ``solid-form-text``, ``solid-form-email`` or ``solid-form-password`` and ``solid-form-textarea`` widgets.
.. _naked:
``naked``
~~~~~~~~~
When set, this attribute removes the submit button. This is particularly useful to prevent the nested forms to
display their own submit button.
.. _order-asc-field: .. _order-asc-field:
.. _order-desc-field: .. _order-desc-field:
``order-asc-[field]`` or ``order-desc-[field]`` ``order-asc-[field]`` or ``order-desc-[field]``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Name of the field used to order the range list ``[field]``. Specifies the field used to order the range list ``[field]``.
i.e. ``order-asc-users="username"`` i.e. ``order-asc-users="username"``
.. _partial: .. _partial:
``partial`` ``partial``
~~~~~~~~~~~ ~~~~~~~~~~~
Add this attribute when the form does not include Use this attribute when the form does not include all the fields of the resource that you want to update.
all the fields of the resource to update. This indicates that only the provided fields should be updated, leaving the unspecified fields unchanged.
.. _pattern-field:
``pattern-[field]``
~~~~~~~~~~~~~~~
*Available from version 0.13*
ASpecifies a regular expression to validate the input's value for the specified ``[field]``.
This attribute works only with a ``solid-form-text`` widget.
.. _range-field-sf:
``range-[field]``
~~~~~~~~~~~~~~~~~
Specifies the URL of a container that lists the accepted values for the specified ``[field]``.
This is particularly useful with a dropdown field.
.. _required-field: .. _required-field:
``required-[field]`` ``required-[field]``
~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~
Add this attribute to make the ``[field]`` required by adding the ``required`` attribute to the input. Makes the specified ``[field]`` required by adding the ``required`` attribute to the input.
.. _min-field: .. _step-field:
``min-[field]`` ``step-[field]``
~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~
Add this attribute for the field ``[field]`` to define its minimum value. *Available from version 0.16*
It works only with ``solid-form-number`` and ``solid-form-time`` widgets.
.. _max-field: Specifies the stepping interval number for the specified ``[field]`` based on the ``min-[field]`` value. This attribute works with:
``max-[field]`` - ``solid-form-time`` widget : The value is given in seconds (default value is 60).
~~~~~~~~~~~~~~~ - ``solid-form-number`` widget : The default value is 1.
Add this attribute for the field ``[field]`` to define its maximum value.
It works only with ``solid-form-number`` and ``solid-form-time`` widgets.
.. _pattern-field: .. _submit-button-sf:
``pattern-[field]`` ``submit-button``
~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~
*Available from version 0.13* Specifies the text of the form's submit button.
Add this attribute for the field ``[field]`` to define a regular expression to check the input's value.
It works only with a ``solid-form-text`` widget.
.. _title-field: .. _title-field:
``title-[field]`` ``title-[field]``
~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~
*Available from version 0.13* *Available from version 0.13*
Add this attribute for the field ``[field]`` to precise extra information about an element. Adds extra information about the specified ``[field]``.
It works only with a ``solid-form-text`` widget. This attribute works only with a ``solid-form-text`` widget.
``confirmation-message``
~~~~~~~~~~~~~~~~~~~~~~~~
**Migrated to the :ref:`validation-mixin <validation-mixin>` page in version 0.16**
.. _autocomplete-field-sf: .. _upload-url-field:
``autocomplete-[field]`` ``upload-url-[field]``
~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~
*Available from version 0.15* Specifies the URL to upload a file for the specified ``[field]``. This attribute automatically sets
``widget-[field]`` to ``solid-form-file`` if not defined.
This is particularly useful with a dropdown field.
Equal to the value ``off``, it cancels the automatic entry of values in the relevant ``[field]``.
It can be added to ``inputs``, ``textarea`` and ``select``.
.. _autosave: Mixin attributes
``autosave`` -----------------
~~~~~~~~~~~~
*Available from version 0.16*
If the attribute is defined, each change in an input will trigger a request to update the resource. **From next-mixin :**
This attribute works only when editing resources, not creating them.
.. _maxlength-field: .. include:: ../Mixins/next-mixin.rst
``maxlength-[field]`` :start-line: 21
~~~~~~~~~~~~~~~~~~~~~
*Available from version 0.16*
Add this attribute for the field ``[field]`` to define the maximum number of characters that can be typed. **From store-mixin :**
It works only with ``solid-form-text``, ``solid-form-email`` or ``solid-form-password`` and ``solid-form-textarea`` widgets.
.. _minlength-field: .. include:: ../Mixins/store-mixin.rst
``minlength-[field]`` :start-line: 21
~~~~~~~~~~~~~~~~~~~~~ :end-before: Events
*Available from version 0.16*
Add this attribute for the field ``[field]`` to define the minimum number of characters that can be typed. **From validation-mixin :**
It works only with ``solid-form-text``, ``solid-form-email`` or ``solid-form-password`` and ``solid-form-textarea`` widgets.
.. _step-field: .. include:: ../Mixins/validation-mixin.rst
``step-[field]`` :start-line: 17
~~~~~~~~~~~~~~~~
*Available from version 0.16* **From widget-mixin :**
.. include:: ../Mixins/widget-mixin.rst
:start-line: 18
Add this attribute for the field ``[field]`` to define the stepping interval number to use as constraint validation. Its based on the ``min-[field]`` value.
It works with :
- ``solid-form-time`` widget : Its value is given in seconds (default value is 60).
- ``solid-form-number`` widget : Its default value is 1.
Widgets Widgets
------- -------
...@@ -192,4 +246,4 @@ Events ...@@ -192,4 +246,4 @@ Events
``save`` ``save``
~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~
Triggered when the response of the submit has been received (successfull or not) Triggered when the response of the submit has been received successfully
...@@ -13,16 +13,6 @@ of fields needed to display the resources properly: ...@@ -13,16 +13,6 @@ of fields needed to display the resources properly:
respectively ``http://www.w3.org/2003/01/geo/wgs84_pos#lat`` and ``http://www.w3.org/2003/01/geo/wgs84_pos#lng``. respectively ``http://www.w3.org/2003/01/geo/wgs84_pos#lat`` and ``http://www.w3.org/2003/01/geo/wgs84_pos#lng``.
How to use
----------
The ``solid-map`` module needs to be imported independantly from the core, like following:
.. code:: html
<script type="module" src="https://unpkg.com/@startinblox/core/dist/components/solid-map.js"></script>
Mixins Mixins
------ ------
...@@ -40,8 +30,8 @@ This component uses the following mixins: ...@@ -40,8 +30,8 @@ This component uses the following mixins:
Please check their documentation to know more about their capabilities. Please check their documentation to know more about their capabilities.
Attributes Specific attributes
---------- -------------------
Like for ``solid-display``, fields can be displayed and filters or searching capabilities can be Like for ``solid-display``, fields can be displayed and filters or searching capabilities can be
added to interact with the list of data being displayed. added to interact with the list of data being displayed.
...@@ -50,12 +40,55 @@ added to interact with the list of data being displayed. ...@@ -50,12 +40,55 @@ added to interact with the list of data being displayed.
~~~~~~~~~~ ~~~~~~~~~~
List of the fields to display in a popup which opens when a marker is clicked. If the attribute is not defined, no popup will show up. List of the fields to display in a popup which opens when a marker is clicked. If the attribute is not defined, no popup will show up.
More details on its use below (in **widget-mixin attributes**).
``clustering`` ``clustering``
~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~
*Available from version 0.16* *Available from version 0.16*
If this attribute is defined, markers spacially close are grouped in clusters. If this attribute is defined, markers spacially close are grouped in clusters.
Mixin attributes
-----------------
**From counter-mixin :**
.. include:: ../Mixins/counter-mixin.rst
:start-line: 17
**From filter-mixin :**
.. include:: ../Mixins/filter-mixin.rst
:start-line: 18
**From grouper-mixin :**
.. include:: ../Mixins/grouper-mixin.rst
:start-line: 18
**From list-mixin :**
.. include:: ../Mixins/list-mixin.rst
:start-line: 25
**From next-mixin :**
.. include:: ../Mixins/next-mixin.rst
:start-line: 21
**From store-mixin :**
.. include:: ../Mixins/store-mixin.rst
:start-line: 21
:end-before: Events
**From widget-mixin :**
.. include:: ../Mixins/widget-mixin.rst
:start-line: 18
Events Events
------- -------
......
...@@ -85,7 +85,7 @@ solid-link ...@@ -85,7 +85,7 @@ solid-link
- ``data-src``: The resource you want to use in your view. Often - ``data-src``: The resource you want to use in your view. Often
used to show more details about this resource, by adding the used to show more details about this resource, by adding the
``bind-resource`` attribute to a component. ``bind-resources`` attribute to a component (more details about ``bind-resources`` below).
Example: Example:
...@@ -98,7 +98,7 @@ solid-analytics ...@@ -98,7 +98,7 @@ solid-analytics
Manage browsing statistics. Manage browsing statistics.
Sign in on a web analytics service and set ``<sib-analytics>`` inside Sign in on a web analytics service and set ``<solid-analytics>`` inside
``<body>``, at the begining for example. ``<body>``, at the begining for example.
``<solid-analytics>`` accepts the following attributes: ``<solid-analytics>`` accepts the following attributes:
...@@ -109,14 +109,14 @@ Sign in on a web analytics service and set ``<sib-analytics>`` inside ...@@ -109,14 +109,14 @@ Sign in on a web analytics service and set ``<sib-analytics>`` inside
necessary to specify the url attribute. necessary to specify the url attribute.
- ``id``: id of the website on the service. - ``id``: id of the website on the service.
Type ``'debug'`` allow to test sib-analytics. It will display the route Type ``'debug'`` allow to test solid-analytics. It will display the route
on the console each time a navigation is triggered. on the console each time a navigation is triggered.
Example : Example :
.. code:: html .. code:: html
<sib-analytics type="matomo" url="https://matomo.example.com/" id="1234"></sib-analytics> <solid-analytics type="matomo" url="https://matomo.example.com/" id="1234"></solid-analytics>
Interacting with the router Interacting with the router
--------------------------- ---------------------------
...@@ -151,17 +151,14 @@ accordingly. ...@@ -151,17 +151,14 @@ accordingly.
More informations about this in the :ref:`sib-auth documentation<bind-user>`. More informations about this in the :ref:`sib-auth documentation<bind-user>`.
Navigate with an event Navigate with an event
~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~
To trigger a route change through javascript, you can trigger a To trigger a route change through javascript, you can trigger a
``requestNavigation`` event anywhere on the DOM. ``requestNavigation`` event anywhere on the DOM.
The detail part must have at least one of these two parameters: The detail part must have at least one of these two parameters:
* ``route``: the name of the route to activate * ``route``: the name of the route to activate
* ``resource``: a resource that will be * ``resource``: a resource that will be passed to all elements with the ``bind-resources`` attribute. If no route name is given, the router tries to find a route that has a ``rdf-type`` that matches the type of the resource.
passed to all elements with the ``bind-resources`` attribute. If no
route name is given, the router tries to find a route that has a
``rdf-type`` that matches the type of the resource.
Events Events
------ ------
......
...@@ -24,7 +24,6 @@ Mixins ...@@ -24,7 +24,6 @@ Mixins
------ ------
This component uses the following mixins: This component uses the following mixins:
* :ref:`required-mixin <required-mixin>`
* :ref:`counter-mixin <counter-mixin>` * :ref:`counter-mixin <counter-mixin>`
* :ref:`federation-mixin <federation-mixin>` * :ref:`federation-mixin <federation-mixin>`
* :ref:`filter-mixin <filter-mixin>` * :ref:`filter-mixin <filter-mixin>`
...@@ -32,6 +31,8 @@ This component uses the following mixins: ...@@ -32,6 +31,8 @@ This component uses the following mixins:
* :ref:`highlighter-mixin <highlighter-mixin>` * :ref:`highlighter-mixin <highlighter-mixin>`
* :ref:`list-mixin <list-mixin>` * :ref:`list-mixin <list-mixin>`
* :ref:`paginate-mixin <paginate-mixin>` * :ref:`paginate-mixin <paginate-mixin>`
* :ref:`required-mixin <required-mixin>`
* :ref:`paginate-mixin <server-pagination-mixin>`
* :ref:`sorter-mixin <sorter-mixin>` * :ref:`sorter-mixin <sorter-mixin>`
* :ref:`store-mixin <store-mixin>` * :ref:`store-mixin <store-mixin>`
* :ref:`widget-mixin <widget-mixin>` * :ref:`widget-mixin <widget-mixin>`
...@@ -39,15 +40,14 @@ This component uses the following mixins: ...@@ -39,15 +40,14 @@ This component uses the following mixins:
Please check their documentation to know more about their capabilities. Please check their documentation to know more about their capabilities.
Attributes Specific attributes
---------- -------------------
``fields`` ``fields``
~~~~~~~~~~ ~~~~~~~~~~
By default, all displayed fields are direct children of List of fields displayed in the table.
``<solid-display>``. Make sure you don’t give your set the same name as
a field as it would result in an infinite loop.
More details on its use below (in **widget-mixin attributes**).
``header`` ``header``
~~~~~~~~~~ ~~~~~~~~~~
...@@ -64,8 +64,8 @@ Attributes ...@@ -64,8 +64,8 @@ Attributes
.. code:: javascript .. code:: javascript
document.querySelector('solid-table').component.selectedLines document.querySelector('solid-table').component.selectedLines
// returns [ "resourceId1", "resourceId2" ] // returns [ "resourceId1", "resourceId2" ]
``editable-[field]`` ``editable-[field]``
~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~
...@@ -76,13 +76,69 @@ Attributes ...@@ -76,13 +76,69 @@ Attributes
.. code:: html .. code:: html
<solid-table <solid-table
data-src="https://server/users/" data-src="https://server/users/"
fields="first_name" fields="first_name"
editable-first_name editable-first_name
widget-first_name="solid-form-placeholder-text" widget-first_name="solid-form-placeholder-text"
placeholder-first_name="Your First Name" placeholder-first_name="Your First Name"
></solid-table> ></solid-table>
Mixin attributes
-----------------
**From counter-mixin :**
.. include:: ../Mixins/counter-mixin.rst
:start-line: 17
**From filter-mixin :**
.. include:: ../Mixins/filter-mixin.rst
:start-line: 18
**From grouper-mixin :**
.. include:: ../Mixins/grouper-mixin.rst
:start-line: 18
**From highlighter-mixin :**
.. include:: ../Mixins/highlighter-mixin.rst
:start-line: 17
**From list-mixin :**
.. include:: ../Mixins/list-mixin.rst
:start-line: 25
**From paginate-mixin :**
.. include:: ../Mixins/paginate-mixin.rst
:start-line: 17
**From required-mixin :**
.. include:: ../Mixins/required-mixin.rst
:start-line: 17
**From sorter-mixin :**
.. include:: ../Mixins/sorter-mixin.rst
:start-line: 17
**From store-mixin :**
.. include:: ../Mixins/store-mixin.rst
:start-line: 21
:end-before: Events
**From widget-mixin :**
.. include:: ../Mixins/widget-mixin.rst
:start-line: 18
Widgets Widgets
------- -------
......