https://github.com/jaweii/Flutter_beautiful_popup
A flutter package help you beautify your app popups.
https://github.com/jaweii/Flutter_beautiful_popup
Last synced: 21 days ago
JSON representation
A flutter package help you beautify your app popups.
- Host: GitHub
- URL: https://github.com/jaweii/Flutter_beautiful_popup
- Owner: jaweii
- License: bsd-3-clause
- Created: 2019-12-05T07:04:14.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-10-13T09:25:37.000Z (over 2 years ago)
- Last Synced: 2024-07-31T15:01:34.241Z (9 months ago)
- Language: JavaScript
- Homepage: https://jaweii.github.io/Flutter_beautiful_popup/example/build/web/
- Size: 21.1 MB
- Stars: 674
- Watchers: 17
- Forks: 90
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-flutter-cn - Beautiful_Popup - 美化应用弹出窗口，由[jaweii](https://github.com/jaweii)创建。 (组件 / UI)
- awesome-github-star - Flutter_beautiful_popup
- awesome-flutter - Beautiful_Popup - A flutter package to help you beautify your app popups. ` 📝 3 days ago ` (UI [🔝](#readme))
- awesome-flutter - Beautiful_Popup - Beautify your app popup by [jaweii](https://github.com/jaweii). (Components / UI)
- awesome-flutter-cn - Beautiful_Popup - 美化应用的弹出层，[jaweii](https://github.com/jaweii). (组件 / UI)
- awesome-flutter - 美丽弹窗 - 作者：[jaweii](https://github.com/jaweii) (Uncategorized / Uncategorized)
- awesome-flutter - 美丽弹窗 - 作者：[jaweii](https://github.com/jaweii) (Uncategorized / Uncategorized)
README
# flutter_beautiful_popup [中文](https://github.com/jaweii/Flutter_beautiful_popup/blob/master/README_CN.md)
A flutter package to help you beautify your app popup, can be used in all platform.[Live Demo](https://jaweii.github.io/Flutter_beautiful_popup/example/build/web/#/).
## Preview:
## Getting Started
Add dependency to you `pubspec.yaml`:
```
dependencies:
flutter_beautiful_popup: ^1.7.0
```
Import the dependency:
```
import 'package:flutter_beautiful_popup/main.dart';
```
And then you can display a popup with certain template like this:
```
final popup = BeautifulPopup(
context: context,
template: TemplateGift,
);
popup.show(
title: 'String or Widget',
content: 'String or Widget',
actions: [
popup.button(
label: 'Close',
onPressed: Navigator.of(context).pop,
),
],
// bool barrierDismissible = false,
// Widget close,
);
```
If you wan to `recolor` the illustration of the template, you can call the `recolor` method, but this function takes a little time to caculate/offset the color cahnnel of the illustration:
```
final newColor = Colors.red.withOpacity(0.5);
await popup.recolor(newColor);
```
All available templates you can find in [Live Demo](https://jaweii.github.io/Flutter_beautiful_popup/example/build/web/#/).
## Customize your own BeautifulPopupTemplate
You can extend `BeautifulPopupTemplate` to customize your own template like this:
```
import 'package:flutter/material.dart';
import 'package:flutter_beautiful_popup/main.dart';
class MyTemplate extends BeautifulPopupTemplate {
final BeautifulPopup options;
MyTemplate(this.options) : super(options);
@override
final illustrationKey = 'images/mytemplate.png';
@override
Color get primaryColor => options.primaryColor ?? Color(0xff000000); // The default primary color of the template is Colors.black.
@override
final maxWidth = 400; // In most situations, the value is the illustration size.
@override
final maxHeight = 600;
@override
final bodyMargin = 10;
// You need to adjust the layout to fit into your illustration.
@override
get layout {
return [
Positioned(
child: background,
),
Positioned(
top: percentH(10),
child: title,
),
Positioned(
top: percentH(40),
height: percentH(actions == null ? 32 : 42),
left: percentW(10),
right: percentW(10),
child: content,
),
Positioned(
bottom: percentW(10),
left: percentW(10),
right: percentW(10),
child: actions ?? Container(),
),
];
}
}
```
To display a popup with your own template:
```
final popup = BeautifulPopup.customize(
context: context,
build: (options) => MyTemplate(options),
);
popup.show(
title: 'Example',
content: Container(
color: Colors.black12,
child: Text(
'This popup shows you how to customize your own BeautifulPopupTemplate.'),
),
actions: [
popup.button(
label: 'Code',
onPressed: () {
js.context.callMethod('open', [
'https://github.com/jaweii/Flutter_beautiful_popup/blob/master/example/lib/MyTemplate.dart'
]);
},
),
],
);
```
## Contributor
