From 0a8a2df97d9e9b4b5238d790649a32f172d0c583 Mon Sep 17 00:00:00 2001 From: sawel24 Date: Fri, 28 Oct 2022 17:48:18 +0300 Subject: [PATCH] fix: update README.md --- README.md | 41 ++++++++++++++++++++++++++++++++++++++++- 1 file changed, 40 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 19cb4de..b8e70db 100644 --- a/README.md +++ b/README.md @@ -8,11 +8,14 @@ ## Installing: -In your pubspec.yaml + +1. Add the dependency in your `pubspec.yaml` file. ```yaml dependencies: full_screen_menu: ^2.0.0 ``` + +2. Import the `settings_ui` package. ```dart import 'package:full_screen_menu/full_screen_menu.dart'; ``` @@ -42,6 +45,42 @@ import 'package:full_screen_menu/full_screen_menu.dart';

+## Full Screen Menu Base Widget + +The Full Screen Menu Base Widget is the block of your menu items located in your screen + +### Parameters + +| Parameter | Description | Required | +|--|--|--| +| Color backgroundColor | Set a background color of your FullScreenMenu | + +| VoidCallback onHide | Set a function which is called by pressing FAB| - +| List items | Set a menu items which you want to display | - +| BuildContext context | Set the context of your parent widget | - +| Function(AnimationController) animationController | Setup your animation when open full screen menu | + + +
+
+
+
+ +## FSMenuItem + +The Full Screen Menu Base Widget is the block of your menu items located in your screen + +### Parameters + +| Parameter | Description | Required | +|--|--|--| +| Text text | Set the text that will be displayed on the item | - +| Icon icon | Set the icon that will be displayed on the item| - +| Function onTap | Set The function that will be called when you click on item | + +| Gradient gradient | Set a gradient that will fill the background of your icon | + + +
+
+
+
## License This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details