Sketch
SketchDocs
by FileKit Studio
Diagram SDK

Quickstart

Getting started with the <Diagram /> component in 60 seconds.

Quickstart

Using @filekit-studio/diagram requires only three simple steps:


1. Install the Packages

npm install @filekit-studio/diagram @filekit-studio/sketch

Ensure @filekit-studio/sketch/styles.css is imported in your root layout.


2. Define Your Architecture in JSON

Declare your nodes and relationships:

data/architecture.ts
import type { DiagramData } from "@filekit-studio/diagram";

export const pipelineData: DiagramData = {
  title: "Payment Processing Flow",
  direction: "LR",
  nodes: [
    { id: "frontend", label: "React Frontend", shape: "rounded", color: "indigo", badge: "UI" },
    { id: "auth", label: "Auth Guard", shape: "diamond", color: "amber", badge: "SEC" },
    { id: "processor", label: "Payment Processor", shape: "rounded", color: "purple" },
    { id: "database", label: "PostgreSQL DB", shape: "cylinder", color: "emerald", badge: "SQL" }
  ],
  edges: [
    { from: "frontend", to: "auth", label: "Login / Token" },
    { from: "auth", to: "processor", label: "Authorized" },
    { from: "processor", to: "database", label: "Save Record" }
  ]
};

3. Mount the <Diagram /> Component

app/page.tsx
"use client";

import React from "react";
import { Diagram } from "@filekit-studio/diagram";
import { pipelineData } from "@/data/architecture";

export default function ArchitecturePage() {
  return (
    <div className="w-full h-[500px] rounded-xl overflow-hidden border">
      <Diagram data={pipelineData} mode="viewer" autoFit={true} />
    </div>
  );
}

Live Output

Here is the live output of the 60-second example above:

Payment Processing Flow
Loading diagram canvas...

On this page