Zum Hauptinhalt springen

SummaryGadgetOptions

SummaryGadgetOptions = object

Properties​

id​

id: string

The id of the gadget.

groupBy?​

optional groupBy: keyof SummaryGadgetFile

Which field of the file to group the files by.

largeIcons?​

optional largeIcons: boolean

Whether to show large icons in the progress gadget.

Default​

false

files​

files: SummaryGadgetFile[]

The files to display in the summary gadget.

getCurrentStepIcon()?​

optional getCurrentStepIcon: (file) => string

A function to overwrite the default icon that is shown next to the title at the top of the gadget. If not defined the icon of the current step will be used.

Parameters​

file​

SummaryGadgetFile

Returns​

string

getCssClassForStep()?​

optional getCssClassForStep: (step) => Record<string, boolean | undefined>

A function to define custom css classes for each step of the progress gadget. If not defined the following classes will be used:

{
   "progress-step-completed": step.completed,
   "progress-step-active": step.isCurrentStep,
   "progress-step-success": step.success === true,
   "progress-step-failed": step.success === false,
   "progress-step-skipped": step.skipped,
}

Parameters​

step​

Step

Returns​

Record<string, boolean | undefined>

customStyles?​

optional customStyles: object

Custom styles for the primary color and progress gadget.

gadgetPrimaryColor?​

optional gadgetPrimaryColor: string

progress?​

optional progress: ProgressProps["customStyles"]