-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
66 additions
and
47 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| # Plugin Component | ||
|
|
||
| A wrapper that creates an iframe for a specified plugin and establishes a two-way communication channel with said plugin, allowing you to pass props (including callbacks between an app and a plugin). Note that the plugin must be built using the app-platform with entryPoints.plugin specified in the d2.config.js file. | ||
|
|
||
| ## Basic Usage (Defining a plugin within an app) | ||
|
|
||
| Within an app you can specify a plugin (either by providing its short name `pluginShortName`, or by specifying a URL directly (`pluginSource`). If you have provided `pluginSource`, this will take precedence (Note: lookup logic is TBD? Should we allow a URL only in development mode, for example?). | ||
|
|
||
| ```jsx | ||
| import { Plugin } from '@dhis2/app-runtime' | ||
|
|
||
| // within the app | ||
| const MyApp = () => ( | ||
| <Plugin | ||
| pluginShortName={mutation} | ||
| onError={(err) => { | ||
| console.error(err) | ||
| }} | ||
| showAlertsInPlugin={true} | ||
| numberToPass={'42'} | ||
| callbackToPass={({ name }) => { | ||
| console.log(`Hi ${name}!`) | ||
| }} | ||
| /> | ||
| ) | ||
| ``` | ||
|
|
||
| ## Basic Usage (Using properties from the parent app) | ||
|
|
||
| You must build your plugin with the app-platform. If you have done this, your entry component will be passed the props from the parent app. From the example above, the properties `numberToPass` and `callbackToPass` will be available in the build plugin (when it is rendered with a <Plugin> component). | ||
|
|
||
| ```jsx | ||
| // your plugin entry point (the plugin itself) | ||
|
|
||
| const MyPlugin = (propsFromParent) => { | ||
| const { numberToPass, callbackToPass: sayHi } = propsFromParent | ||
| return ( | ||
| <> | ||
| <p>{`The meaning of life is: ${numberToPass}`}</p> | ||
| <button onClick={() => sayHi({ name: 'Arthur Dent' })}> | ||
| Say hi | ||
| </button> | ||
| </> | ||
| ) | ||
| } | ||
| ``` | ||
|
|
||
| ## Plugin Props (reserved props) | ||
|
|
||
| | Name | Type | Required | Description | | ||
| | :--------------------: | :------------: | :---------------------------------------------: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | **pluginShortName** | _string_ | _required_ if `pluginSource` is not provided | The shortName of the app/plugin you wish to load (matching the result from api/apps). Used to look up the plugin entry point. If this is not provided, `pluginSource` must be provided. `pluginSource` will take precedence if provided. | | ||
| | **pluginSource** | _string_ (url) | _required_ if `pluginShortName` is not provided | The URL of the plugin. If this is not provided, `pluginShortName` must be provided. | | ||
| | **onError** | _Function_ | _optional_ | Callback function to be called when an error in the plugin triggers an error boundary. You can use this to pass an error back up to the app and create a custom handling/UX if errors occur in the plugin. In general, it is recommended that you use the plugin's built-in error boundaries | | ||
| | **showAlertsInPlugin** | _boolean_ | _optional_ | If `true`, any alerts within the plugin (defined with the `useAlert` hook) will be rendered within the iframe. By default, this is `false`. It is recommended, in general, that you do not override this and allow alerts to be hoisted up to the app level | | ||
|
|
||
| ## Plugin Props (custom props) | ||
|
|
||
| You can specify pass any other props on the <Plugin> component and these will be passed down to the plugin (provided it was built with app-platform). When props are updated, they will be passed back down to the plugin. This mimics the behaviour of a normal React component, and hence you should provide stable references as needed to prevent rerendering. | ||
|
|
||
| ## Extended example | ||
|
|
||
| See these links for an extended example of how <Plugin> component can be used within an [app](https://github.com/tomzemp/workingplugin/blob/plugin-wrapper-in-platform/src/App.js) and consumed within the [plugin](https://github.com/tomzemp/workingplugin/blob/plugin-wrapper-in-platform/src/Plugin.js). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| export { PluginSender } from './PluginSender' | ||
| export { Plugin } from './Plugin' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters