Skip to content

Commit

Permalink
fix: documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
vanlooverenkoen committed Feb 11, 2024
1 parent 22db3a8 commit b9a4ed3
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 2 deletions.
5 changes: 3 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
# 0.0.10 - 0.0.11

# Feat
## Feat
- Automated builds using GitHub Actions
- Added preview video to the `README.md`
- Extra documentation in the `README.md`

# 0.0.4 - 0.0.9

# Feat
## Feat
- Added `Snacky` logo to the `README.md`

# 0.0.3
Expand Down
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,17 @@ Widget build(BuildContext context) {
```dart
final snacky = Snacky(
title: 'My super simple snacky title',
type: SnackyType.info, // or SnackyType.error, SnackyType.success, SnackyType.warning, SnackyType.info
showDuration: Duration(seconds: 3), // How long the snacky should be shown
transitionDuration: Duration(milliseconds: 300), // How long the transition should take
transitionCurve: Curves.easeInOut, // The curve of the transition
location: SnackyLocation.top, // Where the snacky should be shown (SnackyLocation.top or SnackyLocation.bottom)
openUntillClosed: false, // If the snacky should be open untill closed or canceled
canBeClosed: true, // If the snacky can be closed by the user (X button)
onTap: () => print('Snacky tapped'), // What should happen when the snacky is tapped
subtitle: 'My super simple snacky subtitle', // The subtitle of the snacky
leadingWidgetBuilder: (context, snacky) => Icon(Icons.check), // A widget that should be shown before the title
trailingWidgetBuilder: (context, snacky) => Icon(Icons.close), // A widget that should be shown after the title
);
SnackyController.instance.showMessage(snacky);
```
Expand Down

0 comments on commit b9a4ed3

Please sign in to comment.