From bb8d42f1e195eed273bc0efb3c131579099792e5 Mon Sep 17 00:00:00 2001 From: Kevin Sawicki Date: Tue, 7 Mar 2017 09:42:45 -0800 Subject: [PATCH] Mark TouchBar as experimental --- docs/api/browser-window.md | 5 ++++- docs/api/touch-bar.md | 3 +++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index 9463ee0cca1d..fe870ecb36bb 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -1004,7 +1004,7 @@ Same as `webContents.capturePage([rect, ]callback)`. * `userAgent` String (optional) - A user agent originating the request. * `extraHeaders` String (optional) - Extra headers separated by "\n" * `postData` ([UploadRawData](structures/upload-raw-data.md) | [UploadFile](structures/upload-file.md) | [UploadFileSystem](structures/upload-file-system.md) | [UploadBlob](structures/upload-blob.md))[] - (optional) - * `baseURLForDataURL` String (optional) - Base url (with trailing path separator) for files to be loaded by the data url. This is needed only if the specified `url` is a data url and needs to load other files. + * `baseURLForDataURL` String (optional) - Base url (with trailing path separator) for files to be loaded by the data url. This is needed only if the specified `url` is a data url and needs to load other files. Same as `webContents.loadURL(url[, options])`. @@ -1275,6 +1275,9 @@ Sets the touchBar layout for the current window. Specifying `null` or `undefined` clears the touch bar. This method only has an effect if the machine has a touch bar and is running on macOS 10.12.1+. +**Note:** The TouchBar API is currently experimental and may change or be +removed in future Electron releases. + [blink-feature-string]: https://cs.chromium.org/chromium/src/third_party/WebKit/Source/platform/RuntimeEnabledFeatures.json5?l=62 [quick-look]: https://en.wikipedia.org/wiki/Quick_Look [vibrancy-docs]: https://developer.apple.com/reference/appkit/nsvisualeffectview?language=objc diff --git a/docs/api/touch-bar.md b/docs/api/touch-bar.md index 2ca8c1ef32b6..8f0f35449635 100644 --- a/docs/api/touch-bar.md +++ b/docs/api/touch-bar.md @@ -11,6 +11,9 @@ Process: [Main](../tutorial/quick-start.md#main-process) Creates a new touch bar with the specified items. Use `BrowserWindow.setTouchBar` to add the `TouchBar` to a window. +**Note:** The TouchBar API is currently experimental and may change or be +removed in future Electron releases. + ## Examples Below is an example of a simple slot machine touch bar game with a button