Widgets

OutlinedIconButton

OutlinedIconButton

OutlinedIconButton control. Build it with the outlined_icon_button helper.

Example

outlined_icon_button(
  icon: "search",
  tooltip: "Search",
  on_click: ->(event) {}
)

Properties

  • adaptive — Adapts to the platform (Material/Cupertino) when true.
  • alignment — Alignment of the content within the control.
  • autofocus — Requests focus when first shown.
  • bgcolor — Background color.
  • disabled_color — Disabled color.
  • enable_feedback — Plays touch feedback (sound/haptic) on interaction.
  • focus_color — Color shown while focused.
  • highlight_color — Highlight color.
  • hover_color — Color shown while hovered.
  • icon — Icon name shown by the control.
  • icon_color — Color of the icon.
  • icon_size — Sets the icon size property.
  • mouse_cursor — Cursor shown when hovering the control.
  • padding — Inner spacing between the border and the content.
  • selected — Whether the control is selected.
  • selected_icon — Selected icon.
  • selected_icon_color — Selected icon color.
  • size_constraints — Min/max size constraints.
  • splash_color — Splash color.
  • splash_radius — Splash radius.
  • style — Style overrides for the control.
  • url — URL the control loads or links to.
  • visual_density — Compactness of the control's layout.

Common layout and animation properties

  • 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.
  • badge — Badge drawn on the corner of the control.
  • bottom — Bottom offset when positioned inside a stack.
  • col — Responsive column span (1-12) per breakpoint.
  • 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.
  • 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.
  • tooltip — Text shown on hover/long-press.
  • top — Top offset when positioned inside a stack.
  • 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.

Reference

  • Family: materials
  • Widget type: outlinediconbutton
  • Helpers: outlined_icon_button, outlinediconbutton