Skip to content

TextSpan 继承自:ActionControl, Control, BaseControl

一个文本片段。

用法示例:作为 spans 的子项。

要让该对象发挥作用,至少需要设置 text 或 spans 之一。

属性 ​

名称类型默认值说明
textOptional[str]None此片段中包含的文本。 注意: 如果同时定义了 text 和 spans,则以 text 优先。
styleOptional[TextStyle]None定义此文本片段的样式。
spansOptional[list['TextSpan']]None作为子项包含的额外片段。 注意: 如果同时定义了 spans 和 text,则以 text 优先。
urlOptional[Union[str, Url]]None单击此按钮时要打开的 URL。此外,如果提供了 on_click 事件回调,会在其后触发。
semantics_labelOptional[str]None此文本的替代语义标签。 如果存在,此控件的语义将包含此值而非实际文本。 抛出异常: ValueError:如果在 text 为 None 时设置了它。
spell_outOptional[bool]None辅助技术是否应逐字符拼读此文本。 如果文本是 'hello world',将此设为 true 会让 VoiceOver 或 TalkBack 等辅助技术读成 'h-e-l-l-o-space-w-o-r-l-d' 而不是完整单词。这对密码或验证码之类的文本很有用。 如果此片段包含其他文本子片段,它们也会继承此片段的该属性,除非被显式设置。 如果未设置该属性,此文本片段会从父级继承拼读设置。如果此文本片段没有父级,或父级没有拼读设置,则默认情况下此文本片段不会逐字符拼读文本。
actionOptional[Union[ClientAction, list[ClientAction]]]None当此控件被激活时由客户端执行的动作,无需往返到你的 Python 代码。 用于浏览器仅在其处理用户点击时才允许的操作,例如打开文件选择器、写入剪贴板、显示分享面板或打开新标签页。参见 ClientAction。
expandAnnotated[Optional[Union[bool, int]], V.instance_of((bool, int))]None指定此控件是否/如何扩展以填满父布局中的可用空间。 更多信息见此处。 注意: 仅当此控件的直接父级是以下控件或其子类时才生效:Column、Row、View、Page。 抛出异常: ValueError:如果它不是 bool 或 int 类型。
expand_looseboolFalse允许控件在主轴方向有可用空间时扩展,但不要求它填满所有可用空间。 更多信息见此处。 注意: 如果 expand_loose 为 True,则仅在以下条件满足时才生效: - expand 不为 None,且 - 此控件的直接父级是以下控件或其子类之一:Column、Row、View、Page。
colResponsiveNumber12如果此控件的父级是 ResponsiveRow,则此属性决定该控件在屏幕上跨越多少虚拟列。 可以是一个数字,也可以是一个按断点配置不同值的字典,例如 col={"sm": 6}。 值为 0 时会在该断点隐藏控件,因此它不会占用父级 ResponsiveRow 中的任何列。 此控件默认跨越 12 个虚拟列。 | 断点 | 尺寸 | |---|---| | xs | <576px | | sm | ≥576px | | md | ≥768px | | lg | ≥992px | | xl | ≥1200px | | xxl | ≥1400px |
opacityAnnotated[Number, V.between(0.0, 1.0)]1.0定义控件的透明度。 取值范围从 0.0(完全透明)到 1.0(完全不透明,无任何透明感)。 抛出异常: ValueError:如果它不在 0.0 到 1.0(含)之间。
tooltipOptional[TooltipValue]None鼠标悬停在此控件上时显示的工具提示。
badgeOptional[BadgeValue]None显示在此控件顶部的徽章。
visibleboolTrue每个控件都有 visible 属性,默认为 True —— 控件会渲染在页面上。将 visible 设为 False 会彻底阻止控件(及其所有子控件,如果有)渲染到页面画布上。隐藏的控件无法通过键盘或鼠标获得焦点或选中,也不会触发任何事件。
disabledboolFalse每个控件都有 disabled 属性,默认为 False —— 控件及其所有子控件都处于启用状态。 注意: 此属性的值会递归向下传播到所有子控件。 示例: 例如,如果你有一个包含多个输入控件的表单,可以通过禁用容器来一并禁用它们: python ft.Column( disabled = True, controls=[ ft.TextField(), ft.TextField() ] )
rtlboolFalse控件的文本方向是否为从右到左(RTL)。
dataAnyskip_任意类型的自定义数据。
keyOptional['KeyValue']None用于在更新之间保持控件标识稳定的键。

只读属性 ​

名称类型默认值说明
parentOptional['BaseControl']—此控件的直接祖先(父级)。 默认为 None,只有在此控件被挂载(加入页面树)后才有值。 Page 控件(页面树的根)是个例外 —— 它的 parent 始终为 None。
page'Page'—此控件所属的页面。

事件 ​

名称类型默认值说明
on_clickOptional[ControlEventHandler['TextSpan']]None单击此片段时调用。
on_enterOptional[ControlEventHandler['TextSpan']]None鼠标指针进入此片段时调用。
on_exitOptional[ControlEventHandler['TextSpan']]None鼠标指针离开此片段时调用。

方法 ​

名称类型默认值说明
is_isolated——返回此控件是否被标记为隔离。 隔离控件会被排除在父级驱动的更新遍历之外,并需要自行管理更新边界。
init——在控件实例初始化之后、第一次构建/更新周期之前调用。 重写此钩子以执行依赖已初始化字段的轻量级设置。请勿在此处调用 update()。
build——在控件初始化期间调用一次,用于定义其子控件。在此方法中 page 属性可用。
before_update——每当此控件被更新时都会调用此方法。 注意: 务必不要在此处调用或请求 update()。
before_event——在事件处理器执行之前拦截事件。 返回 False 可取消分发。返回 True 或 None 则继续正常的事件处理。
did_mount——在控件挂载到页面树之后调用。 重写此方法以启动需要已挂载页面的资源,例如订阅、定时器或服务监听器。
will_unmount——在控件从页面树移除之前调用。 重写此方法以释放 did_mount() 中创建的资源,例如订阅、定时器或外部句柄。
get_data_channel——解析为此 widget 在 Dart 侧分配的 [DataChannel]。模式: on_data_channel_open: Optional[ft.EventHandler[DataChannelOpenEvent]] = None def init(self): self.on_data_channel_open = self._on_open def _on_open(self, e): self._channel = self.get_data_channel(e.channel_id) 幂等 —— 底层的 Connection 会按 id 缓存 DataChannel,因此重复调用会返回同一实例。没有错误路径:该 id 始终来自框架触发的事件,所以当此方法运行时,通道在两端都已存在。
updateNone—为此控件请求一次 UI 更新。 在更改控件状态或属性后调用。控件必须已挂载到页面且未被标记为冻结。

关注我,学习大模型、大数据、Python等热门技术。