Skip to main content

Interface: ActionInput

Input requested by the host before invoking a user action.

Properties​

key​

key: string

Stable key present in the params object passed to onAction.

type​

type: "number" | "boolean" | "text" | "password" | "select"

Editor used by the host action dialog.

label​

label: string

Human-readable input label.

default?​

optional default?: string | number | boolean

Initial value shown when the action dialog opens.

options?​

optional options?: object[]

Allowed choices when type is select.

label​

label: string

value​

value: string | number