|
| 1 | +# @gravity-ui/graph |
| 2 | + |
| 3 | +> @gravity-ui/graph is a graph visualization library that combines the best of both worlds: Canvas for high performance when viewing the full graph and HTML/React for rich interactions when zoomed in. |
| 4 | + |
| 5 | +Key features: |
| 6 | +- High-performance Canvas rendering for displaying the full graph |
| 7 | +- Automatic switching to HTML/React mode when zooming in for interactive elements |
| 8 | +- Smart system that tracks visible blocks and renders only them in React |
| 9 | +- Extensible architecture through layers (custom rendering layers that act as plugins) |
| 10 | +- Full TypeScript support |
| 11 | +- Organized rendering system with layer-based architecture |
| 12 | + |
| 13 | +## Quick Start & Common Scenarios |
| 14 | + |
| 15 | +- [Getting Started with React](https://raw.githubusercontent.com/gravity-ui/graph/refs/heads/main/docs/react/usage.md): Creating your first graph component with React |
| 16 | +- [Layer Development](https://raw.githubusercontent.com/gravity-ui/graph/refs/heads/main/docs/system/component-lifecycle.md): Creating custom layers (the library's extension mechanism) |
| 17 | +- [Built-in Layers](https://raw.githubusercontent.com/gravity-ui/graph/refs/heads/main/docs/system/graph-settings.md#layers): Overview of available layers like ELK for auto-layout and Minimap |
| 18 | +- [Custom Layer Examples](https://raw.githubusercontent.com/gravity-ui/graph/refs/heads/main/docs/system/component-rendering-lifecycle.md): Examples of custom layer implementation |
| 19 | +- [Event System & Interactions](https://raw.githubusercontent.com/gravity-ui/graph/refs/heads/main/docs/system/events.md): Working with events and user interactions |
| 20 | +- [Graph Configuration](https://raw.githubusercontent.com/gravity-ui/graph/refs/heads/main/docs/system/graph-settings.md): Configuring graph behavior and appearance |
| 21 | + |
| 22 | +## Core Documentation |
| 23 | + |
| 24 | +- [Public API](https://raw.githubusercontent.com/gravity-ui/graph/refs/heads/main/docs/system/public_api.md): Main API for interacting with the graph |
| 25 | +- [Graph Settings](https://raw.githubusercontent.com/gravity-ui/graph/refs/heads/main/docs/system/graph-settings.md): Graph settings and configuration |
| 26 | +- [Component Lifecycle](https://raw.githubusercontent.com/gravity-ui/graph/refs/heads/main/docs/system/component-lifecycle.md): Component and layer lifecycle management |
| 27 | +- [Component Rendering](https://raw.githubusercontent.com/gravity-ui/graph/refs/heads/main/docs/system/component-rendering-lifecycle.md): Component rendering process |
| 28 | +- [Event System](https://raw.githubusercontent.com/gravity-ui/graph/refs/heads/main/docs/system/events.md): Event system and interactions |
| 29 | +- [Scheduler System](https://raw.githubusercontent.com/gravity-ui/graph/refs/heads/main/docs/system/scheduler-system.md): Scheduling and optimization system |
| 30 | + |
| 31 | +## React Integration |
| 32 | + |
| 33 | +- [React Usage Guide](https://raw.githubusercontent.com/gravity-ui/graph/refs/heads/main/docs/react/usage.md): Guide for using with React |
| 34 | + |
| 35 | +## Optional |
| 36 | + |
| 37 | +- [Blocks Documentation](https://raw.githubusercontent.com/gravity-ui/graph/refs/heads/main/docs/blocks/): Documentation about graph blocks |
| 38 | +- [Connections Documentation](https://raw.githubusercontent.com/gravity-ui/graph/refs/heads/main/docs/connections/): Documentation about connections |
| 39 | +- [Components Documentation](https://raw.githubusercontent.com/gravity-ui/graph/refs/heads/main/docs/components/): Documentation about components |
| 40 | +- [Rendering Documentation](https://raw.githubusercontent.com/gravity-ui/graph/refs/heads/main/docs/rendering/): Detailed documentation about the rendering system |
0 commit comments