diff --git a/README.md b/README.md index e06f817..a3d11f7 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,49 @@ -# fluttersliderdrawer +# Flutter slider drawer -A new Flutter plugin. + +A Flutter package with custom implementation of the Sider Drawer Menu (Drawer) ![Plugin example demo](demo.gif) -## Getting Started +To start using this package, add `fluttersliderdrawer` dependency to your `pubspec.yaml` + +```yaml +dependencies: + fluttersliderdrawer: '' +``` + + + +# Features + + - Slider with custom animation time + - Provide Basic Appbar with customization of color, sizes and titles + - Dynamic slider open and close offset + - Provide drawer icon animation +# Code +``` +SliderMenuContainer( + appBarColor: Colors.white, + key: _key, + appBarPadding: const EdgeInsets.only(top: 20), + sliderMenuOpenOffset: 250, + appBarHeight: 60, + title: Text( + title, + style: TextStyle(fontSize: 22, fontWeight: FontWeight.w700), + ), + sliderMenuWidget: MenuWidget( + onItemClick: (title) { + _key.currentState.closeDrawer(); + setState(() { + this.title = title; + }); + }, + ), + sliderMainWidget: MainWidget()), + ```