Docs WIP
This commit is contained in:
43
docs/customization/plugin-api.md
Normal file
43
docs/customization/plugin-api.md
Normal file
@@ -0,0 +1,43 @@
|
||||
# Plugin API
|
||||
|
||||
A plugin is an object that contains functions and components capable of modifying and augmenting Swagger-UI's functionality.
|
||||
|
||||
### Format
|
||||
|
||||
A plugin may contain any or all of these keys:
|
||||
|
||||
```javascript
|
||||
const MyPlugin = {
|
||||
statePlugins: {
|
||||
anyStateKey: {
|
||||
actions,
|
||||
reducers,
|
||||
selectors,
|
||||
wrapActions,
|
||||
wrapSelectors
|
||||
}
|
||||
},
|
||||
components: {
|
||||
|
||||
},
|
||||
wrapComponents: {
|
||||
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Interfaces
|
||||
|
||||
##### Actions
|
||||
|
||||
##### Reducers
|
||||
|
||||
##### Selectors
|
||||
|
||||
##### Components
|
||||
|
||||
##### Wrap-Actions
|
||||
|
||||
##### Wrap-Selectors
|
||||
|
||||
##### Wrap-Components
|
||||
Reference in New Issue
Block a user