GlassEditButton class

A button that toggles edit mode, directly matching SwiftUI's EditButton().

When pressed, GlassEditButton toggles the ambient GlassEditScope between GlassEditMode.inactive and GlassEditMode.active.

Displays Edit when inactive.
Displays Done in bold text when active.

Rendered as a liquid glass capsule with a black label, matching the iOS 26 toolbar button style.

Usage

Typically placed in a GlassAppBar or navigation bar:

GlassAppBar.pinned(
  title: const Text('Contacts'),
  actions: const [
    GlassEditButton(),
  ],
)

Inheritance

Available extensions

Constructors

GlassEditButton({Key? key, String editLabel = 'Edit', String doneLabel = 'Done', Color? color, VoidCallback? onPressed, bool enableHaptics = true}): Creates a standard GlassEditButton bound to the nearest GlassEditScope.
const
GlassEditButton.explicit({Key? key, required bool isEditing, required VoidCallback? onPressed, String editLabel = 'Edit', String doneLabel = 'Done', Color? color, bool enableHaptics = true}): Creates a standalone GlassEditButton with an explicit isEditing state.
const

Properties

color → Color?: Tint color for the button text (defaults to CupertinoColors.label, matching iOS 26 glass toolbar buttons).
final
doneLabel → String: Label shown when active (defaults to 'Done').
final
editLabel → String: Label shown when inactive (defaults to 'Edit').
final
enableHaptics → bool: Whether to trigger a selection haptic feedback tick on tap.
final
hashCode → int: The hash code for this object.
no setterinherited
key → Key?: Controls how one widget replaces another widget in the tree.
finalinherited
onPressed → VoidCallback?: Optional override callback for when the button is tapped. If null in standard mode, automatically calls GlassEditController.toggle.
final
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited

Methods

build(BuildContext context) → Widget: Describes the part of the user interface represented by this widget.
override
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
glassContextMenu({Key? key, required List<Widget> actions, WidgetBuilder? previewBuilder, bool enabled = true, bool enableHaptics = true, double borderRadius = 32.0, double? previewBorderRadius, double rowBorderRadius = 16.0, BorderRadius? rowCorners, Color? originSlotColor, Color? backgroundColor, LiquidGlassSettings? settings, GlassQuality? quality, double backdropBlur = 0.0, Color? barrierColor, double menuWidth = 250.0, VoidCallback? onOpened, VoidCallback? onDismissed, Duration longPressDuration = const Duration(milliseconds: 700)}) → Widget: Available on Widget, provided by the GlassContextMenuExtension extension
Wraps this widget in a GlassContextMenu displaying actions on long-press or right-click.
glassFullScreenCover({required bool isPresented, VoidCallback? onDismiss, required WidgetBuilder content, bool enableSwipeToDismiss = true, double dismissThreshold = 140.0, LiquidGlassSettings? settings, GlassQuality? quality}) → Widget: Available on Widget, provided by the GlassFullScreenCoverExtension extension
Presents a full-viewport modal cover whenever isPresented is true.
navigationTitle(String title) → Widget: Available on Widget, provided by the GlassNavigationTitleExtension extension
Annotates this widget with a navigation title that drives enclosing or descendant GlassAppBar / GlassAppBar.pinned bars (when their explicit title is null) as well as header accessibility semantics.
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
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