TextButton

A low-emphasis text action button.

Example

text_button(
  content: text(value: "Cancel"),
  on_click: ->(_e) { page.go("/") }
)

Common properties

• content
• url
• on_click
• disabled
• style

Usage

row(
  spacing: 8,
  children: [
    text_button(content: text(value: "Skip")),
    elevated_button(content: text(value: "Next"))
  ]
)

Notes

• text_button is useful for secondary actions
• Use url: to open a link through the client url_launcher; use on_click:

for application actions.

Complete API

Helpers

• text_button(content = ..., **props)
• textbutton(content = ..., **props)

Accepted properties

• adaptive — Adapts to the platform (Material/Cupertino) when true.
• align — Alignment of the control within its parent.
• animate_align — Animates alignment changes.
• animate_margin — Animates margin changes.
• animate_offset — Animates offset changes.
• animate_opacity — Animates opacity changes.
• animate_position — Animates position changes.
• animate_rotation — Animates rotation changes.
• animate_scale — Animates scale changes.
• animate_size — Animates size changes.
• aspect_ratio — Width-to-height ratio to maintain.
• autofocus — Requests focus when first shown.
• badge — Badge drawn on the corner of the control.
• bottom — Bottom offset when positioned inside a stack.
• clip_behavior — How content overflowing the bounds is clipped.
• col — Responsive column span (1-12) per breakpoint.
• content — The single child control rendered inside this control.
• data — Arbitrary value you can attach to the control and read back in handlers.
• disabled — Disables interaction when true.
• expand — Fills the available space along the parent's main axis when true.
• expand_loose — Like expand, but only grows up to the child's natural size.
• height — Fixed height in logical pixels.
• icon — Icon name shown by the control.
• icon_color — Color of the icon.
• key — Stable identity used to preserve state across rebuilds.
• left — Left offset when positioned inside a stack.
• margin — Outer spacing around the control.
• offset — Translation offset applied to the control.
• opacity — Opacity from 0.0 (transparent) to 1.0 (opaque).
• right — Right offset when positioned inside a stack.
• rotate — Rotation applied to the control.
• rtl — Renders right-to-left when true.
• scale — Scale transform applied to the control.
• size_change_interval — Throttle interval for on_size_change, in ms.
• style — Style overrides for the control.
• tooltip — Text shown on hover/long-press.
• top — Top offset when positioned inside a stack.
• url — URL the control loads or links to.
• visible — Hides the control when false.
• width — Fixed width in logical pixels.

Events

• on_animation_end — Fired when an animation completes.
• on_blur — Fired when the control loses focus.
• on_click — Fired when the control is clicked/tapped.
• on_focus — Fired when the control gains focus.
• on_hover — Fired when the pointer enters/leaves the control.
• on_long_press — Fired on a long press.
• on_size_change — Fired when the control's size changes.

Wire reference

• Family: materials
• Widget type: textbutton