AMSOM Excel Extractor

Ce package propose un composant d'extraction excel pour Vue.js

Installation

npm i @amsom-habitat/amsom-excel-extractor

Importer les css dans le main.js tel que :

import '@amsom-habitat/amsom-excel-extractor/dist/style.css'

Pour utiliser le package:

import { AmsomExcelExtractor } from '@amsom-habitat/amsom-excel-extractor'

Développement

Après avoir fait vos développements, veillez à bien tenir à jour le changelog.md ainsi que la version du package.json puis faites :

git add .
git commit -m '<commentaire>'
git push origin <branch>

Tests

Les tests sont réalisés de manière automatique sur les branches main et dev mais peuvent être faits localement, notamment pour voir l'évolution du développement via la commande :

npm run storybook

Le valideur devra, si des changements sont observés, aller sur la pipeline pour valider les différences à l'aide de chromatic, sans cela aucun merge-request ne sera possible. Si un merge est effectué, une double vérification sera nécessaire.

Déploiement

Après avoir merge les dev sur la branche main, exécutez :

make publish

Cette commande vérifie la version, le changelog et publie le tout

Utilisation

Props

• owner : Propriétaire des modèles d'extraction (par défaut LOGI)
• token : Token d'authentification de l'utilisateur
• api-url : URL de l'API à utiliser pour les requêtes
• password-access-to-create-model : Mot de passe requis pour créer un modèle d'extraction
• open-in-modal : Permet d'ouvrir le bloc d'extraction dans une modal (par défaut false)

Événements

• extraction-complete : Émis lorsque l'extraction est terminée, avant les autres actions

Exemple complet

<template>
  <amsom-excel-extractor
    owner="LOGI"
    token="votre_token"
    password-access-to-create-model="votre_mot_de_passe"
    api-url="http://votre_api_url"
    open-in-modal
    @extraction-complete="handleExtractionComplete"
  />
</template>

<script>
import { AmsomExcelExtractor } from '@amsom-habitat/amsom-excel-extractor'

export default {
  name: 'TestPage',
  components: { AmsomExcelExtractor },
  methods: {
    handleExtractionComplete(data) {
      alert('Extraction terminée !')
    }
  }
}
</script>