From 7ab236f34d5004d4033a2317dca7fac79afb3e34 Mon Sep 17 00:00:00 2001 From: Manon Bourgognon <manon.bourgognon@epitech.eu> Date: Mon, 11 Jan 2021 14:19:51 +0100 Subject: [PATCH 1/5] Add alt attribute in the doc --- source/import_documentation/Mixins/widget-mixin.rst | 11 ++++++++--- source/import_documentation/Widgets/Reference.rst | 8 ++++---- source/import_documentation/attributes-list.rst | 4 ++++ 3 files changed, 16 insertions(+), 7 deletions(-) diff --git a/source/import_documentation/Mixins/widget-mixin.rst b/source/import_documentation/Mixins/widget-mixin.rst index bad67b6..06afbdd 100644 --- a/source/import_documentation/Mixins/widget-mixin.rst +++ b/source/import_documentation/Mixins/widget-mixin.rst @@ -71,7 +71,7 @@ Attributes ``default-[field]`` ~~~~~~~~~~~~~~~~~~~ - Value displayed for ``[field]`` when it’s empty or not defined + Value displayed for ``[field]`` when it’s empty or not defined. ``widget-[field]`` ~~~~~~~~~~~~~~~~~~ @@ -95,11 +95,11 @@ Attributes ``label-[field]`` ~~~~~~~~~~~~~~~~~ - Set the label for the ``[field]`` + Set the label for the ``[field]``. ``placeholder-[field]`` ~~~~~~~~~~~~~~~~~~~~~~~ - Set the placeholder for the ``[field]`` + Set the placeholder for the ``[field]``. ``class-[field]`` ~~~~~~~~~~~~~~~~~ @@ -126,6 +126,11 @@ Attributes editable-name ></solid-display> +``alt-[field]`` +~~~~~~~~~~~~~~~ + *Works only with solid-display-img* + + Set the alt for the field ``[field]``. ``multiple-[field]`` ~~~~~~~~~~~~~~~~~~~~ diff --git a/source/import_documentation/Widgets/Reference.rst b/source/import_documentation/Widgets/Reference.rst index f25f72d..3d95c3d 100644 --- a/source/import_documentation/Widgets/Reference.rst +++ b/source/import_documentation/Widgets/Reference.rst @@ -29,10 +29,10 @@ Name of the template to use. Available templates: - ``display`` directory - ``value``: displays ``value`` directly in the widget tag. - - ``div``: displays ``value`` inside a ``<div>`` tag - - ``link``: displays ``value`` as an ``href`` attribute in a ``<a>`` tag - - ``img``: displays ``value`` as a ``src`` attribute in a ``<img>`` tag - - ``boolean``: displays label (or name) in a ``<label>`` tag if ``value == true`` + - ``div``: displays ``value`` inside a ``<div>`` tag. + - ``link``: displays ``value`` as an ``href`` attribute in a ``<a>`` tag. + - ``img``: displays ``value`` as a ``src`` attribute in a ``<img>`` tag. + - ``boolean``: displays label (or name) in a ``<label>`` tag if ``value == true``. - ``form`` directory diff --git a/source/import_documentation/attributes-list.rst b/source/import_documentation/attributes-list.rst index 7f42901..00c0f4a 100644 --- a/source/import_documentation/attributes-list.rst +++ b/source/import_documentation/attributes-list.rst @@ -5,6 +5,10 @@ List of attributes (core framework) ~~~~~~~~~~~~~~~~~~ * :ref:`widget-mixin <widget-mixin>` +``alt-[field]`` +~~~~~~~~~~~~~~~ + * :ref:`widget-mixin <widget-mixin>` + ``autocomplete-[field]`` ~~~~~~~~~~~~~~~~~~~~~~~~ * :ref:`solid-form <solid-form>` -- GitLab From 57709ef0f5b306b5297518f5a6fccac74dac642f Mon Sep 17 00:00:00 2001 From: Manon Bourgognon <manon.bourgognon@epitech.eu> Date: Mon, 18 Jan 2021 17:45:08 +0100 Subject: [PATCH 2/5] add oEmbed widget documentation --- source/import_documentation/Widgets/Reference.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/source/import_documentation/Widgets/Reference.rst b/source/import_documentation/Widgets/Reference.rst index 3d95c3d..a1034e2 100644 --- a/source/import_documentation/Widgets/Reference.rst +++ b/source/import_documentation/Widgets/Reference.rst @@ -91,3 +91,4 @@ Features to add to the widget. You can choose as many as you want - ``addable``: adds a ``<solid-form>`` that allows to add data on the field concerned. It accepts attributes from :ref:`solid-form <solid-form>` by using ``addable-[field]-[attribute]="value"`` format. If ``addable-data-src`` is not provided, the solid-form will use the URI in ``range-[field]`` as data-src, if declared. +- ``oembed``: displays the video content of an oEmbed link filled with the associated ``value-[field]`` attribute. \ No newline at end of file -- GitLab From 257daafe2378804140991debd186a137e415a1e4 Mon Sep 17 00:00:00 2001 From: Matthieu Fesselier <matthieu.fesselier@gmail.com> Date: Tue, 19 Jan 2021 09:55:40 +0100 Subject: [PATCH 3/5] update solid-link doc --- source/import_documentation/Components/Solid-Router.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/source/import_documentation/Components/Solid-Router.rst b/source/import_documentation/Components/Solid-Router.rst index 72a9669..80e3b9c 100644 --- a/source/import_documentation/Components/Solid-Router.rst +++ b/source/import_documentation/Components/Solid-Router.rst @@ -76,6 +76,10 @@ solid-link - ``next``: The ``name`` attribute of the ``<solid-route>`` you want to access. +- ``data-src``: The resource you want to use in your view. Often + used to show more details about this resource, by adding the + ``bind-resource`` attribute to a component. + Example: .. code:: html -- GitLab From 4be1178fdc67d6cf0e0542f3147b1e124325d78f Mon Sep 17 00:00:00 2001 From: Manon Bourgognon <manon.bourgognon@epitech.eu> Date: Tue, 9 Feb 2021 15:51:42 +0100 Subject: [PATCH 4/5] Add password widget, solid-map cluster option --- source/import_documentation/Components/Solid-Map.rst | 4 ++++ source/import_documentation/Widgets/Reference.rst | 5 +++-- source/import_documentation/attributes-list.rst | 8 ++++++++ 3 files changed, 15 insertions(+), 2 deletions(-) diff --git a/source/import_documentation/Components/Solid-Map.rst b/source/import_documentation/Components/Solid-Map.rst index 028a5c9..8c7bd3e 100644 --- a/source/import_documentation/Components/Solid-Map.rst +++ b/source/import_documentation/Components/Solid-Map.rst @@ -50,6 +50,10 @@ added to interact with the list of data being displayed. ~~~~~~~~~~ List of the fields to display in a popup which opens when a marker is clicked. If the attribute is not defined, no popup will show up. +``clustering`` +~~~~~~~~~~~~~~ + If this attribute is defined, markers spacially close are grouped in clusters. + Events ------- diff --git a/source/import_documentation/Widgets/Reference.rst b/source/import_documentation/Widgets/Reference.rst index a1034e2..537daab 100644 --- a/source/import_documentation/Widgets/Reference.rst +++ b/source/import_documentation/Widgets/Reference.rst @@ -51,12 +51,13 @@ Name of the template to use. Available templates: - ``radio``: set ``value`` in a list of radio buttons. The list is provided via the ``range`` attribute, which expects a container’s URL, or via the ``enum`` attribute, which takes a list of the values separated by commas. - ``multiple``: Accept a container URI as a ``value``, and inserts one widget per resource with a “remove†button for each widget, and an “add†button. - ``multipleselect``: Accept a container URI as a ``value``, and inserts a dropdown widget with the ``multiple`` attribute. - - ``checkboxes``: Accept a container URI as a ``value``, allow to select multiple values with in a list of checkbox inputs. The list is provided via the ``range`` attribute, which expects a container’s URL, or via the ``enum`` attribute, which takes a list of the values separated by commas. + - ``checkboxes``: Accept a container URI as a ``value``, allow to select multiple values with in a list of checkbox inputs. The list is provided via the ``range`` attribute, which expects a container’s URL, or via the ``enum`` attribute, which takes a list of the values separated by commas. - ``file``: Inserts an ``<input/>`` and an ``<input type="file"/>``. When a file is selected it’s uploaded, URL of file is returned by request and set as the ``<input/>`` value. The upload URL is provided via the ``upload-url`` attribute. - ``image``: Works like ``file`` but allow only images in the input, and create a preview of the image when selected by the user. - - ``color``: set ``value`` in a ``<input>`` of type ``color``. + - ``color``: set ``value`` in an ``<input>`` of type ``color``. + - ``password``: set ``value`` in an ``<input>`` of type ``password``. - ``set`` diff --git a/source/import_documentation/attributes-list.rst b/source/import_documentation/attributes-list.rst index 00c0f4a..5da3c35 100644 --- a/source/import_documentation/attributes-list.rst +++ b/source/import_documentation/attributes-list.rst @@ -14,6 +14,10 @@ List of attributes (core framework) * :ref:`solid-form <solid-form>` * :ref:`solid-form-search <solid-form-search>` +``autosave`` +~~~~~~~~~~~~ + * :ref:`solid-form <solid-form>` + ``child-[field]`` ~~~~~~~~~~~~~~~~~ * :ref:`solid-display <solid-display>` @@ -22,6 +26,10 @@ List of attributes (core framework) ~~~~~~~~~~~~~~~~~ * :ref:`widget-mixin <widget-mixin>` +``clustering`` +~~~~~~~~~~~~~~ + * :ref:`solid-map <solid-map>` + ``confirmation-message`` ~~~~~~~~~~~~~~~~~~~~~~~~ * :ref:`solid-form <solid-form>` -- GitLab From 697a503dfedaf31357385c591974c3d600c3022c Mon Sep 17 00:00:00 2001 From: Manon Bourgognon <manon.bourgognon@epitech.eu> Date: Tue, 9 Feb 2021 15:58:43 +0100 Subject: [PATCH 5/5] Update solid-map clustering attribute --- source/import_documentation/Components/Solid-Map.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/source/import_documentation/Components/Solid-Map.rst b/source/import_documentation/Components/Solid-Map.rst index 8c7bd3e..1e02551 100644 --- a/source/import_documentation/Components/Solid-Map.rst +++ b/source/import_documentation/Components/Solid-Map.rst @@ -52,6 +52,8 @@ added to interact with the list of data being displayed. ``clustering`` ~~~~~~~~~~~~~~ + *Available from version 0.16* + If this attribute is defined, markers spacially close are grouped in clusters. Events -- GitLab