1. Select2

3.x version

Maintained

edit this page

1. Select2

1. Select2¶

The admin comes with select2 integration since version 2.2.6. Select2 is a jQuery based replacement for select boxes. It supports searching, remote data sets, and infinite scrolling of results.

The select2 is enabled on all select form elements by default.

1.1. Disable select2¶

If you don’t want to use select2 in your admin, you can disable it in configuration.

YAML

# config/packages/sonata_admin.yaml

sonata_admin:
    options:
        use_select2:    false # disable select2

Note

If you disable select2, autocomplete form types will stop working.

1.2. Disable select2 on some form elements¶

To disable select2 on some select form element, set data attribute data-sonata-select2 = "false" to this form element:

use Sonata\AdminBundle\Form\Type\ModelType;

protected function configureFormFields(FormMapper $formMapper)
{
    $formMapper
        ->add('category', ModelType::class, [
            'attr' => [
                'data-sonata-select2' => 'false'
            ]
        ])
    ;
}

Note

You have to use false as string! "false"!

1.3. AllowClear¶

Select2 parameter allowClear is handled automatically by admin. But if you want to overload the default functionality, you can set data attribute data-sonata-select2-allow-clear="true" to enable allowClear or data-sonata-select2-allow-clear = "false" to disable the allowClear parameter:

use Sonata\AdminBundle\Form\Type\ModelType;

protected function configureFormFields(FormMapper $formMapper)
{
    $formMapper
        ->add('category', ModelType::class, [
            'attr' => [
                'data-sonata-select2-allow-clear' => 'false'
            ]
        ])
    ;
}

Note

You have to use false as string! "false"!

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.