mirror of
https://github.com/stashapp/stash.git
synced 2025-12-06 08:26:00 +01:00
Document "# requires" in the plugin config (#6306)
* Document "# requires" in the plugin config * Add missing line breaks in UIPluginApi documentation
This commit is contained in:
parent
2cac7d5b20
commit
e176cf5f71
2 changed files with 9 additions and 2 deletions
|
|
@ -65,8 +65,11 @@ Plugins provide tasks which can be run from the Tasks page.
|
|||
|
||||
The basic structure of a plugin configuration file is as follows:
|
||||
|
||||
```
|
||||
```yaml
|
||||
name: <plugin name>
|
||||
# optional list of dependencies to be included
|
||||
# "#" is is part of the config - do not remove
|
||||
# requires: <plugin ID>
|
||||
description: <optional description of the plugin>
|
||||
version: <optional version tag>
|
||||
url: <optional url>
|
||||
|
|
@ -121,6 +124,8 @@ tasks:
|
|||
|
||||
The `name`, `description`, `version` and `url` fields are displayed on the plugins page.
|
||||
|
||||
`# requires` will make the plugin manager select plugins matching the specified IDs to be automatically installed as dependencies. Only works with plugins within the same index.
|
||||
|
||||
The `exec`, `interface`, `errLog` and `tasks` fields are used only for plugins with tasks.
|
||||
|
||||
The `settings` field is used to display plugin settings on the plugins page. Plugin settings can also be set using the graphql mutation `configurePlugin` - the settings set this way do _not_ need to be specified in the `settings` field unless they are to be displayed in the stock plugin settings UI.
|
||||
|
|
|
|||
|
|
@ -23,6 +23,7 @@ This namespace contains the generated graphql client interface. This is a low-le
|
|||
### `libraries`
|
||||
|
||||
`libraries` provides access to the following UI libraries:
|
||||
|
||||
- `ReactRouterDOM`
|
||||
- `Bootstrap`
|
||||
- `Apollo`
|
||||
|
|
@ -149,6 +150,7 @@ InteractiveUtils.interactiveClientProvider = (
|
|||
### `hooks`
|
||||
|
||||
This namespace provides access to the following core utility hooks:
|
||||
|
||||
- `useGalleryLightbox`
|
||||
- `useLightbox`
|
||||
- `useSpriteInfo`
|
||||
|
|
|
|||
Loading…
Reference in a new issue