Skip to content

fix: update README.md #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

fix: update README.md #11

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 40 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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';
```
Expand Down Expand Up @@ -42,6 +45,42 @@ import 'package:full_screen_menu/full_screen_menu.dart';
<br>
<br>

## 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<Widget> 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 | +

<br>
<br>
<br>
<br>

## 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 | +

<br>
<br>
<br>
<br>

## License
This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details