[Autocomplete] Configurable results

[J-Ben87]

Q	A
Bug fix?	no
New feature?	yes
Issues
License	MIT

TomSelect accepts by default an array of results, each item containing a "text" and a "value".
Therefore this bundle exposes results formatted like so.

However one may need to expose additional data such as a "disabled" state to customize TomSelect's rendering.

This PR aims to offer this possibility by letting EntityAutocompleters drive the creation of the results array.

[J-Ben87]

I'm not sure why I am getting failures related to "direct deprecation notices" on [LiveComponent] (see https://github.com/symfony/ux/actions/runs/13069237861/job/36467092283?pr=2541 and https://github.com/symfony/ux/actions/runs/13069237861/job/36467096825?pr=2541) when I didn't update this component nor anything related to zenstruck/foundry 🤔

[daFish]

Hey @J-Ben87, this is awesome. This will be very useful in the context of #2534.

[smnandre]

Well... i'm now pretty sure.

We have

• a getLabel method (equivalent to choice_label in Form options
• a getValue method (equivalent to choice_value in Form options)

Instead of introducing a new method that englobes/replaces the previously existing one, i'd rather add a new method

/**
 * @return array<string, string|null>|null
 */
public function getAttributes(object $entity): ?array

In your scenario, you could return ['disabled' => true] when you'd want to.

Wdyt ?

[smnandre]

Thank you for the PR, this feature (and the effort to improve things passing by -- docblocks for static analysis)!

Minor changes to match existing DX / wording in symfony/form, and maybe add one or two tests to check everything work if the method is not implemented, or does not override getValue/getText

On an implementation level, you should probably do something like this in the formatResult method

$attributes = [];
if (method_exists(..... 
    ....     
}

return [
   ...$attributes, 
   'value' => $autocompleter->getValue(),
   'text' => $autocompleter->getText(),
];

[J-Ben87]

Thanks for your review.

I like your idea of merging extra attributes into an array containing the text and the value.

WDYT of the latest version of my branch?

[smnandre]

Tiny details, then lets see the CI failures and LGTM :)

Would you be ok (on another PR) to write a paragraph + example about this in the documentation ? I can help if you need / want.

[J-Ben87]

Ok everything should be fine now 👍🏻

Regarding the failing tests however, I have no clue why they are failing since they are related to zenstruck/foundry deprecations in another component...
It says:

Since zenstruck/foundry 2.4: In order to use Foundry, you must use the trait "Symfony\Bundle\FrameworkBundle\Test\KernelTestCase" in your "Symfony\UX\LiveComponent\Tests\Unit\Form\ComponentWithFormTest" tests. This will throw an exception in 3.0.

However there is no KernelTestCase trait available in the project. I assume the error message is inaccurate 🤔

---

Edit: I found the failing tests and I fixed them 🥳

[J-Ben87]

No worries for writing a bit of documentation, could you just point me the place and the kind of doc you expect?

[smnandre]

👍 for me!

Nice PR and thank you @J-Ben87