Skip to content

Commit

Permalink
chore: update README & CHANGELOG
Browse files Browse the repository at this point in the history
  • Loading branch information
alexmercerind committed Dec 1, 2022
1 parent 1d09072 commit 6f97d6a
Show file tree
Hide file tree
Showing 2 changed files with 61 additions and 37 deletions.
33 changes: 16 additions & 17 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,29 @@
## 1.1.0+1
## 1.1.1

- Add documentation website.
- feat: `WindowsTaskbar.setWindowTitle` & `WindowsTaskbar.resetWindowTitle` (@alexmercerind).
- refactor: check `nullptr` before invoking `ITaskbarList3` methods (@alexmercerind).

## 1.1.0

- Added `WindowsTaskbar.setOverlayIcon` & `WindowsTaskbar.resetOverlayIcon` (@nikitatg).
- Move implementation to separate translation unit & make methods non-inline (@alexmercerind).
- Now platform channel calls raise errors correctly by checking `HRESULT` (@alexmercerind).
- Deprecated methods:
- feat: `WindowsTaskbar.setOverlayIcon` & `WindowsTaskbar.resetOverlayIcon` (@nikitatg).
- feat: platform channel calls raise errors correctly by checking `HRESULT` (@alexmercerind).
- perf: move impl to separate translation unit & make methods non-inline (@alexmercerind).
- refactor: improved naming of various methods (@alexmercerind).
- deprecated:
- `WindowsTaskbar.clearThumbnailToolbar` is now `WindowsTaskbar.resetThumbnailToolbar`.
- `WindowsTaskbar.setFlashTaskbarAppIcon` is now `WindowsTaskbar.setFlashTaskbarAppIcon`.
- `WindowsTaskbar.stopFlashingTaskbarAppIcon` is now `WindowsTaskbar.resetFlashTaskbarAppIcon`.
- The change has been made to fix inconsistency in names.

## 1.0.0

- Implement `WindowsTaskbar.flashTaskbarAppIcon` & `WindowsTaskbar.stopFlashingTaskbarAppIcon` (@alexmercerind).
- Change project license to MIT (@alexmercerind).
- Use `MultiByteToWideChar` for `std::wstring` convert (@boyan01).
- feat: `WindowsTaskbar.flashTaskbarAppIcon` & `WindowsTaskbar.stopFlashingTaskbarAppIcon` (@alexmercerind).
- fix: use `MultiByteToWideChar` for `std::wstring` convert (@boyan01).
- chore: re-license to MIT (@alexmercerind).

## 0.0.1

- Initial release.
- Expose all common `ITaskbarList3` WIN32 APIs (@alexmercerind).
- Add following methods to `WindowsTaskbar` (@alexmercerind):
- `SetProgressMode`
- `SetProgress`
- `SetThumbnailToolbar`
- `SetThumbnailTooltip`
- feat: most of the common `ITaskbarList3` Win32 APIs (@alexmercerind).
- feat: `SetProgressMode` (@alexmercerind).
- feat: `SetProgress` (@alexmercerind).
- feat: `SetThumbnailToolbar` (@alexmercerind).
- feat: `SetThumbnailTooltip` (@alexmercerind).
65 changes: 45 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,31 @@
<h1><a href="https://github.com/alexmercerind/windows_taskbar">windows_taskbar</a></h1>
<h4>Flutter plugin serving utilities related to Windows taskbar 💙</h4>
<h1 align="center"><a href="https://github.com/alexmercerind/windows_taskbar">windows_taskbar</a></h1>
<p align="center">Flutter plugin serving utilities related to Windows taskbar.</p>

## Install

```yaml
dependencies:
windows_taskbar: ^1.0.0
windows_taskbar: ^1.1.1
```
## Demo
<table>
<tr>
<td>
<img width="713" height="auto" src="https://user-images.githubusercontent.com/28951144/205107667-c3db0382-a5fa-456d-af01-7c5ab9c94ceb.gif">
</td>
</tr>
<tr>
<td>
<img width="713" height="auto" src="https://user-images.githubusercontent.com/28951144/205107645-9732aabe-0e39-42c7-87d3-bbd2bca82fa6.gif">
</td>
</tr>
</table>
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)
## Docs
**Set thumbnail toolbar**
#### Set thumbnail toolbar
```dart
WindowsTaskbar.setThumbnailToolbar(
Expand All @@ -42,31 +50,31 @@ WindowsTaskbar.setThumbnailToolbar(
);
```

**Remove thumbnail toolbar**
#### Remove thumbnail toolbar

```dart
WindowsTaskbar.resetThumbnailToolbar();
```

**Set progress mode**
#### Set progress mode

```dart
WindowsTaskbar.setProgressMode(TaskbarProgressMode.indeterminate);
```

**Set progress**
#### Set progress

```dart
WindowsTaskbar.setProgress(69, 100);
```

**Set thumbnail tooltip**
#### Set thumbnail tooltip

```dart
WindowsTaskbar.setThumbnailTooltip('Awesome Flutter window.');
```

**Flash windows taskbar app icon**
#### Flash windows taskbar app icon

```dart
WindowsTaskbar.setFlashTaskbarAppIcon(
Expand All @@ -75,13 +83,13 @@ WindowsTaskbar.setFlashTaskbarAppIcon(
);
```

**Stop flashing windows taskbar app icon**
#### Stop flashing windows taskbar app icon

```dart
WindowsTaskbar.resetFlashTaskbarAppIcon();
```

**Set overlay icon (a badge)**
#### Set overlay icon (a badge)

```dart
WindowsTaskbar.setOverlayIcon(
Expand All @@ -90,18 +98,35 @@ WindowsTaskbar.setOverlayIcon(
);
```

**Remove overlay icon (a badge)**
#### Remove overlay icon (a badge)

```dart
WindowsTaskbar.resetOverlayIcon();
```

#### Set window title (or taskbar button label)

```dart
WindowsTaskbar.setWindowTitle('Never Gonna Give You Up');
```

#### Reset window title (or taskbar button label)

```dart
WindowsTaskbar.resetWindowTitle();
```

Please see [API reference](https://pub.dev/documentation/windows_taskbar/latest/windows_taskbar/windows_taskbar-library.html) for extended information & more detail about various configurations.

## Sponsor

You may consider buying me a coffee if you like this package.

- [GitHub Sponsors](https://github.com/sponsors/alexmercerind)
- [PayPal](https://paypal.me/alexmercerind)

## License

Copyright © 2021 & onwards, Hitesh Kumar Saini <<[email protected]>>

This library & all the work in this repository is under MIT license that can be found in the LICENSE file.

## Donate

Consider donating me at https://www.paypal.me/alexmercerind if you like the plugin. So that I can atleast pay my internet bill.

0 comments on commit 6f97d6a

Please sign in to comment.