drawerbehavior 0.0.8

  • Readme
  • Changelog
  • Example
  • Installing
  • 87

pub package

Drawer Behavior - Flutter #

Drawer behavior is a library that provide an extra behavior on drawer, such as, move view or scaling view's height while drawer on slide.

Alt Text


Code Base & Credit : https://github.com/matthew-carroll/flutter_ui_challenge_zoom_menu


Todo #

  • [x] Radius Parameter
  • [ ] Right Menu View
  • [ ] 3D effect
  • [ ] Material design drawer's behavior

Usage #

  1. Depend on it

Add this to your package's pubspec.yaml file:

dependencies:
  drawerbehavior: ^0.0.4
  1. Install it

You can install packages from the command line:

with Flutter:

$ flutter packages get

Alternatively, your editor might support flutter packages get. Check the docs for your editor to learn more.

  1. Import it

Now in your Dart code, you can use:

import 'package:drawerbehavior/drawerbehavior.dart';

For Android : Drawer-Behavior #


Example #

import 'package:flutter/material.dart';
import 'package:drawerbehavior/drawerbehavior.dart';

class Drawer4 extends StatefulWidget {
  @override
  _Drawer4State createState() => _Drawer4State();
}

class _Drawer4State extends State<Drawer4> {
  final menu = new Menu(
    items: [
      new MenuItem(
        id: 'restaurant',
        title: 'THE PADDOCK',
      ),
      new MenuItem(
        id: 'other1',
        title: 'THE HERO',
      ),
      new MenuItem(
        id: 'other2',
        title: 'HELP US GROW',
      ),
      new MenuItem(
        id: 'other3',
        title: 'SETTINGS',
      ),
    ],
  );

  var selectedMenuItemId = 'restaurant';
  var _widget = Text("1");

  Widget headerView(BuildContext context) {
    return Column(
      children: <Widget>[
        Container(
          padding: EdgeInsets.fromLTRB(16, 12, 16, 0),
          child: Row(
            children: <Widget>[
              new Container(
                  width: 48.0,
                  height: 48.0,
                  decoration: new BoxDecoration(
                      shape: BoxShape.circle,
                      image: new DecorationImage(
                          fit: BoxFit.fill,
                          image: AssetImage("assets/user1.jpg")))),
              Container(
                  margin: EdgeInsets.only(left: 16),
                  child: Column(
                    mainAxisAlignment: MainAxisAlignment.start,
                    crossAxisAlignment: CrossAxisAlignment.start,
                    children: <Widget>[
                      Text(
                        "John Witch",
                        style: Theme.of(context)
                            .textTheme
                            .subhead
                            .copyWith(color: Colors.white),
                      ),
                      Text(
                        "test123@gmail.com",
                        style: Theme.of(context)
                            .textTheme
                            .subtitle
                            .copyWith(color: Colors.white.withAlpha(200)),
                      )
                    ],
                  ))
            ],
          ),
        ),
        Divider(
          color: Colors.white.withAlpha(200),
          height: 16,
        )
      ],
    );
  }

  @override
  Widget build(BuildContext context) {
    return new DrawerScaffold(
      percentage: 1,
      cornerRadius: 0,
      appBar: AppBarProps(
          title: Text("Drawer 4"),
          actions: [IconButton(icon: Icon(Icons.add), onPressed: () {})]),
      menuView: new MenuView(
        menu: menu,
        headerView: headerView(context),
        animation: false,
        mainAxisAlignment: MainAxisAlignment.start,
        color: Theme.of(context).primaryColor,
        selectedItemId: selectedMenuItemId,
        onMenuItemSelected: (String itemId) {
          selectedMenuItemId = itemId;
          if (itemId == 'restaurant') {
            setState(() => _widget = Text("1"));
          } else {
            setState(() => _widget = Text("default"));
          }
        },
      ),
      contentView: Screen(
        contentBuilder: (context) => Center(child: _widget),
        color: Colors.white,
      ),
    );
  }
}


Preview #

Android #

new DrawerScaffold(
  percentage: 0.6,
  ...
);

new DrawerScaffold(
  percentage: 0.6,
  headerView: headerView(context),
  ...
);

IOS #

new DrawerScaffold(
  percentage: 0.6,
  ...
);

new DrawerScaffold(
  percentage: 0.6,
  headerView: headerView(context),
  ...
);

Customize #

DrawerScaffold

DrawerScaffoldController controller;
MenuView menuView;
Screen contentView;
AppBarProps appBar;
bool showAppBar;
double percentage;
double cornerRadius;

Screen

String title;
DecorationImage background;
WidgetBuilder contentBuilder;
Color color;
Color appBarColor;

MenuView

Menu menu;
String selectedItemId;
bool animation;
Function(String) onMenuItemSelected;
Widget headerView;
Widget footerView;
DecorationImage background;
Color color;
Color selectorColor;
TextStyle textStyle;
Alignment alignment;
EdgeInsets padding;
Function(BuildContext, MenuItem, bool) itemBuilder;

MenuItem

String id;
String title;
IconData icon;

AppBarProps

Icon leadingIcon;
bool automaticallyImplyLeading;
List<Widget> actions;
Widget flexibleSpace;
PreferredSizeWidget bottom;
double elevation;
Brightness brightness;
IconThemeData iconTheme;
TextTheme textTheme;
bool primary;
bool centerTitle;
double titleSpacing;
double toolbarOpacity;
double bottomOpacity;
Color backgroundColor;
Widget title;

0.0.8 #

  • Upgrade min. dart version to 2.1.0

0.0.7 #

  • Add icon parameter on MenuItem
  • Support custom MenuItem widget
  • Add drawer controller
  • Add footer view option

0.0.6 #

  • Drawer absorb gesture, if open

0.0.5 #

  • Handle back button event for Android device
  • Add corner radius constraint
  • Add content shadow constraint

example/lib/main.dart

import 'package:drawerbehavior_example/pages/drawer_custom_item.dart';
import 'package:drawerbehavior_example/pages/drawer_scale.dart';
import 'package:drawerbehavior_example/pages/drawer_scale_icon.dart';
import 'package:drawerbehavior_example/pages/drawer_scale_no_animation.dart';
import 'package:drawerbehavior_example/pages/drawer_slide.dart';
import 'package:drawerbehavior_example/pages/drawer_slide_custom_appbar.dart';
import 'package:drawerbehavior_example/pages/drawer_slide_with_footer.dart';
import 'package:drawerbehavior_example/pages/drawer_slide_with_header.dart';
import 'package:flutter/material.dart';

void main() => runApp(MyApp());

class MyApp extends StatefulWidget {
  @override
  _MyAppState createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  Widget createButton(context, {text, navigate, color}) {
    return SizedBox(
        width: double.infinity,
        child: RaisedButton(
            child: Text(text),
            color: color,
            onPressed: () {
              Navigator.pushNamed(context, navigate);
            }));
  }

  Widget home(context) {
    return Scaffold(
      appBar: AppBar(
        title: Text("Drawer Behavior"),
      ),
      body: Container(
          padding: EdgeInsets.all(16.0),
          child: Column(
            children: <Widget>[
              createButton(context,
                  text: "Scale",
                  navigate: "/drawer1",
                  color: Theme.of(context).accentColor),
              createButton(context,
                  text: "Scale - with Icon",
                  navigate: "/drawer6",
                  color: Theme.of(context).accentColor),
              createButton(context,
                  text: "Scale - no animation",
                  navigate: "/drawer2",
                  color: Theme.of(context).accentColor),
              Divider(height: 16, color: Theme.of(context).dividerColor),
              Text("Align Top"),
              Divider(height: 16, color: Theme.of(context).dividerColor),
              createButton(context,
                  text: "Slide ",
                  navigate: "/drawer3",
                  color: Theme.of(context).accentColor),
              createButton(context,
                  text: "Slide - with Header View",
                  navigate: "/drawer4",
                  color: Theme.of(context).accentColor),
              createButton(context,
                  text: "Slide - with Footer View",
                  navigate: "/drawer8",
                  color: Theme.of(context).accentColor),
              Divider(height: 16, color: Theme.of(context).dividerColor),
              Text("Customize"),
              Divider(height: 16, color: Theme.of(context).dividerColor),
              createButton(context,
                  text: "Customize Item",
                  navigate: "/drawer5",
                  color: Theme.of(context).accentColor),
              createButton(context,
                  text: "Custom AppBar",
                  navigate: "/drawer7",
                  color: Theme.of(context).accentColor),
            ],
          )),
    );
  }

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      theme: ThemeData(
          primarySwatch: Colors.teal, accentColor: Colors.amberAccent),
      routes: {
        "/": home,
        "/drawer1": (context) => DrawerScale(),
        "/drawer2": (context) => DrawerScaleNoAnimation(),
        "/drawer3": (context) => DrawerSlide(),
        "/drawer4": (context) => DrawerSlideWithHeader(),
        "/drawer5": (context) => DrawerCustomItem(),
        "/drawer6": (context) => DrawerScaleIcon(),
        "/drawer7": (context) => DrawerSlideCustomAppBar(),
        "/drawer8": (context) => DrawerSlideWithFooter(),
      },
      debugShowCheckedModeBanner: false,
    );
  }
}

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  drawerbehavior: ^0.0.8

2. Install it

You can install packages from the command line:

with Flutter:


$ flutter pub get

Alternatively, your editor might support flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:drawerbehavior/drawerbehavior.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
80
Health:
Code health derived from static analysis. [more]
99
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
88
Overall:
Weighted score of the above. [more]
87
Learn more about scoring.

We analyzed this package on Mar 27, 2020, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.7.1
  • pana: 0.13.6
  • Flutter: 1.12.13+hotfix.8

Health suggestions

Fix lib/drawer_scaffold.dart. (-1 points)

Analysis of lib/drawer_scaffold.dart reported 2 hints:

line 297 col 17: 'ancestorStateOfType' is deprecated and shouldn't be used. Use findAncestorStateOfType instead. This feature was deprecated after v1.12.1..

line 297 col 41: 'TypeMatcher' is deprecated and shouldn't be used. TypeMatcher has been deprecated because it is no longer used in framework(only in deprecated methods). This feature was deprecated after v1.12.1..

Format lib/menu_screen.dart.

Run flutter format to format lib/menu_screen.dart.

Maintenance suggestions

Package is pre-v0.1 release. (-10 points)

While nothing is inherently wrong with versions of 0.0.*, it might mean that the author is still experimenting with the general direction of the API.

Package is getting outdated. (-2.47 points)

The package was last published 53 weeks ago.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.1.0 <3.0.0
flutter 0.0.0
Transitive dependencies
collection 1.14.11 1.14.12
meta 1.1.8
sky_engine 0.0.99
typed_data 1.1.6
vector_math 2.0.8