为 TextEditingController.buildTextSpan 添加 BuildContext 参数
概述
#已向 TextEditingController.buildTextSpan 添加了 BuildContext 参数。
扩展或实现 TextEditingController 并覆盖 buildTextSpan 的类需要将 BuildContext 参数添加到签名中，使其成为一个有效的覆盖。
调用 TextEditingController.buildTextSpan 的调用者需要将 BuildContext 传递给该调用。
背景
#TextEditingController.buildTextSpan 由 EditableText 在其控制器上调用，以创建它渲染的 TextSpan。buildTextSpan 可以在扩展 TextEditingController 的自定义类中被覆盖。这允许扩展 TextEditingController 的类覆盖 buildTextSpan 以更改文本部分的样式，例如，用于富文本编辑。
buildTextSpan 所需的任何状态（除了 TextStyle 和 withComposing 参数）都需要传递给扩展 TextEditingController 的类。
变更说明
#通过可用的 BuildContext，用户可以在 buildTextSpan 中访问 InheritedWidgets，以检索样式文本所需的 state，或以其他方式操作创建的 TextSpan。
考虑一个示例，其中我们有一个 HighlightTextEditingController，它希望通过将文本颜色设置为 Theme.accentColor 来突出显示文本。
在此更改之前，控制器实现如下所示：
class HighlightTextEditingController extends TextEditingController {
HighlightTextEditingController(this.highlightColor);
final Color highlightColor;
@override
TextSpan buildTextSpan({TextStyle? style, required bool withComposing}) {
return super.buildTextSpan(style: TextStyle(color: highlightColor), withComposing: withComposing);
}并且控制器用户在创建控制器时需要传递颜色。
通过可用的 BuildContext 参数，HighlightTextEditingController 可以使用 Theme.of(BuildContext) 直接访问 Theme.accentColor。
class HighlightTextEditingController extends TextEditingController {
@override
TextSpan buildTextSpan({required BuildContext context, TextStyle? style, required bool withComposing}) {
final Color color = Theme.of(context).accentColor;
return super.buildTextSpan(context: context, style: TextStyle(color: color), withComposing: withComposing);
}
}迁移指南
#覆盖 TextEditingController.buildTextSpan
#在 buildTextSpan 覆盖的签名中添加一个 required BuildContext context 参数。
迁移前的代码
class MyTextEditingController {
@override
TextSpan buildTextSpan({TextStyle? style, required bool withComposing}) {
/* ... */
}
}迁移前示例错误消息
'MyTextEditingController.buildTextSpan' ('TextSpan Function({TextStyle? style, required bool withComposing})') isn't a valid override of 'TextEditingController.buildTextSpan' ('TextSpan Function({required BuildContext context, TextStyle? style, required bool withComposing})').迁移后的代码
class MyTextEditingController {
@override
TextSpan buildTextSpan({required BuildContext context, TextStyle? style, required bool withComposing}) {
/* ... */
}
}调用 TextEditingController.buildTextSpan
#将类型为 BuildContext 的命名参数 'context' 传递给调用。
迁移前的代码
TextEditingController controller = /* ... */;
TextSpan span = controller.buildTextSpan(withComposing: false);迁移前错误消息
The named parameter 'context' is required, but there's no corresponding argument.
Try adding the required argument.迁移后的代码
BuildContext context = /* ... */;
TextEditingController controller = /* ... */;
TextSpan span = controller.buildTextSpan(context: context, withComposing: false);时间线
#已于版本 1.26.0 登陆。
稳定版本：2.0.0
参考资料
#API 文档
相关问题
相关 PR