LiquidGlassContainer class
A container that applies Liquid Glass effects to its child widget.
On iOS 26+ and macOS 26+, this uses native SwiftUI rendering to apply the glass effect. On older versions or other platforms, the child is returned unchanged.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- LiquidGlassContainer
- Available extensions
Constructors
- LiquidGlassContainer({Key? key, required Widget child, required LiquidGlassConfig config, bool autoHideOnModal = true})
-
Creates a Liquid Glass container.
const
Properties
- autoHideOnModal → bool
-
When true (default), destroys the native container's PlatformView while
a modal sheet is presented above this widget's host route. Prevents the
iOS hybrid-composition z-order bleed (Issue #53) where host-page
PlatformView pixels leak through a sheet that also contains a
CN-widget. Requires
CNTabBarRouteObserver()to be registered in the app'snavigatorObservers. No effect on iOS < 26 / non-iOS (fallback path returns the child unchanged).final - child → Widget
-
The child widget to apply the glass effect to.
final
- config → LiquidGlassConfig
-
The glass effect configuration.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- 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< LiquidGlassContainer> -
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
-
liquidGlass(
{CNGlassEffect effect = CNGlassEffect.regular, CNGlassEffectShape shape = CNGlassEffectShape.capsule, double? cornerRadius, Color? tint, bool interactive = false}) → Widget -
Available on Widget, provided by the LiquidGlassExtension extension
Applies a Liquid Glass effect to this widget. -
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