0.0.1 • Published 1 year ago

@gip-recia/info-modal v0.0.1

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
1 year ago

Info-Modal

Info-Modal est un webcomponent s'appuyant sur la librairie Lit pour afficher une modale d'information.

Installation

  1. Installation via npm :
npm install @gip-recia/info-modal
  1. Importation du composant :

Dans un module JavaScript :

import '@gip-recia/info-modal';

Dans une page HTML :

<script src="./path/to/info-modal.min.js"></script>
  1. Ajout du component sur une page HTML :
const infoModal = document.createElement('info-modal');
document.body.appendChild(infoModal);

Paramètres

Propriétés disponibles :

NomTypeObligatoireDescription
titleModalstringnonLe titre de la modale
debugbooleannonUn booléen qui permet d'afficher les retour console ou non
mainElementHTMLElementouiBalise main du DOM (la modale gère la navigation clavier dans le DOM)
<info-modal
  titleModal=""
  debug
/>

Variables CSS

Modification de style

Plusieurs variables CSS peuvent être définis pour personnaliser le webcomponent :

NomDescription
--info-modal-background-modal-container-colorCouleur de fond de la modale
--info-modal-background-modal-overlay-colorCouleur d'arrière plan (donne le "focus visuel" à la modale)
0.0.1

1 year ago