Skip to content

Commit 861a096

Browse files
committed
[Console] Document FinishedIndicator for Progress indicator
1 parent 795148e commit 861a096

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

components/console/helpers/progressindicator.rst

+20
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,26 @@ The progress indicator will now look like this:
9595
⠹ Processing...
9696
⢸ Processing...
9797
98+
Custom Finished Indicator
99+
~~~~~~~~~~~~~~~~~~~~~~~~~
100+
101+
Once the progress indicator is finished, it keeps by default the latest indicator value. You can replace it with a your own::
102+
103+
$progressIndicator->finish('Finished', '✅');
104+
105+
Then the progress indicator will render like this:
106+
107+
.. code-block:: text
108+
109+
⠏ Processing...
110+
⠛ Processing...
111+
✅ Finished
112+
113+
.. versionadded:: 7.2
114+
115+
The ``finishedIndicator`` parameter for method ``finish()`` was introduced in Symfony 7.2.
116+
117+
98118
Customize Placeholders
99119
~~~~~~~~~~~~~~~~~~~~~~
100120

0 commit comments

Comments
 (0)