Skip to content
Snippets Groups Projects
Commit 7f40af8c authored by Manon Bourgognon's avatar Manon Bourgognon
Browse files

Add solid-lang in the documentation

parent a1a00cb2
No related branches found
No related tags found
No related merge requests found
.. _solid-display:
solid-display
=============
......
solid-lang
============
Displays a button to set the language of the application.
.. code:: html
<solid-lang lang="is" data-label="Icelandic"></solid-lang>
It uses the ``selectLanguage`` method from the :ref:`store <selectLanguage>`.
Attributes
----------
``lang``
~~~~~~~~~~~~
Code of the language.
``data-label``
~~~~~~~~~~~~~~
Text to display on the button.
......@@ -14,7 +14,7 @@ API Reference
``getData`` (``async``)
^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^^^^
Fetch and cache the data for a resource
......@@ -29,7 +29,7 @@ Fetch and cache the data for a resource
``get``
^^^^^
^^^^^^^
Synchronously returns a resource from the cache.
......@@ -43,7 +43,7 @@ Synchronously returns a resource from the cache.
``post`` (``async``)
^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^^^
Send a POST request to create a resource in a container. When the request succeed, the resource is cleared from the cache, and the components showing it are notified.
......@@ -58,7 +58,7 @@ Send a POST request to create a resource in a container. When the request succee
``put`` (``async``)
^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^^
Send a PUT request to edit a resource. When the request succeed, the resource is cleared from the cache, and the components showing it are notified.
......@@ -73,7 +73,7 @@ Send a PUT request to edit a resource. When the request succeed, the resource is
``patch`` (``async``)
^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^^^^
Send a PATCH request to edit a resource. When the request succeed, the resource is cleared from the cache, and the components showing it are notified.
......@@ -88,7 +88,7 @@ Send a PATCH request to edit a resource. When the request succeed, the resource
``delete`` (``async``)
^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^^^^^
Send a DELETE request to delete a resource. When the request succeed, the resource is cleared from the cache, and the components showing it are notified.
......@@ -103,7 +103,7 @@ Send a DELETE request to delete a resource. When the request succeed, the resour
``subscribeTo``
^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^
Make a resource listen another one. When a change is detected on a resource, all the resources which are listening are removed from the cache, and the component showing them are notified to re-render their content.
......@@ -114,7 +114,7 @@ Make a resource listen another one. When a change is detected on a resource, all
``clearCache``
^^^^^^^^^^^^
^^^^^^^^^^^^^^^
Manually remove a resource from the cache
......@@ -122,6 +122,7 @@ Manually remove a resource from the cache
* ``id``: uri of the resource to remove from the cache
.. _selectLanguage:
``selectLanguage``
^^^^^^^^^^^^^^^^^^
......
......@@ -34,6 +34,7 @@ Welcome to Startinblox's documentation!
import_documentation/Components/SiB-Map
import_documentation/Components/SiB-Ac-Checker
import_documentation/Components/SiB-Widget
import_documentation/Components/Solid-Lang
.. toctree::
:maxdepth: 2
......@@ -57,6 +58,7 @@ Welcome to Startinblox's documentation!
import_documentation/Mixins/paginate-mixin
import_documentation/Mixins/sorter-mixin
import_documentation/Mixins/highlighter-mixin
import_documentation/Mixins/next-mixin
.. toctree::
:maxdepth: 2
......@@ -64,7 +66,7 @@ Welcome to Startinblox's documentation!
import_documentation/Widgets/Reference
import_documentation/Widgets/Examples
œ
.. toctree::
:maxdepth: 2
:caption: Javascript Api:
......
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