Layout Manager
The Layout Manager plugin injects ORB elements into the DOM. These ORB elements denote HTML content that is editable by Orbee.
Installation¶
This plugin requires no additional installation to be used correctly.
Type aliases¶
Configuration¶
This plugin provides the following configuration variables:
| Variable | Type | Required | Description |
|---|---|---|---|
| layout | Array <LayoutConfig> | ||
| no | Layout configuration to the ORB element container |
Integrations with other Plugins¶
The Layout Manager can set up ORB elements for other plugins to use. However, the desired plugins may require specific attributes to be present on the ORB element to be correctly integrated.
Popup Plugin¶
The popup plugin queries for the data-plugin-id on the ORB element to render its templates into.
{
// Other layout configuration
"attributes": {
"data-plugin-id": "<plugin_id>"
}
}
Methods¶
inject¶
inject ( config: LayoutConfig ): void
Injects an ORB element into the DOM
| Parameter | Type | Required | Description |
|---|---|---|---|
| config | LayoutConfig | no | Layout configuration to the ORB element container |
Events¶
This plugin does not generate any events.
Generated¶
This plugin generates the following events:
Listening¶
This plugin does not listen for any events.
Dependencies¶
This plugin does not depend on any other services or plugins.