Getting Started

typst_flutter is the easiest way to bring professional typesetting to your Flutter apps. Because it utilizes prebuilt Rust binaries, you don’t even need a Rust toolchain to get started.

Installation

Add the package to your Flutter project’s pubspec.yaml:

flutter pub add typst_flutter

Setup (required once)

After adding the package, run the setup script from your app root:

flutter pub get
dart run typst_flutter:setup

This downloads the prebuilt native Typst libraries (~15MB) from GitHub Releases and caches them in your pub cache. You only need to do this once per version upgrade — no Rust toolchain required.

Why is this step needed? pub.dev has a 100MB package size limit. The native .so/.dll/.a binaries live on GitHub Releases instead, and this script fetches the right one for your platform automatically.

Build-time auto-download

The native build scripts (Gradle for Android, CocoaPods for iOS/macOS, CMake for Linux/Windows) will attempt to run dart run typst_flutter:setup automatically if the binaries aren’t already present when you build. This is a best-effort convenience — if it fails for any reason (no internet, permission issue, etc.), just run the command manually from your app root and rebuild:

dart run typst_flutter:setup

Default Built-in Fonts

By default, the compiler is lightweight but comes bundled with the following core fonts to ensure your basic documents and math formulas render perfectly out of the box:

Libertinus Serif (Regular) - The default serif font for Typst.
DejaVu Sans Mono - The default monospaced font for code blocks.
NewCM Math (Book) - The default font for rendering complex mathematical formulas.

If you need additional fonts (e.g., custom brand fonts or emoji fonts), you can pass them via the FontSource API when calling TypstCompiler.create().

Basic Usage (PDF Generation)

Use TypstCompiler.create() to initialize the engine, and pass your Typst source code to compile a high-quality PDF:

import 'package:typst_flutter/typst_flutter.dart';

// 1. Initialize the compiler (loads the native binaries)
final compiler = await TypstCompiler.create();

// 2. Compile your source code to an opaque handle
final doc = await compiler.compile(
  source: r'''
    #set page(width: 148mm, height: 210mm, margin: 1cm)

    = Hello Typst!

    This is rendered *natively* in Flutter.
  ''',
);

// 3. Export to PDF bytes
final pdfBytes = await doc.exportPdf();

print('Generated a ${doc.pageCount}-page PDF (${pdfBytes.length} bytes).');

// Don't forget to dispose the document when you're done!
doc.dispose();

You can then pass pdfBytes to packages like printing or save it to the device’s file system using path_provider.

If you want to display Typst documents directly in your UI (like a real-time editor), use the TypstDocumentViewer widget. It automatically manages the compilation lifecycle.

import 'package:flutter/material.dart';
import 'package:typst_flutter/typst_flutter.dart';

class TypstPreview extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return TypstDocumentViewer(
      source: r'''
        = Multi-page Viewer
        This document spans multiple pages.
        #pagebreak()
        And scrolling is instantly fast because the document handle is immutable!
      ''',
      renderMode: TypstRenderMode.svg, // Use SVG for crisp vector rendering
    );
  }
}

Advanced: Building from Source (Cargokit fallback)

If the prebuilt binaries aren’t available for your target (e.g. an unsupported architecture or a fully-offline build machine), and the auto-download also fails, Android and iOS builds will fall back to Cargokit, which compiles the Rust core from scratch.

To use the source-compilation fallback, install Rust on your build machine. First-time compilation will take 5–15 minutes depending on your CPU.

Linux and Windows desktop builds do not have a Cargokit fallback — they will emit a clear error message asking you to run dart run typst_flutter:setup.