carouselBarBuilder property

RPCarouselBarBuilder? carouselBarBuilder
final

Builds a replacement for the default carousel bar at the top of the task.

When null the default bar is shown — logo, "x of y" progress and a close button — configured through carouselBarImage, carouselBarHorizontalPadding, carouselBarVerticalPadding and carouselBarBackgroundColor. Those four are ignored when a builder is supplied, since the builder owns the whole bar.

Return const SizedBox.shrink() to remove the bar entirely.

Note that the default bar holds the only built-in way to cancel a task, so a replacement should provide its own affordance — either blocTask.sendStatus(RPStepStatus.Canceled) to cancel directly, or RPUITaskState.showCancelConfirmationDialog to confirm first.

Implementation

final RPCarouselBarBuilder? carouselBarBuilder;