PiButton class

A customizable button widget with multiple styles, sizes, and states.

Inheritance
Available extensions

Constructors

PiButton({required void onTap()?, void onDoubleTap()?, void onLongPress()?, String? label, Widget? iconPreffix, Widget? iconSuffix, PiButtonShape shape, PiButtonColor color, PiButtonSize size, PiButtonState state, PiButtonLayout layout, PiButtonType type, PiButtonLoadingType loadingType})
V Button This file defines the PiButton widget which is a customizable button component with various styles, shapes, sizes, and states.
const
factory

Properties

backgroundColor → Color?
Background color of the button.
final
borderRadius → BorderRadius?
Border radius of the button.
final
borderWidth → double?
final
color → PiButtonColor
The type of the button (primary, secondary, etc.).
final
foregroundColor → Color?
Foreground color of the button.
final
hashCode → int
The hash code for this object.
no setterinherited
height → double?
final
horizontalPadding → double?
Padding inside the button.
final
iconPreffix → Widget?
The prefix icon widget for the button.
final
iconPreffixColor → Color?
final
iconSuffix → Widget?
The suffix icon widget for the button.
final
iconSuffixColor → Color?
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
label → String?
The text displayed on the button.
final
layout → PiButtonLayout
The layout style of the button (hug or fill).
final
loadingIconColor → Color?
final
loadingIconStrokeWidth → double?
final
loadingRadius → double?
final
loadingType → PiButtonLoadingType
The loading indicator type (shimmer or circular).
final
onDoubleTap → void Function()?
Callback function for double-tap events.
final
onLongPress → void Function()?
Callback function for long-press events.
final
onTap → void Function()?
Callback function when the button is tapped.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
shape → PiButtonShape
The shape of the button (rounded, rounded_full, square, or circle).
final
size → PiButtonSize
The size of the button (small, medium, large).
final
splashColor → Color?
final
state → PiButtonState
The state of the button (success, disable, loading).
final
textStyle → TextStyle?
Text style for the button label.
final
type → PiButtonType
The border style of the button (outlined or filled).
final
verticalPadding → double?
Padding inside the button.
final
width → double?
final

Methods

backgroundColor({Color color = Colors.transparent}) → Widget

Available on Widget, provided by the PiWidgetExtension extension

borderRadius({double? topLeft, double? topRight, double? bottomLeft, double? bottomRight, double? verticalTop, double? verticalBottom, double? horizontalLeft, double? horizontalRight, double? all}) → Widget

Available on Widget, provided by the PiWidgetExtension extension

build(BuildContext context) → Widget
Describes the part of the user interface represented by this widget.
override
copyWith({TextStyle? textStyle, Color? backgroundColor, Color? foregroundColor, BorderRadius? borderRadius, double? horizontalPadding, double? verticalPadding, Color? loadingIconColor, double? loadingIconStrokeWidth, Color? iconPreffixColor, Color? iconSuffixColor, Color? splashColor, double? height, double? width, double? borderWidth, double? loadingRadius}) → PiButton
createElement() → StatelessElement
Creates a StatelessElement to manage this widget's location in the tree.
inherited
debugDescribeChildren() → List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
innerShadow({double? width, double? height, Color? shadowColor}) → Widget

Available on Widget, provided by the PiWidgetExtension extension

margin({double? horizontal, double? vertical, double? top, double? right, double? bottom, double? left, double? all}) → Widget

Available on Widget, provided by the PiWidgetExtension extension

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
semantics(String id) → Widget

Available on Widget, provided by the PiWidgetExtension extension

shimmer({Color baseColor = const Color(0xFFd2d2d2), Color highlightColor = Colors.white}) → Widget

Available on Widget, provided by the PiWidgetExtension extension

toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String
A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) → String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a one-line detailed description of the object.
inherited
toStringShort() → String
A short, textual description of this widget.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited