From 7f40af8c519e129f9db70fe003df9db433c4af2f Mon Sep 17 00:00:00 2001 From: Manon Bourgognon <manon.bourgognon@epitech.eu> Date: Tue, 8 Sep 2020 18:24:01 +0200 Subject: [PATCH] Add solid-lang in the documentation --- .../Components/SiB-Display.rst | 1 + .../Components/Solid-Lang.rst | 22 +++++++++++++++++++ source/import_documentation/Store-doc.rst | 17 +++++++------- source/index.rst | 4 +++- 4 files changed, 35 insertions(+), 9 deletions(-) create mode 100644 source/import_documentation/Components/Solid-Lang.rst diff --git a/source/import_documentation/Components/SiB-Display.rst b/source/import_documentation/Components/SiB-Display.rst index 0fdcc59..19d25d2 100644 --- a/source/import_documentation/Components/SiB-Display.rst +++ b/source/import_documentation/Components/SiB-Display.rst @@ -1,4 +1,5 @@ .. _solid-display: + solid-display ============= diff --git a/source/import_documentation/Components/Solid-Lang.rst b/source/import_documentation/Components/Solid-Lang.rst new file mode 100644 index 0000000..923425e --- /dev/null +++ b/source/import_documentation/Components/Solid-Lang.rst @@ -0,0 +1,22 @@ +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. diff --git a/source/import_documentation/Store-doc.rst b/source/import_documentation/Store-doc.rst index de75371..3f57566 100644 --- a/source/import_documentation/Store-doc.rst +++ b/source/import_documentation/Store-doc.rst @@ -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`` ^^^^^^^^^^^^^^^^^^ diff --git a/source/index.rst b/source/index.rst index 3a24dc8..d898615 100644 --- a/source/index.rst +++ b/source/index.rst @@ -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: -- GitLab