Skip to content
Snippets Groups Projects
Commit 3bba4b5f authored by Benoit Alessandroni's avatar Benoit Alessandroni
Browse files

Merge branch 'doc-patches-attributes' into 'master'

Doc patches attributes

See merge request !97
parents 7a39ceb9 25834ccd
No related branches found
No related tags found
1 merge request!97Doc patches attributes
Pipeline #14945 passed with stage
in 50 seconds
...@@ -38,6 +38,7 @@ This component uses the following mixins: ...@@ -38,6 +38,7 @@ This component uses the following mixins:
* :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:`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>`
......
...@@ -32,6 +32,7 @@ This component uses the following mixins: ...@@ -32,6 +32,7 @@ This component uses the following mixins:
* :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:`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>`
......
.. _server-pagination-mixin:
server-pagination-mixin
================
The server-pagination mixin is a post-processor mixin, which provides the ability to handle the pagination server side, hence reducing the number of resources fetched on first call.
Used by:
--------
* :ref:`solid-display <solid-display>`
Attributes
----------
``limit``
~~~~~~~~~~~~~~~
The number of resources to fetch.
In this example, the list will show pages of 5 users.
.. code:: html
<solid-display
data-src=http://server/users/"
fields="username"
limit="5"
></solid-display>
``offset``
~~~~~~~~~~~~~~~
The offset of the first resource to fetch
In this example, the list will show pages of 5 users, skipping the first ten.
.. code:: html
<solid-display
data-src=http://server/users/"
fields="username"
limit="5"
offset="10"
></solid-display>
\ No newline at end of file
...@@ -177,6 +177,10 @@ Attributes are specific to base components or they depend on mixins (they can be ...@@ -177,6 +177,10 @@ Attributes are specific to base components or they depend on mixins (they can be
~~~~~~~~ ~~~~~~~~
* :ref:`solid-lang <solid-lang>` * :ref:`solid-lang <solid-lang>`
``limit``
~~~~~~~~~~~~~~~
* :ref:`server-pagination-mixin <server-pagination-mixin>`
``loader-id`` ``loader-id``
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
* :ref:`store-mixin <loader-id>` * :ref:`store-mixin <loader-id>`
...@@ -225,6 +229,10 @@ Attributes are specific to base components or they depend on mixins (they can be ...@@ -225,6 +229,10 @@ Attributes are specific to base components or they depend on mixins (they can be
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
* :ref:`store-mixin <no-render>` * :ref:`store-mixin <no-render>`
``offset``
~~~~~~~~~~~~~~~
* :ref:`server-pagination-mixin <server-pagination-mixin>`
``order-asc`` ``order-asc``
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
* :ref:`sorter-mixin <sorter-mixin>` * :ref:`sorter-mixin <sorter-mixin>`
......
...@@ -16,6 +16,7 @@ the base components to best render the content of the application : ...@@ -16,6 +16,7 @@ the base components to best render the content of the application :
/import_documentation/Mixins/next-mixin /import_documentation/Mixins/next-mixin
/import_documentation/Mixins/paginate-mixin /import_documentation/Mixins/paginate-mixin
/import_documentation/Mixins/required-mixin /import_documentation/Mixins/required-mixin
/import_documentation/Mixins/server-pagination-mixin
/import_documentation/Mixins/sorter-mixin /import_documentation/Mixins/sorter-mixin
/import_documentation/Mixins/store-mixin /import_documentation/Mixins/store-mixin
/import_documentation/Mixins/validation-mixin /import_documentation/Mixins/validation-mixin
......
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