Joomla! Programmers Documentation

The components form field type provides a list box containing enabled extensions of type component.

• type (mandatory) must be components.
• name (mandatory) is the unique name of the field.
• label (mandatory) (translatable) is the field html label.
• description (optional) (translatable) is the field description.
• multiple (optional) if set to true allows multiple items to be selected at the same time. Set to false to allow single selection.
• required (optional) if set to true, the first field option should be empty, see last example.

Implemented by: libraries/src/Form/Field/ComponentsField.php

Example XML parameter definition¶

<field
        name="componentslist" 
        type="components"
        label="Select a component" 
        description=""
/>