katex 1.0.0

A Flutter widget that renders LaTeX math by painting the backend-agnostic box tree from the pure-Dart katex_dart package. KaTeX in Flutter.

katex

A Flutter widget that renders LaTeX math by painting the backend-agnostic box tree produced by the pure-Dart katex_dart package. No re-parsing — the widget is a direct consumer of the same box tree the SVG serializer uses.

See Flutter demo at roszkowski.dev/katex.

See main README for a comparison with other Flutter math libraries, and for the architecture of the katex_dart + katex combo.

Usage

import 'package:katex/katex.dart';

Math(r'\frac{a}{b}');                          // inline
Math(r'\sum_{i=0}^n i', displayMode: true);    // display
Math(r'x^2', fontSize: 24, color: Colors.indigo);
Math(r'\frac{a}', throwOnError: false,         // graceful error handling
     onError: (context, e) => Text('bad: $e'));

See example/ for a runnable gallery demo.

How it works

The katex_dart package parses the TeX into a BoxNode tree once; Math paints it with a CustomPainter — GlyphNode → TextPainter (using the bundled KaTeX_* fonts), RuleNode → drawRect, SvgPathNode → drawPath. Glyph baselines, kerning, and vlist positioning mirror the katex_dart SVG serializer so both backends render identically.

License

MIT — see LICENSE. Ported from KaTeX (MIT). Bundled fonts are SIL OFL (fonts/OFL.txt).

Previous katex library

The previous katex library is now deprecated and available on GitHub. The previous library was a wrapper around the original KaTeX JavaScript library. Thank you, Adam, for handing over the package to me. The new katex library is a pure Dart implementation of KaTeX, with no JavaScript dependency.