Form UI Component cannot be used in frontend

ioweb-gr commented 9 months ago

Summary

As it's recommended to use the ui components as much as possible, I wanted to implement a form in the frontend but I'm experiencing a lot of issues.

When trying to use the form component in the frontend I see the following issues.

The <buttons> argument cannot be used directly as it's focused on the admin toolbar. Therefore if you use it, the button won't render. Therefore you have to add the button directly in the fields like this

        <button name="save">
            <argument name="data" xsi:type="array">
                <item name="config" xsi:type="array">
                    <item name="buttonClasses" xsi:type="string">custom-button-class</item>
                    <item name="actions" xsi:type="array">
                        <item name="0" xsi:type="array">
                            <item name="targetName" xsi:type="string">myform.myform</item>
                            <item name="actionName" xsi:type="string">save</item>
                        </item>
                    </item>
                </item>
            </argument>
            <settings>
                <title translate="true">Save</title>
            </settings>
        </button>

To trigger the save action via the targetName and actionName.

Normally it would be rendered due to Magento_Backend::pageactions.phtml but this block is not available in frontend

The required attributes are not honored, the form can be submitted without any form of validation
The form key is not added properly causing an error

Basically it seems the form component is only usable in admin area and not frontend but it's listed under frontend core ui components on the docs.

https://developer.adobe.com/commerce/frontend-core/ui-components/components/form/

I'm not sure if anyone noticed this but either it should be marked as admin ui component and moved away from that section on the docs or it should be fixed to work properly on the frontend.

The example from the docs won't work either in the frontend.

Therefore the only option left to the developer is left with is to render the form fields directly in the frontend on a phtml file and leverage the mage validation tools directly in the phtml file as it's not possible to use the UI component itself that should be usable according to the docs.

Examples

Here's a sample module with a custom form at URL

<example.com>/myform/render/index

myform.zip

Proposed solution

Fix the UI component to work in the frontend or
Remove it from the frontend ui compoments as it's not usable.

Release note

No response

Triage and priority

[ ] Severity: S0 - Affects critical data or functionality and leaves users without workaround.
[X] Severity: S1 - Affects critical data or functionality and forces users to employ a workaround.
[ ] Severity: S2 - Affects non-critical data or functionality and forces users to employ a workaround.
[ ] Severity: S3 - Affects non-critical data or functionality and does not force users to employ a workaround.
[ ] Severity: S4 - Affects aesthetics, professional look and feel, “quality” or “usability”.

m2-assistant[bot] commented 9 months ago

Hi @ioweb-gr. Thank you for your report. To speed up processing of this issue, 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.

Join Magento Community Engineering Slack and ask your questions in #github channel. :warning: According to the Magento Contribution requirements, all issues must go through the Community Contributions Triage process. Community Contributions Triage is a public meeting. :clock10: You can find the schedule on the Magento Community Calendar page. :telephone_receiver: 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.

m2-assistant[bot] commented 9 months ago

Hi @engcom-Hotel. Thank you for working on this issue. In order to make sure that issue has enough information and ready for development, please read and check the following instruction: :point_down:

[ ] 1. Verify that issue has all the required information. (Preconditions, Steps to reproduce, Expected result, Actual result).
[ ] 2. Verify that issue has a meaningful description and provides enough information to reproduce the issue.
[ ] 3. Add Area: XXXXX label to the ticket, indicating the functional areas it may be related to.
[ ] 4. Verify that the issue is reproducible on 2.4-develop branch
Details
- Add the comment @magento give me 2.4-develop instance to deploy test instance on Magento infrastructure.
- If the issue is reproducible on 2.4-develop branch, please, add the label Reproduced on 2.4.x.
- If the issue is not reproducible, add your comment that issue is not reproducible and close the issue and stop verification process here!
[ ] 5. Add label Issue: Confirmed once verification is complete.
[ ] 6. Make sure that automatic system confirms that report has been added to the backlog.

engcom-Hotel commented 9 months ago

Hello @ioweb-gr,

Thanks for the report and collaboration!

We have tried to reproduce the issue in 2.4-develop branch and the issue is reproducible for us. Hence confirming the issue.

Thanks

github-jira-sync-bot commented 9 months ago

:white_check_mark: Jira issue https://jira.corp.adobe.com/browse/AC-11019 is successfully created for this GitHub issue.

m2-assistant[bot] commented 9 months ago

:white_check_mark: Confirmed by @engcom-Hotel. Thank you for verifying the issue.
Issue Available: @engcom-Hotel, You will be automatically unassigned. Contributors/Maintainers can claim this issue to continue. To reclaim and continue work, reassign the ticket to yourself.

ioweb-gr commented 6 months ago

@magento give me 2.4-develop instance

magento-deployment-service[bot] commented 6 months ago

Hi @ioweb-gr. Thank you for your request. I'm working on Magento instance for you.

magento-deployment-service[bot] commented 6 months ago

Hi @ioweb-gr, here is your Magento Instance: https://5246d4f5953b869513ffc67af480e773.instances-prod.magento-community.engineering Admin access: https://5246d4f5953b869513ffc67af480e773.instances-prod.magento-community.engineering/admin_431d Login: 6136ef16 Password: 79bfb484e146

magento / magento2