https://github.com/solid-software/help_ukraine_widget

🇺🇦 Flutter widget to raise awareness of the war in Ukraine and collect donations.
https://github.com/solid-software/help_ukraine_widget

flutter helpukraine standwithukraine ukraine

Last synced: 9 months ago
JSON representation

🇺🇦 Flutter widget to raise awareness of the war in Ukraine and collect donations.

• Host: GitHub
• URL: https://github.com/solid-software/help_ukraine_widget
• Owner: solid-software
• License: mit
• Created: 2022-08-10T13:31:08.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2022-09-29T23:26:57.000Z (over 3 years ago)
• Last Synced: 2024-08-20T14:21:57.968Z (over 1 year ago)
• Topics: flutter, helpukraine, standwithukraine, ukraine
• Language: Dart
• Homepage:
• Size: 1.8 MB
• Stars: 12
• Watchers: 1
• Forks: 1
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Help Ukraine Widget for Flutter

[![style: solid](https://img.shields.io/badge/style-solid-orange)](https://pub.dev/packages/solid_lints)

This is a port of [Help Ukraine Widget](https://helpukrainewinwidget.org/) -

this widget helps to let users of your app know how they can help Ukraine

from anywhere in the world.

## Showcase

First widget variation

![First widget example](gifs/widget1.gif)

Second widget variation

    

![Second widget example](gifs/widget2.gif)

Third widget variation

![Third widget example](gifs/widget3.gif)

Fourth widget variation

![Fourth widget example](gifs/widget4.gif)

## Features

By installing this widget in your app, you will help to end the war in Ukraine.

It will provide links for:

* [donations](https://uahelp.monobank.ua/),

* sharing this widget

* and [other ways to support Ukraine](https://war.ukraine.ua/).

## Getting started

Add the package as a dependency to your __pubspec.yaml__:

``` yaml

dependencies:

    help_ukraine_widget: 

```

in your code:

``` dart

import 'package:help_ukraine_widget/help_ukraine_widget.dart';

```

## Usage

### Basic usage

Use `OverlayWidget` to float and align the widget above your app:

``` dart

OverlayWidget(

    alignment: Alignment.bottomRight,

    overlayWidget: HorizontalHelpWidget(),

    child: MyApp(),

)

```

### Customization

You can also create custom variations of this widget:

``` dart

// we used that in our widget, but you do you 

final order = [HelpWidgetView.collapsed, HelpWidgetView.main, HelpWidgetView.options];

final _controller = TraverseController(order);

HelpWidget(

    controller: _controller;

    // view with links to resources that help Ukraine

    optionsView: ...

    // The default first view that the users see.

    mainView: ...

    // smallest view that doesn't obstruct user from

    // using the app, but still exists on the screen

    collapsedView: ...

    // axis of transition animation between views

    axis: ...

)

```

## Credits

[jiffsy.co](https://jiffsy.co/) and [Gearheart](https://gearheart.io/) for designing and creating the [original widget](https://helpukrainewinwidget.org/).