Skip to main content

ComponentDisplayDefinition

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

Component extensions for display properties.

Hierarchy#

Index#

Properties#

Properties#

Optional category#

category? : undefined | string

Defined in types/DisplayDefinition.ts:18

Category of the Component.


description#

description: string

Inherited from DisplayDefinition.description

Defined in types/DisplayDefinition.ts:10

Description to display to the user.


Optional iconPath#

iconPath? : undefined | string

Defined in types/DisplayDefinition.ts:16

Path to icon to use for this Component. Path should be relative to component roto index.


label#

label: string

Inherited from DisplayDefinition.label

Defined in types/DisplayDefinition.ts:8

Label/name to display.