README.md

windows_taskbar

Flutter plugin serving utilities related to Windows taskbar.

Installation

Add package to the dependencies section of the pubspec.yaml:

dependencies:
  windows_taskbar: ^1.1.2

Guide

A minimal usage guide for package:windows_taskbar.

Contents

• Set thumbnail toolbar
• Remove thumbnail toolbar
• Set progress mode
• Set progress
• Set thumbnail tooltip
• Flash windows taskbar app icon
• Stop flashing windows taskbar app icon
• Set overlay icon (badge)
• Remove overlay icon (badge)
• Set window title (taskbar button label)
• Reset window title (or taskbar button label)
• Next steps

Set thumbnail toolbar

WindowsTaskbar.setThumbnailToolbar(
  [
  ThumbnailToolbarButton(
    ThumbnailToolbarAssetIcon('assets/camera.ico'),
      'Turn On Camera',
      () {},
    ),
    ThumbnailToolbarButton(
      ThumbnailToolbarAssetIcon('assets/microphone.ico'),
      'Mute',
      () {},
      mode: ThumbnailToolbarButtonMode.disabled | ThumbnailToolbarButtonMode.dismissionClick,
    ),
    ThumbnailToolbarButton(
      ThumbnailToolbarAssetIcon('assets/end_call.ico'),
      'Disconnect',
      () {},
    ),
  ],
);

Remove thumbnail toolbar

WindowsTaskbar.resetThumbnailToolbar();

Set progress mode

WindowsTaskbar.setProgressMode(TaskbarProgressMode.indeterminate);

Set progress

WindowsTaskbar.setProgress(69, 100);

Set thumbnail tooltip

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

Flash windows taskbar app icon

WindowsTaskbar.setFlashTaskbarAppIcon(
  mode: TaskbarFlashMode.all | TaskbarFlashMode.timernofg,
  timeout: const Duration(milliseconds: 500),
);

Stop flashing windows taskbar app icon

WindowsTaskbar.resetFlashTaskbarAppIcon();

Set overlay icon (badge)

WindowsTaskbar.setOverlayIcon(
  ThumbnailToolbarAssetIcon('assets/red_slash.ico'),
  tooltip: 'Stop',
);

Remove overlay icon (badge)

WindowsTaskbar.resetOverlayIcon();

Set window title (taskbar button label)

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

Reset window title (taskbar button label)

WindowsTaskbar.resetWindowTitle();

Next steps

• API reference can be helpful for diving into deeper specifics.
• Source-code of the example application offers some complete code samples.

Sponsor

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

• GitHub Sponsors
• PayPal

License

Copyright © 2021 & onwards, Hitesh Kumar Saini <saini123hitesh@gmail.com>

This project & the work under this repository is governed by MIT license that can be found in the LICENSE file.