0.0.3 • Published 11 months ago

@gip-recia/mediacentre-ui v0.0.3

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
11 months ago

mediacentre-ui

Installation

  1. Installation via npm :
npm install @gip-recia/mediacentre-ui
  1. Importation du composant :

Dans un module JavaScript :

import '@gip-recia/mediacentre-ui'

Dans une page HTML :

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

Paramètres

Propriétés disponibles :

NomTypeObligatoireDefaultDescription
base-api-urlstringnonURL de l'API REST MediaCentre.
config-api-urlstringnonURL de la configuration de l'API REST MediaCentre.
gestion-api-urlstringnonURL des informations de gestion du GAR de de l'API REST MediaCentre.
user-info-api-urlstringnonURL de l'API des informations utilisateurs.
user-rights-api-urlstringnonURL de l'API des droits utilisateurs.
get-user-favorite-resources-urlstringnonURL de l'API pour récupèrer la liste des identifiants des ressources favorites de l'utilisateur.
put-user-favorite-resources-urlstringnonURL de l'API pour modifier la liste des identifiants des ressources favorites de l'utilisateur.
fname-mediacentre-uistringnonFname de la portlet du Mediacentre-UI (utilisé pour la gestion des ressources favorites de l'utilisateur).
uai-currentstringnonClé de la soffit pour obtenir la valeur de l'UAI de l'établissement courant.
uaistringnonClé de la soffit pour obtenir la valeur de la liste des UAI des établissements de l'utilisateur.
help-locationstringnonURL de la page d'aide du Médiacentre.
<mediacentre-ui
  mediacentre-context-url=""
  base-api-url=""
  user-info-api-url=""
  user-rights-api-url=""
  get-user-favorite-resources-url=""
  put-user-favorite-resources-url=""
  fname-mediacentre-ui=""
/>

Variables CSS

Modification de style

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

NomDescription
--ui-mediacentre-border-colorCouleur associée au domaine de l'utilisateur.
--ui-mediacentre-background-colorCouleur de fond du composant (la même que celle du portail).
--ui-mediacentre-card-background-colorCouleur de fond des cartes ressources.
--ui-mediacentre-font-colorCouleur du texte.
--ui-mediacentre-menu-title-background-colorCouleur de fond du titre du menu et de l'icône infos.
--ui-mediacentre-category-hover-background-colorCouleur de fond au survol d'une catégorie.
--ui-mediacentre-category-active-background-colorCouleur de fond d'une catégorie sélectionnée.
--recia-btn-primary-bgCouleur de fond des boutons et des selects.
--recia-btn-primary-colorCouleur du texte des boutons et des selectse.
--mediacentre-menu-bgCouleur de fond du menu.
--primary-transparentCouleur de fond des boutons.
--ui-mediacentre-category-active-background-colorCouleur de fond d'une catégorie sélectionnée.
--ui-mediacentre-blue-linkCouleur des hyperliens.
0.0.3

11 months ago

0.0.2

12 months ago

0.0.1

12 months ago