Custom review page API reference
The custom review page API provides the ReviewComponentProps interface, helper utilities for data processing, and UI components to implement custom review pages for Red Hat Developer Hub Orchestrator workflows.
ReviewComponentProps interface Copy linkLink copied!
Your custom review component receives the following properties through the ReviewComponentProps interface:
| Property | Type | Description |
|---|---|---|
|
|
|
Indicates whether a workflow run is in progress. Disable action buttons when this value is |
|
|
|
Defines field structure, titles, and UI hints such as hidden fields for the workflow form. |
|
|
|
Contains the user-submitted form values structured according to the schema and awaiting review before the workflow runs. |
|
|
|
Returns to the previous step (same behavior as the default review page). This callback matches the default review page behavior. |
|
|
|
Runs the workflow with the reviewed data. Call this function when the user clicks Run to start the workflow. |
Helper utilities Copy linkLink copied!
The orchestrator-form-react package exports the following utilities to help you build custom review pages that handle data correctly:
| Function | Signature | Description |
|---|---|---|
|
|
|
Processes form data for display. Respects |
|
|
|
Returns |
Helper components Copy linkLink copied!
The orchestrator-form-react package exports the following React components for use in custom review pages:
| Component | Props | Description |
|---|---|---|
|
|
|
Renders form data in a nested table structure. Accepts data processed by |
|
|
|
Displays an alert with a toggle switch for showing or hiding fields marked as |
OrchestratorFormApi method Copy linkLink copied!
To provide a custom review page, implement the following method in your OrchestratorFormApi implementation:
| Method | Return Type | Description |
|---|---|---|
|
|
|
Returns your custom review page component, or |