@backstage/plugin-scaffolder-react

Home > @backstage/plugin-scaffolder-react

Functions

Function	Description
createScaffolderFieldExtension(options)	Method for creating field extensions that can be used in the scaffolder frontend form.
createScaffolderLayout(options)	Method for creating custom Layouts that can be used in the scaffolder frontend form
makeFieldSchema(options)
SecretsContextProvider(props)	The Context Provider that holds the state for the secrets.
useCustomFieldExtensions(outlet)	Hook that returns all custom field extensions from the current outlet.
useCustomLayouts(outlet)	Hook that returns all custom field extensions from the current outlet.
useTaskEventStream(taskId)	A hook to stream the logs of a task being processed
useTemplateSecrets()	Hook to access the secrets context to be able to set secrets that are passed to the Scaffolder backend.

Interfaces

Interface	Description
FieldExtensionComponentProps	Type for Field Extension Props for RJSF v5
FieldExtensionUiSchema	Type for Field Extension UiSchema
FieldSchema	FieldSchema encapsulates a JSONSchema7 along with the matching FieldExtensionComponentProps type for a field extension.
LayoutOptions	The type of layouts that is passed to the TemplateForms
ScaffolderApi	An API to interact with the scaffolder backend.
ScaffolderDryRunOptions
ScaffolderDryRunResponse
ScaffolderGetIntegrationsListOptions	The arguments for getIntegrationsList.
ScaffolderGetIntegrationsListResponse	The response shape for getIntegrationsList.
ScaffolderRJSFFieldProps	The props for the Field components
ScaffolderRJSFFormProps	The properties that are passed to the Form
ScaffolderScaffoldOptions	The input options to the scaffold method of the ScaffolderClient.
ScaffolderScaffoldResponse	The response shape of the scaffold method of the ScaffolderClient.
ScaffolderStreamLogsOptions	The input options to the streamLogs method of the ScaffolderClient.
ScaffolderUseTemplateSecrets	The return type from the useTemplateSecrets hook.

Variables

Variable	Description
scaffolderApiRef
ScaffolderFieldExtensions	The Wrapping component for defining fields extensions inside
ScaffolderLayouts	The wrapping component for defining scaffolder layouts as children

Type Aliases

Type Alias	Description
Action	The response shape for a single action in the listActions call to the scaffolder-backend
ActionExample	A single action example
CustomFieldExtensionSchema	Type for the Custom Field Extension schema.
CustomFieldValidator	Field validation type for Custom Field Extensions.
FieldExtensionComponent	The type used to wrap up the Layout and embed the input props
FieldExtensionOptions	Type for the Custom Field Extension with the name and components and validation function.
FormProps	Any @rjsf/core form properties that are publicly exposed to the ScaffolderPage
LayoutComponent	A type used to wrap up the FieldExtension to embed the ReturnValue and the InputProps
LayoutTemplate	The field template from @rjsf/core which is a react component that gets passed @rjsf/core field related props.
ListActionsResponse	The response shape for the listActions call to the scaffolder-backend
LogEvent	The shape of a LogEvent message from the scaffolder-backend
ReviewStepProps	The props for the Last Step in scaffolder template form. Which represents the summary of the input provided by the end user.
ScaffolderOutputLink
ScaffolderOutputText
ScaffolderRJSFField	The Field type for Field Extensions
ScaffolderRJSFRegistryFieldsType	The set of Fields stored in the Registry
ScaffolderStep	The status of the step being processed
ScaffolderTask	The shape of each task returned from the scaffolder-backend
ScaffolderTaskOutput
ScaffolderTaskStatus	The status of each task in a Scaffolder Job
TaskStream	A task event from the event stream
TemplateGroupFilter
TemplateParameterSchema	The shape of each entry of parameters which gets rendered as a separate step in the wizard input