Support gradient text

Author: zmtzawqlp

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 14.1.0
+
+* Support gradient text 
+
 ## 14.0.1
 
 * Implement SelectionArea triple click gestures ([#144563](https://github.com/flutter/flutter/pull/144563))

README-ZH.md

@@ -16,11 +16,11 @@
 
 
 ExtendedText 是 Flutter 官方 Text 的三方扩展库，主要扩展功能如下:
-| 功能   | ExtendedText  | Flutter 官方 Text |
-|--------------------------------------|-----------------------------------------------------------|-----------------------------------------------------|
-| 支持自定义文本溢出效果  | 支持，可以自定义溢出的 Widget，并控制溢出位置（前、中、后）  | 不支 持 ([26748](https://github.com/flutter/flutter/issues/26748),[45336](https://github.com/flutter/flutter/issues/45336))  |
-| 支持复制特殊文本的真实值   | 支持，可以复制出文本的真实值，而不仅是 WidgetSpan 的占位值 | 只能复制出 WidgetSpan 的占位值 (\uFFFC) |
-| 根据文本格式快速构建富文本   | 支持，可以根据文本格式快速构建富文本 | 不支持 |
+| 功能 | ExtendedText  | Flutter 官方 Text   |
+| -------------------------- | ----------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
+| 支持自定义文本溢出效果 | 支持，可以自定义溢出的 Widget，并控制溢出位置（前、中、后） | 不支 持 ([26748](https://github.com/flutter/flutter/issues/26748),[45336](https://github.com/flutter/flutter/issues/45336)) |
+| 支持复制特殊文本的真实值 | 支持，可以复制出文本的真实值，而不仅是 WidgetSpan 的占位值 | 只能复制出 WidgetSpan 的占位值 (\uFFFC)     |
+| 根据文本格式快速构建富文本 | 支持，可以根据文本格式快速构建富文本  | 不支持   |
 
 > 已支持 `HarmonyOS`. 请使用最新的带有 `ohos` 标志的版本. 你可以在 `Versions` 签查找.
 
@@ -499,12 +499,12 @@ Text背景相关的issue[24335](https://github.com/flutter/flutter/issues/24335)
 
 文本溢出相关issue [26748](https://github.com/flutter/flutter/issues/26748)
 
-| parameter  | description | default |
-| ----------- | ------------------------------------------------------------ | ------------------- |
-| child  | The widget of TextOverflow. | @required |
-| maxHeight  | Widget的最大高度，默认为 TextPaint计算出来的行高 preferredLineHeight. | preferredLineHeight |
-| align  | left，靠近最后裁剪文本；right，靠近文本的右下角 | right |
-| position | 溢出文本出现的地方. | TextOverflowPosition.end |
+| parameter | description  | default  |
+| --------- | --------------------------------------------------------------------- | ------------------------ |
+| child | The widget of TextOverflow.  | @required  |
+| maxHeight | Widget的最大高度，默认为 TextPaint计算出来的行高 preferredLineHeight. | preferredLineHeight  |
+| align | left，靠近最后裁剪文本；right，靠近文本的右下角  | right  |
+| position  | 溢出文本出现的地方.    | TextOverflowPosition.end |
 
 ```dart
  ExtendedText(
@@ -600,6 +600,49 @@ class MyTextSelectionControls extends TextSelectionControls {
 
 ```
 
+## Gradient
+
+### GradientConfig
+
+
+用于配置文本渐变的设置。
+
+* [gradient] 是要应用于文本的渐变效果。
+* [ignoreWidgetSpan] 决定是否将 WidgetSpan 元素包含在渐变应用中。默认情况下，WidgetSpan 被忽略。
+* [renderMode] 指定渐变应用于文本的方式。默认值为 [GradientRenderMode.fullText]，即将渐变应用于整个文本。
+* [ignoreRegex] 是一个正则表达式，用于排除文本中的某些部分，使其不受渐变效果影响。例如，可以用来排除特定字符或词语（如表情符号或特殊符号）以免它们受到渐变的影响。
+* [beforeDrawGradient] 在渐变被绘制到文本之前调用的回调函数。
+
+* [blendMode] 应用于渐变的混合模式。
+ 默认值: [BlendMode.srcIn]（即渐变将应用于文本上）。
+ 推荐使用 [BlendMode.srcIn] 或 [BlendMode.srcATop]。
+
+``` dart
+ GradientConfig _config = GradientConfig(
+ gradient: const LinearGradient(
+ colors: <Color>[Colors.blue, Colors.red],
+ ),
+ ignoreRegex: GradientConfig.ignoreEmojiRegex,
+ ignoreWidgetSpan: true,
+ renderMode: GradientRenderMode.fullText,
+ );
+```
+
+### IgnoreGradientSpan
+
+该 `InlineSpan` 将始终忽略渐变效果。
+
+``` dart
+class IgnoreGradientTextSpan extends TextSpan with IgnoreGradientSpan {
+ IgnoreGradientTextSpan({String? text, List<InlineSpan>? children})
+ : super(
+ text: text,
+ children: children,
+ );
+}
+```
+
+
 
 ## ☕️Buy me a coffee
 

README.md

@@ -10,11 +10,11 @@ Extended official text to build special text like inline image or @somebody quic
 
 ExtendedText is a third-party extension library for Flutter's official Text component. The main extended features are as follows:
 
-| Feature | ExtendedText | Text |
-|------------------------------------------|-------------------------------------------------------------|-------------------------------------------------------|
-| Customized text overflow effects | Supported, allows customizing the overflow widget and controlling overflow positions (before, middle, after) | Not supported ([26748](https://github.com/flutter/flutter/issues/26748),[45336](https://github.com/flutter/flutter/issues/45336)) |
-| Copying the actual value of special text | Supported, enables copying the actual value of the text, not just the placeholder value of WidgetSpan | Can only copy the placeholder value of WidgetSpan (\uFFFC) |
-| Quick construction of rich text based on text format  | Supported, enables quick construction of rich text based on text format | Not supported |
+| Feature  | ExtendedText  | Text  |
+| ---------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |
+| Customized text overflow effects  | Supported, allows customizing the overflow widget and controlling overflow positions (before, middle, after) | Not supported ([26748](https://github.com/flutter/flutter/issues/26748),[45336](https://github.com/flutter/flutter/issues/45336)) |
+| Copying the actual value of special text  | Supported, enables copying the actual value of the text, not just the placeholder value of WidgetSpan  | Can only copy the placeholder value of WidgetSpan (\uFFFC)  |
+| Quick construction of rich text based on text format | Supported, enables quick construction of rich text based on text format  | Not supported  |
 
 > `HarmonyOS` is supported. Please use the latest version which contains `ohos` tag. You can check it in `Versions` tab.
 
@@ -40,6 +40,9 @@ dependencies:
  - [Custom Background](#custom-background)
  - [Custom Overflow](#custom-overflow)
  - [Join Zero-Width Space](#join-zero-width-space)
+ - [Gradient](#gradient)
+ - [GradientConfig](#gradientconfig)
+ - [IgnoreGradientSpan](#ignoregradientspan)
 
 ## Speical Text
 
@@ -481,12 +484,12 @@ refer to issues [24335](https://github.com/flutter/flutter/issues/24335)/[24337]
 
 refer to issue [26748](https://github.com/flutter/flutter/issues/26748)
 
-| parameter  | description | default |
-| ----------- | ------------------------------------------------------------ | ------------------- |
-| child  | The widget of TextOverflow. | @required |
-| maxHeight  | The maxHeight of [TextOverflowWidget], default is preferredLineHeight. | preferredLineHeight |
-| align  | The Align of [TextOverflowWidget], left/right. | right |
-| position | The position which TextOverflowWidget should be shown. | TextOverflowPosition.end   |
+| parameter | description  | default  |
+| --------- | ---------------------------------------------------------------------- | ------------------------ |
+| child | The widget of TextOverflow.  | @required  |
+| maxHeight | The maxHeight of [TextOverflowWidget], default is preferredLineHeight. | preferredLineHeight  |
+| align | The Align of [TextOverflowWidget], left/right.  | right  |
+| position  | The position which TextOverflowWidget should be shown.   | TextOverflowPosition.end |
 
 ```dart
  ExtendedText(
@@ -584,3 +587,52 @@ class MyTextSelectionControls extends TextSelectionControls {
 
 ```
 
+## Gradient
+
+### GradientConfig
+
+
+Configuration for applying gradients to text.
+
+* [gradient] is the gradient that will be applied to the text.
+
+* [ignoreWidgetSpan] determines whether `WidgetSpan` elements should be
+included in the gradient application. By default, widget spans are ignored.
+
+* [renderMode] specifies how the gradient should be applied to the text. The default
+is [GradientRenderMode.fullText], meaning the gradient will apply to the entire text.
+
+* [ignoreRegex] is a regular expression used to exclude certain parts of the text
+from the gradient effect. For example, it can be used to exclude specific characters
+or words (like emojis or special symbols) from the gradient application.
+
+* [beforeDrawGradient] A callback function that is called before the gradient is drawn on the text.
+
+* [blendMode] The blend mode to be used when applying the gradient.
+ default: [BlendMode.srcIn] (i.e., the gradient will be applied to the text).
+ It's better to use [BlendMode.srcIn] or [BlendMode.srcATop].
+
+``` dart
+ GradientConfig _config = GradientConfig(
+ gradient: const LinearGradient(
+ colors: <Color>[Colors.blue, Colors.red],
+ ),
+ ignoreRegex: GradientConfig.ignoreEmojiRegex,
+ ignoreWidgetSpan: true,
+ renderMode: GradientRenderMode.fullText,
+ );
+```
+
+### IgnoreGradientSpan
+
+The `InlineSpan` will always ignore the gradient.
+
+``` dart
+class IgnoreGradientTextSpan extends TextSpan with IgnoreGradientSpan {
+ IgnoreGradientTextSpan({String? text, List<InlineSpan>? children})
+ : super(
+ text: text,
+ children: children,
+ );
+}
+```

example/.gitignore

@@ -69,3 +69,4 @@ build/
 !**/ios/**/default.pbxuser
 !**/ios/**/default.perspectivev3
 !/packages/flutter_tools/test/data/dart_dependencies_test/**/.packages
+.flutter-plugins-dependencies