From 81a3fb59f7c45fdeba6f9de052791b936fa89289 Mon Sep 17 00:00:00 2001 From: Dano Morrison Date: Tue, 31 Mar 2020 19:57:26 -0400 Subject: [PATCH] Added progress bar documentation --- docs/reference/flow.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/reference/flow.rst b/docs/reference/flow.rst index 7a2db40f5..be6d2421b 100644 --- a/docs/reference/flow.rst +++ b/docs/reference/flow.rst @@ -55,6 +55,13 @@ Sequence The options specified as ``handMeDowns`` are transferred to nested components during the prepare phase. This option is largely for convenience, and designed to decrease the amount of repetition when all nested components behave similarly -- typically, nested components share the same data storage and output element, so these are passed on by default. Similarly, the :js:attr:`debug ` mode is easiest to set on the topmost component, and will automatically propagate to include all other components. + .. js:attribute:: options.showProgress + + If ``true``, shows a progress bar at the top of the page that visualizes progress through this Sequence. + + .. js:attribute:: options.progressBarMessage + + The text that will be displayed next to the progress bar (if shown). Defaults to 'Completion Progress'. ---- .. _reference/flow/loop: