https://github.com/mixmaxhq/electron-promote-windows-tray-items
Ensure Windows tray items created by an Electron app show up in the toolbar, not the customization area.
https://github.com/mixmaxhq/electron-promote-windows-tray-items
unsupported
Last synced: 19 days ago
JSON representation
Ensure Windows tray items created by an Electron app show up in the toolbar, not the customization area.
- Host: GitHub
- URL: https://github.com/mixmaxhq/electron-promote-windows-tray-items
- Owner: mixmaxhq
- License: mit
- Created: 2016-01-05T05:37:37.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2023-08-11T13:25:15.000Z (almost 2 years ago)
- Last Synced: 2024-10-15T15:42:54.892Z (7 months ago)
- Topics: unsupported
- Language: C#
- Homepage:
- Size: 96.7 KB
- Stars: 12
- Watchers: 5
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# electron-promote-windows-tray-items
When you first create an Electron [tray item][tray item] on Windows, it will show up in the toolbar
customization area:
rather than in the toolbar itself:
By default, the user must explicitly choose to show icons in the toolbar. But not only does this
create extra, potentially non-intuitive work for the user, it forces the design of icons that
will look good in both the toolbar and the customization area since you
[can't choose different icons for each location][different icons].
This package helps you skip this process. For any item in its default state, i.e. the user has not
explicitly _hid_ the item from the toolbar, this package will "promote" that item from the customization
area to the toolbar.
## Requirements
This package may be safely required on non-Windows platforms, though the package will return an error
if it is attempted to be used on non-Windows platforms.
This project is currently compatible with Electron 0.36.2 due to its dependence on
[electron-edge][electron-edge].
## Installation
For Electron:
```js
npm install electron-promote-windows-tray-items
```
or
```js
npm install electron-promote-windows-tray-items --save
```
## Usage
```js
var promoteWindowsTrayItems = require('electron-promote-windows-tray-items');
// Create a tray item.
var icon = new Tray(/* ... */);
if (process.platform === 'win32') {
// Icon will now be in the toolbar customization area without the user explicitly toggling it to show in the toolbar.
promoteWindowsTrayItems(function(err) {
// Icon will now be in the toolbar itself unless the user explicitly hid it from the toolbar.
});
}
```
## Contributing
We welcome pull requests! Please lint your code.
## Credits
Created by [Jeff Wear][Jeff Wear], with the core C# logic used by this module
[originally developed][original PR] by [Paul Betts][Paul Betts].
## Copyright and License
Copyright 2016 Mixmax, Inc., licensed under the MIT License.
Some portions derived from [Squirrel.Windows][Squirrel.Windows], copyright 2012-2016 GitHub, Inc.,
licensed under the MIT License.
[tray item]: https://github.com/atom/electron/blob/master/docs/api/tray.md
[different icons]: https://github.com/atom/electron/issues/3970
[electron-edge]: https://github.com/kexplo/electron-edge#electron-edge
[Jeff Wear]: https://github.com/wearhere
[original PR]: https://github.com/Squirrel/Squirrel.Windows/pull/447
[Paul Betts]: https://github.com/paulcbetts
[Squirrel.Windows]: https://github.com/Squirrel/Squirrel.Windows
## Release History
* 1.0.1 README fixes
* 1.0.0 Initial release.