@gip-recia/actualites

actualites

• actualites
  • Installation
  • Paramètres
    • carrousel-ui
    • all-news
  • Variables CSS
    • Modification de style

Installation

• Installation via npm :

npm install @gip-recia/actualites

• Importation du composant :

Dans un module JavaScript :

import '@gip-recia/actualites'

Dans une page HTML :

<script src="./path/to/actualites.min.js"></script>

• Ajout du composant sur une page HTML :

const actualites = document.createElement('')
document.body.appendChild(actualites)

Paramètres

Propriétés disponibles :

carrousel-ui

Nom	Type	Obligatoire	Default	Description
user-info-api-url	string	true		URL dédiée à la récupération du token via le portail
get-user-news-url	string	true		URL permettant de récupérer une liste d'item en fonction des paramètres de filtrage
get-item-by-id-url	string	true		URL permettant de récupérer les informations d'un item
get-news-reading-informations-url	string	true		URL permettant de récupérer les informations de lecture de l'utilisateur
set-reading-url	string	true		URL permettant la gestion de la lecture d'un item en fonction de l'utilisateur
all-news-page-url	string	true		Url permettant d'accèder à la page 'toutes les actualités'
dnma-fname	string	true		Fname du service associé à fournir pour le DNMA
locale-key	string	false	News	Clé pour savoir quelles valeurs de texte utiliser pour la plupart des éléments
use-reading-info	boolean	true		Détermine s'il faut gérer le status "lu"/"non lu"

<carrousel-ui
  user-info-api-url=""
  get-user-news-url=""
  get-item-by-id-url=""
  get-news-reading-informations-url=""
  set-reading-url=""
  all-news-page-url=""
/>

all-news

Nom	Type	Obligatoire	Default	Description
user-info-api-url	string	true		URL dédiée à la récupération du token via le portail
get-user-news-url	string	true		URL permettant de récupérer une liste d'item en fonction des paramètres de filtrage
get-item-by-id-url	string	true		URL permettant de récupérer les informations d'un item
get-news-reading-informations-url	string	true		URL permettant de récupérer les informations de lecture de l'utilisateur
set-reading-url	string	true		URL permettant la gestion de la lecture d'un item en fonction de l'utilisateur
back-url	string	true		Url pointant vers l'acceuil
dnma-fname	string	true		Fname du service associé à fournir pour le DNMA
locale-key	string	false	News	Clé pour savoir quelles valeurs de texte utiliser pour la plupart des éléments
use-reading-info	boolean	true		Détermine s'il faut gérer le status "lu"/"non lu"

<all-news
  user-info-api-url=""
  get-user-news-url=""
  get-item-by-id-url=""
  get-news-reading-informations-url=""
  set-reading-url=""
  back-url=""
/>

Variables CSS

Modification de style

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

Nom
--recia-white
--recia-stroke
--recia-basic-grey
--recia-basic-black
--recia-lighter-black
--recia-primary
--recia-primary-pressed
--recia-secondary-hover
--recia-secondary-pressed
--recia-primary-20
--recia-shadow-neutral
--recia-shadow-strong
--recia-shadow-hover
--recia-shadow-low-elevation