🌟 Surface

WORK IN PROGRESS

Overhaul ongoing. Documentation & Readme may be out of date.

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

+ 🏓 BouncyBall

A delightfully bouncy and position-mirroring reaction to user input on a piece of Material.

Details in the screenshot above are from an outdated version.

📚 SurfaceLayer Container Division

Offers robust customization for a set app-wide style or on-the-fly changes.

• Support for Colors and Gradients in both 📚 SurfaceLayers BASE and MATERIAL layers.
• Support for three different filters and their strengths.
  • The top-most of which will affect any InkResponse that occurs on the middle 📚 SurfaceLayer
• Insets may be divided amongst different 📚 Layers by 🔛 Shape.padLayer.

🔰 Shape Customized SurfaceShapes

• 🆕 Manual Shapeing is here! Work in progress.
• Defined by 📐 CornerSpec and generates a SurfaceShape.
• Optionally, provide a ➖ border or 📏 scaling.

🔲 Peek

📚 MATERIAL inset or "border", the size of which is set by parameter 🔲 Peek.peek.

• Give special treatment, generally a thicker appearance, to selected side(s) by passing Peek.alignment and tuning with Peek.ratio.

👆 TapSpec

If the 🌟 Surface is TapSpec.tappable then:

• 👆 TapSpec.onTap callback becomes available.
• Colors may be provided for InkResponse customization--though ThemeData defaults are accessed otherwise.
• Consider a HapticFeedback shortcut 👆 TapSpec.providesFeedback.
• Enjoy the 🏓 BouncyBall splashFactory, pick your own, or have 🌟 Surface default to your Theme's.

🔬 Filter defines 🤹‍♂️ SurfaceFX ImageFilters

• In configured 👓 Filter.filteredLayers Set
  • Whose radii (strength) are mapped with 📊 Filter.radiusMap
• A 📚 SurfaceLayer.BASE filter may be extended through the Surface.margin with Filter.extendBaseFilter.
• 🤹‍♂️ SurfaceFX typedef for passing along your own FilterSpec.effects based on 📚 SurfaceLayer and the current Layer's radius.
  • Default effect is a nice gaussian blur (though a new 🌟 Surface has no active effects).

🤹‍♂️ FX Open to Grow

Currently only responsible for 💧 FX.blurry, the default ImageFilter for 🔬 Filter.

📖 Reference

🌟 Surface - A shapeable, layered, animated container Widget

🔰 Shape

• Defined by 📐 CornerSpec and generates a SurfaceShape

🔲 Peek - An Object with optional parameters to customize a 🌟 Surface's "peek"

👆 TapSpec - An Object with optional parameters to customize a 🌟 Surface's tap behavior

🔬 Filter - An Object with optional parameters to customize a 🌟 Surface's 🤹‍♂️ filters/effects

• 🤹‍♂️ SurfaceFX typedef for custom FilterSpec.effects!

🏓 BouncyBall

A delightfully bouncy and position-mirroring reaction to user input on a piece of Material.

Turn ink splashes for an InkWell, InkResponse or material Theme into 🏓 BouncyBalls or 🔮 "glass" BouncyBalls with the built-in InteractiveInkFeatureFactorys, or design your own with custom rubber Paint using 🪀 BouncyBall.mold.

🎊 Just a few extra goodies for fun.

• 🔦 `WithShading` Color extension
  • ⬛ `withBlack` .withBlack(int subtract)
  • ⬜ `withWhite` .withWhite(int add)
• 🤚 `DragNub` A small, round "handle" indicator used to visualize impression of draggable material

🌇 Roadmap

This is my first public package and I expect things may still be altered greatly.

• Speaking of which, an overhaul is currently ongoing as of 0.4.0. I am still new to Dart and improving my programming. Feel absolutely free to suggest improvements or make PRs.
• Since releasing Surface, I have found many more advanced and powerful packages. Still Surface progress marches onward as I plan to continue development as I learn.
• For example, I have already earned experience in deprecating features and "bad pushes"!

🔳 Animations of 📐 Surface.shape change.

✅ Differed radius on 📚 SurfaceLayer.MATERIAL vs 📚 SurfaceLayer.BASE

• Smaller inner radius gives a better aesthetic for nested shapes.
• 🆕 Manual setting of Surface.radius or Surface.baseRadius available now.
• 🆕 Manual Shapeing is here! Work in progress.

✅ Proposed SurfaceCornerSpec for Surface.corners parameter or expansion of 🔰 SurfaceShape class that allows customization of all four corners independently.

• 🆕 Manual Shapeing is here! Work in progress.

🌟 Surface Example

See example usage of the 🌟 Surface package for Flutter:

• Surface Example Android source: /example/lib/main.dart
• Animated GIF preview of Surface Example app
• Surface Example APK

🔗 SOURCE FOR BACKGROUND