npm
@clipmind/mindmap

NPMパッケージ

JavaScriptまたはTypeScriptプロジェクトで直接マインドマップを構築できます。@clipmind/mindmapパッケージは、プロフェッショナルなマインドマップの作成、操作、エクスポートのための強力で柔軟なAPIを提供します。

インストール

npm、yarn、またはpnpmを使用してパッケージをインストールします:

Terminalbash
# Using npm
npm install @clipmind/mindmap

# Using yarn
yarn add @clipmind/mindmap

# Using pnpm
pnpm add @clipmind/mindmap

クイックスタート

マインドマップの作成とエクスポートの基本的な例:

TypeScript
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>
  );
}

機能

TypeScript サポート

包括的な型定義による完全なTypeScriptサポートで、より良い開発体験を提供します。

複数のレイアウト

6種類の異なるレイアウトタイプから選択し、アイデアやデータを最適に可視化できます。

56以上のテーマ

ブランドや個人の好みに合わせて選べる豊富なカラーテーマライブラリ。

複数のエクスポート形式

マインドマップをSVG、PNG、PDF形式で、カスタマイズ可能なオプション付きでエクスポートできます。

利用可能なレイアウト

マインドマップを整理する6種類のレイアウトから選択:

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

テーマライブラリ

マインドマップをカスタマイズする56以上の組み込みカラーテーマ:

+44 その他

コアAPI

メソッド説明
generateStore()新しいMindMapStoreインスタンスを初期化します。
loadFromMarkdown(md)マークダウン文字列からマインドマップ構造を読み込みます。
addChildNode(parentId)指定された親ノードに新しい子ノードを追加します。
deleteNodes(nodeIds)IDによるノードの削除
setNodeText(nodeId, text)ノードのテキスト内容の更新
setLayout(type)マインドマップのレイアウトタイプの変更
setTheme(name)マインドマップへのカラーテーマの適用
saveSvg()マインドマップのSVGファイルとしてのエクスポート
savePng()マインドマップのPNG画像としてのエクスポート
savePdf()マインドマップのPDFドキュメントとしてのエクスポート

はじめに

プロジェクトでマインドマップを作成する準備はできましたか?詳細なAPIリファレンスやその他の例については、完全なドキュメントをご確認ください。

完全なドキュメントを表示