ActionDisplayDefinition

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

Action-specific Display attributes.

Hierarchy

• DisplayDefinition

  ↳ ActionDisplayDefinition

Index

Properties

• description
• directions
• important
• label

Properties

description

• description: string

Inherited from DisplayDefinition.description

Defined in packages/spectral/src/types/DisplayDefinition.ts:10

Description to display to the user.

---

Optional directions

• directions? : undefined | string

Defined in packages/spectral/src/types/DisplayDefinition.ts:36

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

---

Optional important

• important? : undefined | false | true

Defined in packages/spectral/src/types/DisplayDefinition.ts:38

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 packages/spectral/src/types/DisplayDefinition.ts:8

Label/name to display.