From 3e5486323ae5e80e2dc9f13895d3818402be8ec3 Mon Sep 17 00:00:00 2001 From: Sean Lee Date: Fri, 1 May 2020 00:25:13 +0800 Subject: [PATCH] docs: event.newGuest for new-window in WebContents and webContents in BrowsweWindow's constructor (#21698) * docs: `newGuest` in `WebContents` and `webContents` in `BrowsweWindow` According to the example codes in the documentation of `new-window` event in `WebContents`, `webContents` in `BrowsweWindow` constructor options and `newGuest` in `event` argument of `new-window` handler are both existing but documented. This patch is for adding the related documentations. Also, it provides typescript-definitations for these two properties. * Remove the documnent of `webContents` in BrowserWindow constructor option. --- docs/api/structures/new-window-event.md | 4 ++++ docs/api/web-contents.md | 2 +- filenames.auto.gni | 1 + 3 files changed, 6 insertions(+), 1 deletion(-) create mode 100644 docs/api/structures/new-window-event.md diff --git a/docs/api/structures/new-window-event.md b/docs/api/structures/new-window-event.md new file mode 100644 index 000000000000..b3939a00785a --- /dev/null +++ b/docs/api/structures/new-window-event.md @@ -0,0 +1,4 @@ +# NewWindowEvent Object extends `Event` + +* `newGuest` BrowserWindow (optional) + diff --git a/docs/api/web-contents.md b/docs/api/web-contents.md index b192615ee90a..e8b67f0b30e7 100644 --- a/docs/api/web-contents.md +++ b/docs/api/web-contents.md @@ -138,7 +138,7 @@ Emitted when page receives favicon urls. Returns: -* `event` Event +* `event` NewWindowEvent * `url` String * `frameName` String * `disposition` String - Can be `default`, `foreground-tab`, `background-tab`, diff --git a/filenames.auto.gni b/filenames.auto.gni index 1dfb19bc7a4c..7241e72b5888 100644 --- a/filenames.auto.gni +++ b/filenames.auto.gni @@ -100,6 +100,7 @@ auto_filenames = { "docs/api/structures/mime-typed-buffer.md", "docs/api/structures/mouse-input-event.md", "docs/api/structures/mouse-wheel-input-event.md", + "docs/api/structures/new-window-event.md", "docs/api/structures/notification-action.md", "docs/api/structures/point.md", "docs/api/structures/post-body.md",