Skip to content

[Form] Documenting choice_lazy option #20319

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.

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 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions reference/forms/types/choice.rst
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,8 @@ correct types will be assigned to the model.

.. include:: /reference/forms/types/options/choice_loader.rst.inc

.. include:: /reference/forms/types/options/choice_lazy.rst.inc

.. include:: /reference/forms/types/options/choice_name.rst.inc

.. include:: /reference/forms/types/options/choice_translation_domain_enabled.rst.inc
Expand Down
31 changes: 31 additions & 0 deletions reference/forms/types/options/choice_lazy.rst.inc
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
``choice_lazy``
~~~~~~~~~~~~~~~

**type**: ``boolean`` **default**: ``false``

The ``choice_lazy`` option is especially useful when dealing with a large set of
choices, where loading all of them at once could lead to performance issues or
significant delays::

use App\Entity\User;
use Symfony\Bridge\Doctrine\Form\Type\EntityType;

$builder->add('user', EntityType::class, [
'class' => User::class,
'choice_lazy' => true,
]);

When set to ``true``, and used in combination with the ``choice_loader`` option,
the form will only load and render the choices that are preset as default values
or submitted. This allows you to defer loading the full list of choices and can
improve the performance of your form.

.. caution::

Please note that when using ``choice_lazy``, you are responsible for providing
the user interface to select choices, typically through a JavaScript plugin that
can handle the dynamic loading of choices.

.. versionadded:: 7.2

The ``choice_lazy`` option was introduced in Symfony 7.2.
Loading