From e767914ffe92113e59d079eaa6befa4e0e411c14 Mon Sep 17 00:00:00 2001 From: Hitesh Kumar Saini Date: Tue, 19 Oct 2021 23:32:58 +0530 Subject: [PATCH] Add documentation --- README.md | 77 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 77 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..5a4e783 --- /dev/null +++ b/README.md @@ -0,0 +1,77 @@ +

windows_taskbar

+

Flutter plugin serving utilities related to Windows taskbar 💙

+ +## Install + +```yaml +dependencies: + windows_taskbar: ^0.0.1 +``` + +## Demo + +Checkout the example Flutter application [here](https://github.com/alexmercerind/windows_taskbar/blob/master/example/lib/main.dart). + +![](https://github.com/alexmercerind/windows_taskbar/blob/assets/bMebejv57F.gif) +![](https://github.com/alexmercerind/windows_taskbar/blob/assets/OdzgD1yqEO.gif) + + +## Documentation + +**Set thumbnail toolbar** + +```dart +WindowsTaskbar.setThumbnailToolbar( + [ + ThumbnailToolbarButton( + ThumbnailToolbarAssetIcon('res/previous.ico'), + 'Button 1', + () {}, + ), + ThumbnailToolbarButton( + ThumbnailToolbarAssetIcon('res/pause.ico'), + 'Button 2', + () {}, + mode: ThumbnailToolbarButtonMode.disabled | ThumbnailToolbarButtonMode.dismissionClick, + ), + ThumbnailToolbarButton( + ThumbnailToolbarAssetIcon('res/next.ico'), + 'Button 3', + () {}, + ), + ], +); +``` + +**Clear thumbnail toolbar** + +```dart +WindowsTaskbar.clearThumbnailToolbar(); +``` + +**Set progress mode** + +```dart +WindowsTaskbar.setProgressMode(TaskbarProgressMode.indeterminate); +``` + +**Set progress** + +```dart +WindowsTaskbar.setProgress(69, 100); +``` + +**Set thumbnail tooltip** + +```dart +WindowsTaskbar.setThumbnailTooltip('Awesome Flutter window.); +``` + +## License + +GNU Lesser General Public License v2.1 + +Copyright © 2021, Hitesh Kumar Saini <> + +Contributions welcomed. +