InkLayer CoreOne PDF engine for every web framework

Build your product UI. Let Core handle PDF viewing, annotations, keyword review, secure output, and export.

Get started

API reference

Live demo

PDF document with a text highlight and a selected freehand annotation.

Use your framework of choice

Use the same Core API in React, Vue, Svelte, Angular, Web Components, or plain TypeScript.

Core handles PDF behavior

Viewing, annotations, zoom, search, watermarks, print, and export live in Core, while your application controls the interface and workflow.

Annotations built in and extensible

Start with sixteen types for highlights, text, shapes, signatures, and more, then define your own tools when needed.

Review prepared keyword rules

Batch-scan literal terms and regular expressions, preview matches by rule, review occurrences, and create permanent highlights.

Export securely redacted copies

Keep matches readable while reviewing, then flatten approved coverings into a new image-only PDF with no copyable source text.

Controlled from mount to teardown

Cancel in-progress loads, destroy instances cleanly, run isolated viewers side by side, and import Core safely during SSR.

Start with Core

Install Core, provide two host elements, give the scroll container an explicit size, and load a PDF.

bash

npm install @inklayer-dev/core

html

<div id="pdf-workspace">
  <div id="pages"></div>
</div>

css

html, body, #pdf-workspace {
  height: 100%;
  margin: 0;
}

#pages {
  height: 100%;
  overflow: auto;
  background: #f2f4f7;
}

import { createInkLayer } from '@inklayer-dev/core/capabilities'
import '@inklayer-dev/core/style'

const root = document.querySelector<HTMLElement>('#pdf-workspace')!
const pages = document.querySelector<HTMLElement>('#pages')!

const core = await createInkLayer({
  root,
  pageFlow: { container: pages, scale: 'page-width' }
})
await core.load({ url: '/documents/review.pdf', range: 'auto' })

Getting started →

NOTE

InkLayer Core is headless: it owns PDF and annotation behavior while your framework owns the toolbar, panels, and workflow.

From keyword rules to safe output

Pass Core a prepared set of terms or regular expressions—such as contract clauses, prohibited wording, account numbers, or dates. The Highlighter scans them together, previews matches in each rule's color, and gives your application an immutable review state. Accepted matches can become permanent Highlight annotations.

When matched text is sensitive, reuse the reviewed ranges to print or export a securely redacted copy. The on-screen review remains readable and color-coded; the generated PDF uses opaque coverings and image-only pages, so it contains no source text that can be selected from beneath a black box. Image-only output also flattens all other text, links, forms, and vector content.

Keyword Highlighter guide → · Secure redaction guide → · Highlighter demo → · Redaction demo →

Choose your next task

Load PDF → · Create your first annotation → · Create your first keyword highlight → · Create your first keyword redaction → · Print and export →

Extend only when you need to

Capability plugins connect one instance to application services such as logging, annotation storage, text input, printing, and downloads. Annotation Type Definitions add namespaced drawing tools. However you extend it, Core retains control of coordinates, validation, interaction, rendering, output, and cleanup.

Build your first plugin →