Skip to content

Commit c5e781e

Browse files
ppisljarppisljar
committed
ui_actions service initial docs (elastic#78902)
1 parent 20147ea commit c5e781e

File tree

108 files changed

+2014
-11
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

108 files changed

+2014
-11
lines changed

‎docs/developer/plugin-list.asciidoc

+9-1
Original file line numberDiff line numberDiff line change
@@ -189,9 +189,16 @@ so they can properly protect the data within their clusters.
189189
which also contains the timelion APIs and backend, look at the vis_type_timelion plugin.
190190
191191
192-
|{kib-repo}blob/{branch}/src/plugins/ui_actions/README.md[uiActions]
192+
|<<uiactions-plugin>>
193193
|An API for:
194194
195+
- creating custom functionality (`actions`)
196+
- creating custom user interaction events (`triggers`)
197+
- attaching and detaching `actions` to `triggers`.
198+
- emitting `trigger` events
199+
- executing `actions` attached to a given `trigger`.
200+
- exposing a context menu for the user to choose the appropriate action when there are multiple actions attached to a single trigger.
201+
195202
196203
|{kib-repo}blob/{branch}/src/plugins/url_forwarding/README.md[urlForwarding]
197204
|This plugins contains helpers to redirect legacy URLs. It can be used to forward old URLs to their new counterparts.
@@ -533,5 +540,6 @@ in their infrastructure.
533540
534541
include::{kibana-root}/src/plugins/dashboard/README.asciidoc[leveloffset=+1]
535542
include::{kibana-root}/src/plugins/expressions/README.asciidoc[leveloffset=+1]
543+
include::{kibana-root}/src/plugins/ui_actions/README.asciidoc[leveloffset=+1]
536544
include::{kibana-root}/x-pack/plugins/dashboard_enhanced/README.asciidoc[leveloffset=+1]
537545
include::{kibana-root}/x-pack/plugins/embeddable_enhanced/README.asciidoc[leveloffset=+1]

‎docs/development/plugins/ui_actions/public/index.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md)
4+
5+
## API Reference
6+
7+
## Packages
8+
9+
| Package | Description |
10+
| --- | --- |
11+
| [kibana-plugin-plugins-ui\_actions-public](./kibana-plugin-plugins-ui_actions-public.md) | |
12+

‎docs/development/plugins/ui_actions/public/kibana-plugin-plugins-ui_actions-public.action.execute.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-plugins-ui\_actions-public](./kibana-plugin-plugins-ui_actions-public.md) &gt; [Action](./kibana-plugin-plugins-ui_actions-public.action.md) &gt; [execute](./kibana-plugin-plugins-ui_actions-public.action.execute.md)
4+
5+
## Action.execute() method
6+
7+
Executes the action.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
execute(context: ActionExecutionContext<Context>): Promise<void>;
13+
```
14+
15+
## Parameters
16+
17+
| Parameter | Type | Description |
18+
| --- | --- | --- |
19+
| context | <code>ActionExecutionContext&lt;Context&gt;</code> | |
20+
21+
<b>Returns:</b>
22+
23+
`Promise<void>`
24+

‎docs/development/plugins/ui_actions/public/kibana-plugin-plugins-ui_actions-public.action.getdisplayname.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-plugins-ui\_actions-public](./kibana-plugin-plugins-ui_actions-public.md) &gt; [Action](./kibana-plugin-plugins-ui_actions-public.action.md) &gt; [getDisplayName](./kibana-plugin-plugins-ui_actions-public.action.getdisplayname.md)
4+
5+
## Action.getDisplayName() method
6+
7+
Returns a title to be displayed to the user.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
getDisplayName(context: ActionExecutionContext<Context>): string;
13+
```
14+
15+
## Parameters
16+
17+
| Parameter | Type | Description |
18+
| --- | --- | --- |
19+
| context | <code>ActionExecutionContext&lt;Context&gt;</code> | |
20+
21+
<b>Returns:</b>
22+
23+
`string`
24+

‎docs/development/plugins/ui_actions/public/kibana-plugin-plugins-ui_actions-public.action.gethref.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-plugins-ui\_actions-public](./kibana-plugin-plugins-ui_actions-public.md) &gt; [Action](./kibana-plugin-plugins-ui_actions-public.action.md) &gt; [getHref](./kibana-plugin-plugins-ui_actions-public.action.gethref.md)
4+
5+
## Action.getHref() method
6+
7+
This method should return a link if this item can be clicked on. The link is used to navigate user if user middle-clicks it or Ctrl + clicks or right-clicks and selects "Open in new tab".
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
getHref?(context: ActionExecutionContext<Context>): Promise<string | undefined>;
13+
```
14+
15+
## Parameters
16+
17+
| Parameter | Type | Description |
18+
| --- | --- | --- |
19+
| context | <code>ActionExecutionContext&lt;Context&gt;</code> | |
20+
21+
<b>Returns:</b>
22+
23+
`Promise<string | undefined>`
24+

‎docs/development/plugins/ui_actions/public/kibana-plugin-plugins-ui_actions-public.action.geticontype.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-plugins-ui\_actions-public](./kibana-plugin-plugins-ui_actions-public.md) &gt; [Action](./kibana-plugin-plugins-ui_actions-public.action.md) &gt; [getIconType](./kibana-plugin-plugins-ui_actions-public.action.geticontype.md)
4+
5+
## Action.getIconType() method
6+
7+
Optional EUI icon type that can be displayed along with the title.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
getIconType(context: ActionExecutionContext<Context>): string | undefined;
13+
```
14+
15+
## Parameters
16+
17+
| Parameter | Type | Description |
18+
| --- | --- | --- |
19+
| context | <code>ActionExecutionContext&lt;Context&gt;</code> | |
20+
21+
<b>Returns:</b>
22+
23+
`string | undefined`
24+

‎docs/development/plugins/ui_actions/public/kibana-plugin-plugins-ui_actions-public.action.id.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-plugins-ui\_actions-public](./kibana-plugin-plugins-ui_actions-public.md) &gt; [Action](./kibana-plugin-plugins-ui_actions-public.action.md) &gt; [id](./kibana-plugin-plugins-ui_actions-public.action.id.md)
4+
5+
## Action.id property
6+
7+
A unique identifier for this action instance.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
id: string;
13+
```

‎docs/development/plugins/ui_actions/public/kibana-plugin-plugins-ui_actions-public.action.iscompatible.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-plugins-ui\_actions-public](./kibana-plugin-plugins-ui_actions-public.md) &gt; [Action](./kibana-plugin-plugins-ui_actions-public.action.md) &gt; [isCompatible](./kibana-plugin-plugins-ui_actions-public.action.iscompatible.md)
4+
5+
## Action.isCompatible() method
6+
7+
Returns a promise that resolves to true if this action is compatible given the context, otherwise resolves to false.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
isCompatible(context: ActionExecutionContext<Context>): Promise<boolean>;
13+
```
14+
15+
## Parameters
16+
17+
| Parameter | Type | Description |
18+
| --- | --- | --- |
19+
| context | <code>ActionExecutionContext&lt;Context&gt;</code> | |
20+
21+
<b>Returns:</b>
22+
23+
`Promise<boolean>`
24+

‎docs/development/plugins/ui_actions/public/kibana-plugin-plugins-ui_actions-public.action.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-plugins-ui\_actions-public](./kibana-plugin-plugins-ui_actions-public.md) &gt; [Action](./kibana-plugin-plugins-ui_actions-public.action.md)
4+
5+
## Action interface
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
export interface Action<Context extends BaseContext = {}, T = ActionType> extends Partial<Presentable<ActionExecutionContext<Context>>>
11+
```
12+
13+
## Properties
14+
15+
| Property | Type | Description |
16+
| --- | --- | --- |
17+
| [id](./kibana-plugin-plugins-ui_actions-public.action.id.md) | <code>string</code> | A unique identifier for this action instance. |
18+
| [MenuItem](./kibana-plugin-plugins-ui_actions-public.action.menuitem.md) | <code>UiComponent&lt;{</code><br/><code> context: ActionExecutionContext&lt;Context&gt;;</code><br/><code> }&gt;</code> | <code>UiComponent</code> to render when displaying this action as a context menu item. If not provided, <code>getDisplayName</code> will be used instead. |
19+
| [order](./kibana-plugin-plugins-ui_actions-public.action.order.md) | <code>number</code> | Determined the order when there is more than one action matched to a trigger. Higher numbers are displayed first. |
20+
| [type](./kibana-plugin-plugins-ui_actions-public.action.type.md) | <code>T</code> | The action type is what determines the context shape. |
21+
22+
## Methods
23+
24+
| Method | Description |
25+
| --- | --- |
26+
| [execute(context)](./kibana-plugin-plugins-ui_actions-public.action.execute.md) | Executes the action. |
27+
| [getDisplayName(context)](./kibana-plugin-plugins-ui_actions-public.action.getdisplayname.md) | Returns a title to be displayed to the user. |
28+
| [getHref(context)](./kibana-plugin-plugins-ui_actions-public.action.gethref.md) | This method should return a link if this item can be clicked on. The link is used to navigate user if user middle-clicks it or Ctrl + clicks or right-clicks and selects "Open in new tab". |
29+
| [getIconType(context)](./kibana-plugin-plugins-ui_actions-public.action.geticontype.md) | Optional EUI icon type that can be displayed along with the title. |
30+
| [isCompatible(context)](./kibana-plugin-plugins-ui_actions-public.action.iscompatible.md) | Returns a promise that resolves to true if this action is compatible given the context, otherwise resolves to false. |
31+
| [shouldAutoExecute(context)](./kibana-plugin-plugins-ui_actions-public.action.shouldautoexecute.md) | Determines if action should be executed automatically, without first showing up in context menu. false by default. |
32+

‎docs/development/plugins/ui_actions/public/kibana-plugin-plugins-ui_actions-public.action.menuitem.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-plugins-ui\_actions-public](./kibana-plugin-plugins-ui_actions-public.md) &gt; [Action](./kibana-plugin-plugins-ui_actions-public.action.md) &gt; [MenuItem](./kibana-plugin-plugins-ui_actions-public.action.menuitem.md)
4+
5+
## Action.MenuItem property
6+
7+
`UiComponent` to render when displaying this action as a context menu item. If not provided, `getDisplayName` will be used instead.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
MenuItem?: UiComponent<{
13+
context: ActionExecutionContext<Context>;
14+
}>;
15+
```

‎docs/development/plugins/ui_actions/public/kibana-plugin-plugins-ui_actions-public.action.order.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-plugins-ui\_actions-public](./kibana-plugin-plugins-ui_actions-public.md) &gt; [Action](./kibana-plugin-plugins-ui_actions-public.action.md) &gt; [order](./kibana-plugin-plugins-ui_actions-public.action.order.md)
4+
5+
## Action.order property
6+
7+
Determined the order when there is more than one action matched to a trigger. Higher numbers are displayed first.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
order?: number;
13+
```

‎docs/development/plugins/ui_actions/public/kibana-plugin-plugins-ui_actions-public.action.shouldautoexecute.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-plugins-ui\_actions-public](./kibana-plugin-plugins-ui_actions-public.md) &gt; [Action](./kibana-plugin-plugins-ui_actions-public.action.md) &gt; [shouldAutoExecute](./kibana-plugin-plugins-ui_actions-public.action.shouldautoexecute.md)
4+
5+
## Action.shouldAutoExecute() method
6+
7+
Determines if action should be executed automatically, without first showing up in context menu. false by default.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
shouldAutoExecute?(context: ActionExecutionContext<Context>): Promise<boolean>;
13+
```
14+
15+
## Parameters
16+
17+
| Parameter | Type | Description |
18+
| --- | --- | --- |
19+
| context | <code>ActionExecutionContext&lt;Context&gt;</code> | |
20+
21+
<b>Returns:</b>
22+
23+
`Promise<boolean>`
24+

‎docs/development/plugins/ui_actions/public/kibana-plugin-plugins-ui_actions-public.action.type.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-plugins-ui\_actions-public](./kibana-plugin-plugins-ui_actions-public.md) &gt; [Action](./kibana-plugin-plugins-ui_actions-public.action.md) &gt; [type](./kibana-plugin-plugins-ui_actions-public.action.type.md)
4+
5+
## Action.type property
6+
7+
The action type is what determines the context shape.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
readonly type: T;
13+
```

‎docs/development/plugins/ui_actions/public/kibana-plugin-plugins-ui_actions-public.action_visualize_field.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-plugins-ui\_actions-public](./kibana-plugin-plugins-ui_actions-public.md) &gt; [ACTION\_VISUALIZE\_FIELD](./kibana-plugin-plugins-ui_actions-public.action_visualize_field.md)
4+
5+
## ACTION\_VISUALIZE\_FIELD variable
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
ACTION_VISUALIZE_FIELD = "ACTION_VISUALIZE_FIELD"
11+
```

‎docs/development/plugins/ui_actions/public/kibana-plugin-plugins-ui_actions-public.action_visualize_geo_field.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-plugins-ui\_actions-public](./kibana-plugin-plugins-ui_actions-public.md) &gt; [ACTION\_VISUALIZE\_GEO\_FIELD](./kibana-plugin-plugins-ui_actions-public.action_visualize_geo_field.md)
4+
5+
## ACTION\_VISUALIZE\_GEO\_FIELD variable
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
ACTION_VISUALIZE_GEO_FIELD = "ACTION_VISUALIZE_GEO_FIELD"
11+
```

‎docs/development/plugins/ui_actions/public/kibana-plugin-plugins-ui_actions-public.actionbytype.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-plugins-ui\_actions-public](./kibana-plugin-plugins-ui_actions-public.md) &gt; [ActionByType](./kibana-plugin-plugins-ui_actions-public.actionbytype.md)
4+
5+
## ActionByType type
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
export declare type ActionByType<T extends ActionType> = Action<ActionContextMapping[T], T>;
11+
```

‎docs/development/plugins/ui_actions/public/kibana-plugin-plugins-ui_actions-public.actioncontextmapping.__.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-plugins-ui\_actions-public](./kibana-plugin-plugins-ui_actions-public.md) &gt; [ActionContextMapping](./kibana-plugin-plugins-ui_actions-public.actioncontextmapping.md) &gt; [""](./kibana-plugin-plugins-ui_actions-public.actioncontextmapping.__.md)
4+
5+
## ActionContextMapping."" property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
[DEFAULT_ACTION]: BaseContext;
11+
```

‎docs/development/plugins/ui_actions/public/kibana-plugin-plugins-ui_actions-public.actioncontextmapping.action_visualize_field.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-plugins-ui\_actions-public](./kibana-plugin-plugins-ui_actions-public.md) &gt; [ActionContextMapping](./kibana-plugin-plugins-ui_actions-public.actioncontextmapping.md) &gt; [ACTION\_VISUALIZE\_FIELD](./kibana-plugin-plugins-ui_actions-public.actioncontextmapping.action_visualize_field.md)
4+
5+
## ActionContextMapping.ACTION\_VISUALIZE\_FIELD property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
[ACTION_VISUALIZE_FIELD]: VisualizeFieldContext;
11+
```

‎docs/development/plugins/ui_actions/public/kibana-plugin-plugins-ui_actions-public.actioncontextmapping.action_visualize_geo_field.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-plugins-ui\_actions-public](./kibana-plugin-plugins-ui_actions-public.md) &gt; [ActionContextMapping](./kibana-plugin-plugins-ui_actions-public.actioncontextmapping.md) &gt; [ACTION\_VISUALIZE\_GEO\_FIELD](./kibana-plugin-plugins-ui_actions-public.actioncontextmapping.action_visualize_geo_field.md)
4+
5+
## ActionContextMapping.ACTION\_VISUALIZE\_GEO\_FIELD property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
[ACTION_VISUALIZE_GEO_FIELD]: VisualizeFieldContext;
11+
```

‎docs/development/plugins/ui_actions/public/kibana-plugin-plugins-ui_actions-public.actioncontextmapping.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-plugins-ui\_actions-public](./kibana-plugin-plugins-ui_actions-public.md) &gt; [ActionContextMapping](./kibana-plugin-plugins-ui_actions-public.actioncontextmapping.md)
4+
5+
## ActionContextMapping interface
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
export interface ActionContextMapping
11+
```
12+
13+
## Properties
14+
15+
| Property | Type | Description |
16+
| --- | --- | --- |
17+
| [""](./kibana-plugin-plugins-ui_actions-public.actioncontextmapping.__.md) | <code>BaseContext</code> | |
18+
| [ACTION\_VISUALIZE\_FIELD](./kibana-plugin-plugins-ui_actions-public.actioncontextmapping.action_visualize_field.md) | <code>VisualizeFieldContext</code> | |
19+
| [ACTION\_VISUALIZE\_GEO\_FIELD](./kibana-plugin-plugins-ui_actions-public.actioncontextmapping.action_visualize_geo_field.md) | <code>VisualizeFieldContext</code> | |
20+

‎docs/development/plugins/ui_actions/public/kibana-plugin-plugins-ui_actions-public.actiondefinitionbytype.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-plugins-ui\_actions-public](./kibana-plugin-plugins-ui_actions-public.md) &gt; [ActionDefinitionByType](./kibana-plugin-plugins-ui_actions-public.actiondefinitionbytype.md)
4+
5+
## ActionDefinitionByType type
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
export declare type ActionDefinitionByType<T extends ActionType> = ActionDefinition<ActionContextMapping[T]>;
11+
```

‎docs/development/plugins/ui_actions/public/kibana-plugin-plugins-ui_actions-public.actionexecutioncontext.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-plugins-ui\_actions-public](./kibana-plugin-plugins-ui_actions-public.md) &gt; [ActionExecutionContext](./kibana-plugin-plugins-ui_actions-public.actionexecutioncontext.md)
4+
5+
## ActionExecutionContext type
6+
7+
Action methods are executed with Context from trigger + [ActionExecutionMeta](./kibana-plugin-plugins-ui_actions-public.actionexecutionmeta.md)
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
export declare type ActionExecutionContext<Context extends BaseContext = BaseContext> = Context & ActionExecutionMeta;
13+
```

0 commit comments

Comments
 (0)