ArcaneSheet class

A modal sheet that slides in from screen edges.

Inheritance

Constructors

ArcaneSheet({String? id, required bool isOpen, required Widget child, VoidCallback? onClose, SheetPosition position = SheetPosition.bottom, SheetSize size = SheetSize.auto, String? title, String? description, Widget? header, Widget? footer, bool showBackdrop = true, bool closeOnBackdropClick = true, bool showCloseButton = true, bool showDragHandle = true, String? maxWidth, bool escapeCloses = true, bool focusTrap = true, bool restoreFocus = true, ArcaneStyleData? styles, ArcaneDecoration? decoration, Key? key})
const
ArcaneSheet.bottom({String? id, required bool isOpen, required Widget child, VoidCallback? onClose, SheetSize size = SheetSize.auto, String? title, String? description, Widget? header, Widget? footer, bool showBackdrop = true, bool closeOnBackdropClick = true, bool showCloseButton = false, bool showDragHandle = true, String? maxWidth, bool escapeCloses = true, bool focusTrap = true, bool restoreFocus = true, ArcaneStyleData? styles, ArcaneDecoration? decoration, Key? key})
const
ArcaneSheet.end({String? id, required bool isOpen, required Widget child, VoidCallback? onClose, SheetSize size = SheetSize.md, String? title, String? description, Widget? header, Widget? footer, bool showBackdrop = true, bool closeOnBackdropClick = true, bool showCloseButton = true, bool showDragHandle = false, String? maxWidth, bool escapeCloses = true, bool focusTrap = true, bool restoreFocus = true, ArcaneStyleData? styles, ArcaneDecoration? decoration, Key? key})
const
ArcaneSheet.top({String? id, required bool isOpen, required Widget child, VoidCallback? onClose, SheetSize size = SheetSize.auto, String? title, String? description, Widget? header, Widget? footer, bool showBackdrop = true, bool closeOnBackdropClick = true, bool showCloseButton = true, bool showDragHandle = false, String? maxWidth, bool escapeCloses = true, bool focusTrap = true, bool restoreFocus = true, ArcaneStyleData? styles, ArcaneDecoration? decoration, Key? key})
const

Properties

child Widget
final
closeOnBackdropClick bool
final
decoration ArcaneDecoration?
Semantic, theme-interpreted decoration (elevation + theme-specific fields).
final
description String?
final
escapeCloses bool
final
focusTrap bool
final
final
hashCode int
The hash code for this object.
no setterinherited
final
id String?
final
isOpen bool
final
key Key?
Controls how one component replaces another component in the tree.
finalinherited
maxWidth String?
final
onClose VoidCallback?
final
position SheetPosition
final
restoreFocus bool
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
showBackdrop bool
final
showCloseButton bool
final
showDragHandle bool
final
size SheetSize
final
styles ArcaneStyleData?
Literal, theme-permeable style override (always applied, wins over theme).
final
title String?
final

Methods

build(BuildContext context) Widget
Describes the part of the user interface represented by this component.
override
createElement() Element
Creates a StatelessElement to manage this component's location in the tree.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
shouldRebuild(covariant Component newComponent) bool
Implement this method to determine whether a rebuild can be skipped.
inherited
toString() String
A string representation of this object.
inherited

Operators

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