Skip to content

[Autocomplete] Document how to disable default TomSelect plugins #3087

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

Open
wants to merge 4 commits into
base: 2.x
Choose a base branch
from
+19 −0
Open

[Autocomplete] Document how to disable default TomSelect plugins #3087

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4053ec7
docs: document possibility to disable tomselect default plugins
raphael-geffroy Sep 18, 2025
0b5eb1a
fix doc
raphael-geffroy Sep 18, 2025
f240684
fix doc
raphael-geffroy Sep 18, 2025
bb1248e
tomselect-plugins-dedicated-section
raphael-geffroy Nov 29, 2025
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
19 changes: 19 additions & 0 deletions src/Autocomplete/doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,6 +206,7 @@
``tom_select_options`` (default: ``[]``)
Use this to set custom `Tom Select Options`_. If you need to set
an option using JavaScript, see `Extending Tom Select`_.
See :ref:`_disabling-tom-select-plugins` for managing TomSelect plugins.

``options_as_html`` (default: ``false``)
Set to ``true`` if your options (e.g. ``choice_label``) contain HTML. Not
Expand Down Expand Up @@ -415,6 +416,24 @@
You *can* add autocompletion to this via the ``autocomplete_url`` option - but you'll
likely need to create your own :ref:`custom autocomplete endpoint <custom-autocomplete-endpoint>`.

.. _disabling-tom-select-plugins:

Check failure on line 419 in src/Autocomplete/doc/index.rst

View workflow job for this annotation

GitHub Actions / DOCtor-RST 

Please add a blank line after the anchor ".. _disabling-tom-select-plugins:"
Disabling TomSelect plugins

Check failure on line 420 in src/Autocomplete/doc/index.rst

View workflow job for this annotation

GitHub Actions / DOCtor-RST 

Please ensure title "Disabling TomSelect plugins" and underline length are matching
--------------------------

You can disable default plugins using ``tom_select_options.plugins``::

$resolver->setDefaults([
'class' => Ingredient::class,
'tom_select_options' => [
'plugins' => [
'clear_button' => false, // Disable the clear button
'remove_button' => false, // Disable the remove button
],
],
]);

See TomSelect plugins documentation : https://tom-select.js.org/plugins

Customizing the AJAX URL/Route
------------------------------

Expand Down