docs: explanation of default services and current state

This commit is contained in:
dannyrb 2019-12-06 09:17:20 -05:00
parent caa6062c41
commit 6c63a917d3
3 changed files with 21 additions and 10 deletions

View File

@ -28,7 +28,10 @@ them different below:
### Services (default) ### Services (default)
... Services are a work in progress. As we are still in the progress of creating a
non-ui maintained service, this usage may change.
[You can read more about default services: here](./services.md)
### UI Services ### UI Services

View File

@ -1,4 +1,12 @@
# Services # Services (default)
- [Overview](#overview)
- [Example](#example)
## Overview
Services are a work in progress. As we are still in the progress of creating a
non-ui maintained service, this usage may change.
<div style="text-align: center;"> <div style="text-align: center;">
<a href="/assets/img/services.png"> <a href="/assets/img/services.png">

View File

@ -1,7 +1,7 @@
# UI Services # UI Services
- [Overview](#/) - [Overview](#overview)
- [Example](#/) - [Example](#example)
- [Tips & Tricks](#/) - [Tips & Tricks](#/)
- [Maintained Services](#/) - [Maintained Services](#/)
@ -36,7 +36,7 @@ The `ServicesManager` is:
- All of it's lifecycle hooks (`preInit`) - All of it's lifecycle hooks (`preInit`)
- Each "getModuleFunction" (`getToolbarModule`, `getPanelModule`, etc.) - Each "getModuleFunction" (`getToolbarModule`, `getPanelModule`, etc.)
## An Example ## Example
That's all fine and good, but it's still a little too abstract. What does this That's all fine and good, but it's still a little too abstract. What does this
translate to in practice? translate to in practice?
@ -99,8 +99,8 @@ parts and pieces of the OHIF Platform to create a polished and powerful product.
To accomplish that, we maintain several UI Services that you can use in your own To accomplish that, we maintain several UI Services that you can use in your own
project, or provide alternative implementations for: project, or provide alternative implementations for:
| Name | Description | Docs | | Name | Docs |
| --------------------- | ----------- | ------------------------------------ | | --------------------- | ------------------------------------ |
| UIDialogService | | [Here](./ui-dialog-service.md) | | UIDialogService | [Here](./ui-dialog-service.md) |
| UIModalService | | [Here](./ui-modal-service.md) | | UIModalService | [Here](./ui-modal-service.md) |
| UINotificationService | | [Here](./ui-notification-service.md) | | UINotificationService | [Here](./ui-notification-service.md) |