Merge pull request #4922 from electron/bengotow/sheet-offset

Allow sheets to be attached at a custom offset #4679
This commit is contained in:
Cheng Zhao 2016-04-20 08:55:42 +09:00
commit eb9e0e5534
7 changed files with 47 additions and 4 deletions

View file

@ -675,6 +675,17 @@ Returns the title of the native window.
**Note:** The title of web page can be different from the title of the native
window.
### `win.setSheetOffset(offset)`
Changes the attachment point for sheets on Mac OS X. By default, sheets are attached
just below the window frame, but you may want to display them beneath a HTML-rendered
toolbar. For example:
```
var toolbarRect = document.getElementById('toolbar').getBoundingClientRect();
win.setSheetOffset(toolbarRect.height);
```
### `win.flashFrame(flag)`
* `flag` Boolean

View file

@ -18,10 +18,6 @@ The Dialog is opened from Electron's main thread. If you want to use the dialog
const dialog = require('electron').remote.dialog;
```
**Note for OS X**: If you want to present dialogs as sheets, the only thing you
have to do is provide a `BrowserWindow` reference in the `browserWindow`
parameter.
## Methods
The `dialog` module has the following methods:
@ -125,3 +121,13 @@ This API can be called safely before the `ready` event the `app` module emits,
it is usually used to report errors in early stage of startup. If called
before the app `ready`event on Linux, the message will be emitted to stderr,
and no GUI dialog will appear.
## Sheets
On Mac OS X, dialogs are presented as sheets attached to a window if you provide
a `BrowserWindow` reference in the `browserWindow` parameter, or modals if no
window is provided.
You can call `BrowserWindow.getCurrentWindow().setSheetOffset(offset)` to change
the offset from the window frame where sheets are attached.