11# Help Ukraine Widget for Flutter
2+
23[ ![ style: solid] ( https://img.shields.io/badge/style-solid-orange )] ( https://pub.dev/packages/solid_lints )
34
45This is a port of [ Help Ukraine Widget] ( https://helpukrainewinwidget.org/ ) -
56this widget helps to let users of your app know how they can help Ukraine
67from anywhere in the world.
78
8- ### Showcase
9+ ## Showcase
910
1011<details open ><summary >First widget variation</summary >
1112
@@ -15,7 +16,6 @@ from anywhere in the world.
1516<details ><summary >Second widget variation</summary >
1617
1718![ Second widget example] ( gifs/widget2.gif )
18- </details >
1919
2020<details ><summary >Third widget variation</summary >
2121
@@ -28,6 +28,7 @@ from anywhere in the world.
2828</details >
2929
3030## Features
31+
3132By installing this widget in your app, you will help to end the war in Ukraine.
3233It will provide links for:
3334
@@ -36,6 +37,7 @@ It will provide links for:
3637* and [ other ways to support Ukraine] ( https://war.ukraine.ua/ ) .
3738
3839## Getting started
40+
3941Add the package as a dependency to your __ pubspec.yaml__ :
4042
4143``` yaml
@@ -52,7 +54,9 @@ import 'package:help_ukraine_widget/help_ukraine_widget.dart';
5254## Usage
5355
5456### Basic usage
57+
5558Use ` OverlayWidget ` to float and align the widget above your app:
59+
5660``` dart
5761OverlayWidget(
5862 alignment: Alignment.bottomRight,
@@ -62,7 +66,9 @@ OverlayWidget(
6266```
6367
6468### Customization
69+
6570You can also create custom variations of this widget:
71+
6672``` dart
6773// we used that in our widget, but you do you
6874final order = [HelpWidgetView.collapsed, HelpWidgetView.main, HelpWidgetView.options];
@@ -85,17 +91,17 @@ HelpWidget(
8591
8692To make it easier we provide some classes:
8793
88- #### Components ####
94+ #### Components
8995
90- ##### Buttons #####
96+ ##### Buttons
9197
9298` DetailsButton ` - used in main view to go to options view.
9399
94100` HelpOptionButton ` - used in options view as a link to external resources.
95101
96102` RoundedButton ` - close button for ` CardRounded ` .
97103
98- ##### Other #####
104+ ##### Other
99105
100106` CardRounded ` - base widget for every view.
101107
@@ -110,6 +116,7 @@ To make it easier we provide some classes:
110116` XMark ` - flexible cross icon.
111117
112118### Controllers
119+
113120` TraverseController ` is used to track current view and direction of last transition.
114121
115122### Helpers
@@ -121,6 +128,7 @@ To make it easier we provide some classes:
121128` HelpWidgetView ` - enum to track current view using ` TraverseController ` .
122129
123130### Theme
131+
124132` FontConfig ` - common font settings in project.
125133
126134` HelpColors ` - common colors used in project.
0 commit comments