Skip to content

Commit e4d5028

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

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

components/console/helpers/progressindicator.rst

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,28 @@ 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+
The progress indicator will now look like this:
108+
109+
.. code-block:: text
110+
111+
⠏ Processing...
112+
⠛ Processing...
113+
✅ Finished
114+
115+
.. versionadded:: 7.2
116+
117+
The ``finishedIndicator`` parameter for method ``finish()`` were introduced in Symfony 7.2.
118+
119+
98120
Customize Placeholders
99121
~~~~~~~~~~~~~~~~~~~~~~
100122

0 commit comments

Comments
 (0)