yujunjun/strapi
1
0
Fork 0
mirror of https://github.com/strapi/strapi.git synced 2025-11-01 02:16:03 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve doc

Browse Source 
Signed-off-by: soupette <cyril.lpz@gmail.com>
This commit is contained in:
soupette 2020-04-24 12:46:37 +02:00
parent 8f22ee2c5a
commit 03b7b3340f
1 changed files with 17 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
docs/3.0.0-beta.x/plugin-development/frontend-development.md
View File

@ -60,23 +60,23 @@ Each plugin exports all its configurations in an object. This object is located
Here are its properties:
| key | type | Description |
| ------------------------- | ------- | :------------------------------------------------------------------------------------------------------ |
| blockerComponent | node | can be either `null` or React node (e.g. `() => <div />`) |
| blockerComponentProps | object | `{}` |
| description | string | `My awesome plugin` |
| id | string | Id of the plugin from the `package.json` |
| initializer | node | Refer to the [Initializer documentation](#initializer) |
| injectedComponents | array | Refer to the [Injected Component documentation](#injected-components) |
| isReady | boolean | The app will load until this proprety is true |
| leftMenuLinks | array | `[]` |
| mainComponent | node | The plugin's App container, setting it to null will prevent the plugin from being displayed in the menu |
| name | string | The plugin's name retrieved from the package.json |
| pluginLogo | file | The plugin's logo |
| preventComponentRendering | boolean | Whether or not display the plugin's blockerComponent instead of the main component |
| settings | object | Refer to the [Plugins settings API](./frontend-settings-api.md) |
| reducers | object | The plugin's redux reducers |
| trads | object | The plugin's translation files |
| key | type | Description |
| ------------------------- | ------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| blockerComponent | node | Props can be either `null` or React node (e.g. `() => <div />`) |
| blockerComponentProps | object | Props to provide to customise the [blockerComponent](https://github.com/strapi/strapi/blob/58588e10e5d15921b0966e20ce1bc6cde70df5cc/packages/strapi-helper-plugin/lib/src/components/BlockerComponent/index.js#L81-L86) |
| description | string | Plugin's description retrieved from the package.json |
| id | string | Id of the plugin from the `package.json` |
| initializer | node | Refer to the [Initializer documentation](#initializer) |
| injectedComponents | array | Refer to the [Injected Component documentation](#injected-components) |
| isReady | boolean | The app will load until this proprety is true |
| leftMenuLinks | array | Array of links to inject in the menu |
| mainComponent | node | The plugin's App container, setting it to null will prevent the plugin from being displayed in the menu |
| name | string | The plugin's name retrieved from the package.json |
| pluginLogo | file | The plugin's logo |
| preventComponentRendering | boolean | Whether or not display the plugin's blockerComponent instead of the main component |
| settings | object | Refer to the [Plugins settings API](./frontend-settings-api.md) |
| reducers | object | The plugin's redux reducers |
| trads | object | The plugin's translation files |
### Initializer