Embeddables

Embeddables are re-usable widgets that can be rendered in any environment or plugin. Developers can embed them directly in their plugin. End users can dynamically add them to any embeddable containers.

Embeddable containers

Containers are a special type of embeddable that can contain nested embeddables. Embeddables can be dynamically added to embeddable containers. Currently only dashboard uses this interface.

Examples

Many example embeddables are implemented and registered here. They can be played around with and explored in the Embeddable Explorer example plugin. Just run OpenSearch Dashboards with

yarn start --run-examples

and navigate to the Embeddable explorer app.

There is also an example of rendering dashboard container outside of dashboard app here.

Docs

Embeddable docs, guides & caveats

Testing

Run unit tests

node scripts/jest embeddable