@descartes/d-inkmap v0.0.1

D-InkMap, composant Javascript

Le composant Javascript D-InkMap est un plugin de Descartes.

Paquet NPM

Le composant Javascript D-InkMap est disponible sous forme de paquet NPM sous l'appellation @descartes/d-inkmap.

Utilisation dans une application tierce

Installation

Pour installer le composant JS D-inkmap dans un projet NPM :

$ npm install @descartes/d-inkmap

Note : le paquet n'est pas disponible sur les dépôts public, il faut donc faire pointer le scope @descartes sur le dépôt souhaité:

• dépôt public (pour les versions diffusées) :
  https://forge.din.developpement-durable.gouv.fr/nexus/repository/npm-public/
• dépôt privé (pour les versions en cours de développement) :
  https://forge.din.developpement-durable.gouv.fr/nexus/repository/projet-descartes-npm/

Pour que NPM puisse se connecter aux dépôts, il faut renseigner le fichier .npmrc :

registry=https://forge.din.developpement-durable.gouv.fr/nexus/repository/xxxx/
...

Inclusion du composant

Tout d'abord, le chargement de la librairie principale Descartes est nécessaire: le paquet @descartes/XXX doit être inclus dans l'application.

Pour utiliser le composant JS D-InkMap, il suffit d'inclure les fichiers suivants dans la page HTML de l'application (les chemins relatifs doivent être respectés) :

• vendor/d-inkmap-required.css
• vendor/d-inkmap-required.js
• css/d-inkmap.css
• d-inkmap.js

Utilisation du composant en cours de développement

Compilation

La compilation du composant JS de D-InkMap se fait à l'aide de Webpack. Par ailleurs le composant possède les dépendances suivantes :

Pour compiler le composant :

$ npm run build

Lors de la compilation, les fichiers suivants sont générés dans le répertoire dist à la racine de ce module :

• d-inkmap.js et d-inkmap.css : contiennent le code source et les feuilles de style utilisées par D-InkMap

  ces fichiers sont générés par Webpack

• le répertoire vendor contient les fichiers d-inkmap-required.js et d-inkmap-required.css; ces deux fichiers contiennent l'intégralité des dépendances requises par D-InkMap

  ces fichiers sont générés par le script src/build/build.js

• tous les autre fichiers (images, polices, ...) sont des ressources requises pour le bon fonctionnement du composant

Développement du composant

Pour lancer les exemples D-InkMap :

$ npm run dev

Si besoin, pour spécifier un port : npm run dev -- --port=8989. Le port par défaut est 8080.

L'index des examples est accessible sur http://localhost:8080. Les exemples se rafraichissent automatiquement en cas de changement dans les fichiers source.

Note : Le répertoire dist ainsi que les répertoires /test/manuel et /node_modules sont rendus accessibles à la racine du serveur.

Publication