ShadToolbarButton class
A button used inside ShadTextSelectionToolbar.
Displays a label widget with an optional hover highlight and custom styling. The label is wrapped in a DefaultTextStyle so plain Text widgets pick up the effective style automatically.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- ShadToolbarButton
- Available extensions
- Annotations
-
- @Deprecated('Use ShadContextMenuItem instead. ' 'This widget will be removed in a future release.')
Constructors
- ShadToolbarButton({Key? key, required Widget label, required VoidCallback? onPressed, EdgeInsetsGeometry? padding, Color? color, Color? hoverColor, TextStyle? textStyle})
-
const
Properties
- color → Color?
-
Background color of the button. Defaults to transparent.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- hoverColor → Color?
-
Background color of the button when hovered.
Defaults to ShadColorScheme.accent.
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- label → Widget
-
The content of the button.
final
- onPressed → VoidCallback?
-
Called when the button is pressed.
final
- padding → EdgeInsetsGeometry?
-
Padding around the button content.
Defaults to
EdgeInsets.symmetric(horizontal: 8, vertical: 6).final - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- textStyle → TextStyle?
-
Text style applied to the label via DefaultTextStyle.
Defaults to ShadTextTheme.small with normal weight and
ShadColorScheme.foreground color.
final
Methods
-
animate(
{Key? key, List< Effect> ? effects, AnimateCallback? onInit, AnimateCallback? onPlay, AnimateCallback? onComplete, bool? autoPlay, Duration? delay, AnimationController? controller, Adapter? adapter, double? target, double? value}) → Animate -
Available on Widget, provided by the AnimateWidgetExtensions extension
Wraps the target Widget in an Animate instance, and returns the instance for chaining calls. Ex.myWidget.animate()is equivalent toAnimate(child: myWidget). -
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< ShadToolbarButton> -
Creates the mutable state for this widget at a given location in the tree.
override
-
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
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
positionedWith(
ShadPosition position) → Widget -
Available on Widget, provided by the PositionedExt 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