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

Add validationMixin documentation

parent c67867b4
No related branches found
No related tags found
3 merge requests!60Dev to Master,!56Validation Mixin,!55Add validationMixin documentation
......@@ -33,7 +33,10 @@ Attributes
``confirmation-message``
~~~~~~~~~~~~~~~~~~~~~~~~~
Add this attribute to create a dialog box linked with the submit button of the solid-form.
*Available from version 0.13*
**Migrated to the validation mixin page in version 0.16**
Add this attribute to create a dialog box linked with the button of the solid-delete.
Its value matches the message displayed in the dialog box.
......
......@@ -29,7 +29,7 @@ Attributes
List of the fields used to create the form (by default, all of them are used).
``label-[field]``
~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~
When displaying a form, the default labels are the fields names of the model.
If you want something fancier, you can set this attribute.
i.e. ``label-username="Your name"``
......@@ -41,7 +41,7 @@ Attributes
display their own submit button.
``upload-url-[field]``
~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~
URL to upload file for field ``[field]``, it
automatically set ``widget-[field]`` to ``solid-form-file`` if net defined.
It’s particularly useful with a dropdown field.
......@@ -51,13 +51,13 @@ Attributes
Text of the submit button of the form.
``range-[field]``
~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~
URL of a container which list the accepted values
for the field ``[field]``. It’s particularly useful with a dropdown
field.
``enum-[field]``
~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~
*Available from version 0.13*
List of values of your choice for the field ``[field]``.
......@@ -72,7 +72,7 @@ Attributes
and "a", "b", "c" will be loaded in value attribute.
``order-asc-[field]`` or ``order-desc-[field]``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Name of the field used to order the range list ``[field]``.
``partial``
......@@ -81,12 +81,12 @@ Attributes
all the fields of the resource to update.
``min-[field]``
~~~~~~~~~~~
~~~~~~~~~~~~~~~
Add this attribute for the field ``[field]`` to define its minimum value.
It works only with a ``solid-form-number`` widget.
``max-[field]``
~~~~~~~~~~~
~~~~~~~~~~~~~~~
Add this attribute for the field ``[field]`` to define its maximum value.
It works only with a ``solid-form-number`` widget.
......@@ -98,15 +98,16 @@ Attributes
It works only with a ``solid-form-text`` widget.
``title-[field]``
~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~
*Available from version 0.13*
Add this attribute for the field ``[field]`` to precise extra information about an element.
It works only with a ``solid-form-text`` widget.
``confirmation-message``
~~~~~~~~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~~~
*Available from version 0.13*
**Migrated to the validation mixin page in version 0.16**
Add this attribute to create a dialog box linked with the submit button of the solid-form.
Its value matches the message displayed in the dialog box.
......
.. _validation-mixin:
validation-mixin
================
*Available from version 0.16*
The validation mixin creates a modal dialog before deleting or submitting data.
Used by:
--------
* :ref:`solid-delete <solid-delete>`
* :ref:`solid-form <solid-form>`
Attributes
----------
``confirmation-type``
~~~~~~~~~~~~~~~~~~~~~
It is a prerequisite and can take two options :
- ``confirm``: to access to a basic modal dialog.
- ``dialog``: to get a ``<dialog>`` more customizable.
``confirmation-message``
~~~~~~~~~~~~~~~~~~~~~~~~
Message displayed in the modal dialog (``confirm`` or ``dialog`` type).
The message by default is "Please, confirm your choice".
**The attributes below only concern ``dialog`` type.**
``confirmation-submit-text``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Text displayed on the submit button ("Ok" by default).
``confirmation-cancel-text``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Text displayed on the cancel button ("Cancel" by default).
``confirmation-submit-class``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Submit button class name (undefined by default).
``confirmation-cancel-class``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Cancel button class name (undefined by default).
Some examples of the use of validation mixin attributes :
.. code:: html
<solid-delete
data-src="http://server/user/"
confirmation-type="confirm"
confirmation-message="Thank you to confirm the data deletion."
></solid-delete>
<solid-form
data-src="../data/list/events.jsonld"
confirmation-type="dialog"
confirmation-message="Are you sure you want to create this event ?"
confirmation-submit-text="Yes, I am"
confirmation-submit-class="submit-button"
confirmation-cancel-class="cancel-button"
></solid-form>
\ No newline at end of file
......@@ -30,10 +30,29 @@ List of attributes (core framework)
~~~~~~~~~~~~~~
* :ref:`solid-map <solid-map>`
``confirmation-cancel-text``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* :ref:`validation-mixin <validation-mixin>`
``confirmation-cancel-class``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* :ref:`validation-mixin <validation-mixin>`
``confirmation-message``
~~~~~~~~~~~~~~~~~~~~~~~~
* :ref:`solid-form <solid-form>`
* :ref:`solid-delete <solid-delete>`
* :ref:`validation-mixin <validation-mixin>`
``confirmation-type``
~~~~~~~~~~~~~~~~~~~~~
* :ref:`validation-mixin <validation-mixin>`
``confirmation-submit-class``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* :ref:`validation-mixin <validation-mixin>`
``confirmation-submit-text``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* :ref:`validation-mixin <validation-mixin>`
``counter-template``
~~~~~~~~~~~~~~~~~~~~
......
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