mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions 1

fixes (#17363)

Browse source
This commit is contained in:
Shelley Vohr 2019-04-25 15:44:54 -07:00 • committed by GitHub
parent 6530c99cfa
commit 075b818a8e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 35 additions and 38 deletions
Download patch file Download diff file Expand all files Collapse all files

24
docs/api/app.md
View file

@ -1064,6 +1064,7 @@ gpuDevice:
machineModelName: 'MacBookPro',
machineModelVersion: '11.5' }
```
Using `basic` should be preferred if only basic information like `vendorId` or `driverId` is needed.
### `app.setBadgeCount(count)` _Linux_ _macOS_
@ -1080,10 +1081,14 @@ On macOS, it shows on the dock icon. On Linux, it only works for Unity launcher.
**Note:** Unity launcher requires the existence of a `.desktop` file to work,
for more information please read [Desktop Environment Integration][unity-requirement].
**[Deprecated Soon](modernization/property-updates.md)**
### `app.getBadgeCount()` _Linux_ _macOS_
Returns `Integer` - The current value displayed in the counter badge.
**[Deprecated Soon](modernization/property-updates.md)**
### `app.isUnityRunning()` _Linux_
Returns `Boolean` - Whether the current desktop environment is Unity launcher.
@ -1344,11 +1349,6 @@ Sets the `image` associated with this dock icon.
## Properties
### `app.applicationMenu`
A `Menu` property that return [`Menu`](menu.md) if one has been set and `null` otherwise.
Users can pass a [Menu](menu.md) to set this property.
### `app.accessibilitySupportEnabled` _macOS_ _Windows_
A `Boolean` property that's `true` if Chrome's accessibility support is enabled, `false` otherwise. This property will be `true` if the use of assistive technologies, such as screen readers, has been detected. Setting this property to `true` manually enables Chrome's accessibility support, allowing developers to expose accessibility switch to users in application settings.
@ -1359,6 +1359,20 @@ This API must be called after the `ready` event is emitted.
**Note:** Rendering accessibility tree can significantly affect the performance of your app. It should not be enabled by default.
### `app.applicationMenu`
A `Menu` property that return [`Menu`](menu.md) if one has been set and `null` otherwise.
Users can pass a [Menu](menu.md) to set this property.
### `app.badgeCount` _Linux_ _macOS_
An `Integer` property that returns the badge count for current app. Setting the count to `0` will hide the badge.
On macOS, setting this with any nonzero integer shows on the dock icon. On Linux, this property only works for Unity launcher.
**Note:** Unity launcher requires the existence of a `.desktop` file to work,
for more information please read [Desktop Environment Integration][unity-requirement].
### `app.isPackaged`
A `Boolean` property that returns `true` if the app is packaged, `false` otherwise. For many apps, this property can be used to distinguish development and production environments.

2
docs/api/modernization/property-updates.md
View file

@ -5,7 +5,6 @@ The Electron team is currently undergoing an initiative to convert separate gett
## Candidates
* `app` module
* `badgeCount`
* `name`
* `dock`
* `badge`
@ -58,3 +57,4 @@ The Electron team is currently undergoing an initiative to convert separate gett
* `app` module
* `accessibilitySupport`
* `applicationMenu`
* `badgeCount`