Skip to main content

RouterProps

Home > @backstage/plugin-scaffolder > RouterProps

The Props for the Scaffolder Router

Signature:

export type RouterProps = {
components?: {
ReviewStepComponent?: React.ComponentType<ReviewStepProps>;
TemplateCardComponent?: React.ComponentType<{
template: TemplateEntityV1beta3;
}>;
TaskPageComponent?: React.ComponentType<PropsWithChildren<{}>>;
EXPERIMENTAL_TemplateOutputsComponent?: React.ComponentType<{
output?: ScaffolderTaskOutput;
}>;
EXPERIMENTAL_TemplateListPageComponent?: React.ComponentType<TemplateListPageProps>;
EXPERIMENTAL_TemplateWizardPageComponent?: React.ComponentType<TemplateWizardPageProps>;
};
groups?: TemplateGroupFilter[];
templateFilter?: (entity: TemplateEntityV1beta3) => boolean;
headerOptions?: {
pageTitleOverride?: string;
title?: string;
subtitle?: string;
};
defaultPreviewTemplate?: string;
formProps?: FormProps;
contextMenu?: {
editor?: boolean;
actions?: boolean;
tasks?: boolean;
};
};

References: ReviewStepProps, TemplateEntityV1beta3, ScaffolderTaskOutput, TemplateGroupFilter, FormProps