sipa-bms-ui

Librairie de composants et plugins VueJS pour les projets de l'équipe BMS du groupe Sipa. Créée et maintenue par l'équipe BMS.

Installation

Installer d'abord la librairie avec votre package manager préféré :

npm i -D sipa-bms-ui

Attention, cette librairie n'est pas compatible Vue 2 et n'embarque pas le runtime de Vue. Il faut que votre application importe elle-même Vue 3.

Autre pré-requis: Utiliser vue-router comme router par défaut

Theming

Il faut ajouter le CSS des composants qui a été extrait de manière globale en ajoutant à votre main.js ou main.ts la ligne suivante :

import 'sipa-bms-ui/dist/style.css';

Utilisation

Deux modes d'instanciations sont disponibles pour les composants de la librairie. En mode composant par composant (on-demand) ou de manière globale. Il est recommandé d'utiliser le mode on demand pour avoir des bundle plus petit.

Utilisation en local

Pour utiliser une version non-publiée de la lib, il faut builder la librairie et faire référence au dossier de la librairie sur le produit. Ensuite, il faut lancer un npm install pour mettre à jour les dépendances. Ensuite, à chaque build futur, les changements seront impactés.

Dans la librairie

npm run build

Dans le backoffice

  "devDependencies": {
    "sipa-bms-ui": "file:../platform-library-vuejs-bms",
  }

Méthode on-demand tree-shakeable

À l'intérieur de votre composant, importer ce que vous souhaitez depuis le paquet sipa-bms-ui :

<script setup lang="ts">
import { BmsButton } from 'sipa-bms-ui';
</script>

<template>
  <BmsButton></BmsButton>
</template>

Méthode globale

Pour la méthode globale, dans votre fichier de montage, il faut importer et utiliser la méthode createBmsUi() :

import { createApp } from 'vue';
import { createBmsUi } from 'sipa-bms-ui';
import App from './App.vue';

createApp(App).use(createBmsUi()).mount('#app');

Les plugins

Quatre plugins sont pour le moment disponibles sur la librairie :

• field : gérer des champs de formulaires très simplistes
• notifications : notifications en mode toast.
• confirm : modale de confirmation qui renvoie une promesse
• router-history : sauvegarde les étapes de la navigation
• feature-flipping : gère un feature flipping côté client

Pour les instancier, il faut les importer et les appeler comme n'importe quel plugin Vue.

import { createApp } from 'vue';
import {
  createBmsUi,
  field,
  notifications,
  confirmPlugin,
  routerHistoryPlugin,
  featureFlipperPlugin,
} from '.';
import App from './App.vue';

createApp(App)
  .use(createBmsUi())
  .use(field)
  .use(notifications)
  .use(confirmPlugin)
  .use(routerHistoryPlugin)
  .use(featureFlipperPlugin, { featureA: false })
  .mount('#app');

Field

Utilisation du plugin field dans un template :

<field>
  <template #default="scope">
    <input type="text" v-field="scope" v-model="message" />
  </template>
</field>

notifications

Utilisation du plugin notification :

Dans le composant racine, tel que App.vue ou autre

<bms-notifications />

import { useNotifications } from 'sipa-bms-ui';

const { success, error } = useNotifications();

const onClickOnButtonOrAfterFormSubmit = () => {
  // (text, time). Si 0, dismiss manuel.
  success('This is a success', 6000);
};

const onErrorOfSomething = () => {
  // même signature que success
  error('This is an error');
};

confirm

Utilisation du plugin confirm :

Dans le composant racine, tel que App.vue ou autre

<bms-confirm />

import { useConfirm } from 'sipa-bms-ui';

const { confirm } = useConfirm();

const onNeedToConfirmAction = async () => {
  if (await confirm(`Question à poser à l'utilisateur`)) {
    // After, the user has confirmed
  } else {
    // user has closed or cancelled the operation
  }
};

Router History

Utilisation du plugin router-history :

Dans le composant racine, tel que App.vue ou autre

<bms-router-history />

Cela donne accès au composable useRouterHistory et à l'utilisation du BmsBackButton

Feature Flipper

Ce plugin donne accès à un debug mode, où le développeur ou un administrateur peut activer / désactiver des fonctionnalités cachées.

Lors de l'installation du plugin, lui donner les features qui sont valables avec la valeur par défaut.

app.use(featureFlipperPlugin, { featureA: false });

Après un Konami Code, une modal permet de changer les valeurs de ces features.

Ces valeurs sont stockées dans le localStorage.

Si des valeurs sont activées, un bandeau indique que c'est le cas et permet de rouvrir la modal.

Dans les composants, le composable useFeatureFlipper expose la méthode isFeatureEnabled(featureName) pour vérifier ces valeurs.

Pour toute question, contactez l'équipe BMS.