mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions 1

More docs updates

Browse source
This commit is contained in:
Samuel Attard 2016-11-05 19:42:45 +11:00 • committed by Zeke Sikelianos
parent 1a9b4b4671
commit 63ebc41778
8 changed files with 44 additions and 40 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/api/structures/file-filter.md Normal file
View file

@ -0,0 +1,4 @@
# FileFilter Object
* `name` String
* `extensions` String[]

4
docs/api/structures/jump-list-category.md
View file

@ -10,9 +10,9 @@
of the category and its items are set by Windows. Items may be added to
this category indirectly using `app.addRecentDocument(path)`.
* `custom` - Displays tasks or file links, `name` must be set by the app.
* `name` String - Must be set if `type` is `custom`, otherwise it should be
* `name` String - (optional) Must be set if `type` is `custom`, otherwise it should be
omitted.
* `items` JumpListItem[] - Array of [`JumpListItem`](jump-list-item.md) objects if `type` is `tasks` or
* `items` JumpListItem[] - (optional) Array of [`JumpListItem`](jump-list-item.md) objects if `type` is `tasks` or
`custom`, otherwise it should be omitted.
**Note:** If a `JumpListCategory` object has neither the `type` nor the `name`

10
docs/api/structures/jump-list-item.md
View file

@ -7,16 +7,16 @@
* `file` - A file link will open a file using the app that created the
Jump List, for this to work the app must be registered as a handler for
the file type (though it doesn't have to be the default handler).
* `path` String - Path of the file to open, should only be set if `type` is
* `path` String - (optional) Path of the file to open, should only be set if `type` is
`file`.
* `program` String - Path of the program to execute, usually you should
* `program` String - (optional) Path of the program to execute, usually you should
specify `process.execPath` which opens the current program. Should only be
set if `type` is `task`.
* `args` String - The command line arguments when `program` is executed. Should
* `args` String - (optional) The command line arguments when `program` is executed. Should
only be set if `type` is `task`.
* `title` String - The text to be displayed for the item in the Jump List.
* `title` String - (optional) The text to be displayed for the item in the Jump List.
Should only be set if `type` is `task`.
* `description` String - Description of the task (displayed in a tooltip).
* `description` String - (optional) Description of the task (displayed in a tooltip).
Should only be set if `type` is `task`.
* `iconPath` String - The absolute path to an icon to be displayed in a
Jump List, which can be an arbitrary resource file that contains an icon