npm
@clipmind/mindmap

Package NPM

Créez des cartes mentales directement dans vos projets JavaScript ou TypeScript. Le package @clipmind/mindmap fournit une API puissante et flexible pour créer, manipuler et exporter des cartes mentales professionnelles.

Installation

Installez le package en utilisant npm, yarn, ou pnpm :

Terminalbash
# Using npm
npm install @clipmind/mindmap

# Using yarn
yarn add @clipmind/mindmap

# Using pnpm
pnpm add @clipmind/mindmap

Démarrage Rapide

Voici un exemple simple de création et d'exportation d'une carte mentale :

ExempleTypeScript
import { useEffect, useState } from 'react';
import { MindMapEditor, generateStore, loadFromMarkdown } from '@clipmind/mindmap';
import styled from 'styled-components';
import type { MindMapStore } from '@clipmind/mindmap';

const Container = styled.div`
  width: 100vw;
  height: 100vh;
  display: flex;
  flex-direction: column;
  align-items: center;
  justify-content: center;
`;

export function MindmapDemo() {
  const [store, setStore] = useState<MindMapStore | null>(null);

  useEffect(() => {
    // generateStore is async to ensure fonts are loaded before layout calculation
    generateStore().then(s => {
      loadFromMarkdown('# Hello World\n\n## Item 1\n### Item 1.1\n## Item 2', s);
      setStore(s);
    });
  }, []);

  if (!store) {
    return <Container>{'Loading...'}</Container>;
  }

  return (
    <Container>
      <MindMapEditor store={store} />
    </Container>
  );
}

Fonctionnalités

Prise en charge de TypeScript

Prise en charge complète de TypeScript avec des définitions de types exhaustives pour une meilleure expérience de développement.

Mises en page multiples

Choisissez parmi 6 types de mise en page différents pour visualiser au mieux vos idées et vos données.

56+ Thèmes

Une bibliothèque riche de thèmes de couleurs pour correspondre à votre marque ou à vos préférences personnelles.

Formats d'export multiples

Exportez vos cartes mentales aux formats SVG, PNG ou PDF avec des options personnalisables.

Dispositions disponibles

Choisissez parmi 6 types de dispositions pour organiser vos cartes mentales :

M
Mindmap
L
Logic
O
Org
T
Tree
F
Fishbone
TL
Timeline

Bibliothèque de thèmes

Plus de 56 thèmes de couleurs intégrés pour personnaliser vos cartes mentales :

+44 de plus

API principale

MéthodeDescription
generateStore()Initialiser une nouvelle instance de MindMapStore.
loadFromMarkdown(md)Charger la structure de la carte mentale à partir d'une chaîne Markdown.
addChildNode(parentId)Ajouter un nouveau nœud enfant au parent spécifié.
deleteNodes(nodeIds)Supprimer des nœuds par leurs identifiants.
setNodeText(nodeId, text)Mettre à jour le contenu textuel d'un nœud.
setLayout(type)Changer le type de mise en page de la carte mentale.
setTheme(name)Appliquer un thème de couleurs à la carte mentale.
saveSvg()Exporter la carte mentale en fichier SVG.
savePng()Exporter la carte mentale en image PNG.
savePdf()Exporter la carte mentale en document PDF.

Commencer

Prêt à créer des cartes mentales dans votre projet ? Consultez la documentation complète pour une référence API détaillée et plus d'exemples.

Voir la Documentation Complète