From 7bdc875d731391b08b7a978508a8129063a9aa7c Mon Sep 17 00:00:00 2001 From: Daniyil Yakovlev Date: Thu, 2 Jun 2022 14:47:46 +0300 Subject: [PATCH] Update readme to v2.0.3 --- README.md | 44 ++++++++++++++++++++++---------------------- 1 file changed, 22 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 7a5f480..8e4c246 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ In your pubspec.yaml ```yaml dependencies: - badges: ^2.0.2 + badges: ^2.0.3 ``` ```dart import 'package:badges/badges.dart'; @@ -32,9 +32,9 @@ import 'package:badges/badges.dart';
## Animations: -| | | | -| ------------- | ------------- | ------------ | -| `BadgeAnimationType.slide` | `BadgeAnimationType.scale` | `BadgeAnimationType.fade` | +| | | | +| -------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | +| `BadgeAnimationType.slide` | `BadgeAnimationType.scale` | `BadgeAnimationType.fade` |
# Chips: @@ -59,24 +59,24 @@ Sometimes you may want to use chip but it's too big, even if set padding to zero ## Custom Usage There are several options that allow for more control: -| Properties | Description | -|--------------|-----------------| -| `Widget badgeContent` | The content of badge. Usually `Text` or `Icon`. | -| `Color badgeColor` | Background color of the badge. | -| `Widget child` | The main widget. By default it's below the red badge. Usually `Icon`, `IconButton`, `Text` or button. | -| `double elevation` | Shadow of the badge. | -| `Gradient gradient` | Gradient color for the badge content. | -| `bool toAnimate` | Whether animate badge when badge content changed or not. | -| `BadgePosition position` | Can be one of `BadgePosition.topStart()`, `BadgePosition.topEnd()`, `BadgePosition.bottomStart()`, `BadgePosition.bottomEnd()`. Sometimes you want to create unique badge position or create new one manually. For this use `BadgePosition.topEnd(top: -12, end: -20)` or `BadgePosition(start, top, end, bottom)`. | -| `BadgeShape shape` | `BadgeShape.circle` or `BadgeShape.square`. You can use `borderRadius` to change border radius of badge of you use square `BadgeShape.square`. | -| `BorderRadiusGeometry borderRadius` | Border radius of badge. Applies only if `BadgeShape.square` is used. | -| `EdgeInsetsGeometry padding` | The padding of badge content. | -| `Duration animationDuration` | The duration of badge animation when badge content is changed. | -| `BadgeAnimationType animationType` | Can be one of `BadgeAnimationType.slide`, `BadgeAnimationType.scale` or `BadgeAnimationType.fade`. | -| `bool showBadge` | Hide or show badge with animation using bool flag. | -| `AlignmentGeometry alignment` | Alignment of the whole widget | -| `bool ignorePointer` | Enable or disable (default) ignore pointer option | -| `BorderSide borderSide` | Adds a border to the badge | +| Properties | Description | +| ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `Widget badgeContent` | The content of badge. Usually `Text` or `Icon`. | +| `Color badgeColor` | Background color of the badge. | +| `Widget child` | The main widget. By default it's below the red badge. Usually `Icon`, `IconButton`, `Text` or button. | +| `double elevation` | Shadow of the badge. | +| `Gradient gradient` | Gradient color for the badge content. | +| `bool toAnimate` | Whether animate badge when badge content changed or not. | +| `BadgePosition position` | Can be one of `BadgePosition.topStart()`, `BadgePosition.topEnd()`, `BadgePosition.bottomStart()`, `BadgePosition.bottomEnd()`. Sometimes you want to create unique badge position or create new one manually. For this use `BadgePosition.topEnd(top: -12, end: -20)` or `BadgePosition(start, top, end, bottom)`. | +| `BadgeShape shape` | `BadgeShape.circle` or `BadgeShape.square`. You can use `borderRadius` to change border radius of badge of you use square `BadgeShape.square`. | +| `BorderRadiusGeometry borderRadius` | Border radius of badge. Applies only if `BadgeShape.square` is used. | +| `EdgeInsetsGeometry padding` | The padding of badge content. | +| `Duration animationDuration` | The duration of badge animation when badge content is changed. | +| `BadgeAnimationType animationType` | Can be one of `BadgeAnimationType.slide`, `BadgeAnimationType.scale` or `BadgeAnimationType.fade`. | +| `bool showBadge` | Hide or show badge with animation using bool flag. | +| `AlignmentGeometry alignment` | Alignment of the whole widget | +| `bool ignorePointer` | Enable or disable (default) ignore pointer option | +| `BorderSide borderSide` | Adds a border to the badge |