As per the vocabulary, the Registry is designed as a storage place for apps outside of ui-dashboard to register resources. These will then become available to dashboard for the purposes of dynamic interactions between different frontend apps.
...
A RegistryResource is a class containing information about a particular resource of the registry. It has fields that are technically publically available, but they should only be accessed through the requisite getters and setters.
Once https://github.com/tc39/proposal-private-methods#private-methods-and-fields or equivalent become available and supported, these fields should be made private. This class contains the following methods with which to interact with it:
| Warning |
|---|
The templating parts below are not yet implemented and are likely to change as the project iterates forwards. |
...
| Warning |
|---|
The methods above for templating and customRendering are essentially just code injection, so it is vitally important that implementers consider that their code is just going to be run within ui-dashboard. The risk here is minimal, with no user defined methods, but it's still worth noting and taking care when implementing a custom render function. |
...
As things stand the Registry singleton class is defined within ui-dashboard, and not exposed, so other modules cannot yet make use of this registry beyond contributing to it. The plan is to make this work available, and expose it through another frontend module. The git repo "ui-plugin-resource-registry" was originally going to house this work, but it has been moved back to ui-dashboard for now pending more work, meaning even if the Registry object was exposed, it would be dependent on the existence of the "ui-dashboard" module.
It may be necessary to rename the repo "ui-resource-registry", as it is likely to no longer function as a plugin, rather as a full module, and the code in that repo will need to be brought up to date as changes are made to the reflected code in ui-dashboard.
ui-dashboard Registry implementation
ui-plugin-resourceui-stripes-registry