fr.md

Mind Elixir

English 中文 Español Français Português Русский 日本語

Mind Elixir est un noyau JavaScript open source pour créer des cartes mentales. Vous pouvez l'utiliser avec n'importe quel framework frontend de votre choix.

Caractéristiques :

• Léger
• Haute performance
• Indépendant du framework
• Extensible via plugins
• Plugin intégré pour le glisser-déposer / édition de nœuds
• Export en SVG / PNG / Html
• Résumé des nœuds
• Opérations en masse supportées
• Annuler / Refaire
• Raccourcis efficaces
• Stylisation facile des nœuds avec les variables CSS

Table des matières

• Essayer maintenant
  • Playground
• Documentation
• Utilisation
  • Installation
    • NPM
    • Balise script
  • Initialisation
  • Structure des données
  • Gestion des événements
  • Export et import des données
  • Gardes d'opération
• Exporter en image
  • Solution 1
  • Solution 2
• APIs
• Thème
• Raccourcis
• Écosystème
• Développement
• Remerciements
• Contributeurs

Essayer maintenant

https://mind-elixir.com/

Playground

• Vanilla JS - https://codepen.io/ssshooter/pen/OJrJowN
• React - https://codesandbox.io/s/mind-elixir-3-x-react-18-x-vy9fcq
• Vue3 - https://codesandbox.io/s/mind-elixir-3-x-vue3-lth484
• Vue2 - https://codesandbox.io/s/mind-elixir-3-x-vue-2-x-5kdfjp

Documentation

https://docs.mind-elixir.com/

Utilisation

Installation

NPM

npm i mind-elixir -S

import MindElixir from 'mind-elixir'

Balise script

<script type="module" src="https://cdn.jsdelivr.net/npm/mind-elixir/dist/MindElixir.js"></script>

Initialisation

<div id="map"></div>
<style>
  #map {
    height: 500px;
    width: 100%;
  }
</style>

Changement majeur depuis la version 1.0.0, data doit être passé à init(), et non options.

import MindElixir from 'mind-elixir'
import example from 'mind-elixir/dist/example1'

let options = {
  el: '#map', // ou HTMLDivElement
  direction: MindElixir.LEFT,
  draggable: true, // par défaut true
  contextMenu: true, // par défaut true
  toolBar: true, // par défaut true
  nodeMenu: true, // par défaut true
  keypress: true, // par défaut true
  locale: 'en', // [zh_CN,zh_TW,en,ja,pt,ru] en attente de PRs
  overflowHidden: false, // par défaut false
  mainLinkStyle: 2, // [1,2] par défaut 1
  mouseSelectionButton: 0, // 0 pour le bouton gauche, 2 pour le bouton droit, par défaut 0
  contextMenuOption: {
    focus: true,
    link: true,
    extend: [
      {
        name: 'Édition de nœud',
        onclick: () => {
          alert('menu étendu')
        },
      },
    ],
  },
  before: {
    insertSibling(el, obj) {
      return true
    },
    async addChild(el, obj) {
      await sleep()
      return true
    },
  },
}

let mind = new MindElixir(options)

mind.install(plugin) // installer votre plugin

// créer de nouvelles données de carte
const data = MindElixir.new('nouveau sujet')
// ou `example`
// ou les données retournées par `.getData()`
mind.init(data)

// obtenir un nœud
MindElixir.E('node-id')

Structure des données

// structure complète des données de nœud jusqu'à présent
const nodeData = {
  topic: 'sujet du nœud',
  id: 'bd1c24420cd2c2f5',
  style: { fontSize: '32', color: '#3298db', background: '#ecf0f1' },
  expanded: true,
  parent: null,
  tags: ['Tag'],
  icons: ['😀'],
  hyperLink: 'https://github.com/ssshooter/mind-elixir-core',
  image: {
    url: 'https://raw.githubusercontent.com/ssshooter/mind-elixir-core/master/images/logo2.png', // requis
    // vous devez interroger la hauteur et la largeur de l'image et calculer la valeur appropriée pour afficher l'image
    height: 90, // requis
    width: 90, // requis
  },
  children: [
    {
      topic: 'enfant',
      id: 'xxxx',
      // ...
    },
  ],
}

Gestion des événements

mind.bus.addListener('operation', operation => {
  console.log(operation)
  // return {
  //   name: nom de l'action,
  //   obj: objet cible
  // }

  // name: [insertSibling|addChild|removeNode|beginEdit|finishEdit]
  // obj: cible

  // name: moveNode
  // obj: {from:cible1,to:cible2}
})

mind.bus.addListener('selectNode', node => {
  console.log(node)
})

mind.bus.addListener('expandNode', node => {
  console.log('expandNode: ', node)
})

Export et import des données

// export des données
const data = mind.getData() // objet javascript, voir src/example.js
mind.getDataString() // objet en chaîne
mind.getDataMd() // markdown

// import des données
// initialisation
let mind = new MindElixir(options)
mind.init(data)
// mise à jour des données
mind.refresh(data)

Gardes d'opération

let mind = new MindElixir({
  // ...
  before: {
    insertSibling(el, obj) {
      console.log(el, obj)
      if (this.currentNode.nodeObj.parent.root) {
        return false
      }
      return true
    },
    async addChild(el, obj) {
      await sleep()
      if (this.currentNode.nodeObj.parent.root) {
        return false
      }
      return true
    },
  },
})

Exporter en image

Solution 1

const mind = {
  /** instance mind elixir */
}
const downloadPng = async () => {
  const blob = await mind.exportPng() // Obtenez un Blob !
  if (!blob) return
  const url = URL.createObjectURL(blob)
  const a = document.createElement('a')
  a.href = url
  a.download = 'filename.png'
  a.click()
  URL.revokeObjectURL(url)
}

Solution 2

Installer @ssshooter/modern-screenshot, puis :

import { domToPng } from '@ssshooter/modern-screenshot'

const download = async () => {
  const dataUrl = await domToPng(mind.nodes, {
    onCloneNode: node => {
      const n = node as HTMLDivElement
      n.style.position = ''
      n.style.top = ''
      n.style.left = ''
      n.style.bottom = ''
      n.style.right = ''
    },
    padding: 300,
    quality: 1,
  })
  const link = document.createElement('a')
  link.download = 'screenshot.png'
  link.href = dataUrl
  link.click()
}

APIs

https://github.com/ssshooter/mind-elixir-core/blob/master/api/mind-elixir.api.md

Thème

const options = {
  // ...
  theme: {
    name: 'Dark',
    // palette de couleurs des lignes principales
    palette: ['#848FA0', '#748BE9', '#D2F9FE', '#4145A5', '#789AFA', '#706CF4', '#EF987F', '#775DD5', '#FCEECF', '#DA7FBC'],
    // remplacer les variables css
    cssVar: {
      '--main-color': '#ffffff',
      '--main-bgcolor': '#4c4f69',
      '--color': '#cccccc',
      '--bgcolor': '#252526',
      '--panel-color': '255, 255, 255',
      '--panel-bgcolor': '45, 55, 72',
    },
    // toutes les variables voir /src/index.less
  },
  // ...
}

// ...

mind.changeTheme({
  name: 'Latte',
  palette: ['#dd7878', '#ea76cb', '#8839ef', '#e64553', '#fe640b', '#df8e1d', '#40a02b', '#209fb5', '#1e66f5', '#7287fd'],
  cssVar: {
    '--main-color': '#444446',
    '--main-bgcolor': '#ffffff',
    '--color': '#777777',
    '--bgcolor': '#f6f6f6',
  },
})

Soyez conscient que Mind Elixir n'observera pas le changement de prefers-color-scheme. Veuillez changer le thème manuellement lorsque le schéma change.

Raccourcis

Raccourci	Fonction
Entrée	Insérer un nœud frère
Tab	Insérer un nœud enfant
F1	Centrer la carte
F2	Commencer l'édition du nœud actuel
↑	Sélectionner le nœud frère précédent
↓	Sélectionner le nœud frère suivant
← / →	Sélectionner le parent ou le premier enfant
PageUp / Alt + ↑	Déplacer le nœud vers le haut
PageDown / Alt + ↓	Déplacer le nœud vers le bas
Ctrl + ↑	Changer la disposition en mode latéral
Ctrl + ←	Changer la disposition vers la gauche
Ctrl + →	Changer la disposition vers la droite
Ctrl + C	Copier le nœud actuel
Ctrl + V	Coller le nœud copié
Ctrl + "+"	Zoomer la carte mentale
Ctrl + "-"	Dézoomer la carte mentale
Ctrl + 0	Réinitialiser le niveau de zoom

Écosystème

• @mind-elixir/node-menu
• @mind-elixir/node-menu-neo
• @mind-elixir/export-xmind
• @mind-elixir/export-html
• mind-elixir-react

Les PRs sont les bienvenues !

Développement

pnpm i
pnpm dev

Tester les fichiers générés avec dev.dist.ts :

pnpm build
pnpm link ./

Mettre à jour la documentation :

# Installer api-extractor
pnpm install -g @microsoft/api-extractor
# Maintenir /src/docs.ts
# Générer la documentation
pnpm doc
pnpm doc:md

Remerciements

• @viselect/vanilla

Contributeurs

Merci pour vos contributions à Mind Elixir ! Votre soutien et votre dévouement rendent ce projet meilleur.