Skip to main content

Control

Base class for controls.

Not meant to be used directly.

Inherits: BaseControl

Properties

  • badge - A badge to show on top of this control.
  • col - 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.
  • disabled - Every control has disabled property which is False by default - control and all its children are enabled.
  • expand - Specifies whether/how this control should expand to fill available space in its parent layout.
  • expand_loose - Allows the control to expand along the main axis if space is available, but does not require it to fill all available space.
  • opacity - Defines the transparency of the control.
  • rtl - Whether the text direction of the control should be right-to-left (RTL).
  • tooltip - The tooltip to show when this control is hovered over.
  • visible - Every control has visible property which is True by default - control is rendered on the page.

Properties​

badgeclass-attributeinstance-attribute​

badge: Optional[BadgeValue] = None

A badge to show on top of this control.

colclass-attributeinstance-attribute​

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:

BreakpointDimension
xs<576px
sm≥576px
md≥768px
lg≥992px
xl≥1200px
xxl≥1400px

disabledclass-attributeinstance-attribute​

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()
    ]
)

expandclass-attributeinstance-attribute​

expand: Annotated[Optional[Union[bool, int]], V.instance_of((bool, int))] = 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.

Raises:

  • ValueError - If it is not of type bool or int.

expand_looseclass-attributeinstance-attribute​

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.

opacityclass-attributeinstance-attribute​

opacity: Annotated[Number, V.between(0.0, 1.0)] = 1.0

Defines the transparency of the control.

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

Raises:

  • ValueError - If it is not between 0.0 and 1.0, inclusive.

rtlclass-attributeinstance-attribute​

rtl: bool = False

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

tooltipclass-attributeinstance-attribute​

tooltip: Optional[TooltipValue] = None

The tooltip to show when this control is hovered over.

visibleclass-attributeinstance-attribute​

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.