⚠️ This Fork is deprecated in favour of flutter_statusbar_control ⚠️

flutter_statusbar_manager

As FooStudio/flutter_statusbar_manager doesn't seem to be maintained anymore, this fork will keep some further development as I want to continue using this dependencies in some projects.

Updates

v3.1.2 add cutout-mode for android and SafeArea to demo app
v3.1.1 resolve UIOverlay-deprecations and update of demo app
v3.1.0 support for Android V2 thanks to jWinterDay and rafaelmaeuer
v3.0.1 compatible with flutter web thanks to rafaelmaeuer
v3.0.0 support for null safety thanks to NarHakobyan
v2.0.0 compatible with AndroidX thanks to lorenzOliveto

Find a complete list of changes in CHANGELOG, tested lately with iOS15 and Android API 30.

About

Flutter Statusbar Manager, lets you control the status bar color, style (theme), visibility, and translucent properties across iOS and Android. With some added bonus for Android to control the Navigation Bar.

This plugin is based on React Native's StatusBar component.

The Navigation Bar code was taken from the awesome flutter-screen-theme-plugin.

Examples Android

Status Bar Color	Status Bar Hide	Navigation Bar

Examples iOS

Demo Iphone 8	Demo Iphone X

Note: not all of the shown examples might still work in the latest versions of Android or iOS

Installation

flutter_statusbar_manager:
  git:
    url: https://github.com/rafaelmaeuer/flutter_statusbar_manager.git

to your pubspec.yaml ,and run

flutter packages get

in your project's root directory.

Basic Usage

Create a new project with command

flutter create myapp

On iOS add the following in your Info.plist (if not already present):

<key>UIViewControllerBasedStatusBarAppearance</key>
<false/>

On Android add the following in your styles.xml (cutout-mode for API >27):

<item name="android:windowLayoutInDisplayCutoutMode" tools:targetApi="o_mr1">shortEdges</item>

Import the plugin in lib/main.dart like this:

import 'package:flutter_statusbar_manager/flutter_statusbar_manager.dart';

Methods

setColor

Platforms: Android

The setColor method will set the status bar background color. On iOS the method will always return a successful Future.

Parameter	Type	Default	Required	Description
color	`Color`	none	Yes	The color to be set as background, can use colors with opacity.
animated	`bool`	false	No	Whether or not to animate the color change.

await FlutterStatusbarManager.setColor(Colors.green, animated:true);

setTranslucent

Platforms: Android

The setTranslucent method will set the status bar translucent status. On iOS the methods will always return a successful Future.

Parameter	Type	Default	Required	Description
translucent	`bool`	none	Yes	Whether or not the status bar will be translucent.

await FlutterStatusbarManager.setTranslucent(true);

setHidden

Platforms: Android, iOS

The setHidden will hide the status bar.

Parameter	Type	Default	Required	Description
hidden	`bool`	none	Yes	Whether or not to hide the status bar.
animation	`StatusBarAnimation`	StatusBarAnimation.NONE	No	The hiding animation to use `(iOS only)`.

await FlutterStatusbarManager.setHidden(true, animation:StatusBarAnimation.SLIDE);

setStyle

Platforms: Android, iOS

The setStyle method will set the status bar theme.

Parameter	Type	Default	Required	Description
style	`StatusBarStyle`	none	Yes	The status bar theme to use for styling, can either be light, dark, default.

await FlutterStatusbarManager.setStyle(StatusBarStyle.DARK_CONTENT);

setNetworkActivityIndicatorVisible

Platforms: iOS

The setNetworkActivityIndicatorVisible method will show or hide the activity indicator, On Android the method will always return a successful Future.

Parameter	Type	Default	Required	Description
visible	`bool`	none	Yes	Whether or not to show the activity indicator.

await FlutterStatusbarManager.setNetworkActivityIndicatorVisible(true);

getHeight

Platforms: Android, iOS

The getHeight getter method will return the height of the status bar.

double height = await FlutterStatusbarManager.getHeight

Bonus Methods

setNavigationBarColor

Platforms: Android

The setNavigationBarColor method will set the navigation bar background color. On iOS the method will always return a successful Future.

Parameter	Type	Default	Required	Description
color	`Color`	none	Yes	The color to be set as background.
animated	`bool`	false	No	Whether or not to animate the color change.

await FlutterStatusbarManager.setNavigationBarColor(Colors.green, animated:true);

setNavigationBarStyle

Platforms: Android

The setNavigationBarStyle method will set the navigation bar theme.

Parameter	Type	Default	Required	Description
style	`NavigationBarStyle`	none	Yes	The navigation bar theme to use for styling, can either be light, dark, default.

await FlutterStatusbarManager.setNavigationBarStyle(NavigationBarStyle.DARK);

setFullscreen

Platforms: Android, iOS

The setFullscreen method will set the app in fullscreen mode.

Parameter	Type	Default	Required	Description
fullscreen	`bool`	none	Yes	Whether or not to set the app on fullscreen mode.

await FlutterStatusbarManager.setNavigationBarStyle(NavigationBarStyle.DARK);

Enums

StatusBarStyle

StatusBarStyle.DEFAULT
StatusBarStyle.LIGHT_CONTENT
StatusBarStyle.DARK_CONTENT

StatusBarAnimation

StatusBarAnimation.NONE
StatusBarAnimation.FADE
StatusBarAnimation.SLIDE

NavigationBarStyle

NavigationBarStyle.DEFAULT
NavigationBarStyle.DARK
NavigationBarStyle.LIGHT

Status bar

Compatibility: Android (6.0+) & iOS

On Android, it will only work with Android 6.0 (Marshmallow) and above devices.

Navigation bar

Compatibility: Android only

Android 5.0 (Lollipop) and above: color

Android 8.0 (Oreo) and above: style (dark/light)

efraespada / flutter_statusbar_manager Goto Github PK