solid-software / help_ukraine_widget Goto Github PK

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

License: MIT License

Swift 0.82% Dart 57.09% CMake 17.36% C++ 20.35% C 1.35% HTML 1.77% Ruby 1.26%

flutter helpukraine standwithukraine ukraine

help_ukraine_widget's Introduction

Help Ukraine Widget for Flutter

This is a port of Help Ukraine Widget - this widget helps to let users of your app know how they can help Ukraine from anywhere in the world.

Showcase

First widget variation

Second widget variation

Third widget variation

Fourth widget variation

Features

By installing this widget in your app, you will help to end the war in Ukraine. It will provide links for:

donations,
sharing this widget
and other ways to support Ukraine.

Getting started

Add the package as a dependency to your pubspec.yaml:

dependencies:
    help_ukraine_widget: <latest version>

in your code:

import 'package:help_ukraine_widget/help_ukraine_widget.dart';

Usage

Basic usage

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

OverlayWidget(
    alignment: Alignment.bottomRight,
    overlayWidget: HorizontalHelpWidget(),
    child: MyApp(),
)

Customization

You can also create custom variations of this widget:

// 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 and Gearheart for designing and creating the original widget.

help_ukraine_widget's People

Contributors

Stargazers

Watchers

Forkers

mkobuolys

help_ukraine_widget's Issues

Add third widget variation

https://helpukrainewinwidget.org/install-manually

Add second widget variation

https://helpukrainewinwidget.org/install-manually

Code documentation

We need to make sure code documentation is full, helpful and readable.

Refactor Chevron to apply rotation in _ChevronPainter instead of using RotatedBox

defaultOptionsList items have no onTap callbacks

The defaultOptionsList items have no onTap callbacks, hence nothing happens on click by default.

Add way to drop in the widget to predefined location on screen

The original widget places itself on screen (see Placement: ... selector https://helpukrainewinwidget.org/install-manually).

We need to replicate that so that the Widget would be easier to integrate into the app.

Add fourth widget variation

https://helpukrainewinwidget.org/install-manually

BLYAT UDALAYTE WIDGET

Add interactive example to README

We should host the example storybook on Github Pages and provide a link to it in our README.

Add theming support

Default white version of the widget won't look good in every app.

Add README

We need to add a README, which would include:

The rationale behind the Widget
Some examples of how it should look
Usage instructions
- Basic usage
- Customization (UI layout, theming)
- Localization (depends on #7)