Documentation du popup de confidentialitée

Démarrer

inclure le script du popup a partir du CDN

latest
<script src="https://privacy.codems.com/dist/cdm-acceptation@latest/cdm-acceptation.js"></script>
ou avec le numéro de version.
<script src="https://privacy.codems.com/dist/[email protected]/cdm-acceptation.js"></script>

Ensuite, dans le javascript, initialiser le module.

Le plugin prend en compte d'attendre que le DOM soit prêt, pas besoins de gérer ça.

CdmAcceptation.init({});

Configuration

La méthode init() prend en argument un objet représentant la configuration du plugin.

Toute les valeurs ont une valeur par défaut.

VariabletypeValeur par défautDescription
acceptButtonTextstringthis.defaultTexts.acceptButtonText[this.lang];Bouton sur le bouton d'acceptation.
alignmentstring'center'L'alignement du popup. Accepte les valeur flex ( 'flex-start','center','flex-end' )
S'applique seulement si themeWide est à false.
borderRadiusstring'10px'l'arrodissement du popup.
boxShadowstring0px 2px 10px #0001Applique une ombre au popup
contentFontSizestring14pxFont size du popup
contentPaddingstring30px 30pxPadding du contenu du popup.
cssVarBuilderfunction(val) => valPermet d'ajouter ou de modifier des variables css. (Appelé au build)
dimmerClickThroughboolfalseSi true, les clics de souris passeront au travers du div d'assombrissement.
dimmerColorbooltrueSi true, le fond de la page sera assombris.
fontColorstring'#000'La couleur de la police du message.
fontFamilystring'Arial'La police utilisée dans le popup.
isDimmedbool
langstring'fr'Vaut 'fr' ou 'en'. S'applique seulement si les messages par défauts sont utilisés.
maxWidthstring'1000px'La largeur maximal du popup.
S'applique seulement si themeWide est à false.
messagestringthis.defaultTexts.message[this.lang]Le message affiché dans le popup.
modalBgColorstring'#fff'La couleur d'arrière plan du modal.
modalBorderSpacingobject{ bottom: '30px', left: '30px', right: '30px' }L'espacement du bord de page du popup.
modalBorderSpacingMobileobject{ bottom: '30px', left: '30px', right: '30px' }L'espacement du bord de page du popup.
policyLinkstring''Liens vers la politique de confidentialitée.
policyLinkTextstringthis.defaultTexts.policyLinkText[this.lang]Liens vers la politique de confidentialitée.
primaryColorstring'#202b38'La couleur primaire du plugin.
templateCSSstring*Le css de base injecté. (déconseillé de modifier).
templateHTMLstring*Le html de base du modal. Contient des slots qui sont string replace au build. (déconseillé de modifier).
templateReplacefunction(key, val) => valPermet d'influencer les variable remplacée dans le template. (Appelé au build)
themeWideboolfalseSi true, le popup sera aligné au bas et prendera toute la largeur de l'écran.
titlestringthis.defaultTexts.title[this.lang]Le titre affiché dans le popup.
titleFontSizestring18pxFont size du titre

Exemples

Wide

Dimmers

Couleurs

Contribuer

Compilation

Le JS du plugin est compilé avec rollup.

npm run dev

Le SCSS du plugin est compilé avec le plugin vscode liveSassCompiler ( id : glenn2223.live-sass )

Dossier dist

Le dossier dist, avec le temps, augmentera de numéro de version. Veuillez a garder les dossiers de versions précédentes afin de permettre a un site d'utiliser une plus vielle version.

Le compilateur rollup est configurer pour compiler dans un dossier du numéro de version, et d'écraser le latest.

A chaque changement que vous ferez, augmentez le numéro de version dans le package.json.