Skip to content

Latest commit

 

History

History
41 lines (31 loc) · 2.02 KB

README.md

File metadata and controls

41 lines (31 loc) · 2.02 KB

Version Banner

An app Banner Widget that shows the current app version. Can be used with App Flavors to show what flavor of the app is currently being used.

Getting Started

This widget should wrap MaterialApp or CupertinoApp.

Example

VersionBanner(
          text: "Yay!",
          packageExtensions: [".dev"],
          extensionHandling: VersionBannerExtensionHandling.packageContainDev,
          child: MaterialApp(
                       debugShowCheckedModeBanner: false,
                       title: 'Flutter Demo',
                       theme: ThemeData(
                         primarySwatch: Colors.blue,
                       ),
                       home: MyHomePage(title: 'Flutter Demo Home Page'),
                     )
      );

packageExtensions will check the app's package name with the given array based on value of extensionHandling.

[Original/Default Behavior] If extensionHandling is VersionBannerExtensionHandling.packageContainDev and the package name contains part of the String in the array, then the banner is visible.

If extensionHandling is VersionBannerExtensionHandling.packageSuffixDev and the package name ends with any of the String in the array, then the banner is visible.

The following properties can be changed:

  • color - Banner's color
  • textStyle - Banner's text style
  • text - The text to appear. If set to null will show the pubspec version
  • location - the banner's location on the screen, based on the class BannerLocation
  • packageExtensions - will check the app's package name with the given array and decide the banner's visibility
  • extensionHandling - will control the behavior for packageExtensions to work
  • visible - decides if the banner is visible or not. If set to false, it overrides the packageExtensions attribute