Module:Color contrast/Documentation
Ceci est la page de documentation de Module:Color contrast [modifier] [purger].
Cette sous-page contient les instructions et les catégories de son module d'origine et elle n'est pas destinée à être visualisée directement.
Utilisation
[modifier le code]Ce module fournit quatre fonctions pour calculer le contraste de couleurs entre elles ou par rapport à un fond noir.
Fonctions exportables
[modifier le code]Lorsque la fonction prend en argument, elle doit être appelée depuis un modèle. Sinon, elle doit être appelée depuis un module.
lum(frame)– Prend en argument un code (hexadécimal, littéral… ) de couleur et retourne son contraste avec le noir._ratio(args)etratio(frame)où args = { couleur1, couleur2, error="code à renvoyer si erreur" } – renvoie le contraste entre deux couleurs (nombre entre 0 et 1)._greatercontrast(args)etgreatercontrast(frame)où args = { couleur_ref, couleur1, couleur2, bias=biais, css=false } – compare le contraste de deux couleurs par rapport à une couleur de référence et retourne celle qui a le meilleur contraste._styleratio(args)etstyleratio(frame)où args = { chaîne css, couleur fond par défaut, couleur texte par défaut } – Calcule le contraste entre la couleur du texte et celle du fond dans une chaîne de caractères css.
Modules externes et autres éléments dont ce module a besoin pour fonctionner
[modifier le code]mw.loadData– Charge efficacement un tableau lua contenu dans un autre module ;mw.text.unstripNoWiki– Remplace les strip markers <nowiki> par la chaine d'origine ;mw.ustring.match– Cherche la première correspondance d'un motif dans une chaine de caractères ;mw.text.split– Découpe une chaine de caractères en sous-chaines et retourne le résultat sous la forme d'un tableau ;mw.ustring.gsub– Remplace toutes les occurrences d'un motif dans une chaîne de caractères par une chaîne de remplacement ;
Module:Color contrast/colors– Sous-module gérant les couleurs définies par leur nom et pas un code hexadécimal.
Modules lua utilisant ce module
[modifier le code]- Module:Overlay (utilise
_greatercontrast) - Module:Adjacent stations (utilise
_greatercontrastet_ratio) - Module:Routemap (utilise
_greatercontrast)
Modèles appelant directement ce module
[modifier le code]- Modèle:Infobox Personnalité des sciences humaines et sociales et Modèle:Charte SHS (utilisent
greatercontrast)
Exemples
[modifier le code]Appel depuis un modèle
[modifier le code]lum :
{{#invoke:Color contrast|lum|#4444FF}} donne : 0.12583187813127
{{#invoke:Color contrast|lum|red}} donne : 0.2126
ratio :
{{#invoke:Color contrast|ratio|red|blue|error=?}} donne : 2.1489361702128
greatercontrast :
{{#invoke:Color contrast|greatercontrast|FFF|green|000}} donne : 000
styleratio :
{{#invoke:Color contrast|styleratio|text-align:center;background-color:#FFF;color:#000|white|#202122}} donne : 21
Appel depuis un module
[modifier le code]local styleratio = require('Module:Color contrast')._styleratio
args = { "text-align:center;background-color:#FFF;color:#000", "white", "#202122" }
return styleratio(args)
