fluttermoji 0.1.1
fluttermoji: ^0.1.1 copied to clipboard

Flutter Android iOS

A light-weight and highly customizable SVG graphic set for Flutter, which provides a Customizer Widget, CircleAvatar and other utility functions.

Fluttermoji #

A light-weight and highly customizable SVG graphic set for Flutter, which provides a Customizer Widget, CircleAvatar and other utility functions.

This package provides you two easy-to-use widgets -

NameDescriptionScreenshot
FluttermojiCircleAvatarUse your fluttermoji anywhere in your Flutter app with a simple customizable widget. Supports material dark theme too.1608830483994
FluttermojiCustomizerA complete personalization suit that offers previews of each individual component and a modern UI with material light and dark theme support.1608827561239

Use the given utility functions to send and receive Fluttermoji data from your server/DB efficiently.

Function PrototypeDescription
String decodeFluttermojifromString(String encodedData)Decode your string containing the attributes to a SVG and render it by enclosing this string with a SvgPicture.string()
Future<Map> encodeMySVGtoMap()Retrieve the local user's fluttermoji attributes from local storage and encodes them to a Map of attributes and returns a Future, you have to await on function call.
Future<String> encodeMySVGtoString()Retrieve the local user's fluttermoji attributes from local storage and encodes them to a String containing a map of attributes and returns a Future, you have to await on function call.

SVG Assets used are derived from getavataaars.com .

Screenshots #

Example app #

Use them in your games or social media apps #

Usage Instructions #

  1. Depend on it by importing your package in the pubspec.yaml file.
     dependencies:
         fluttermoji: any
    
  2. Add the following import to your .dart file
     import 'package:fluttermoji/fluttermoji.dart';
    
  3. Add the FluttermojiCircleAvatar widget to display your Fluttermoji where needed.
     FluttermojiCircleAvatar();
    
  4. To allow your users to personalize their Fluttermoji, add the following widget and pair it with the above one in your page.
     FluttermojiCustomizer();
    

That's all it takes, simple right ? The two widgets communicate with each other and update in real-time throughout your widget tree.

Usage Guidelines #

The package offers a ton of features in the simplest way possible, however there are some points worth noting.

  • FluttermojiCircleAvatar would render an avatar with the default set of options until customized and saved by the user.
  • FluttermojiCustomizer updates the preview in real-time however changes must be saved by tapping the Save icon built into the widget itself.
  • FluttermojiCustomizer uses a Scaffold whose height is set to 0.4*screen height by default, if you do not pass a value to the scaffoldHeight property make sure to place the widget properly.
  • If you plan on using FluttermojiCustomizer in Landscape mode, manually pass in the desired width for the widget in the scaffoldWidth property.
  • The Fluttermoji's attributes are saved to local app storage. Clearing app data would mean clearing these attributes as well.

Attributions #

Community #

If you find any issues or have some feedback, please raise the same on the GitHub repo or contact me directly. Share your creative implementation of Fluttermoji with me and I might feature them on this page. Just place a comment in the Discussions forum on the repo. Do leave a thumbs up if you liked it.

Happy Fluttering ; )

28
likes
90
pub points
41%
popularity

A light-weight and highly customizable SVG graphic set for Flutter, which provides a Customizer Widget, CircleAvatar and other utility functions.

Repository (GitHub)
View/report issues

Documentation

API reference

Uploader

p.surajkumar907@gmail.com

License

BSD (LICENSE)

Dependencies

flutter, flutter_svg, get, shared_preferences

More

Packages that depend on fluttermoji