API Reference

@univerjs-pro/ink

Reusable ink model, geometry, and custom shape integration for Web SDK editors.

TypeScript
import { UniverInkPlugin } from '@univerjs-pro/ink'univer.registerPlugin(UniverInkPlugin)

Entry Points

This package exports the plugin entry and ink model utilities.

For Board insertion, import @univerjs-pro/boards/facade and use FBoard.insertInk() / getInks(). That entry also provides IBoardInkFacadeInsertOptions and univerAPI.Enum.BoardInkTool, BoardInkPointType, and BoardInkHandleKind. See the Board Ink API.

How is this guide?

© 2026 DreamNum Co., Ltd.