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
1213![ ] ( gifs/widget1.gif )
1314</details >
1415
1516<details ><summary >Second widget variation</summary >
16-
17+
1718![ ] ( gifs/widget2.gif )
1819</details >
1920
@@ -28,6 +29,7 @@ from anywhere in the world.
2829</details >
2930
3031## Features
32+
3133By installing this widget in your app, you will help to end the war in Ukraine.
3234It will provide links for:
3335
@@ -36,6 +38,7 @@ It will provide links for:
3638* and [ other ways to support Ukraine] ( https://war.ukraine.ua/ ) .
3739
3840## Getting started
41+
3942Add the package as a dependency to your __ pubspec.yaml__ :
4043
4144``` yaml
@@ -52,7 +55,9 @@ import 'package:help_ukraine_widget/help_ukraine_widget.dart';
5255## Usage
5356
5457### Basic usage
58+
5559Use ` OverlayWidget ` to float and align the widget above your app:
60+
5661``` dart
5762OverlayWidget(
5863 alignment: Alignment.bottomRight,
@@ -62,7 +67,9 @@ OverlayWidget(
6267```
6368
6469### Customization
70+
6571You can also create custom variations of this widget:
72+
6673``` dart
6774// we used that in our widget, but you do you
6875final order = [HelpWidgetView.collapsed, HelpWidgetView.main, HelpWidgetView.options];
@@ -85,17 +92,17 @@ HelpWidget(
8592
8693To make it easier we provide some classes:
8794
88- #### Components ####
95+ #### Components
8996
90- ##### Buttons #####
97+ ##### Buttons
9198
9299` DetailsButton ` - used in main view to go to options view.
93100
94101` HelpOptionButton ` - used in options view as a link to external resources.
95102
96103` RoundedButton ` - close button for ` CardRounded ` .
97104
98- ##### Other #####
105+ ##### Other
99106
100107` CardRounded ` - base widget for every view.
101108
@@ -110,6 +117,7 @@ To make it easier we provide some classes:
110117` XMark ` - flexible cross icon.
111118
112119### Controllers
120+
113121` TraverseController ` is used to track current view and direction of last transition.
114122
115123### Helpers
@@ -121,6 +129,7 @@ To make it easier we provide some classes:
121129` HelpWidgetView ` - enum to track current view using ` TraverseController ` .
122130
123131### Theme
132+
124133` FontConfig ` - common font settings in project.
125134
126135` HelpColors ` - common colors used in project.
0 commit comments