Skip to content

Commit

Permalink
[Release v1.0.0] Update version + README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ngthailam committed May 21, 2022
1 parent b6233e6 commit a1bc504
Show file tree
Hide file tree
Showing 3 changed files with 44 additions and 38 deletions.
21 changes: 14 additions & 7 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,23 @@
## 0.0.1
## 1.0.0

* Initial release
* Allow app shortcuts management on Android
* Add support setting icon and subtitle for IOS shortcuts
* Breaking change
* Change ShortcutArg.dart, separate AndroidArg and IosArg
* Removed enabled field from AndroidArg since it does nothing

## 0.1.0
## 0.2.1

* Reduce dart version requirement to 2.12.0
* Add feedback when icon resource not found on Android

## 0.2.0

* Implement shortcuts on IOS

## 0.2.1
## 0.1.0

* Add feedback when icon resource not found on Android
* Reduce dart version requirement to 2.12.0

## 0.0.1

* Initial release
* Allow app shortcuts management on Android
59 changes: 29 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,34 +17,6 @@ Go to the plugin official [pub.dev](https://pub.dev/packages/flutter_app_shortcu

Review [this](/example/lib/main.dart) file to get full example usages

<br>

## Arguments

### ShortcutArg
| Name | Type | Requirements | Description |
| ------------- | ------------- | ------------- | ------------- |
| id | String | Unique | When pushing shortcuts with the same ID, the existing one is updated |
| title | String | Not empty | App short cut label (title) |
| iconResourceName | String | | Icon resource name (see below for usage) |
| androidArg | AndroidArg | | Extra arguments for Android shortcuts |
| iosArg | IosArg | | Extra arguments for IOS shortcuts |

### AndroidArg
| Name | Type | Requirements | Description |
| ------------- | ------------- | ------------- | ------------- |
| longLabel | String | | if there is enough space on the device, longLabel replaces title |
| uri | String | |Uri when click on shortcut |

<br>

### IosArg
| Name | Type | Requirements | Description |
| ------------- | ------------- | ------------- | ------------- |
| subtitle | String | | Subtitle of the shortcut |

<br>

## Example

### Android
Expand Down Expand Up @@ -83,6 +55,33 @@ Add a new icon
- Add image set using Xcode
- Set `iconResourceName` to the same name as the added icon in previous step


<br><br>

## Arguments

### ShortcutArg
| Name | Type | Requirements | Description |
| ------------- | ------------- | ------------- | ------------- |
| id | String | Unique | When pushing shortcuts with the same ID, the existing one is updated |
| title | String | Not empty | App short cut label (title) |
| iconResourceName | String | | Icon resource name (see below for usage) |
| androidArg | AndroidArg | | Extra arguments for Android shortcuts |
| iosArg | IosArg | | Extra arguments for IOS shortcuts |

### AndroidArg
| Name | Type | Requirements | Description |
| ------------- | ------------- | ------------- | ------------- |
| longLabel | String | | if there is enough space on the device, longLabel replaces title |
| uri | String | |Uri when click on shortcut |

<br>

### IosArg
| Name | Type | Requirements | Description |
| ------------- | ------------- | ------------- | ------------- |
| subtitle | String | | Subtitle of the shortcut |

<br><br>

# Limitations
Expand All @@ -93,13 +92,13 @@ Add a new icon
- Cannot return icon name when cal getShortcuts
- Cannot set disabled message (will implement in the future)
- Cannot use icon from flutter side (will implement in the future)
- On click short cut does nothing
- On click short cut does nothing (will implement in the future)
## IOS
- On IOS, enable and disable shortcuts is not available
- Cannot return icon name when cal getShortcuts
- Does no support disable, enable icons
- Cannot use icon from flutter side (will implement in the future)
- On click short cut does nothing
- On click short cut does nothing (will implement in the future)
<br><br>

# TODO
Expand Down
2 changes: 1 addition & 1 deletion pubspec.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: flutter_app_shortcut
description: A plugin for you to easily implement dynamic native app shortcut for Android and quick actions for IOS
version: 0.2.1
version: 1.0.0
documentation: https://github.com/ngthailam/flutter_app_short_cut/blob/main/README.md
repository: https://github.com/ngthailam/flutter_app_short_cut
issue_tracker: https://github.com/ngthailam/flutter_app_short_cut/issues
Expand Down

0 comments on commit a1bc504

Please sign in to comment.