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
Hide whitespace changes
Inline Side-by-side
Showing
with 569 additions and 150 deletions
source/conf.py
View file @ 405339e9
......@@ -32,6 +32,7 @@ templates_path = []
exclude_patterns = []
autosectionlabel_prefix_document = True
# -- Options for HTML output -------------------------------------------------
......
source/import_documentation/Components/Solid-Ac-Checker.rst
View file @ 405339e9
......@@ -23,8 +23,9 @@ This component uses the following mixins:
Please check their documentation to know more about their capabilities.
Attributes
----------
Specific attributes
-------------------
``permission``
~~~~~~~~~~~~~~
......@@ -35,10 +36,19 @@ Attributes
Displays the element if the user has not the specified right
Possible values:
- `acl:Read <https://github.com/solid/web-access-control-spec#aclread>`__
- `acl:Write <https://github.com/solid/web-access-control-spec#aclwrite>`__
- `acl:Append <https://github.com/solid/web-access-control-spec#aclappend>`__
- `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
source/import_documentation/Components/Solid-Auth.rst
View file @ 405339e9
.. _sib-auth:
sib-auth
================
========
Allows your users to login via a given OIDC provider.
Installation
--------------
Initialize ``sib-auth`` in your HTML file:
Initialize ``sib-auth`` in your HTML file :
.. code:: html
.. code:: html
<script type="module" src="https://unpkg.com/@startinblox/oidc@latest"></script>
<sib-auth>
<sib-auth-provider
data-authority="https://test-paris.happy-dev.fr/openid/"
data-id="paris"
>
</sib-auth-provider>
</sib-auth>
<script type="module" src="https://unpkg.com/@startinblox/oidc@latest"></script>
<sib-auth>
<sib-auth-provider
data-authority="https://test-paris.happy-dev.fr/openid/"
data-id="paris"
></sib-auth-provider>
</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
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The Django package associated is there => https://github.com/jblemee/django-oidc-provider
More documentation here => https://django-oidc-provider.readthedocs.io/en/latest/
Don't forget to set up your RSA key:
.. code:: bash
.. code:: bash
python3 ./manage.py creatersakey
python3 ./manage.py creatersakey
Setup your login button
......@@ -40,36 +40,57 @@ Setup your login button
Here is an example to make you understand the logic:
.. code:: html
.. code:: html
<button id="login">Login</button>
<!-- wherever you want in your interface -->
<button id="login">Login</button>
<!-- wherever you want in your interface -->
<script>
// wherever you want in your project
document.querySelector('#login').addEventListener('click', () => {
document.querySelector('sib-auth').login()
});
</script>
<script>
// wherever you want in your project
document.querySelector('#login').addEventListener('click', () => {
document.querySelector('sib-auth').login()
});
</script>
bind-user
Attributes
----------
To associate the currently logged in user to a component, add the bind-user attribute to it.
It will set its ``data-src`` attribute to the currently logged in user's resource URL.
Example:
.. code:: html
.. _bind-user:
``bind-user``
~~~~~~~~~~~~~
To associate the currently logged in user to a component, add the bind-user attribute to it.
It will set its ``data-src`` attribute to the currently logged in user's resource URL.
Example:
.. code:: html
<sib-conversation bind-user></sib-conversation>
will result in:
.. code:: html
<sib-conversation data-src="https://your-domain/your-user-uri/3" bind-user></sib-conversation>
<sib-conversation bind-user></sib-conversation>
``auto-login``
~~~~~~~~~~~~~~
If set, ``auto-login`` will automatically redirect the user to the login page of his
provider if he's not authenticated yet.
will result in:
Example:
.. code:: html
.. code:: html
<sib-conversation data-src="https://your-domain/your-user-uri/3" bind-user></sib-conversation>
<sib-auth auto-login>
<sib-auth-provider
data-authority="https://test-paris.happy-dev.fr/openid/"
data-id="paris"
></sib-auth-provider>
</sib-auth>
Methods available
------------------
Methods
-------
``login``
~~~~~~~~~
......
source/import_documentation/Components/Solid-Calendar.rst
View file @ 405339e9
......@@ -23,6 +23,27 @@ This component uses the following mixins:
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
-------
......
source/import_documentation/Components/Solid-Delete.rst
View file @ 405339e9
......@@ -7,7 +7,7 @@ Receives the URL of a resource or of a container of resources via its
.. code:: html
<solid-delete data-src="http://localhost:8000/conversations/9/"></solid-delete>
<solid-delete data-src="http://server/conversations/9/"></solid-delete>
Mixins
......@@ -16,12 +16,13 @@ Mixins
This component uses the following mixin:
* :ref:`next-mixin <next-mixin>`
* :ref:`validation-mixin <validation-mixin>`
Please check their documentation to know more about its capabilities.
Attributes
----------
Specific attributes
-------------------
``data-src``
~~~~~~~~~~~~
......@@ -32,6 +33,20 @@ Attributes
The text to display on the delete button.
Mixin attributes
-----------------
**From next-mixin :**
.. include:: ../Mixins/next-mixin.rst
:start-line: 21
**From validation-mixin :**
.. include:: ../Mixins/validation-mixin.rst
:start-line: 17
Events
-------
......
source/import_documentation/Components/Solid-Display.rst
View file @ 405339e9
......@@ -13,16 +13,22 @@ added to interact with the list of data being displayed.
.. code:: html
<solid-display
data-src="https://api.startinblox.com/users/"
data-src="https://server/users/"
fields="first_name, last_name"
></solid-display>
To make the styling easier, if the ``solid-display`` shows a resource,
a ``solid-resource`` attribute is automatically added to the element.
If it's a container, a ``solid-container`` attribute is added.
Then, you can target your elements with the CSS rules ``solid-display[solid-resource]``
or ``solid-display[solid-container]``.
Mixins
------
This component uses the following mixins:
* :ref:`required-mixin <required-mixin>`
* :ref:`counter-mixin <counter-mixin>`
* :ref:`federation-mixin <federation-mixin>`
* :ref:`filter-mixin <filter-mixin>`
......@@ -31,6 +37,8 @@ This component uses the following mixins:
* :ref:`list-mixin <list-mixin>`
* :ref:`next-mixin <next-mixin>`
* :ref:`paginate-mixin <paginate-mixin>`
* :ref:`required-mixin <required-mixin>`
* :ref:`paginate-mixin <server-pagination-mixin>`
* :ref:`sorter-mixin <sorter-mixin>`
* :ref:`store-mixin <store-mixin>`
* :ref:`widget-mixin <widget-mixin>`
......@@ -38,24 +46,88 @@ This component uses the following mixins:
Please check their documentation to know more about their capabilities.
Attributes
----------
Specific attributes
-------------------
``fields``
~~~~~~~~~~
By default, all displayed fields are direct children of
``<solid-display>``. Make sure you don’t give your set the same name as
a field as it would result in an infinite loop.
List of fields displayed.
By default, all displayed fields are direct children of ``<solid-display>``.
More details on its use below (in **widget-mixin attributes**).
``child-[field]``
~~~~~~~~~~~~~~~~~
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
``child-xyz``
~~~~~~~~~~~~~
add attribute ``xyz`` to all children.
**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
-------
By default, the widget used is ``<solid-display-div>``. Cf the
`Widget <https://docs.startinblox.com/import_documentation/Widgets/Reference.html>`__ page for more info.
By default, the widget used is ``<solid-display-div>``. Cf the
:ref:`Widget <reference>` page for more info.
Events
......
source/import_documentation/Components/Solid-Form-Search.rst
View file @ 405339e9
......@@ -14,7 +14,7 @@ This must have a ``filtered-by`` attribute set to the id of the current ``solid-
></solid-form-search>
<solid-display
data-src="http://example.com/users"
data-src="http://server/users"
fields="username, last_name, email"
filtered-by="my-filter"
></solid-display>
......@@ -29,47 +29,160 @@ This component uses the following mixins:
Please check their documentation to know more about their capabilities.
Attributes
----------
Specific attributes
-------------------
``fields``
~~~~~~~~~~
List of fields used to perform the search.
``label-xyz``
~~~~~~~~~~~~~
More details on its use below (in **widget-mixin attributes**).
.. _label-field-sfs:
``label-[field]``
~~~~~~~~~~~~~~~~~
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"``
.. _submit-button-sfs:
``submit-button``
~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~
*Available from version 0.13*
Text of the submit button to create in the search form. If the attribute is not defined,
no button will be added and the form will trigger the search on change.
``range-xyz``
~~~~~~~~~~~~~
.. _class-submit-button-sfs:
``class-submit-button``
~~~~~~~~~~~~~~~~~~~~~~~
Define the ``class`` of the ``div`` containing the submit button.
.. _range-field-sfs:
``range-[field]``
~~~~~~~~~~~~~~~~~
URL of a container which list the accepted values
for the field ``xyz``. It’s particularly useful with a dropdown
for the field ``[field]``. It’s particularly useful with a dropdown or multipleselect
field.
``enum-xyz``
~~~~~~~~~~~~~
List of values of your choice for the field ``xyz``.
.. _enum-field-sfs:
``enum-[field]``
~~~~~~~~~~~~~~~~
*Available from version 0.13*
List of values of your choice for the field ``[field]``.
They have to be filled manually and must be separated by commas.
It’s particularly useful with a dropdown or radio field.
Two formats are possible:
* ``enum-xyz="value1, value2, value3"`` : each value will be displayed
* ``enum-[field]="value1, value2, value3"`` : each value will be displayed
and loaded in value attribute
* ``enum-xyz="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.
.. _start-value-field:
``start-value-[field]``
~~~~~~~~~~~~~~~~~~~~~~~
*Available from version 0.15*
Allows to define the value of the first ``<input>`` to filter data.
Only usable with ``solid-form-rangedate`` and ``solid-form-rangenumber``.
In ``solid-form-rangedate``, it can be defined to ``today``.
.. _end-value-field:
``end-value-[field]``
~~~~~~~~~~~~~~~~~~~~~
*Available from version 0.15*
Allows to define the value of the second ``<input>`` to filter data.
Only usable with ``solid-form-rangedate`` and ``solid-form-rangenumber``.
In ``solid-form-rangedate``, it can be defined to ``today``.
.. _autocomplete-field-sfs:
``autocomplete-[field]``
~~~~~~~~~~~~~~~~~~~~~~~~
*Available from version 0.15*
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``.
.. _search-placeholder-field:
``search-placeholder-[field]``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*Available from version 0.17*
Allows to modify "searchPlaceholder" displayed in the search bar (from SlimSelect plugin).
Its value by default is "Search" in English, "Rechercher" in French.
**It works only with the autocompletion feature.**
.. _search-text-field:
``search-text-[field]``
~~~~~~~~~~~~~~~~~~~~~~~
*Available from version 0.17*
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.
**It works only with the autocompletion feature.**
.. code:: html
<solid-form-search
id="filter-multiselectautocomp"
fields="skills"
widget-skills="solid-form-multipleselect-autocompletion-placeholder"
placeholder-skills="Please, pick a value"
search-text-skills="Nothing found"
search-placeholder-skills="Searching..."
></solid-form-search>
<solid-display
data-src="data/list/users.jsonld"
fields="username, skills"
multiple-skills
filtered-by="filter-multiselectautocomp"
></solid-display>
.. _auto-range-field:
``auto-range-[field]``
~~~~~~~~~~~~~~~~~~~~~~~
*Available from version 0.17*
Dynamically populates a dropdown based on the values of the ``solid-display``(s) associated.
For each ``solid-display``, it will look for its ``field`` values, and add them to the dropdown.
Each value is displayed only once.
``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 :
.. code:: html
<solid-form-search
id="filter-autorange"
fields="skills"
auto-range-skills
></solid-form-search>
<solid-display
data-src="data/list/users.jsonld"
fields="username, skills"
multiple-skills
filtered-by="filter-autorange"
></solid-display>
Mixin attributes
-----------------
**From widget-mixin :**
.. include:: ../Mixins/widget-mixin.rst
:start-line: 18
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.
By default, the widget used is ``<solid-form-label-text>``. Cf the
:ref:`Widget <reference>` page for more info.
Events
......
source/import_documentation/Components/Solid-Form.rst
View file @ 405339e9
......@@ -2,14 +2,31 @@
solid-form
==========
Receives the URL of a ressource via its ``data-src`` attribute, and
displays a form to edit the resource. If given the URL of a container of
ressources, and displays a creation form to add a resource to the
container.
The `solid-form` component serves dual purposes: editing existing resources
and creating new resources within a 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
<solid-form data-src="http://localhost:8000/todos/"></solid-form>
<solid-form data-src="http://example.com/container/"></solid-form>
Mixins
------
......@@ -17,97 +34,207 @@ Mixins
This component uses the following mixins:
* :ref:`next-mixin <next-mixin>`
* :ref:`store-mixin <store-mixin>`
* :ref:`validation-mixin <validation-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.
Specific attributes
-------------------
.. _autocomplete-field-sf:
``autocomplete-[field]``
~~~~~~~~~~~~~~~~~~~~~~~~
*Available from version 0.15*
When set to ``off``, it disables the automatic entry of values in the specified ``[field]``.
This attribute can be added to ``inputs``, ``textarea`` and ``select``.
.. _autosave:
``autosave``
~~~~~~~~~~~~
*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``
~~~~~~~~~~~~~~~~~~~~~~~
Define the ``class`` of the ``div`` containing the submit button.
.. _enum-field-sf:
``enum-[field]``
~~~~~~~~~~~~~~~~
*Available from version 0.13*
Specifies a list of values for the specified ``[field]``.
These values must be be filled manually and separated by commas.
This is particularly useful for dropdown or radio fields.
Two formats are possible:
* ``enum-[field]="value 1, value 2, value 3"`` : each value will be displayed
and loaded in value attribute
* ``enum-[field]="value1 = a, value2 = b, value3 = c"``: each value will be displayed
and "a", "b", "c" will be loaded in value attribute.
Attributes
----------
``fields``
~~~~~~~~~~
List of the fields used to create the form (by default, all of them are used).
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-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"``
.. _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 the attribute is set, the submit button will be
removed. It’s particularly useful to prevent the nested forms to
When set, this attribute removes the submit button. This is particularly useful to prevent the nested forms to
display their own submit button.
``upload-url-xyz``
~~~~~~~~~~~~~~~~~~
URL to upload file for field ``xyz``, it
automatically set ``widget-xyz`` to ``solid-form-file`` if net defined.
It’s particularly useful with a dropdown field.
.. _order-asc-field:
.. _order-desc-field:
``order-asc-[field]`` or ``order-desc-[field]``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Specifies the field used to order the range list ``[field]``.
i.e. ``order-asc-users="username"``
.. _partial:
``partial``
~~~~~~~~~~~
Use this attribute when the form does not include all the fields of the resource that you want 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]``
~~~~~~~~~~~~~~~~~~~~
Makes the specified ``[field]`` required by adding the ``required`` attribute to the input.
.. _step-field:
``step-[field]``
~~~~~~~~~~~~~~~~
*Available from version 0.16*
Specifies the stepping interval number for the specified ``[field]`` based on the ``min-[field]`` value. This attribute works with:
- ``solid-form-time`` widget : The value is given in seconds (default value is 60).
- ``solid-form-number`` widget : The default value is 1.
.. _submit-button-sf:
``submit-button``
~~~~~~~~~~~~~~~~~
Text of the submit button of the form.
Specifies the text of the form's submit button.
``range-xyz``
~~~~~~~~~~~~~
URL of a container which list the accepted values
for the field ``xyz``. It’s particularly useful with a dropdown
field.
``enum-xyz``
~~~~~~~~~~~~~
List of values of your choice for the field ``xyz``.
They have to be filled manually and must be separated by commas.
It’s particularly useful with a dropdown or radio field.
.. _title-field:
``title-[field]``
~~~~~~~~~~~~~~~~~
*Available from version 0.13*
Two formats are possible:
* ``enum-xyz="value 1, value 2, value 3"`` : each value will be displayed
and loaded in value attribute
* ``enum-xyz="value1 = a, value2 = b, value3 = c"``: each value will be displayed
and "a", "b", "c" will be loaded in value attribute.
Adds extra information about the specified ``[field]``.
This attribute works only with a ``solid-form-text`` widget.
``order-asc-xyz`` or ``order-desc-xyz``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Name of the field used to order the range list ``xyz``.
``partial``
~~~~~~~~~~~
Add this attribute when the form does not include
all the fields of the resource to update.
.. _upload-url-field:
``upload-url-[field]``
~~~~~~~~~~~~~~~~~~~~~~
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.
``min-xyz``
~~~~~~~~~~~
Add this attribute for the field ``xyz`` to define its minimum value.
It works only with a ``solid-form-number`` widget.
``max-xyz``
~~~~~~~~~~~
Add this attribute for the field ``xyz`` to define its maximum value.
It works only with a ``solid-form-number`` widget.
Mixin attributes
-----------------
``pattern-xyz``
~~~~~~~~~~~~~~~
Add this attribute for the field ``xyz`` to define a regular expression to check the input's value.
It works only with a ``solid-form-text`` widget.
**From next-mixin :**
``title-xyz``
~~~~~~~~~~~~~~
Add this attribute for the field ``xyz`` to precise extra information about an element.
It works only with a ``solid-form-text`` widget.
.. include:: ../Mixins/next-mixin.rst
:start-line: 21
**From store-mixin :**
.. include:: ../Mixins/store-mixin.rst
:start-line: 21
:end-before: Events
**From validation-mixin :**
.. include:: ../Mixins/validation-mixin.rst
:start-line: 17
**From widget-mixin :**
``confirmation-message``
~~~~~~~~~~~~~~~~~~~~~~~~~
Add this attribute to create a dialog box linked with the submit button of the solid-form.
Its value matches the message displayed in the dialog box.
.. include:: ../Mixins/widget-mixin.rst
:start-line: 18
Widgets
-------
By default, the widget used is ``<solid-form-label-text>``. Cf the
`Widget <https://docs.startinblox.com/import_documentation/Widgets/Reference.html>`__ page for more info.
By default, the widget used is ``<solid-form-label-text>``. Cf the
:ref:`Widget <reference>` page for more info.
Events
......@@ -119,4 +246,4 @@ Events
``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
source/import_documentation/Components/Solid-Map.rst
View file @ 405339e9
......@@ -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``.
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
------
......@@ -40,8 +30,8 @@ This component uses the following mixins:
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
added to interact with the list of data being displayed.
......@@ -50,6 +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.
More details on its use below (in **widget-mixin attributes**).
``clustering``
~~~~~~~~~~~~~~
*Available from version 0.16*
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
-------
......@@ -57,6 +96,6 @@ Events
~~~~~~~~~~~~~~~~~~~
Triggered when a marker is clicked on the map
Usefull links :
Useful links:
---------------
To find latitude and longitude : https://www.latlong.net/
\ No newline at end of file
To find latitude and longitude: https://www.latlong.net/
\ No newline at end of file