ActionDisplayDefinition
@prismatic-io/spectral › "types/DisplayDefinition" › ActionDisplayDefinition
Action-specific Display attributes.
#
Hierarchy↳ ActionDisplayDefinition
#
Index#
Properties#
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:28
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:30
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.