Skip to content

TextSpan

TextSpan #

Bases: 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.

badge #

badge: BadgeValue | None = None

A badge to show on top of this control.

col #

col: ResponsiveNumber = 12

If a parent of this control is a ResponsiveRow, this property is used to determine how many virtual columns of a screen this control will span.

Can be a number or a dictionary configured to have a different value for specific breakpoints, for example col={"sm": 6}.

This control spans the 12 virtual columns by default.

Dimensions
Breakpoint Dimension
xs <576px
sm ≥576px
md ≥768px
lg ≥992px
xl ≥1200px
xxl ≥1400px

data #

data: Any = skip_field()

Arbitrary data of any type.

disabled #

disabled: bool = False

Every control has disabled property which is False by default - control and all its children are enabled.

Note

The value of this property will be propagated down to all children controls recursively.

Example

For example, if you have a form with multiple entry controls you can disable them all together by disabling container:

ft.Column(
    disabled = True,
    controls=[
        ft.TextField(),
        ft.TextField()
    ]
)

expand #

expand: bool | int | None = None

Specifies whether/how this control should expand to fill available space in its parent layout.

More information here.

Note

Has effect only if the direct parent of this control is one of the following controls, or their subclasses: Column, Row, View, Page.

expand_loose #

expand_loose: bool = False

Allows the control to expand along the main axis if space is available, but does not require it to fill all available space.

More information here.

Note

If expand_loose is True, it will have effect only if:

  • expand is not None and
  • the direct parent of this control is one of the following controls, or their subclasses: Column, Row, View, Page.

key #

key: (
    str | int | float | bool | ValueKey | ScrollKey | None
) = None

on_click #

on_click: ControlEventHandler[TextSpan] | None = None

Called when this span is clicked.

on_enter #

on_enter: ControlEventHandler[TextSpan] | None = None

Called when a mouse pointer has entered this span.

on_exit #

on_exit: ControlEventHandler[TextSpan] | None = None

Called when a mouse pointer has exited this span.

opacity #

opacity: Number = 1.0

Defines the transparency of the control.

Value ranges from 0.0 (completely transparent) to 1.0 (completely opaque without any transparency).

page #

page: Page | PageView | None

The page (of type Page or PageView) to which this control belongs to.

parent #

parent: BaseControl | None

The direct ancestor(parent) of this control.

It defaults to None and will only have a value when this control is mounted (added to the page tree).

The Page control (which is the root of the tree) is an exception - it always has parent=None.

rtl #

rtl: bool = False

Whether the text direction of the control should be right-to-left (RTL).

semantics_label #

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.

spans #

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 #

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 #

style: TextStyle | None = None

Defines the style of this text span.

text #

text: str | None = None

The text contained in this span.

Note

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

tooltip #

tooltip: TooltipValue | None = None

The tooltip ot show when this control is hovered over.

url #

url: str | None = None

The URL to open when the span is clicked. If registered, on_click event is fired after that.

url_target #

url_target: UrlTarget = BLANK

Where to open URL in the web mode.

visible #

visible: bool = True

Every control has visible property which is True by default - control is rendered on the page. Setting visible to False completely prevents control (and all its children if any) from rendering on a page canvas. Hidden controls cannot be focused or selected with a keyboard or mouse and they do not emit any events.

before_event #

before_event(e: ControlEvent)

before_update #

before_update()

clean #

clean() -> None

did_mount #

did_mount()

init #

init()

is_isolated #

is_isolated()

update #

update() -> None

will_unmount #

will_unmount()