Compare commits

...

3 Commits

Author SHA1 Message Date
WithoutPants
acb3b4ee44 Fix typo 2025-11-25 08:34:22 +11:00
DogmaDragon
b7c6e370dc Add missing line breaks in UIPluginApi documentation 2025-11-22 23:34:12 +02:00
DogmaDragon
19d6f5543d Document "# requires" in the plugin config 2025-11-22 23:19:18 +02:00
2 changed files with 9 additions and 2 deletions

View File

@@ -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:
```
name: <plugin name>
```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.

View File

@@ -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`