Custom Scaffolder Field Extensions

Published on February 28th, 2024

You can extend and customize the available Scaffolder functionality by using Roadie Custom Plugins. You can use the same workflow and development experience to build your own Custom Scaffolder Field Extensions as any other plugin, using the Roadie CLI. To see more information on how to develop custom plugins navigate to the Custom Plugins Documentation.

To see more information on how to develop custom plugins. It is recommended to navigate to the Custom Plugins Documentation.

Constructing React components for your Field Extension

To construct the correct type of React components that are compatible to be registered as Scaffolder Field Extensions, the recommended approach is to follow the tutorial on the Open Source Backstage documentation page.

Registering your Field Extension

Scaffolder Field Extensions are automatically registered to be usable within Scaffolder Templates, once they have been registered as a Custom Plugin component to the Roadie application. You can do this by navigating to the Administration -> Custom Plugins page and registering your Custom Plugin bundle, including a component of type ScaffolderFieldExtension.

Custom plugin registration form

Additional Resources