Zum Hauptinhalt springen

RequestCoverProps

RequestCoverProps = object

Properties​

id?​

optional id: string

The id of the gadget.

title​

title: string

The title of the gadget that will be displayed in the header.

createdAt​

createdAt: string

The date to be displayed in the header.

globalState​

globalState: string

The global state the file is currently in.

headers​

headers: object

The titles for the main sections.

comment​

comment: string

requestInformations​

requestInformations: string

vendor​

vendor: string

verifications​

verifications: string

comments​

comments: object

The data for the comments section.

visible​

visible: boolean

entries​

entries: object

entries.comment​

comment: TextItem

entries.reasonReject​

reasonReject: TextItem

requestInformations​

requestInformations: Record<string, TextItem>

The data for the request information section.

processing​

processing: Record<string, TextItem>

The data for the processing information section.

vendor​

vendor: object

The data for the headers of the processing information section.

id​

id: TextItem

name​

name: TextItem

countryCode​

countryCode: TextItem

zipCode​

zipCode: TextItem

city​

city: TextItem

street​

street: TextItem

verifications​

verifications: MultiTableGadgetOptions

The options object for the MultiTable that displays the verification information.

steps​

steps: Step[]

The data for the progress gadget.

customStyles?​

optional customStyles: object

Custom styles for the primary color and progress gadget.

gadgetPrimaryColor?​

optional gadgetPrimaryColor: string

The primary color of the gadget. This will be used to overwrite the default color. The default is set in ou.spc.ptpREQ.clientHeaderCode.css.gadgets:

   const chroma = require("chromaColorTool");
   const signalColor = chroma("signalcolor");

   const primaryColor = signalColor;

   const gadgetsCss = `
   .ptpRequest-gadget-wrapper {
       --gadget-primary-color: ${primaryColor};
   }
   `;

progress?​

optional progress: ProgressProps["customStyles"]

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>

getCurrentStepIcon()?​

optional getCurrentStepIcon: (steps) => 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​

steps​

Step[]

Returns​

string

getCurrentStepIconStyles()?​

optional getCurrentStepIconStyles: (steps) => CSSProperties

A function to overwrite the default styles of the icon that is shown next to the title. If not defined there will be no styles applied.

Parameters​

steps​

Step[]

Returns​

CSSProperties

sectionOverwrites?​

optional sectionOverwrites: SectionOverwrites

An object to define overwrites for different sections of the gadget.

sectionTemplates?​

optional sectionTemplates: SectionTemplates

An object to define custom templates that will be shown after the specified section respectively.

customCss?​

optional customCss: string

A string of custom CSS that will be applied to the gadget.