refactor: make templateImage a property on nativeImage (#18124)
* refactor: make templateImage a property on nativeImage * Update docs/api/native-image.md Co-Authored-By: codebytere <codebytere@github.com> * fix nativeImage prototype deprecation * update for new property name * Update docs/api/native-image.md Co-Authored-By: codebytere <codebytere@github.com>
This commit is contained in:
parent
cfb6e847a0
commit
02710ef574
6 changed files with 50 additions and 6 deletions
|
@ -30,8 +30,6 @@ The Electron team is currently undergoing an initiative to convert separate gett
|
|||
* `DownloadItem` class
|
||||
* `savePath`
|
||||
* `paused`
|
||||
* `NativeImage`
|
||||
* `templateImage`
|
||||
* `Session` module
|
||||
* `preloads`
|
||||
* `SystemPreferences` module
|
||||
|
@ -58,3 +56,5 @@ The Electron team is currently undergoing an initiative to convert separate gett
|
|||
* `applicationMenu`
|
||||
* `badgeCount`
|
||||
* `name`
|
||||
* `NativeImage`
|
||||
* `isMacTemplateImage`
|
||||
|
|
|
@ -71,7 +71,6 @@ images/
|
|||
└── icon@3x.png
|
||||
```
|
||||
|
||||
|
||||
```javascript
|
||||
const { Tray } = require('electron')
|
||||
let appIcon = new Tray('/Users/somebody/images/icon.png')
|
||||
|
@ -276,10 +275,14 @@ Returns [`Size`](structures/size.md)
|
|||
|
||||
Marks the image as a template image.
|
||||
|
||||
**[Deprecated Soon](modernization/property-updates.md)**
|
||||
|
||||
#### `image.isTemplateImage()`
|
||||
|
||||
Returns `Boolean` - Whether the image is a template image.
|
||||
|
||||
**[Deprecated Soon](modernization/property-updates.md)**
|
||||
|
||||
#### `image.crop(rect)`
|
||||
|
||||
* `rect` [Rectangle](structures/rectangle.md) - The area of the image to crop.
|
||||
|
@ -324,3 +327,11 @@ to explicitly add different scale factor representations to an image. This
|
|||
can be called on empty images.
|
||||
|
||||
[buffer]: https://nodejs.org/api/buffer.html#buffer_class_buffer
|
||||
|
||||
## Properties
|
||||
|
||||
### `nativeImage.isMacTemplateImage` _macOS_
|
||||
|
||||
A `Boolean` property that determines whether the image is considered a [template image](https://developer.apple.com/documentation/appkit/nsimage/1520017-template).
|
||||
|
||||
Please note that this property only has an effect on macOS.
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue