From 6abc4fb2552c344d73a0d062e70aad189d0f8efe Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Wed, 9 Sep 2015 13:48:04 -0700 Subject: [PATCH 1/4] :fire: odd, stray + --- docs/api/browser-window.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index d74e999379ba..ad62cc017cdb 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -117,7 +117,7 @@ Properties `width` and `height` are required. The `BrowserWindow` object emits the following events: -+**Note** Some events are only available on specific operating systems and are labeled as such. +**Note** Some events are only available on specific operating systems and are labeled as such. ### Event: 'page-title-updated' @@ -292,7 +292,7 @@ Remove the devtools extension whose name is `name`. Objects created with `new BrowserWindow` have the following instance methods: -+**Note** Some methods are only available on specific operating systems and are labeled as such. +**Note** Some methods are only available on specific operating systems and are labeled as such. ```javascript var BrowserWindow = require('browser-window'); From 5593717d782dfc2cd549d51bf9fdaf48830ef731 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Wed, 9 Sep 2015 13:57:35 -0700 Subject: [PATCH 2/4] Create Instance Properties section --- docs/api/browser-window.md | 58 +++++++++++++++++++++++--------------- 1 file changed, 36 insertions(+), 22 deletions(-) diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index ad62cc017cdb..a0f29e349da6 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -288,6 +288,42 @@ API is not for programming use. Remove the devtools extension whose name is `name`. + +## Instance Properties + +Objects created with `new BrowserWindow` have the following properties: + +```javascript +var BrowserWindow = require('browser-window'); + +// In this example `win` is our instance +var win = new BrowserWindow({ width: 800, height: 600 }); + +``` + +### `win.webContents` + +The `WebContents` object this window owns, all web page related events and +operations will be done via it. + +See the [`webContents` documentation](web-contents.md) for its methods and +events. + +**Note:** Users should never store this object because it may become `null` +when the renderer process (web page) has crashed. + +### `win.devToolsWebContents` + +The `WebContents` of devtools for this window. + +**Note:** Users should never store this object because it may become `null` +when the devtools has been closed. + +### `win.id` + +The unique ID of this window. + + ## Instance Methods Objects created with `new BrowserWindow` have the following instance methods: @@ -302,28 +338,6 @@ var win = new BrowserWindow({ width: 800, height: 600 }); ``` -### `win.webContents()` - -The `WebContents` object this window owns, all web page related events and -operations will be done via it. - -See the [`webContents` documentation](web-contents.md) for its methods and -events. - -**Note:** Users should never store this object because it may become `null` -when the renderer process (web page) has crashed. - -### `win.devToolsWebContents()` - -Get the `WebContents` of devtools for this window. - -**Note:** Users should never store this object because it may become `null` -when the devtools has been closed. - -### `win.id()` - -Get the unique ID of this window. - ### `win.destroy()` Force closing the window, the `unload` and `beforeunload` event won't be emitted From 1a35d6bda66e8e6e391fd398e43dab99d848ccf8 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Wed, 9 Sep 2015 14:00:37 -0700 Subject: [PATCH 3/4] :fire: extra lines --- docs/api/browser-window.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index a0f29e349da6..f8df8eda9fb7 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -288,7 +288,6 @@ API is not for programming use. Remove the devtools extension whose name is `name`. - ## Instance Properties Objects created with `new BrowserWindow` have the following properties: @@ -323,7 +322,6 @@ when the devtools has been closed. The unique ID of this window. - ## Instance Methods Objects created with `new BrowserWindow` have the following instance methods: From 2ac2392a6bfedd406446e9ad994923d2938697c8 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Thu, 10 Sep 2015 12:11:40 -0700 Subject: [PATCH 4/4] :fire: extra line --- docs/api/browser-window.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index 58a708cfb193..a008baaec492 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -313,7 +313,6 @@ when the renderer process (web page) has crashed. ### `win.devToolsWebContents` - Get the `WebContents` of DevTools for this window. **Note:** Users should never store this object because it may become `null`