Sketch
SketchDocs
by FileKit Studio
Whiteboard SDK

Overview

Getting started with the @filekit-studio/sketch whiteboard engine.

Whiteboard SDK

@filekit-studio/sketch is a full-featured, local-first interactive whiteboard engine for React and Next.js.

It features:

  • Freehand Drawing & Geometric Shapes: Rectangle, diamond, ellipse, cloud, cylinder, sticky notes, and text.
  • Magnetic Arrow Connectors: Smart connection bindings to element anchor points with straight, curved, and elbow S-curves.
  • 54 Granular UI Flags: Toggle any toolbar button, modal, or overlay individually via SketchUIConfig.
  • Export Engine: Export high-resolution PNG, vector SVG, multi-page vector PDF, and native JSON.

Live Interactive Whiteboard Embed

Below is an interactive <SketchViewer /> embed. Try panning with your mouse or zooming with the controls:

Whiteboard Canvas Embed
Loading whiteboard canvas...

Two Core Modes

  1. <SketchEditor />: The full-featured whiteboard editor with drawing tools, color palettes, undo/redo, stencils, and export menus.
  2. <SketchViewer />: A lightweight, read-only viewer for embedding drawings and architecture diagrams into documentation and blog posts.

On this page