diff --git a/source/import_documentation/Components/Solid-Calendar.rst b/source/import_documentation/Components/Solid-Calendar.rst index b42fda6ef4e2381480dba4eb6287a6b0a62be36e..65c7e255e83e297a14571853847a7243b71ec088 100644 --- a/source/import_documentation/Components/Solid-Calendar.rst +++ b/source/import_documentation/Components/Solid-Calendar.rst @@ -1,3 +1,4 @@ +.. _solid-calendar: solid-calendar ============== @@ -17,6 +18,7 @@ Mixins This component uses the following mixins: - `list-mixin <list-mixin>`__ +- `next-mixin <next-mixin>`__ - `store-mixin <store-mixin>`__ Please check their documentation to know more about their capabilities. diff --git a/source/import_documentation/Components/Solid-Delete.rst b/source/import_documentation/Components/Solid-Delete.rst index 027e3b06cf07de0b7af171237007c8810431a4dc..072d70f64cdadfbbef9b28a172d1a46163207a56 100644 --- a/source/import_documentation/Components/Solid-Delete.rst +++ b/source/import_documentation/Components/Solid-Delete.rst @@ -1,3 +1,4 @@ +.. _solid-delete: solid-delete ============ @@ -8,6 +9,17 @@ Receives the URL of a resource or of a container of resources via its <solid-delete data-src="http://localhost:8000/conversations/9/"></solid-delete> + +Mixins +------ + +This component uses the following mixin: + +- `next-mixin <next-mixin>`__ + +Please check their documentation to know more about its capabilities. + + Attributes ---------- diff --git a/source/import_documentation/Components/Solid-Display.rst b/source/import_documentation/Components/Solid-Display.rst index ddd1ee582491068b0da7d15df2ed25edfec822b2..19d25d2baa9918036cf95e525e4e856761bc1d0c 100644 --- a/source/import_documentation/Components/Solid-Display.rst +++ b/source/import_documentation/Components/Solid-Display.rst @@ -1,3 +1,5 @@ +.. _solid-display: + solid-display ============= @@ -28,6 +30,7 @@ This component uses the following mixins: - `grouper-mixin <grouper-mixin>`__ - `highlighter-mixin <highlighter-mixin>`__ - `list-mixin <list-mixin>`__ +- `next-mixin <next-mixin>`__ - `paginate-mixin <paginate-mixin>`__ - `sorter-mixin <sorter-mixin>`__ - `store-mixin <store-mixin>`__ diff --git a/source/import_documentation/Components/Solid-Form.rst b/source/import_documentation/Components/Solid-Form.rst index c05fc801dd87d8631836c084e588907d4a287313..bfb0820ce6f165a2c20113583124601845c42635 100644 --- a/source/import_documentation/Components/Solid-Form.rst +++ b/source/import_documentation/Components/Solid-Form.rst @@ -1,3 +1,4 @@ +.. _solid-form: solid-form ========== @@ -15,6 +16,7 @@ Mixins This component uses the following mixins: +- `next-mixin <https://docs.startinblox.com/import_documentation/Mixins/next-mixin.html>`__ - `store-mixin <https://docs.startinblox.com/import_documentation/Mixins/store-mixin.html>`__ - `widget-mixin <https://docs.startinblox.com/import_documentation/Mixins/widget-mixin.html>`__ diff --git a/source/import_documentation/Components/Solid-Lang.rst b/source/import_documentation/Components/Solid-Lang.rst new file mode 100644 index 0000000000000000000000000000000000000000..923425ece887f1b9a02c26519af0e0110d5b9033 --- /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/Components/Solid-Map.rst b/source/import_documentation/Components/Solid-Map.rst index 3b5fbaa9f7dc03e2b79499612ee26a6950f6b452..83c7e1b149bdfd71cfbfc33b754a2dfc1b1dea8f 100644 --- a/source/import_documentation/Components/Solid-Map.rst +++ b/source/import_documentation/Components/Solid-Map.rst @@ -1,3 +1,4 @@ +.. _solid-map: solid-map ========= @@ -31,6 +32,7 @@ This component uses the following mixins: - `filter-mixin <filter-mixin>`__ - `grouper-mixin <grouper-mixin>`__ - `list-mixin <list-mixin>`__ +- `next-mixin <next-mixin>`__ - `store-mixin <store-mixin>`__ - `widget-mixin <widget-mixin>`__ diff --git a/source/import_documentation/Mixins/list-mixin.rst b/source/import_documentation/Mixins/list-mixin.rst index f9a77708ea75372d322094b53a049f74ef01be94..dd7618ba9b3e5a56b6910448b829cf3cf2826c63 100644 --- a/source/import_documentation/Mixins/list-mixin.rst +++ b/source/import_documentation/Mixins/list-mixin.rst @@ -12,7 +12,7 @@ Used by: * `solid-map <SiB-Map>`__ Post-processors: --------- +---------------- * `counter-mixin <counter-mixin>`__ diff --git a/source/import_documentation/Mixins/next-mixin.rst b/source/import_documentation/Mixins/next-mixin.rst new file mode 100644 index 0000000000000000000000000000000000000000..9bc51c2da949c9417b4ff9b8e95afff12e7bb3aa --- /dev/null +++ b/source/import_documentation/Mixins/next-mixin.rst @@ -0,0 +1,30 @@ +next-mixin +========== + +The next-mixin provides the ability to precise the componant or the page to display after an action. + +Used by: +-------- + + * :ref:`solid-display <solid-display>` + * :ref:`solid-map <solid-map>` + * :ref:`solid-calendar <solid-calendar>` + + * :ref:`solid-form <solid-form>` + * :ref:`solid-delete <solid-delete>` + + + +Attributes +---------- + +``next`` +~~~~~~~~ + `name` attribute of the `<solid-route>` that should be accessed when a `<solid-display>`, `<solid-map>` or `<solid-calendar>` element is clicked. + + It can also be used to indicate the `name` attribute of the `<solid-route>` to reach after : + + * a click on a `<solid-delete>` button (only after the resource is correctly deleted); + * a click on the submit button in a `<solid-form>` (only after the resource is correctly saved). + + See the documentation of `<solid-router>` for more details. diff --git a/source/import_documentation/Mixins/store-mixin.rst b/source/import_documentation/Mixins/store-mixin.rst index 0e50591ac1db6e1123595f4494f2b4264a7b4528..ca09b2124c601b5a14e9570ed49012830831dbcc 100644 --- a/source/import_documentation/Mixins/store-mixin.rst +++ b/source/import_documentation/Mixins/store-mixin.rst @@ -1,5 +1,5 @@ store-mixin -========== +=========== The store mixin allows to fetch a resource or a container from an URI, and provides the data to the component. @@ -48,13 +48,6 @@ Attributes this extra context will be applied on all the components which doesn’t have an ``extra-context`` attribute. -``next`` -~~~~~~~~ - ``name`` attribute of the ``<solid-route>`` that should - be accessed when a ``<solid-display>`` element is clicked. See the - documentation of ``<solid-router>`` for more details. - - ``loader-id`` ~~~~~~~~~~~~~ Id of the loader element you want to display during the loading time. @@ -80,6 +73,7 @@ Attributes .. image:: ./../../_static/images/import_documentation/loader.gif :alt: Exemple of loader + Events ------ diff --git a/source/import_documentation/Store-doc.rst b/source/import_documentation/Store-doc.rst index de75371b3166126bb3215ae2f7936ea82e24e346..3f575666f4213a1f64f2beddd65448464958dcbd 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 8359cd895deaf94a4b6f23fbf9a2bf167d31d0df..1a3880267b420ee852f426dfd50c9951f30ee6e3 100644 --- a/source/index.rst +++ b/source/index.rst @@ -32,6 +32,7 @@ Welcome to Startinblox's documentation import_documentation/Components/Solid-Map import_documentation/Components/Solid-Ac-Checker import_documentation/Components/Solid-Widget + import_documentation/Components/Solid-Lang .. toctree:: :maxdepth: 2 @@ -55,6 +56,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