TopoKit Documentation
Everything you need to build production-grade graph visualizations with TopoKit. From installation to advanced performance tuning, this documentation covers every aspect of the SDK.
TopoKit is a TypeScript-native graph visualization SDK designed for the modern web. It ships as four composable packages that give you full control over your graph data model, layout algorithms, canvas rendering, and React integration.
Getting Started
Install TopoKit and create your first graph visualization in under 5 minutes.
Core Concepts
Understand the graph model, node and edge structures, events, and theming system.
Features
Explore layouts, filtering, edge bundling, clustering, progressive expand, and more.
Components
Built-in UI components: legend, badges, minimap, toolbar, search, tooltips, and panels.
Advanced
Web Worker layout, performance optimization, white-label mode, and licensing details.
API Reference
Complete reference of all classes, methods, configuration options, and React hooks.
Package Overview
| Package | Description | Dependencies |
|---|---|---|
@topokit/core | Graph data model, event system, themes | None (zero dependencies) |
@topokit/layouts | 7 layout algorithms (force, hierarchical, circular, dagre, radial, concentric, grid) | @topokit/core |
@topokit/renderer-canvas | Canvas 2D renderer with all UI components | @topokit/core, @topokit/layouts |
@topokit/react | React 18+ hooks and components | All of the above |