diff --git a/docs/images/represented-file.png b/docs/images/represented-file.png new file mode 100644 index 000000000000..a2d3a3cdd770 Binary files /dev/null and b/docs/images/represented-file.png differ diff --git a/docs/tutorial/represented-file.md b/docs/tutorial/represented-file.md index b8867d628587..3e9eee30a445 100644 --- a/docs/tutorial/represented-file.md +++ b/docs/tutorial/represented-file.md @@ -1,28 +1,45 @@ # Represented File for macOS BrowserWindows -On macOS a window can set its represented file, so the file's icon can show in -the title bar and when users Command-Click or Control-Click on the title a path -popup will show. +## Overview -You can also set the edited state of a window so that the file icon can indicate -whether the document in this window has been modified. - -__Represented file popup menu:__ +On macOS, you can set a represented file for any window in your application. +The represented file's icon will be shown in the title bar, and when users +`Command-Click` or `Control-Click`, a popup with a path to the file will be +shown. ![Represented File][represented-image] +> NOTE: The screenshot above is an example where this feature is used to indicate the currently opened file in the Atom text editor. + +You can also set the edited state for a window so that the file icon can +indicate whether the document in this window has been modified. + To set the represented file of window, you can use the [BrowserWindow.setRepresentedFilename][setrepresentedfilename] and -[BrowserWindow.setDocumentEdited][setdocumentedited] APIs: +[BrowserWindow.setDocumentEdited][setdocumentedited] APIs. + +## Example + +Starting with a working application from the +[Quick Start Guide](quick-start.md), add the following lines to the +`main.js` file: ```javascript -const { BrowserWindow } = require('electron') +const { app, BrowserWindow } = require('electron') -const win = new BrowserWindow() -win.setRepresentedFilename('/etc/passwd') -win.setDocumentEdited(true) +app.whenReady().then(() => { + const win = new BrowserWindow() + + win.setRepresentedFilename('/etc/passwd') + win.setDocumentEdited(true) +}) ``` +After launching the Electron application, click on the title with `Command` or +`Control` key pressed. You should see a popup with the file you just defined: + +![Represented file](../images/represented-file.png) + [represented-image]: https://cloud.githubusercontent.com/assets/639601/5082061/670a949a-6f14-11e4-987a-9aaa04b23c1d.png [setrepresentedfilename]: ../api/browser-window.md#winsetrepresentedfilenamefilename-macos [setdocumentedited]: ../api/browser-window.md#winsetdocumenteditededited-macos