ActionInputModel

ActionInputModel = object

Defined in: packages/schema/src/model.ts:972

One input of a named action’s dialog (inputs: (i) => [...]); see Named actions.

Properties

component?

optional component?: string

Defined in: packages/schema/src/model.ts:1001

The project component (defineUi({ components })) a custom input is, which gets ActionInputProps.

---

default?

optional default?: JsonValue

Defined in: packages/schema/src/model.ts:986

What it holds when the dialog opens.

---

help?

optional help?: string

Defined in: packages/schema/src/model.ts:980

A line under it.

---

kind

kind: ActionInputKind

Defined in: packages/schema/src/model.ts:976

What it asks for.

---

label

label: string

Defined in: packages/schema/src/model.ts:978

Its label.

---

max?

optional max?: number

Defined in: packages/schema/src/model.ts:990

The most characters a text may have.

---

multiline?

optional multiline?: boolean

Defined in: packages/schema/src/model.ts:988

A text that runs over several lines, in a box that grows with it.

---

name

name: string

Defined in: packages/schema/src/model.ts:974

The input’s name: the key of its answer in the handler’s values, and how when names it.

---

options?

optional options?: object[]

Defined in: packages/schema/src/model.ts:992

A choice’s values, each with its label, in order.

label

label: string

What it reads as.

value

value: string

The value the handler gets.

---

props?

optional props?: Record<string, JsonValue>

Defined in: packages/schema/src/model.ts:1003

The plain data a custom input’s component gets as props.

---

required

required: boolean

Defined in: packages/schema/src/model.ts:982

Whether it must be answered before the action runs; a boolean never must.

---

resource?

optional resource?: string

Defined in: packages/schema/src/model.ts:999

The resource a choice picks a record of; the handler gets its key.

---

when?

optional when?: string

Defined in: packages/schema/src/model.ts:984

An AIP-160 condition over the inputs before it, such as plan = 'pro'; it shows, and is answered, only while it holds.