パッケージ、リポジトリ、アプリカテゴリを検索

flutter_math_fork のカバー
パッケージ詳細v0.7.4

flutter_math_fork

純粋なDartおよびFlutterを使用した高速かつ高品質なTeX数式レンダリング。

AndroidiOSWebmacOSWindowsLinux
30日間ダウンロード
33.1万
いいね数
172
Pub ポイント
140

パッケージをインストール

flutter pub add flutter_math_fork

パッケージ概要

公開情報に基づく選定ガイドです。参考としてご利用ください。

精度と速度を兼ね備えたTeX数式をレンダリングするための高性能なDartおよびFlutterパッケージです。flutter_mathのフォークとして構築されており、純粋なDartを使用してFlutterアプリに数学式をスムーズに統合できるようにし、Android、iOS、Web、macOS、Windows、Linuxなどすべての主要プラットフォームで互換性を確保しています。教育アプリや科学ツール、正確な式表示が必要なあらゆるアプリに最適です。

用途

  • 教育アプリ
  • 科学計算機
  • 数学コンテンツのレンダリング
  • インタラクティブな学習プラットフォーム
  • ドキュメントビューア

主な機能

  • 純粋な Dart 実装
  • 高速レンダリング
  • クロスプラットフォーム対応
  • TeX構文の互換性
  • カスタマイズ可能なスタイル

適している対象

  • 数学的な計算が重いアプリを開発する開発者
  • 教育技術プロジェクト
  • 正確な式表示を必要とするアプリ
  • 軽量な数式レンダリングを求めるFlutter開発者

注意事項

  • 基本的な TeX 機能に限定
  • 高度なLaTeXパッケージのサポートなし
  • レンダリングの品質はフォントの利用可能性に依存します
  • 複雑な方程式には調整が必要になる場合があります

元の README

関連するソースリポジトリの README 原文のスナップショットです。最新の内容はリポジトリをご覧ください。

Flutter Math

Build Status codecov Pub Version

⚠ fork

This is a fork of flutter_math addressing compatibility problems while flutter_math is not being maintained.


Math equation rendering in pure Dart & Flutter.

This project aims to achieve maximum compatibility and fidelity with regard to the KaTeX project, while maintaining the performance advantage of Dart and Flutter. A further UnicodeMath-style equation editing support will be experimented in the future.

The TeX parser is a Dart port of the KaTeX parser. There are only a few unsupported features and parsing differences compared to the original KaTeX parser. List of some unsupported features can be found here.

Online Demo

Rendering Samples

x = \frac{-b \pm \sqrt{b^2 - 4ac}}{2a}

Example1

i\hbar\frac{\partial}{\partial t}\Psi(\vec x,t) = -\frac{\hbar}{2m}\nabla^2\Psi(\vec x,t)+ V(\vec x)\Psi(\vec x,t)

Example2

\hat f(\xi) = \int_{-\infty}^\infty f(x)e^{- 2\pi i \xi x}\mathrm{d}x

Example3

How to use

Add flutter_math to your pubspec.yaml dependencies

Mobile

Currently only Android platform has been tested. If you encounter any issues with iOS, please file them.

Web

Web support is added in v0.1.6. It is tested for DomCanvas backend. In general it should behave largely the same with mobile. It is expected to break with CanvasKit backend. Check out the Online Demo

API usage (v0.2.0)

The usage is straightforward. Just Math.tex(r'\frac a b'). There is also optional arguments of TexParserSettings settings, which corresponds to Settings in KaTeX and support a subset of its features.

Display-style equations:

Math.tex(r'\frac a b', mathStyle: MathStyle.display) // Default

In-line equations

Math.tex(r'\frac a b', mathStyle: MathStyle.text)

The default size of the equation is obtained from the build context. If you wish to specify the size, you can use textStyle. Note: this parameter will also change how big 1cm/1pt/1inch is rendered on the screen. If you wish to specify the size of those absolute units, use logicalPpi

Math.tex(
  r'\frac a b',
  textStyle: TextStyle(fontSize: 42),
  // logicalPpi: MathOptions.defaultLogicalPpiFor(42),
)

There is also a selectable variant SelectableMath that creates selectable and copy-able equations on both mobile and web. (EXPERIMENTAL) Users can select part of the equation and obtain the encoded TeX strings. The usage is similar to Flutter's SelectableText.

SelectableMath.tex(r'\frac a b', textStyle: TextStyle(fontSize: 42))

If you would like to display custom styled error message, you should use onErrorFallback parameter. You can also process the errors in this function. But beware this function is called in build function.

Math.tex(
  r'\garbled $tring', 
  textStyle: TextStyle(color: Colors.green),
  onErrorFallback: (err) => Container(
    color: Colors.red,
    child: Text(err.messageWithType, style: TextStyle(color: Colors.yellow)),
  ),
)

If you wish to have more granularity dealing with equations, you can manually invoke the parser and supply AST into the widget.

SyntaxTree ast;
try {
  ast = SyntaxTree(greenRoot: TexParser(r'\frac a b', TexParserSettings()).parse());
} on ParseException catch (e) {
  // Handle my error here
}

SelectableMath(
  ast: ast,
  mathStyle: MathStyle.text,
  textStyle: TextStyle(fontSize: 42),
)

Line Breaking

Credits

This project is possible thanks to the inspirations and resources from the KaTeX Project, MathJax, Zefyr, and CaTeX.

Goals

  • [x] : TeX math parsing (See design doc)
  • [x] : AST rendering in flutter
  • [x] : Selectable widget
  • [x] : TeX output (WIP)
  • [ ] : UnicodeMath parsing and encoding
  • [ ] : UnicodeMath-style editing
  • [ ] : Breakable equations
  • [ ] : MathML parsing and encoding

カテゴリー

依存関係

依存関係一覧 5 件

ソースリポジトリ

このパッケージを使用しているプロジェクト