Flutter数学公式渲染插件flutter_math的使用
Flutter数学公式渲染插件flutter_math的使用
插件简介
flutter_math 是一个基于纯 Dart 和 Flutter 实现的数学公式渲染插件。该项目旨在与 KaTeX 项目保持最大兼容性,并在性能上发挥 Dart 和 Flutter 的优势。未来还将尝试加入对 UnicodeMath 风格公式的编辑支持。
其 TeX 解析器是 KaTeX 解析器的 Dart 移植版本。与原始 KaTeX 解析器相比,只有少数功能未被支持或存在解析差异。具体不支持的功能可以查看 这里。
在线演示
渲染示例
示例 1:
公式:x = \frac{-b \pm \sqrt{b^2 - 4ac}}{2a}

示例 2:
公式: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)

示例 3:
公式:\hat f(\xi) = \int_{-\infty}^\infty f(x)e^{- 2\pi i \xi x}\mathrm{d}x

如何使用
1. 添加依赖
在 pubspec.yaml 文件中添加以下依赖:
dependencies:
flutter_math: ^0.2.0
然后运行 flutter pub get 安装依赖。
2. 支持平台
移动端
目前仅针对 Android 平台进行了测试。如果在 iOS 上遇到问题,请提交问题报告。
Web 端
从 v0.1.6 开始支持 Web 端。已测试通过 DomCanvas 后端,移动端和 Web 端的行为基本一致。但由于兼容性问题,不建议在 CanvasKit 后端下使用。可以在 在线演示 中查看效果。
API 使用说明(v0.2.0)
使用方法非常简单,只需调用 Math.tex() 方法即可渲染公式。
基本用法
// 显示样式公式
Math.tex(r'\frac a b', mathStyle: MathStyle.display) // 默认为显示样式
// 行内公式
Math.tex(r'\frac a b', mathStyle: MathStyle.text)
指定字体大小
默认字体大小由上下文决定。若要指定大小,可以使用 textStyle 参数。注意:此参数还会影响屏幕上的绝对单位(如 cm、pt、inch)的渲染尺寸。如果需要指定这些单位的实际大小,可以使用 logicalPpi 参数。
Math.tex(
r'\frac a b',
textStyle: TextStyle(fontSize: 42),
// logicalPpi: MathOptions.defaultLogicalPpiFor(42),
)
可选文本选择功能
SelectableMath 是一个可选变体,支持在移动和 Web 端对公式进行选择和复制操作(实验性功能)。用户可以选择公式的一部分并获取对应的 TeX 字符串。其使用方式类似于 Flutter 的 SelectableText。
SelectableMath.tex(r'\frac a b', textStyle: TextStyle(fontSize: 42))
自定义错误处理
如果需要自定义错误提示框,可以使用 onErrorFallback 参数。你还可以在此函数中处理错误信息。但请注意,此函数会在构建函数中调用。
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)),
),
)
手动解析公式
如果你需要更精细地控制公式渲染,可以直接手动调用解析器并传入抽象语法树(AST)。
SyntaxTree ast;
try {
ast = SyntaxTree(greenRoot: TexParser(r'\frac a b', TexParserSettings()).parse());
} on ParseException catch (e) {
// 处理解析错误
}
SelectableMath(
ast: ast,
mathStyle: MathStyle.text,
textStyle: TextStyle(fontSize: 42),
)
致谢
本项目得益于以下资源的启发和支持:
目标
- ✅ 已实现:TeX 数学公式解析
- ✅ 已实现:在 Flutter 中渲染抽象语法树(AST)
- ✅ 已实现:可选文本选择功能
- ✅ 已实现:输出 TeX (正在进行中)
- ❌ 未实现:UnicodeMath 解析与编码
- ❌ 未实现:UnicodeMath 风格编辑
- ❌ 未实现:可断行公式
- ❌ 未实现:MathML 解析与编码
示例代码
以下是完整的示例代码:
import 'package:flutter/material.dart';
import 'demo.dart';
import 'equations.dart';
import 'feature.dart';
void main() {
runApp(MyApp());
}
class MyApp extends StatelessWidget {
[@override](/user/override)
Widget build(BuildContext context) => MaterialApp(
title: 'Flutter Math Demo v0.2.0',
theme: ThemeData(
primarySwatch: Colors.blue,
visualDensity: VisualDensity.adaptivePlatformDensity,
),
home: DefaultTabController(
length: 3,
child: Scaffold(
appBar: AppBar(
title: Text(
'Flutter Math Demo v0.2.0',
),
bottom: TabBar(tabs: [
Text('Interactive Demo'),
Text('Equation Samples'),
Text('Supported Features'),
]),
),
body: TabBarView(children: [
DemoPage(),
EquationsPage(),
FeaturePage(),
]),
),
),
);
}
更多关于Flutter数学公式渲染插件flutter_math的使用的实战教程也可以访问 https://www.itying.com/category-92-b0.html
更多关于Flutter数学公式渲染插件flutter_math的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html
flutter_math 是一个用于在 Flutter 应用中渲染数学公式的插件。它基于 LaTeX 语法,可以用来显示复杂的数学公式。以下是如何使用 flutter_math 插件的基本步骤:
1. 添加依赖
首先,在 pubspec.yaml 文件中添加 flutter_math 依赖:
dependencies:
flutter:
sdk: flutter
flutter_math: ^0.5.0
然后运行 flutter pub get 来安装依赖。
2. 导入包
在需要使用 flutter_math 的 Dart 文件中导入包:
import 'package:flutter_math/flutter_math.dart';
3. 使用 Math.tex 渲染公式
flutter_math 提供了 Math.tex 小部件来渲染 LaTeX 公式。你可以直接在 Flutter 的 Widget 树中使用它:
import 'package:flutter/material.dart';
import 'package:flutter_math/flutter_math.dart';
class MathFormulaScreen extends StatelessWidget {
[@override](/user/override)
Widget build(BuildContext context) {
return Scaffold(
appBar: AppBar(
title: Text('Math Formula Example'),
),
body: Center(
child: Column(
mainAxisAlignment: MainAxisAlignment.center,
children: [
Math.tex(
r'\frac{a}{b} + \sqrt{c}',
textStyle: TextStyle(fontSize: 24),
),
SizedBox(height: 20),
Math.tex(
r'\int_{a}^{b} x^2 \,dx',
textStyle: TextStyle(fontSize: 24),
),
SizedBox(height: 20),
Math.tex(
r'\sum_{i=1}^{n} i = \frac{n(n+1)}{2}',
textStyle: TextStyle(fontSize: 24),
),
],
),
),
);
}
}
4. 自定义样式
你可以通过 textStyle 参数来自定义公式的字体大小、颜色等样式:
Math.tex(
r'\frac{a}{b} + \sqrt{c}',
textStyle: TextStyle(fontSize: 24, color: Colors.blue),
),
5. 处理复杂的公式
flutter_math 支持大多数 LaTeX 数学符号和命令。你可以渲染复杂的公式,如矩阵、方程组等:
Math.tex(
r'\begin{pmatrix} a & b \\ c & d \end{pmatrix}',
textStyle: TextStyle(fontSize: 24),
),
6. 注意事项
flutter_math目前可能不支持所有的 LaTeX 命令和符号,具体支持情况可以参考插件的文档。- 如果你需要更复杂的数学公式渲染功能,可能需要考虑其他解决方案,如使用 WebView 加载 MathJax 或 KaTeX。
7. 示例代码
以下是一个完整的示例代码,展示了如何在 Flutter 应用中使用 flutter_math:
import 'package:flutter/material.dart';
import 'package:flutter_math/flutter_math.dart';
void main() {
runApp(MyApp());
}
class MyApp extends StatelessWidget {
[@override](/user/override)
Widget build(BuildContext context) {
return MaterialApp(
title: 'Flutter Math Example',
theme: ThemeData(
primarySwatch: Colors.blue,
),
home: MathFormulaScreen(),
);
}
}
class MathFormulaScreen extends StatelessWidget {
[@override](/user/override)
Widget build(BuildContext context) {
return Scaffold(
appBar: AppBar(
title: Text('Math Formula Example'),
),
body: Center(
child: Column(
mainAxisAlignment: MainAxisAlignment.center,
children: [
Math.tex(
r'\frac{a}{b} + \sqrt{c}',
textStyle: TextStyle(fontSize: 24),
),
SizedBox(height: 20),
Math.tex(
r'\int_{a}^{b} x^2 \,dx',
textStyle: TextStyle(fontSize: 24),
),
SizedBox(height: 20),
Math.tex(
r'\sum_{i=1}^{n} i = \frac{n(n+1)}{2}',
textStyle: TextStyle(fontSize: 24),
),
SizedBox(height: 20),
Math.tex(
r'\begin{pmatrix} a & b \\ c & d \end{pmatrix}',
textStyle: TextStyle(fontSize: 24),
),
],
),
),
);
}
}

