VSinerva/freesewing
1
0
Fork 0
Code Activity

fix(docs): Improve conditional plugins docs

Browse source
This commit is contained in:
Benjamin F 2022-12-13 04:32:36 -08:00
parent 9e11419aea
commit 7cc76b3edf
1 changed files with 8 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

15
markdown/dev/reference/api/part/config/plugins/en.md
View file

@ -17,7 +17,7 @@ const part = {
```
<Tip>
You should only list the plugins that required by the part itself,
You should only list the plugins that are required by the part itself,
not those required by its dependencies
</Tip>
@ -44,20 +44,21 @@ const part = {
## Conditional plugins
A conditional plugin is loaded conditionally. It should be provided
as an object with the following structure:
A conditional plugin is loaded only when a condition is met.
The plugin and condition should be provided as an `Object`
with the following structure:
```js
import myPlugin from './my-plugin.mjs'
const plugin = {
plugin,
const myConditionalPlugin = {
myPlugin,
condition,
}
```
Where `plugin` is the plugin itself, and `condition` is the
method to determing whether or not to load it.
Where `myPlugin` is the plugin itself, and `condition` is the method
that returns `true` if the plugin should be loaded.
<Related>