Mirrors/stash
1
0
Fork 0
mirror of https://github.com/stashapp/stash.git synced 2025-12-17 20:34:37 +03:00
Code Issues Packages Projects Releases Wiki Activity

UI nested instead (#5125)

Browse Source 
* Support multiple calls to PluginApi.patch.instead for a component.

Allow calling the original/chained function from the hook function.

* Add example of new usage of instead
* Update documentation
This commit is contained in:
WithoutPants
2024-08-20 12:36:45 +10:00
committed by GitHub
parent a94bf29b34
commit 49060e6686
4 changed files with 59 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
ui/v2.5/src/docs/en/Manual/UIPluginApi.md
View File

@@ -117,12 +117,12 @@ Returns `void`.
#### `PluginApi.patch.instead`
Registers a replacement function for a component. The provided function will be called with the arguments passed to the original render function, plus the original render function as the last argument. An error will be thrown if the component already has a replacement function registered.
Registers a replacement function for a component. The provided function will be called with the arguments passed to the original render function, plus the next render function as the last argument. Replacement functions will be called in the order that they are registered. If a replacement function does not call the next render function then the following replacement functions will not be called or applied.
| Parameter | Type | Description |
|-----------|------|-------------|
| `component` | `string` | The name of the component to patch. |
| `fn` | `Function` | The replacement function. It accepts the same arguments as the original render function, plus the original render function, and is expected to return the replacement component. |
| `fn` | `Function` | The replacement function. It accepts the same arguments as the original render function, plus the next render function, and is expected to return the replacement component. |
Returns `void`.