flutter pub add span_builder基于插件公开信息、社区数据与项目使用情况整理的选型参考。
SpanBuilder 是一个 Flutter/Dart 包，旨在简化从纯文本创建富文本段落的过程，便于集成样式化文本、链接和交互元素。它会自动管理 GestureRecognizers 的释放，防止内存泄漏并提升性能。适用于包含嵌入式交互的动态文本渲染，例如可点击的标签或提及。该包支持简洁的声明式语法，用于构建复杂的文本布局，而无需手动管理生命周期。
以下为关联源码仓库的 README 原文快照，最新内容请访问源码仓库。
Facilitates creation of spans from plain text and provides an automated disposal of GestureRecognizers.
Given some plain text, e.g.: "The quick brown fox" allows you to apply multiple spans at multiple positions. Positions can be specified by a matching word (whereText), e.g. "brown" and/or range from=10, to=15. Spans are subclasses of InlineSpan. If the span you are trying to apply is TextSpan you don't need to pass whereText as it will be inferred from text within the provided span.
Once you are done using SpanBuilder, use build() to return calculated list of spans. Spans can't overlap.
final spans = SpanBuilder("The quick brown fox")
.apply(TextSpan(text: "brown", style: TextStyle(fontWeight: FontWeight.bold)))
.apply(TextSpan(text: "🦊"), whereText: "fox")
.build()
From there you can use these spans in your RichText, e.g.:
RichText(
text: TextSpan(children: spans)
)
If you plan to make your text "tappable" read on.
If you try passing GestrueRecognizer as a field in TextSpan it will get stripped away - HERE IS WHY.
TL;DR: We don't want to leak GestureRecognizer but TextSpan has no idea about the lifecycle of Widget so you need a stateful widget to keep a reference to the recognizer untill you're done with it. Sounds like a mess, right?
The workaround is to provide a builder for the recognizer like this:
apply(TextSpan(text: "jumps"),
recognizerBuilder: () => TapGestureRecognizer()..onTap = () {
// your code here
})
Then you can use this SpanBuilder together with SpanBuilderWidget which will manage creating and disposing of TapGestrueRecognizer at the right time:
SpanBuilderWidget(
text: SpanBuilder("fox jumps")
..apply(TextSpan(text: "jumps"),
recognizerBuilder: () => TapGestureRecognizer()..onTap = () {
// your code here
})
)
If you care only about onTap interaction you can use this API shortcut:
apply(TextSpan(text: "jumps"),
onTap: () {
// your code here
}
)
There are little resources on how to test RichText in general. For this reason there is helper testing library span_builder_test that can help you verify state of your spans in your UI tests.
void main() {
testWidgets('MyApp test', (WidgetTester tester) async {
await tester.pumpWidget(MyApp());
final spanFinder = find.byKey(span_key);
expect(spanFinder, findsOneWidget);
final allSpans = tester.findSpans(spanFinder).length;
expect(allSpans, 8);
final foxSpans = tester.findSpans(spanFinder, predicate: (span) {
return span is TextSpan && span.text == "🦊";
});
expect(foxSpans.length, 1);
});
}
WidgetTest helpers and extensions for testing span_builder
This is a companion library to the span_builder library intended to help you write test wherever that library is used.
暂无相关数据。