Question

How do you create comments for fields in a ui_component form?

I can do it like this when building the form with php:

$fieldset->addField(
            'url',
            'text',
            [
                'name' => 'url',
                'label' => __('URL'),
                'title' => __('URL'),
                'required' => false,
                'note' => 'Can be an absolute or relative path.'
            ]
        );

I can't find how to achieve this in an xml form component.

Was it helpful?

Solution

You should use notice:

<item name="notice" xsi:type="string" translate="true">

Full example:

<field name="name">
            <argument name="data" xsi:type="array">
                <item name="config" xsi:type="array">
                    <item name="dataType" xsi:type="string">text</item>
                    <item name="label" xsi:type="string" translate="true">Name</item>
                    <item name="formElement" xsi:type="string">input</item>
                    <item name="source" xsi:type="string">model</item>
                    <item name="sortOrder" xsi:type="number">10</item>
                    <item name="dataScope" xsi:type="string">name</item>
                    <item name="notice" xsi:type="string" translate="true">Enter full store name here</item>
                    <item name="validation" xsi:type="array">
                        <item name="required-entry" xsi:type="boolean">true</item>
                    </item>
                </item>
            </argument>
        </field>
Licensed under: CC-BY-SA with attribution
Not affiliated with magento.stackexchange
scroll top