feature #1338 [Autocomplete] Support the render.loading_more Tom Select option (vgaret)

This PR was squashed before being merged into the 2.x branch.

Discussion
----------

[Autocomplete] Support the `render.loading_more` Tom Select option

| Q            | A         |
| ------------ | --------- |
| Bug fix?     | no        |
| New feature? | yes       |
| Issues       | Fix #1159 |
| License      | MIT       |

Here is my proposal for the support of the `render.loading_more` option from the Virtual Scroll plugin of Tom Select ([docs](https://tom-select.js.org/plugins/virtual_scroll/)). I also suggested a French translation, as it is my main language.

NB: I have slightly modified the default value ("Loading more results ... "  ➡️ "Loading more results...").

Commits
-------

c1ce573 [Autocomplete] Support the `render.loading_more` Tom Select option

Author: weaverryan

src/Autocomplete/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## Unreleased
+
+-   Add support for the `render.loading_more` Tom Select Virtual Scroll option (`loading_more_text`)
+
 ## 2.13.2
 
 -   Revert "Change JavaScript package to `type: module`"

src/Autocomplete/assets/dist/controller.d.ts

@@ -12,6 +12,7 @@ export default class extends Controller {
     static values: {
         url: StringConstructor;
         optionsAsHtml: BooleanConstructor;
+        loadingMoreText: StringConstructor;
         noResultsFoundText: StringConstructor;
         noMoreResultsText: StringConstructor;
         minCharacters: NumberConstructor;
@@ -20,6 +21,7 @@ export default class extends Controller {
     };
     readonly urlValue: string;
     readonly optionsAsHtmlValue: boolean;
+    readonly loadingMoreTextValue: string;
     readonly noMoreResultsTextValue: string;
     readonly noResultsFoundTextValue: string;
     readonly minCharactersValue: number;

src/Autocomplete/assets/dist/controller.js

@@ -317,6 +317,9 @@ _default_1_instances = new WeakSet(), _default_1_getCommonConfig = function _def
             item: function (item) {
                 return `<div>${item.text}</div>`;
             },
+            loading_more: () => {
+                return `<div class="loading-more-results">${this.loadingMoreTextValue}</div>`;
+            },
             no_more_results: () => {
                 return `<div class="no-more-results">${this.noMoreResultsTextValue}</div>`;
             },
@@ -342,6 +345,7 @@ _default_1_instances = new WeakSet(), _default_1_getCommonConfig = function _def
 default_1.values = {
     url: String,
     optionsAsHtml: Boolean,
+    loadingMoreText: String,
     noResultsFoundText: String,
     noMoreResultsText: String,
     minCharacters: Number,

src/Autocomplete/assets/src/controller.ts

@@ -15,6 +15,7 @@ export default class extends Controller {
     static values = {
         url: String,
         optionsAsHtml: Boolean,
+        loadingMoreText: String,
         noResultsFoundText: String,
         noMoreResultsText: String,
         minCharacters: Number,
@@ -24,6 +25,7 @@ export default class extends Controller {
 
     declare readonly urlValue: string;
     declare readonly optionsAsHtmlValue: boolean;
+    declare readonly loadingMoreTextValue: string;
     declare readonly noMoreResultsTextValue: string;
     declare readonly noResultsFoundTextValue: string;
     declare readonly minCharactersValue: number;
@@ -224,6 +226,9 @@ export default class extends Controller {
                 item: function (item: any) {
                     return `<div>${item.text}</div>`;
                 },
+                loading_more: (): string => {
+                    return `<div class="loading-more-results">${this.loadingMoreTextValue}</div>`;
+                },
                 no_more_results: (): string => {
                     return `<div class="no-more-results">${this.noMoreResultsTextValue}</div>`;
                 },

src/Autocomplete/doc/index.rst

@@ -213,6 +213,10 @@ e.g. ``FoodAutocompleteField`` from above):
     an autocomplete-Ajax endpoint (e.g. for a custom ``ChoiceType``), then set this
     to change the field into an AJAX-powered select.
 
+``loading_more_text`` (default: 'Loading more results...')
+    Rendered at the bottom of the list while fetching more results. This message is
+    automatically translated using the ``AutocompleteBundle`` domain.
+
 ``no_results_found_text`` (default: 'No results found')
     Rendered when no matching results are found. This message is automatically translated
     using the ``AutocompleteBundle`` domain.

src/Autocomplete/src/Form/AutocompleteChoiceTypeExtension.php

@@ -79,6 +79,7 @@ public function finishView(FormView $view, FormInterface $form, array $options):
             $values['min-characters'] = $options['min_characters'];
         }
 
+        $values['loading-more-text'] = $this->trans($options['loading_more_text']);
         $values['no-results-found-text'] = $this->trans($options['no_results_found_text']);
         $values['no-more-results-text'] = $this->trans($options['no_more_results_text']);
         $values['preload'] = $options['preload'];
@@ -99,6 +100,7 @@ public function configureOptions(OptionsResolver $resolver): void
             'tom_select_options' => [],
             'options_as_html' => false,
             'allow_options_create' => false,
+            'loading_more_text' => 'Loading more results...',
             'no_results_found_text' => 'No results found',
             'no_more_results_text' => 'No more results',
             'min_characters' => null,

src/Autocomplete/translations/AutocompleteBundle.ar.php

@@ -10,6 +10,7 @@
  */
 
 return [
+    // 'Loading more results...' => 'Loading more results...',
     'No results found' => 'لم يتم العثور على أي نتائج',
     'No more results' => 'لا توجد نتائج أٌخرى',
 ];

src/Autocomplete/translations/AutocompleteBundle.bg.php

@@ -10,6 +10,7 @@
  */
 
 return [
+    // 'Loading more results...' => 'Loading more results...',
     'No results found' => 'Няма намерени съвпадения',
     'No more results' => 'Няма повече резултати',
 ];

src/Autocomplete/translations/AutocompleteBundle.ca.php

@@ -10,6 +10,7 @@
  */
 
 return [
+    // 'Loading more results...' => 'Loading more results...',
     'No results found' => 'No s\'han trobat resultats',
     'No more results' => 'No hi ha més resultats',
 ];

src/Autocomplete/translations/AutocompleteBundle.cs.php

@@ -10,6 +10,7 @@
  */
 
 return [
+    // 'Loading more results...' => 'Loading more results...',
     'No results found' => 'Nenalezeny žádné položky',
     // 'No more results' => 'No more results',
 ];