Skip to content

Commit 961dfb1

Browse files
committed
README.md Updated
1 parent ee28e3f commit 961dfb1

File tree

1 file changed

+34
-10
lines changed

1 file changed

+34
-10
lines changed

README.md

Lines changed: 34 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,39 @@
1-
# flutter_shortcuts
1+
# Flutter Shortcuts
22

3-
A new Flutter plugin.
3+
<img src="https://i.imgur.com/462Y6wf.gif" title="source: imgur.com" />
44

5-
## Getting Started
5+
![GitHub](https://img.shields.io/github/license/divshekhar/flutter_shortcuts?style=plastic) ![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/divshekhar/flutter_shortcuts?style=plastic) ![GitHub top language](https://img.shields.io/github/languages/top/divshekhar/flutter_shortcuts?style=plastic) ![GitHub language count](https://img.shields.io/github/languages/count/divshekhar/flutter_shortcuts?style=plastic) ![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/divshekhar/flutter_shortcuts?style=plastic)
66

7-
This project is a starting point for a Flutter
8-
[plug-in package](https://flutter.dev/developing-packages/),
9-
a specialized package that includes platform-specific implementation code for
10-
Android and/or iOS.
7+
## Show some :heart: and :star: the repo
118

12-
For help getting started with Flutter, view our
13-
[online documentation](https://flutter.dev/docs), which offers tutorials,
14-
samples, guidance on mobile development, and a full API reference.
9+
[![GitHub followers](https://img.shields.io/github/followers/divshekhar.svg?style=social&label=Follow)](https://github.com/divshekhar/)
1510

11+
## Arguments
12+
13+
There are several options that allow for more control:
14+
15+
| Properties | Description |
16+
|--------------|-----------------|
17+
| `initialize` | performs action when shortcut is initiated. |
18+
| `getMaxShortcutLimit` | returns the maximum number of static or dynamic shortcuts that each launcher icon can have at a time. |
19+
| `setShortcutItems` | will set all the shortcut items. |
20+
| `clearShortcutItems` | will remove all the shortcut items.|
21+
| `pushShortcutItem` | will push a new shortcut item.If there is already a dynamic or pinned shortcut with the same **ID**, the shortcut will be updated and pushed at the end of the shortcut list. |
22+
| `addShortcutItems` |updates dynamic or pinned shortcuts with same IDs and pushes new shortcuts with different IDs. |
23+
| `updateShortcutItems` | updates shortcut items. If the IDs of the shortcuts are not same, no changes will be reflected. |
24+
| `updateShortcutItem` | updates a single shortcut item based on id. If the ID of the shortcut is not same, no changes will be reflected. |
25+
| `changeShortcutItemIcon` | will change the icon of the shortcut based on id.s If the ID of the shortcut is not same, no changes will be reflected. |
26+
27+
## Project Created & Maintained By
28+
29+
### Divyanshu Shekhar
30+
31+
<a href="https://twitter.com/dshekhar17"><img src="https://github.com/aritraroy/social-icons/blob/master/twitter-icon.png?raw=true" width="60"></a> <a href="https://in.linkedin.com/in/divyanshu-shekhar-a8a04a162"><img src="https://github.com/aritraroy/social-icons/blob/master/linkedin-icon.png?raw=true" width="60"></a> <a href="https://instagram.com/dshekhar17"><img src="https://github.com/aritraroy/social-icons/blob/master/instagram-icon.png?raw=true" width="60"></a>
32+
33+
### Subham Praharaj
34+
35+
<a href="https://twitter.com/SubhamPraharaj6"><img src="https://github.com/aritraroy/social-icons/blob/master/twitter-icon.png?raw=true" width="60"></a> <a href="https://instagram.com/the_champ_subham_865"><img src="https://github.com/aritraroy/social-icons/blob/master/instagram-icon.png?raw=true" width="60"></a>
36+
37+
## Copyright & License
38+
39+
Code and documentation Copyright (c) 2021 [Divyanshu Shekhar](https://divyanshushekhar.com). Code released under the [BSD 3-Clause License](./LICENSE).

0 commit comments

Comments
 (0)