GlassEditScope class

An ambient scope providing GlassEditMode to descendant widgets, directly matching SwiftUI's @Environment(\.editMode) environment key.

Descendants like GlassListTile, GlassEditButton, and GlassReorderableList automatically adapt their layout and controls based on this scope.

Usage

GlassEditScope(
  child: Column(
    children: [
      const GlassAppBar.pinned(
        actions: [
          GlassEditButton(),
        ],
      ),
      GlassListTile(
        title: const Text('John Appleseed'),
        onDelete: () => removeItem(),
        canReorder: true,
      ),
    ],
  ),
)

Inheritance

Available extensions

Constructors

GlassEditScope({Key? key, required Widget child, GlassEditController? controller, GlassEditMode initialMode = GlassEditMode.inactive, ValueChanged<GlassEditMode>? onModeChanged}): Creates a GlassEditScope with its own internal controller or a provided controller.
const

Properties

child → Widget: The child subtree with ambient access to edit mode.
final
controller → GlassEditController?: Optional external controller for managing the edit mode.
final
hashCode → int: The hash code for this object.
no setterinherited
initialMode → GlassEditMode: The initial edit mode when controller is not provided.
final
key → Key?: Controls how one widget replaces another widget in the tree.
finalinherited
onModeChanged → ValueChanged<GlassEditMode>?: Callback fired whenever the edit mode changes.
final
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited

Methods

createElement() → StatefulElement: Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<GlassEditScope>: 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
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

Static Methods

isEditing(BuildContext context) → bool: Convenience helper to check if edit mode is currently active.
maybeOf(BuildContext context) → GlassEditController?: Returns the nearest GlassEditController in the widget tree, or null if none is found.
of(BuildContext context) → GlassEditController: Returns the nearest GlassEditController in the widget tree, or throws if none is found.