Skip to content

[Console] Document FinishedIndicator for Progress indicator #20300

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 7, 2024
Merged

[Console] Document FinishedIndicator for Progress indicator #20300

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions components/console/helpers/progressindicator.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,26 @@ The progress indicator will now look like this:
⠹ Processing...
⢸ Processing...

Custom Finished Indicator
~~~~~~~~~~~~~~~~~~~~~~~~~

Once the progress indicator is finished, it keeps by default the latest indicator value. You can replace it with a your own::

$progressIndicator->finish('Finished', '✅');

Then the progress indicator will render like this:

.. code-block:: text

⠏ Processing...
⠛ Processing...
✅ Finished

.. versionadded:: 7.2

The ``finishedIndicator`` parameter for method ``finish()`` was introduced in Symfony 7.2.


Customize Placeholders
~~~~~~~~~~~~~~~~~~~~~~

Expand Down
Loading