Skip to content

Commit 7bdc875

Browse files
yadaniyilyadaniyil
committed
Update readme to v2.0.3
1 parent 17234da commit 7bdc875

File tree

1 file changed

+22
-22
lines changed

1 file changed

+22
-22
lines changed

‎README.md‎

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
In your pubspec.yaml
1212
```yaml
1313
dependencies:
14-
badges: ^2.0.2
14+
badges: ^2.0.3
1515
```
1616
```dart
1717
import 'package:badges/badges.dart';
@@ -32,9 +32,9 @@ import 'package:badges/badges.dart';
3232
<br>
3333

3434
## Animations:
35-
| <img src="https://raw.githubusercontent.com/yadaniil/flutter_badges/master/images/first_badge_example.gif" height="200px"> | <img src="https://raw.githubusercontent.com/yadaniil/flutter_badges/master/images/second_badge_example.gif" height="200px"> | <img src="https://raw.githubusercontent.com/yadaniil/flutter_badges/master/images/third_badge_example.gif" height="200px"> |
36-
| ------------- | ------------- | ------------ |
37-
| `BadgeAnimationType.slide` | `BadgeAnimationType.scale` | `BadgeAnimationType.fade` |
35+
| <img src="https://raw.githubusercontent.com/yadaniil/flutter_badges/master/images/first_badge_example.gif" height="200px"> | <img src="https://raw.githubusercontent.com/yadaniil/flutter_badges/master/images/second_badge_example.gif" height="200px"> | <img src="https://raw.githubusercontent.com/yadaniil/flutter_badges/master/images/third_badge_example.gif" height="200px"> |
36+
| -------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
37+
| `BadgeAnimationType.slide` | `BadgeAnimationType.scale` | `BadgeAnimationType.fade` |
3838
<br>
3939

4040
# Chips:
@@ -59,24 +59,24 @@ Sometimes you may want to use chip but it's too big, even if set padding to zero
5959
## Custom Usage
6060
There are several options that allow for more control:
6161

62-
| Properties | Description |
63-
|--------------|-----------------|
64-
| `Widget badgeContent` | The content of badge. Usually `Text` or `Icon`. |
65-
| `Color badgeColor` | Background color of the badge. |
66-
| `Widget child` | The main widget. By default it's below the red badge. Usually `Icon`, `IconButton`, `Text` or button. |
67-
| `double elevation` | Shadow of the badge. |
68-
| `Gradient gradient` | Gradient color for the badge content. |
69-
| `bool toAnimate` | Whether animate badge when badge content changed or not. |
70-
| `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)`. |
71-
| `BadgeShape shape` | `BadgeShape.circle` or `BadgeShape.square`. You can use `borderRadius` to change border radius of badge of you use square `BadgeShape.square`. |
72-
| `BorderRadiusGeometry borderRadius` | Border radius of badge. Applies only if `BadgeShape.square` is used. |
73-
| `EdgeInsetsGeometry padding` | The padding of badge content. |
74-
| `Duration animationDuration` | The duration of badge animation when badge content is changed. |
75-
| `BadgeAnimationType animationType` | Can be one of `BadgeAnimationType.slide`, `BadgeAnimationType.scale` or `BadgeAnimationType.fade`. |
76-
| `bool showBadge` | Hide or show badge with animation using bool flag. |
77-
| `AlignmentGeometry alignment` | Alignment of the whole widget |
78-
| `bool ignorePointer` | Enable or disable (default) ignore pointer option |
79-
| `BorderSide borderSide` | Adds a border to the badge |
62+
| Properties | Description |
63+
| ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
64+
| `Widget badgeContent` | The content of badge. Usually `Text` or `Icon`. |
65+
| `Color badgeColor` | Background color of the badge. |
66+
| `Widget child` | The main widget. By default it's below the red badge. Usually `Icon`, `IconButton`, `Text` or button. |
67+
| `double elevation` | Shadow of the badge. |
68+
| `Gradient gradient` | Gradient color for the badge content. |
69+
| `bool toAnimate` | Whether animate badge when badge content changed or not. |
70+
| `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)`. |
71+
| `BadgeShape shape` | `BadgeShape.circle` or `BadgeShape.square`. You can use `borderRadius` to change border radius of badge of you use square `BadgeShape.square`. |
72+
| `BorderRadiusGeometry borderRadius` | Border radius of badge. Applies only if `BadgeShape.square` is used. |
73+
| `EdgeInsetsGeometry padding` | The padding of badge content. |
74+
| `Duration animationDuration` | The duration of badge animation when badge content is changed. |
75+
| `BadgeAnimationType animationType` | Can be one of `BadgeAnimationType.slide`, `BadgeAnimationType.scale` or `BadgeAnimationType.fade`. |
76+
| `bool showBadge` | Hide or show badge with animation using bool flag. |
77+
| `AlignmentGeometry alignment` | Alignment of the whole widget |
78+
| `bool ignorePointer` | Enable or disable (default) ignore pointer option |
79+
| `BorderSide borderSide` | Adds a border to the badge |
8080

8181
<br>
8282
<br>

0 commit comments

Comments
 (0)