Skip to content

Commit 716211f

Browse files
author
Stacey Gammon
authored
Update README.md (#63622)
1 parent c57297c commit 716211f

File tree

1 file changed

+11
-25
lines changed

1 file changed

+11
-25
lines changed

src/plugins/embeddable/README.md

Lines changed: 11 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,25 @@
1-
# The Embeddable API V2
1+
# Embeddables
22

3-
The Embeddable API's main goal is to have documented and standardized ways to share and exchange information and functionality across applications and plugins.
3+
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_.
44

5-
There are three main pieces of this infrastructure:
6-
- Embeddables & Containers
7-
- Actions
8-
- Triggers
5+
## Embeddable containers
96

10-
## Embeddables & Containers
7+
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.
118

12-
Embeddables are isolated, serializable, renderable widgets. A developer can hard code an embeddable inside their
13-
application, or they can use some built in actions to allow users to dynamically add them to *containers*.
14-
15-
Containers are a special type of embeddable that can contain nested embeddables.
16-
17-
## Actions
18-
19-
Actions are pluggable pieces of functionality exposed to the user that take an embeddable as context, plus an optional action context.
20-
21-
## Triggers
22-
23-
Triggers are the way actions are connected to a user action. We ship with two default triggers, `CONTEXT_MENU_TRIGGER` and `APPLY_FILTER`.
24-
25-
Actions attached to the `CONTEXT_MENU_TRIGGER` will be displayed in supported embeddables context menu to the user. Actions attached to the `APPLY_FILTER` trigger will show up when any embeddable emits this trigger.
9+
## Examples
2610

27-
A developer can register new triggers that their embeddables, or external components, can emit (as long as they have an embeddable to pass along as context).
11+
Many example embeddables are implemented and registered [here](https://github.com/elastic/kibana/tree/master/examples/embeddable_examples). They can be played around with and explored [in the Embeddable Explorer example plugin](https://github.com/elastic/kibana/tree/master/examples/embeddable_explorer). Just run kibana with
2812

29-
## Examples
13+
```
14+
yarn start --run-examples
15+
```
3016

31-
Many examples can be viewed in the functionally tested `kbn_tp_embeddable_explorer` plugin, as well as the jest tested classes inside the `embeddable_api/public/test_samples` folder.
17+
and navigate to the Embeddable explorer app.
3218

3319
## Testing
3420

3521
Run unit tests
3622

3723
```shell
38-
node scripts/jest embeddable_api
24+
node scripts/jest embeddable
3925
```

0 commit comments

Comments
 (0)