Surface class

🌟 Surface

A shapeable, layered, intrinsincally animated container Widget offering convenient access to blurring ImageFilters, Material InkResponse, and HapticFeedback.

Robustly customizable and, watch out, could also be expensive.

❗ CAUTION

With default 🤹‍♂️ SurfaceFX 💧 Fx.blurry, only provide 👓 Filter.filteredLayers value for which you intend on passing each relevant 💧 Filter.radiusMap map parameter.

  • Not only are the blurry BackdropFilters expensive, but the inheritance/ancestry behavior is strange.
  • If all three filters are active via 👓 Filter.filteredLayers, passing 📊 baseRadius: 0 eliminates the remaining children filters, regardless of their passed 📊 radius.
    • This behavior can be worked-around by setting any parent 📚 Layer's radius to just above 0, specifically radius > (_MINIMUM_BLUR == 0.0003)
    • 📚 BASE > 📚 MATERIAL > 📚 CHILD
    • But in this case a different 👓 FilterSpec.filteredLayers Set should be passed anyway that only activates the correct 📚 Layer(s).
Inheritance

Constructors

Surface({double? width, double? height, EdgeInsets margin = const EdgeInsets.all(0), EdgeInsets padding = const EdgeInsets.all(0), Color? color, Color? baseColor, Gradient? gradient, Gradient? baseGradient, Shape shape = const Shape(), Peek peek = Peek.DEFAULT, TapSpec tapSpec = const TapSpec(), Filter filter = Filter.DEFAULT, Duration duration = const Duration(milliseconds: 500), Curve curve = Curves.easeIn, Widget? child, Clip clipBehavior = Clip.hardEdge, Key? key})
🌟 Surface
const

Properties

baseColor → Color?
If 🎨 color or 🎨 baseColor is initialized, then initializing the respective Gradient parameter overrides the Color pass.
final
baseGradient → Gradient?
If 🌆 gradient or 🌆 baseGradient is initialized, then respective Color parameter is ignored.
final
child → Widget?
The 👶 child Widget to render inside as the Surface content after considering all layout parameters.
final
clipBehavior → Clip
Defaults to standard Clip.hardEdge. Must not be Clip.none.
final
color → Color?
If 🎨 color or 🎨 baseColor is initialized, then initializing the respective Gradient parameter overrides the Color pass.
final
curve → Curve
The Curve that the internal AnimatedContainers use for intrinsic property-change animations.
final
duration → Duration
The Duration that the internal AnimatedContainers use for intrinsic property-change animations.
final
filter → Filter
Provided a 🔬 Filter to alter filter appearance at all 📚 SurfaceLayers.
final
gradient → Gradient?
If 🌆 gradient or 🌆 baseGradient is initialized, then respective Color parameter is ignored.
final
hashCode → int
The hash code for this object.
no setterinherited
height → double?
The width and height follow rules of AnimatedContainer, applying directly to the 📚 SurfaceLayer.BASE.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
margin → EdgeInsets
margin applies to 📚 SurfaceLayer.BASE and the 🌟 Surface as a whole.
final
padding → EdgeInsets
margin applies to 📚 SurfaceLayer.BASE and the 🌟 Surface as a whole.
final
peek → Peek
Surface 🔲 Peek.peek is applied as insets to 📚 SurfaceLayer.MATERIAL.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
shape → Shape
WIP
final
tapSpec → TapSpec
Not only does 👆 TapSpec.tappable provide onTap Callback, it also adds an InkResponse to the Material before rendering child.
final
width → double?
The width and height follow rules of AnimatedContainer, applying directly to the 📚 SurfaceLayer.BASE.
final

Methods

build(BuildContext context) → Widget
👷‍♂️🌟 Build Surface
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.
override
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}) → 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