From 3859359a058e79c290c49c6d1ff16990138bd598 Mon Sep 17 00:00:00 2001 From: dannyrb Date: Tue, 18 Jun 2019 16:11:38 -0400 Subject: [PATCH] Note regarding how extensions are specified for app --- docs/latest/advanced/extensions.md | 29 ++++++++++++++++++----------- 1 file changed, 18 insertions(+), 11 deletions(-) diff --git a/docs/latest/advanced/extensions.md b/docs/latest/advanced/extensions.md index 677d47e93..22368bb4d 100644 --- a/docs/latest/advanced/extensions.md +++ b/docs/latest/advanced/extensions.md @@ -53,7 +53,9 @@ export default { } } - // Not yet used + /** + * Not yet implemented + */ getPanelModule: () => null, /** @@ -76,12 +78,20 @@ export default { ### Modules -There are a few different kinds of modules. Each kind of module allows us to -extend the viewer in a different way, and provides a consistent API for us to do -so. You can find a full list of the -[different types of modules `in ohif-core`](https://github.com/OHIF/ohif-core/blob/43c08a29eff3fb646a0e83a03a236ddd84f4a6e8/src/plugins.js#L1-L6). -Information on each type of module, it's API, and how we determine when/where it -should be used is included below: +There are a few different module types. Each module type allows us to extend the +viewer in a different way, and provides a consistent API for us to do so. You +can find a full list of the different types of modules +[`in ohif-core`][module-types]. Information on each type of module, it's API, +and how we determine when/where it should be used is included below. + +> NOTE: Modifying the extensions/modules registered to the OHIF Viewer currently +> requires us to import and pass extensions to the ExtensionManager in +> `src/App.js`, then rebuild the application. Long-term, we intend to make it +> possible to accomplish this without a build step. + +#### Commands + +... #### Viewport @@ -137,10 +147,6 @@ For a complete example implementation, > The panel module is not yet in use. -#### Commands - -... - #### Hotkeys ... @@ -189,4 +195,5 @@ directory. [example-ext-src]: https://github.com/OHIF/Viewers/blob/master/extensions/_ohif-example-extension/src/index.js) +[module-types]: https://github.com/OHIF/ohif-core/blob/43c08a29eff3fb646a0e83a03a236ddd84f4a6e8/src/plugins.js#L1-L6