Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add comment/note declaration in admin form xml #36609

Open
nbennett25 opened this issue Dec 14, 2022 · 1 comment
Open

Add comment/note declaration in admin form xml #36609

nbennett25 opened this issue Dec 14, 2022 · 1 comment

Comments

@nbennett25
Copy link

Description

Can we get a note/comment node for the ui_form elements? I see a tooltip available, but it would be nice to have the ability to add a note/comment to a form element via the xml configuration; something like:

<fieldset name="field_name" sortOrder="25">
        <settings>
            <collapsible>true</collapsible>
            <label translate="true">My Custom Field Name</label>
            <dataScope>general</dataScope>
        </settings>
        <field name="my.field_name" formElement="input">
            <argument name="data" xsi:type="array">
                <item name="config" xsi:type="array">
                    <item name="source" xsi:type="string">my.field_name</item>
                    <item name="validation" xsi:type="array">
                        <item name="custom-validation" xsi:type="boolean">true</item>
                    </item>
                    <item name="note" xsi:type="string" translate="true"><![CDATA[Comment that appears under the form field]]></item>
                </item>
            </argument>
            <settings>
                <dataType>number</dataType>
                <label translate="true">Field Name</label>
            </settings>
        </field>
...

Expected behavior

Comment appears in the admin form with helpful information below the defined form input field

Benefits

Makes custom form more informative

Additional information

No response

Release note

No response

@m2-assistant
Copy link

m2-assistant bot commented Dec 14, 2022

Hi @nbennett25. Thank you for your report.
To speed up processing of this issue, make sure that you provided the following information:

  • Summary of the issue
  • Information on your environment
  • Steps to reproduce
  • Expected and actual results

Make sure that the issue is reproducible on the vanilla Magento instance following Steps to reproduce. To deploy vanilla Magento instance on our environment, Add a comment to the issue:

@magento give me 2.4-develop instance - upcoming 2.4.x release

For more details, review the Magento Contributor Assistant documentation.

Add a comment to assign the issue: @magento I am working on this

To learn more about issue processing workflow, refer to the Code Contributions.


⚠️ According to the Magento Contribution requirements, all issues must go through the Community Contributions Triage process. Community Contributions Triage is a public meeting.

🕙 You can find the schedule on the Magento Community Calendar page.

📞 The triage of issues happens in the queue order. If you want to speed up the delivery of your contribution, join the Community Contributions Triage session to discuss the appropriate ticket.

✏️ Feel free to post questions/proposals/feedback related to the Community Contributions Triage process to the corresponding Slack Channel

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Feature Requests Backlog
  
Ready for Grooming
Development

No branches or pull requests

1 participant