docs: panel docs and gif
This commit is contained in:
parent
ac69b0a656
commit
ab106afae3
BIN
docs/latest/assets/img/extensions-panel.gif
Normal file
BIN
docs/latest/assets/img/extensions-panel.gif
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 178 KiB |
@ -1,6 +1,19 @@
|
|||||||
# Module: Panel
|
# Module: Panel
|
||||||
|
|
||||||
...
|
The panel module provides the ability to define `menuOptions` and `components`
|
||||||
|
that can be used by the consuming application. `components` are React Components
|
||||||
|
that can be displayed in the consuming application's "Panel" Component.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
<center><i>A panel extension example</i></center>
|
||||||
|
|
||||||
|
The `menuOptions`'s `target` key points to a registered `components`'s `id`. A
|
||||||
|
`defaultContext` is applied to all `menuOption`s; however, each `menuOption` can
|
||||||
|
optional provide it's own `context` value.
|
||||||
|
|
||||||
|
The `getPanelModule` receives an object containing the `ExtensionManager`'s
|
||||||
|
associated `ServicesManager` and `CommandsManager`.
|
||||||
|
|
||||||
```js
|
```js
|
||||||
import MyComponent from './MyComponent.js';
|
import MyComponent from './MyComponent.js';
|
||||||
@ -10,15 +23,24 @@ export default {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* @param {object} params
|
* @param {object} params
|
||||||
* @param {object} params.servicesManager
|
* @param {ServicesManager} params.servicesManager
|
||||||
|
* @param {CommandsManager} params.commandsManager
|
||||||
*/
|
*/
|
||||||
getPanelModule({ servicesManager }) {
|
getPanelModule({ servicesManager, commandsManager }) {
|
||||||
return {
|
return {
|
||||||
menuOptions: [
|
menuOptions: [
|
||||||
{
|
{
|
||||||
|
// A suggested icon
|
||||||
|
// Available icons determined by consuming app
|
||||||
icon: 'list',
|
icon: 'list',
|
||||||
|
// A suggested label
|
||||||
label: 'Magic',
|
label: 'Magic',
|
||||||
|
// 'right' or 'left'
|
||||||
|
from: 'right',
|
||||||
|
// The target component to toggle open/close
|
||||||
target: 'target-component-id',
|
target: 'target-component-id',
|
||||||
|
// Overrides `defaultContext`, if specified
|
||||||
|
context: ['ACTIVE_VIEWPORT:MAGIC'],
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
components: [
|
components: [
|
||||||
@ -27,7 +49,7 @@ export default {
|
|||||||
component: MyComponent,
|
component: MyComponent,
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
defaultContext: ['VIEWER'],
|
defaultContext: ['ROUTE:VIEWER'],
|
||||||
};
|
};
|
||||||
},
|
},
|
||||||
};
|
};
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user