@amsom-habitat/file-manager

AMSOM File Manager

Ce package regroupe plusieurs composants destinés à la gestion de fichiers et documents pour les outils d'AMSOM Habitat.

Il regroupe les composants :

• AmsomUploadFile - voir la documentation ici
• AmsomDocumentList - voir la documentation ici
• AmsomImageList - voir la documentation ici

Installation

npm i @amsom-habitat/file-manager

Importer les CSS dans le main.js tel que :

import '@amsom-habitat/file-manager/dist/style.css'

Vue d'ensemble des composants

AmsomUploadFile

Composant d'upload de fichiers avancé avec :

• Upload par drag & drop ou sélection
• Compression automatique des images
• Conversion d'images en PDF
• Fusion de PDFs
• Validation MIME type et taille
• Formats de sortie : File natif ou base64

Documentation complète →

Exemple d'utilisation :

<amsom-upload-file
  name="mon-upload"
  v-model="files"
  label="Télécharger vos documents"
  :merge-pdfs="true"
/>

AmsomDocumentList

Composant de liste de documents avec :

• Téléchargement individuel ou groupé (ZIP)
• Groupement par catégorie
• Personnalisation des handlers
• Gestion des erreurs
• Mode anonyme

Documentation complète →

Exemple d'utilisation :

<amsom-document-list
  :document-list="documents"
  title="Mes documents"
  group-by-category
  show-download-all
/>

AmsomImageList

Composant de galerie d'images avec :

• Capture photo (caméra frontale/arrière)
• Visualisation en modal
• Navigation entre images
• Suppression d'images
• Limite d'images configurable

Documentation complète →

Exemple d'utilisation :

<amsom-image-list
  v-model:images="photos"
  :images-limit="5"
  capture="environment"
/>

Import des composants

Import nommé (recommandé)

import { AmsomUploadFile, AmsomDocumentList, AmsomImageList } from '@amsom-habitat/file-manager'

Import individuel

import AmsomUploadFile from '@amsom-habitat/file-manager'
import AmsomDocumentList from '@amsom-habitat/file-manager'
import AmsomImageList from '@amsom-habitat/file-manager'

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.

Dépendances

Ce package dépend de :

• @amsom-habitat/ui - Composants UI (AmsomModal, AmsomOverlay, AmsomSkeleton)
• @amsom-habitat/file-utils - Utilitaires de gestion de fichiers
• @amsom-habitat/date-utils - Utilitaires de gestion de dates
• @fortawesome/vue-fontawesome - Icônes FontAwesome
• pdf-merger-js - Fusion de PDFs
• jszip - Création de fichiers ZIP
• mime - Gestion des types MIME

Support

Pour toute question ou problème, veuillez contacter l'équipe de développement AMSOM Habitat.

Licence

Propriété d'AMSOM Habitat - Tous droits réservés