-
-
Notifications
You must be signed in to change notification settings - Fork 5.2k
[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
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.