Skip to content

TextSpan

Inherits: Control

A text span.

Usage Example: As a child of Text.spans.

For the object to be useful, at least one of text or spans should be set.

Properties

  • semantics_label(str | None) –

    An alternative semantics label for this text.

  • spans(list[TextSpan] | None) –

    Additional spans to include as children.

  • spell_out(bool | None) –

    Whether the assistive technologies should spell out this text

  • style(TextStyle | None) –

    Defines the style of this text span.

  • text(str | None) –

    The text contained in this span.

  • url(str | Url | None) –

    The URL to open when this button is clicked.

Events

Properties#

semantics_label class-attribute instance-attribute #

semantics_label: str | None = None

An alternative semantics label for this text.

If present, the semantics of this control will contain this value instead of the actual text.

Raises:

spans class-attribute instance-attribute #

spans: list[TextSpan] | None = None

Additional spans to include as children.

Note

If both spans and text are defined, the text takes precedence.

spell_out class-attribute instance-attribute #

spell_out: bool | None = None

Whether the assistive technologies should spell out this text character by character.

If the text is 'hello world', setting this to true causes the assistive technologies, such as VoiceOver or TalkBack, to pronounce 'h-e-l-l-o-space-w-o-r-l-d' instead of complete words. This is useful for texts, such as passwords or verification codes.

If this span contains other text span children, they also inherit the property from this span unless explicitly set.

If the property is not set, this text span inherits the spell out setting from its parent. If this text span does not have a parent or the parent does not have a spell out setting, this text span does not spell out the text by default.

style class-attribute instance-attribute #

style: TextStyle | None = None

Defines the style of this text span.

text class-attribute instance-attribute #

text: str | None = None

The text contained in this span.

Note

If both text and spans are defined, the text takes precedence.

url class-attribute instance-attribute #

url: str | Url | None = None

The URL to open when this button is clicked.

Additionally, if on_click event callback is provided, it is fired after that.

Events#

on_click class-attribute instance-attribute #

on_click: ControlEventHandler[TextSpan] | None = None

Called when this span is clicked.

on_enter class-attribute instance-attribute #

on_enter: ControlEventHandler[TextSpan] | None = None

Called when a mouse pointer has entered this span.

on_exit class-attribute instance-attribute #

on_exit: ControlEventHandler[TextSpan] | None = None

Called when a mouse pointer has exited this span.