Skip to content

Commit e767914

Browse files
Add documentation
1 parent 1c76e4c commit e767914

File tree

1 file changed

+77
-0
lines changed

1 file changed

+77
-0
lines changed

README.md

+77
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
<h1 align="center"><a href="https://github.com/alexmercerind/windows_taskbar">windows_taskbar</a></h1>
2+
<h4 align="center">Flutter plugin serving utilities related to Windows taskbar 💙</h4>
3+
4+
## Install
5+
6+
```yaml
7+
dependencies:
8+
windows_taskbar: ^0.0.1
9+
```
10+
11+
## Demo
12+
13+
Checkout the example Flutter application [here](https://github.com/alexmercerind/windows_taskbar/blob/master/example/lib/main.dart).
14+
15+
![](https://github.com/alexmercerind/windows_taskbar/blob/assets/bMebejv57F.gif)
16+
![](https://github.com/alexmercerind/windows_taskbar/blob/assets/OdzgD1yqEO.gif)
17+
18+
19+
## Documentation
20+
21+
**Set thumbnail toolbar**
22+
23+
```dart
24+
WindowsTaskbar.setThumbnailToolbar(
25+
[
26+
ThumbnailToolbarButton(
27+
ThumbnailToolbarAssetIcon('res/previous.ico'),
28+
'Button 1',
29+
() {},
30+
),
31+
ThumbnailToolbarButton(
32+
ThumbnailToolbarAssetIcon('res/pause.ico'),
33+
'Button 2',
34+
() {},
35+
mode: ThumbnailToolbarButtonMode.disabled | ThumbnailToolbarButtonMode.dismissionClick,
36+
),
37+
ThumbnailToolbarButton(
38+
ThumbnailToolbarAssetIcon('res/next.ico'),
39+
'Button 3',
40+
() {},
41+
),
42+
],
43+
);
44+
```
45+
46+
**Clear thumbnail toolbar**
47+
48+
```dart
49+
WindowsTaskbar.clearThumbnailToolbar();
50+
```
51+
52+
**Set progress mode**
53+
54+
```dart
55+
WindowsTaskbar.setProgressMode(TaskbarProgressMode.indeterminate);
56+
```
57+
58+
**Set progress**
59+
60+
```dart
61+
WindowsTaskbar.setProgress(69, 100);
62+
```
63+
64+
**Set thumbnail tooltip**
65+
66+
```dart
67+
WindowsTaskbar.setThumbnailTooltip('Awesome Flutter window.);
68+
```
69+
70+
## License
71+
72+
GNU Lesser General Public License v2.1
73+
74+
Copyright © 2021, Hitesh Kumar Saini <<saini123hitesh@gmail.com>>
75+
76+
Contributions welcomed.
77+

0 commit comments

Comments
 (0)