diff --git a/source/import_documentation/Mixins/required-mixin.rst b/source/import_documentation/Mixins/required-mixin.rst new file mode 100644 index 0000000000000000000000000000000000000000..48cca54abe861df0abf36c1f30914b00f91a35a0 --- /dev/null +++ b/source/import_documentation/Mixins/required-mixin.rst @@ -0,0 +1,31 @@ +.. _required-mixin: +required-mixin +=============== + +The required mixin is a post-processor mixin, compatible with list-mixin. +It provides the ability to display a list of resources according to the property/-ies its possess. + +Used by: +-------- + + * :ref:`solid-display <solid-display>` + + +Attributes +---------- + +``required-xyz`` +~~~~~~~~~~~~~~~~ + The attribute takes no value. ``xyz`` represents the mandatory property of resources to be displayed. + + In this example, users must have email to be dislayed. + + .. code:: html + + <solid-display + data-src=http://server/users/" + fields="username" + required-email + ></solid-display> + + It is possible to combine this mixin twice, ``required-uvw`` and ``required-xyz``. \ No newline at end of file diff --git a/source/index.rst b/source/index.rst index 0beec3beebbf1ae8db130762f22eddca90516ff5..23a1705b4aea782f28afb844498492f43b44c4a8 100644 --- a/source/index.rst +++ b/source/index.rst @@ -57,6 +57,7 @@ Welcome to Startinblox's documentation import_documentation/Mixins/paginate-mixin import_documentation/Mixins/sorter-mixin import_documentation/Mixins/highlighter-mixin + import_documentation/Mixins/required-mixin import_documentation/Mixins/next-mixin .. toctree::