flutter_residemenu

Residemenu for flutter,android and ios supported

Screenshot

ios

Usage

declare in pubspec.yaml


dependencies:
  ...

  residemenu:
    ^1.2.5

build() method to create my ResideMenu Widget,child is your contentView(if you use MaterialApp,mostly Scaffold), about leftScafford,rightScafford,they are used to build your MenuView According to the layout of the public. the more you can see the demo find how to use.If you do not meet your needs, you can use the ResideMenu.custom method.


      Widget buildItem(msg) {
        return new Material(
          color: Colors.transparent,
          child: new InkWell(
            child: const ResideMenuItem(
                title: "菜单一", icon: const Icon(Icons.home, color: Colors.grey),right: const Icon(Icons.arrow_forward,color:Colors.grey),),
            onTap: () {
              Scaffold
                  .of(context)
                  .showSnackBar(new SnackBar(content: new Text('你点击了$msg')));
            },
          ),
        );
      }

    new ResideMenu.scafford(

            decoration: new BoxDecoration(
                image: new DecorationImage(
                    image: new AssetImage("images/menu_background.png"),
                    fit: BoxFit.cover)),
            leftScafford: new MenuScaffold(
                                  header: new ConstrainedBox(

                                    constraints: new BoxConstraints(maxHeight: 80.0, maxWidth: 80.0),
                                    child: new CircleAvatar(

                                      backgroundImage: new AssetImage('images/author.jpeg'),
                                      radius: 40.0,
                                    ),
                                  ),
                                  children: <Widget>[
                                    buildItem("菜单一"),
                                    buildItem("菜单二"),
                                    buildItem("菜单三"),
                                    buildItem("菜单四"),
                                    buildItem("菜单五")
                                  ],
                                ),
            rightScafford: ...,
            controller: _menuController,
            child: ...
            )

Table

Attribute NameAttribute ExplainParameter TypeDefault Valuerequirement
childyour content ViewWidgetnullnecessary
directionThe direction of allowing ResideMenu to slideenumleftoptional
leftView,rightViewthe Menu Content ViewWidgetnulloptional
elevationContent View shadowdouble12.0optional
controllerControl menu behavior, get menu status, monitor menu open, close and other events.MenuControllernulloptional
decorationuse to set bg and color in bottomBoxDecorationnulloptional
onOpenEvent(bool isOpenLeft) => Voidnulloptional
onCloseEvent() => Voidnulloptional
onOffsetChangewhen the child offset change it will callback(0~1)(double offset) => voidnulloptional
enableFadefadeColor cover content Viewbooltrueoptional
enableScaleif you the gpu too high that lead the performance problem,it should be closedbooltrueoptional

LICENSE

MIT License

Copyright (c) 2018 Jpeng

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Libraries

residemenu
Author: Jpeng Email: peng8350@gmail.com createTime: 2018-5-9 21:13