yujunjun/strapi
1
0
Fork 0
mirror of https://github.com/strapi/strapi.git synced 2025-12-27 15:13:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation

Browse Source 
Signed-off-by: soupette <cyril.lpz@gmail.com>
This commit is contained in:
soupette 2020-04-20 11:04:07 +02:00
parent 0faf75124f
commit cf3690d41c
1 changed files with 20 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -60,19 +60,23 @@ Each plugin exports all its configurations in an object. This object is located
Here are its properties:
| key | type | value |
| ------------------------- | -------- | :-------------------------------------------------------------------------------- |
| 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) |
| leftMenuLinks | array | `[]` |
| lifecycles | function | Refer to the [Lifecycle documentation](#lifecycle) |
| mainComponent | node | The plugin's App container |
| preventComponentRendering | boolean | Wheter or not display the plugin's blockerComponent instead of the main component |
| trads | object | The plugin's translation files |
| key | type | value |
| ------------------------- | ------- | :------------------------------------------------------------------------------------------------------ |
| 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 | Wheter or not display the plugin's blockerComponent instead of the main component |
| settings | object | Refer to ther [Plugins settings API](./frontend-settings-api.md) |
| reducers | object | The plugin's redux reducers |
| trads | object | The plugin's translation files |
### Initializer
@ -126,16 +130,8 @@ class Initializer extends React.PureComponent {
}
// Prevent the plugin from being rendered if currentEnvironment === PRODUCTION
this.props.updatePlugin(
pluginId,
'preventComponentRendering',
preventComponentRendering
);
this.props.updatePlugin(
pluginId,
'blockerComponentProps',
blockerComponentProps
);
this.props.updatePlugin(pluginId, 'preventComponentRendering', preventComponentRendering);
this.props.updatePlugin(pluginId, 'blockerComponentProps', blockerComponentProps);
// Emit the event plugin ready
this.props.updatePlugin(pluginId, 'isReady', true);
}
@ -188,11 +184,7 @@ class App extends React.Component {
return (
<div>
<Switch>
<Route
exact
path={`/plugins/${pluginId}/user/:id`}
component={UserPage}
/>
<Route exact path={`/plugins/${pluginId}/user/:id`} component={UserPage} />
</Switch>
</div>
);