|
@@ -0,0 +1,46 @@
|
|
|
+# Recent Documents (Windows & macOS)
|
|
|
+
|
|
|
+Windows and macOS provide easy access to a list of recent documents opened by
|
|
|
+the application via JumpList or dock menu, respectively.
|
|
|
+
|
|
|
+__JumpList:__
|
|
|
+
|
|
|
+![JumpList Recent Files][jumplist-image]
|
|
|
+
|
|
|
+__Application dock menu:__
|
|
|
+
|
|
|
+![macOS Dock Menu][dock-menu-image]
|
|
|
+
|
|
|
+To add a file to recent documents, you can use the
|
|
|
+[app.addRecentDocument][addrecentdocument] API:
|
|
|
+
|
|
|
+```javascript
|
|
|
+const { app } = require('electron')
|
|
|
+app.addRecentDocument('/Users/USERNAME/Desktop/work.type')
|
|
|
+```
|
|
|
+
|
|
|
+And you can use [app.clearRecentDocuments][clearrecentdocuments] API to empty
|
|
|
+the recent documents list:
|
|
|
+
|
|
|
+```javascript
|
|
|
+const { app } = require('electron')
|
|
|
+app.clearRecentDocuments()
|
|
|
+```
|
|
|
+
|
|
|
+## Windows Notes
|
|
|
+
|
|
|
+In order to be able to use this feature on Windows, your application has to be
|
|
|
+registered as a handler of the file type of the document, otherwise the file
|
|
|
+won't appear in JumpList even after you have added it. You can find everything
|
|
|
+on registering your application in [Application Registration][app-registration].
|
|
|
+
|
|
|
+When a user clicks a file from the JumpList, a new instance of your application
|
|
|
+will be started with the path of the file added as a command line argument.
|
|
|
+
|
|
|
+## macOS Notes
|
|
|
+
|
|
|
+When a file is requested from the recent documents menu, the `open-file` event
|
|
|
+of `app` module will be emitted for it.
|
|
|
+
|
|
|
+[jumplist-image]: https://cloud.githubusercontent.com/assets/2289/23446924/11a27b98-fdfc-11e6-8485-cc3b1e86b80a.png
|
|
|
+[dock-menu-image]: https://cloud.githubusercontent.com/assets/639601/5069610/2aa80758-6e97-11e4-8cfb-c1a414a10774.png
|