Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

wb-config - Configuration web component #9676

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

duboisp
Copy link
Member

@duboisp duboisp commented Sep 29, 2023

Nouveau web component permettant de configurer les plugin de WET-BOEW.

Ceci va permettre de simplifier la gestion et la mise à jour de certaine configuration complex et très hiérarchique tel qu'avec le data-json et le wb-geomap plugin.

Copy link
Contributor

@Garneauma Garneauma left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Révision partielle.

Je suggère de diviser la documentation et les exemples pratiques. Pourrais-tu créer une page de documentation sous /plugins ?


<dl class="dl-horizontal">
<dt><code>wb-plugin</code></dt>
<dd>Name of the plugin for which the configuration is intended.</dd>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<dd>Name of the plugin for which the configuration is intended.</dd>
<dd>Name of the plugin for which the configuration is intended. Should only be applied to the root <code>&lt;wb-config></code> element.</dd>

<dt><code>wb-prop</code></dt>
<dd>Name of the property.</dd>
<dt><code>wb-value</code></dt>
<dd>JSON value of the named property unless the data type is specified. If not set, the inner <code>&lt;wb-config></code> will be taken, and then the node's text content.</dd>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<dd>JSON value of the named property unless the data type is specified. If not set, the inner <code>&lt;wb-config></code> will be taken, and then the node's text content.</dd>
<dd>JSON value of the property defined in <code>wb-prop</code> unless a data type is specified in <code>wb-type</code>. If no <code>wb-value</code> is specified, the inner <code>&lt;wb-config></code> will be used and the type will be set to Array. If the element contains no <code>&lt;wb-config></code>, the node's text content will be used.</dd>

Je suggère ce changement d'après ce que j'ai compris. Laisse-moi savoir si je suis dans le champ.

<dd>JSON value of the named property unless the data type is specified. If not set, the inner <code>&lt;wb-config></code> will be taken, and then the node's text content.</dd>
<dt><code>wb-type</code></dt>
<dd>
<p>Data type of the value supporting the following:</p>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<p>Data type of the value supporting the following:</p>
<p>Data type of the value. Supports the following values:</p>


<h2>Data tables with remote configuration</h2>

<p>Add a data attribute to the enhanced element with the plugin name followed by <code>-config</code> and an ID pointer to the <code>&lt;wb-config></code> element.</p>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<p>Add a data attribute to the enhanced element with the plugin name followed by <code>-config</code> and an ID pointer to the <code>&lt;wb-config></code> element.</p>
<p>Add a data attribute to the enhanced element with the plugin name followed by <code>-config</code>, for example: <code>data-wb-tables-config</code>. The value of this data attribute should be the <code>id</code> of the <code>&lt;wb-config></code> element.</p>


<dl class="dl-horizontal">
<dt><code>wb-plugin</code></dt>
<dd>Nom du plugin pour lequel la configuration est destinée.</dd>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<dd>Nom du plugin pour lequel la configuration est destinée.</dd>
<dd>Nom du plugin pour lequel la configuration est destinée. Ne devrait être appliqué qu'à l'élément racine <code>&lt;wb-config></code>.</dd>

<dt><code>wb-prop</code></dt>
<dd>Nom de la propriété.</dd>
<dt><code>wb-value</code></dt>
<dd>Valeur JSON de la propriété nommée, sauf si le type de données est spécifié. Si ce n'est pas défini, <code>&lt;wb-config></code> sera pris en compte, puis le contenu textuel du noeud.</dd>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<dd>Valeur JSON de la propriété nommée, sauf si le type de données est spécifié. Si ce n'est pas défini, <code>&lt;wb-config></code> sera pris en compte, puis le contenu textuel du noeud.</dd>
<dd>Valeur JSON de la propriété définie dans <code>wb-prop</code> sauf si un type de données est spécifié dans <code>wb-type</code>. Si aucun <code>wb-value</code> n'est spécifié, le <code>&lt;wb-config></code> interne sera utilisé et le type sera défini à Array. Si l'élément ne contient pas de <code>&lt;wb-config></code>, le contenu texte de l'élément sera utilisé.</dd>

<dd>Valeur JSON de la propriété nommée, sauf si le type de données est spécifié. Si ce n'est pas défini, <code>&lt;wb-config></code> sera pris en compte, puis le contenu textuel du noeud.</dd>
<dt><code>wb-type</code></dt>
<dd>
<p>Type de données de la valeur prenant en charge les éléments suivants :</p>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<p>Type de données de la valeur prenant en charge les éléments suivants :</p>
<p>Type de données de la valeur. Prend en charge les valeurs suivantes :</p>


<h2>Tableaux de données avec configuration à distance</h2>

<p>Ajoutez un attribut de données sur l'élément amélioré avec le nom du plugin suivi de <code>-config</code> et d'un pointeur d'ID vers l'élément <code>&lt;wb-config></code>.</p>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<p>Ajoutez un attribut de données sur l'élément amélioré avec le nom du plugin suivi de <code>-config</code> et d'un pointeur d'ID vers l'élément <code>&lt;wb-config></code>.</p>
<p>Ajoutez un attribut de données à l'élément amélioré avec le nom du plugin suivi de <code>-config</code>, par exemple : <code>data-wb-tables-config</code>. La valeur de cet attribut de données doit être le <code>id</code> de l'élément <code>&lt;wb-config></code>.</p>

</thead>
</table>

<h3>Source code</h3>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<h3>Source code</h3>
<h3>Code source</h3>

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants