Skip to content

fix: update README.md #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix: update README.md #13

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 33 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,15 @@


## Installing:
In your pubspec.yaml
1. Add the dependency in your `pubspec.yaml` file.

```yaml
dependencies:
status_alert: ^1.0.1
```

2. Import the `settings_ui` package.

```dart
import 'package:status_alert/status_alert.dart';
```
Expand All @@ -32,6 +36,34 @@ import 'package:status_alert/status_alert.dart';
<br>
<br>

## Status Alert Base Widget

Status Alert Base Widget

### Parameters

| Parameter | Description | Required |
|--|--|--|
| PopupMediaConfiguration? configuration | | +
| BorderRadius borderRadius | Set a border radius for Alert Widget | +
| Color? backgroundColor | Set a background color for Alert Widget | +
| Alignment alignment | Set an alignment of the whole widget | +
| EdgeInsets padding | Set a padding of the content widget | +
| EdgeInsets margin | Margin of the content widget | +
| String? title | Set a title of Alert Widget | -
| String? subtitle | Set a subtitle of Alert Widget | -
| Duration? duration | Set a duration after which the widget disappears | -
| StatusAlertTextConfiguration? titleOptions | Set a TextConfiguration for title | -
| StatusAlertTextConfiguration? subtitleOptions | Set a TextConfiguration for subtitle | -
| VoidCallback? onHide | Set the function that will be called after duration | -
| double? blurPower | Set a blur Power for Alert Widget | -
| double? maxWidth | Set a max width Alert Widget | -

<br>
<br>
<br>
<br>

## Apple Podcasts vs Status Alert:
<img src="https://raw.githubusercontent.com/yako-dev/flutter-status-alert/master/assets/apple_podcasts_subscribed_animation.gif" height="500px"> <img src="https://raw.githubusercontent.com/yako-dev/flutter-status-alert/master/assets/status_alert_subscribed_animation.gif" height="500px">
<br>
Expand Down