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

docs: document BrowserWindow.setBackgroundColor

Browse source
This commit is contained in:
Jeremy Apthorp 2018-10-09 14:14:50 -07:00
parent 1a17ce81d5
commit 373ffa9fee
1 changed files with 10 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
docs/api/browser-window.md
View file

@ -201,8 +201,8 @@ It creates a new `BrowserWindow` with native properties as set by the `options`.
* `enableLargerThanScreen` Boolean (optional) - Enable the window to be resized larger * `enableLargerThanScreen` Boolean (optional) - Enable the window to be resized larger
than screen. Default is `false`. than screen. Default is `false`.
* `backgroundColor` String (optional) - Window's background color as a hexadecimal value, * `backgroundColor` String (optional) - Window's background color as a hexadecimal value,
like `#66CD00` or `#FFF` or `#80FFFFFF` (alpha is supported). Default is like `#66CD00` or `#FFF` or `#80FFFFFF` (alpha is supported if
`#FFF` (white). If `transparent` is set to `true`, only values with transparent (`#00-------`) or opaque (`#FF-----`) alpha values are respected. `transparent` is set to `true`). Default is `#FFF` (white).
* `hasShadow` Boolean (optional) - Whether window should have a shadow. This is only * `hasShadow` Boolean (optional) - Whether window should have a shadow. This is only
implemented on macOS. Default is `true`. implemented on macOS. Default is `true`.
* `opacity` Number (optional) - Set the initial opacity of the window, between 0.0 (fully * `opacity` Number (optional) - Set the initial opacity of the window, between 0.0 (fully
@ -864,6 +864,14 @@ height areas you have within the overall content view.
Calling this function with a value of `0` will remove any previously set aspect Calling this function with a value of `0` will remove any previously set aspect
ratios. ratios.
#### `win.setBackgroundColor(backgroundColor)
* `backgroundColor` String - Window's background color as a hexadecimal value,
like `#66CD00` or `#FFF` or `#80FFFFFF` (alpha is supported if `transparent`
is `true`). Default is `#FFF` (white).
Sets the background color of the window. See [Setting
`backgroundColor`](#setting-backgroundcolor).
#### `win.previewFile(path[, displayName])` _macOS_ #### `win.previewFile(path[, displayName])` _macOS_
* `path` String - The absolute path to the file to preview with QuickLook. This * `path` String - The absolute path to the file to preview with QuickLook. This