AppFlowy/frontend/app_flowy/packages/appflowy_popover/README.md

40 lines
1.5 KiB
Markdown
Raw Normal View History

2022-09-01 07:28:16 +00:00
<!--
2022-08-29 05:56:16 +00:00
This README describes the package. If you publish this package to pub.dev,
this README's contents appear on the landing page for your package.
For information about how to write a good package README, see the guide for
2022-09-01 07:28:16 +00:00
[writing package pages](https://dart.dev/guides/libraries/writing-package-pages).
2022-08-29 05:56:16 +00:00
For general information about developing packages, see the Dart guide for
[creating packages](https://dart.dev/guides/libraries/create-library-packages)
and the Flutter guide for
2022-09-01 07:28:16 +00:00
[developing packages and plugins](https://flutter.dev/developing-packages).
2022-08-29 05:56:16 +00:00
-->
2022-09-01 07:28:16 +00:00
# AppFlowy Popover
2022-08-29 05:56:16 +00:00
TODO: Put a short description of the package here that helps potential users
know whether this package might be useful for them.
## Features
2022-09-01 07:28:16 +00:00
> A popover is a transient view that appears above other content onscreen when you tap a control or in an area. Typically, a popover includes an arrow pointing to the location from which it emerged. Popovers can be nonmodal or modal. A nonmodal popover is dismissed by tapping another part of the screen or a button on the popover. A modal popover is dismissed by tapping a Cancel or other button on the popover.
2022-08-29 05:56:16 +00:00
2022-09-01 07:28:16 +00:00
Source: [Human Interface Guidelines](https://developer.apple.com/design/human-interface-guidelines/ios/views/popovers/).
2022-08-29 05:56:16 +00:00
2022-09-01 07:28:16 +00:00
- Basic popover style
- Nested popover support
- Exclusive popover API
2022-08-29 05:56:16 +00:00
2022-09-01 07:28:16 +00:00
## Example
2022-08-29 05:56:16 +00:00
```dart
2022-09-01 07:28:16 +00:00
Popover(
triggerActions: PopoverTriggerActionFlags.click,
child: TextButton(child: Text("Popover"), onPressed: () {}),
popupBuilder(BuildContext context) {
return PopoverMenu();
},
);
2022-08-29 05:56:16 +00:00
```