https://github.com/anderscheow/whats_new
(Flutter) Beautiful way to showcase new features of your app.
https://github.com/anderscheow/whats_new
Last synced: 4 months ago
JSON representation
(Flutter) Beautiful way to showcase new features of your app.
- Host: GitHub
- URL: https://github.com/anderscheow/whats_new
- Owner: anderscheow
- License: mit
- Created: 2018-10-24T10:41:12.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-02-18T08:25:00.000Z (over 7 years ago)
- Last Synced: 2025-10-23T06:25:06.185Z (8 months ago)
- Language: Dart
- Homepage:
- Size: 68.4 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# whats_new
Beautiful way to showcase new features of your app.
[](https://pub.dartlang.org/packages/whats_new)
## Getting Started
Add the dependency to your `pubspec.yaml`
```yaml
dependencies:
whats_new: ^0.0.4
```
And run `flutter packages upgrade`
## How to use
### Option 1
Use `WhatsNew.show(BuildContext, WhatsNewContent)`.
````dart
// Only show partial configurations, please refer WhatsNewContent to view more configurations
WhatsNew.show(context, WhatsNewContent(
backgroundColor: Colors.white,
title: 'What\'s New',
titleColor: Colors.black,
primaryButtonText: 'Let\'s Go',
primaryButtonTextColor: Colors.white,
primaryButtonBackgroundColor: Colors.red,
secondaryButtonText: 'Learn more',
secondaryButtonTextColor: Colors.red,
transitionDuration: Duration(milliseconds: 350),
featureItemTransitionDuration: Duration(milliseconds: 350),
hideSecondaryButton: false,
dismissible: false,
callback: this,
features: [
Feature(
icon: 'assets/camera-iris.png',
iconColor: Colors.red,
title: 'Title four',
titleColor: Colors.black,
description: 'Lorem ipsum dolor sit amet',
descriptionColor: Colors.grey
),
Feature(
icon: 'assets/cellphone.png',
iconColor: Colors.red,
title: 'Title five',
titleColor: Colors.black,
description: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt',
descriptionColor: Colors.grey
)
],
));
````
or
### Option 2
Created your own `WhatsNewContent` and launch with your own `Navigator`.
````dart
var content = WhatsNewContent(...)
Navigator.of(context).push(WhatsNew(content));
````
## Example
Check out the [example](https://pub.dartlang.org/packages/whats_new#-example-tab-) for more details.
## Changelog
See [changelog](https://pub.dartlang.org/packages/whats_new#-changelog-tab-).
## Contributions
Any contribution is more than welcome! You can contribute through pull requests and issues on GitHub.