Skip to content

ModelActionRawState

Overview

Target state.

Properties

actionErrorSummary

Error toast summary.

Type: ComputedRef

Source: client/lib/use/useModelAction.js:56

actionSuccessSummary

Success toast summary.

Type: ComputedRef

Source: client/lib/use/useModelAction.js:55

actionVerboseNameLowerCase

Human-readable action label.

Type: ComputedRef

Source: client/lib/use/useModelAction.js:54

bannerDescription

Banner description.

Type: ComputedRef

Source: client/lib/use/useModelAction.js:59

bannerIconName

Icon name for the current tone.

Type: ComputedRef

Source: client/lib/use/useModelAction.js:60

bannerTitle

Banner title.

Type: ComputedRef

Source: client/lib/use/useModelAction.js:58

bulk

Whether more than one primary key is targeted.

Type: ComputedRef

Source: client/lib/use/useModelAction.js:48

confirmMessage

Confirmation prompt copy.

Type: ComputedRef

Source: client/lib/use/useModelAction.js:57

dryRunTarget

Identity of the current target (joined pks), for a consumer to key its own "already dry-ran this one" bookkeeping off of.

Type: ComputedRef

Source: client/lib/use/useModelAction.js:64

modelVerboseName

Singular or plural model name.

Type: ComputedRef

Source: client/lib/use/useModelAction.js:53

objectsMap

Selected objects by string primary key.

Copy state.

Type: ComputedRef

Source: client/lib/use/useModelAction.js:50

pkCount

Number of primary keys targeted.

Type: ComputedRef

Source: client/lib/use/useModelAction.js:49

pks

Primary keys targeted by the action.

Type: ComputedRef

Source: client/lib/use/useModelAction.js:46

pksAsString

String primary keys for rendering.

Type: ComputedRef

Source: client/lib/use/useModelAction.js:47

readyToDryRun

Whether the action can run a dry-run request right now (a target is present, dry-run is enabled, and the action instance is idle). Carries no per-target memory of its own; pair it with dryRunTarget so the dry-run trigger latches per target instead of re-firing on every idle tick.

Type: ComputedRef

Source: client/lib/use/useModelAction.js:61

Source

client/lib/use/useModelAction.js:43

Documents matching: server v3.0.0a1.post1client v3.0.0-alpha.2