Skip to main content

ActionDisplayDefinition

@prismatic-io/spectral"types/DisplayDefinition"ActionDisplayDefinition

Action-specific Display attributes.

Hierarchy#

Index#

Properties#

Properties#

description#

description: string

Inherited from DisplayDefinition.description

Defined in types/DisplayDefinition.ts:10

Description to display to the user.


Optional directions#

directions? : undefined | string

Defined in types/DisplayDefinition.ts:24

Directions to help guide the user if additional configuration is required for this Action.


Optional important#

important? : undefined | false | true

Defined in types/DisplayDefinition.ts:26

Indicate that this Action is important and/or commonly used from the parent Component. Should be enabled sparingly.


label#

label: string

Inherited from DisplayDefinition.label

Defined in types/DisplayDefinition.ts:8

Label/name to display.