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

Use 'atomScreen' for the variable name

Browse source 
Even though it's not screen's fault, it's super easy in the DevTools to write `screen = require('screen')`, then wonder why it doesn't work (because `window.screen` is reserved by the DOM). This makes people who just type in the example more likely to get it right.
This commit is contained in:
Paul Betts 2015-02-03 11:32:33 -08:00
parent d17e6a3857
commit b77ed51594
1 changed files with 6 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
docs/api/screen.md
View file

@ -5,6 +5,8 @@ not use this module until the `ready` event of `app` module gets emitted.
`screen` is an [EventEmitter](http://nodejs.org/api/events.html#events_class_events_eventemitter).
Make sure to note that in the renderer / DevTools, `window.screen` is a reserved DOM property, so writing `screen = require('screen')` won't work. In our examples below, we use `atomScreen` as the variable name instead.
An example of creating a window that fills the whole screen:
```javascript
@ -14,8 +16,8 @@ var BrowserWindow = require('browser-window');
var mainWindow;
app.on('ready', function() {
var screen = require('screen');
var size = screen.getPrimaryDisplay().workAreaSize;
var atomScreen = require('screen');
var size = atomScreen.getPrimaryDisplay().workAreaSize;
mainWindow = new BrowserWindow({ width: size.width, height: size.height });
});
```
@ -29,8 +31,8 @@ var BrowserWindow = require('browser-window');
var mainWindow;
app.on('ready', function() {
var screen = require('screen');
var displays = screen.getAllDisplays();
var atomScreen = require('screen');
var displays = atomScreen.getAllDisplays();
var externalDisplay = null;
for (var i in displays) {
if (displays[i].bounds.x > 0 || displays[i].bounds.y > 0) {