Columns functionality for \Magento\Theme\Block\Html\Topmenu seems broken

ioweb-gr commented 9 months ago

Summary

I'm trying to customize the topmenu without adding 3rd party modules.

I noticed that \Magento\Theme\Block\Html\Topmenu::getHtml has the possibility to add a limit and also columns should be possible to add with the built in functionality \Magento\Theme\Block\Html\Topmenu::shouldAddNewColumn

However when setting the value for limit to 10 in default.xml

e.g.

                        <arguments>
                            <argument name="columns_limit" xsi:type="number">10</argument>
                        </arguments>

I get greeted with errors if there's a menu item with less than 10 children

And when using a number that's acceptable for all menu items like 5 then the submenu doesn't render fully.

There's no documentation in the source code or the docs about the built-in functionality which seems partially broken.

Could someone from the core developers let us know if this functionality should be usable (should be working) and perhaps an example for using it?

Examples

Create a menu item with 50 sub categories and try to columnize using

                        <arguments>
                            <argument name="columns_limit" xsi:type="number">10</argument>
                        </arguments>

In the topnav block.

menu.tar.gz

Proposed solution

No response

Release note

No response

Triage and priority

[ ] Severity: S0 - Affects critical data or functionality and leaves users without workaround.
[ ] 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.

ioweb-gr commented 9 months ago

To add some more observations, it seems that it does render the items grouped in columns but the CSS is not proper for the change. So apart from the exception, the problem must be that the CSS is not taking this situation into account to render the columns even though the functionality is there

m2-assistant[bot] commented 9 months ago

Hi @engcom-November. 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-November commented 9 months ago

Hello @ioweb-gr,

Thank you for the report and collaboration!

We were able to reproduce this issue on 2.4-develop. Please look at the screenshot below: When adding the column limit less then the total number of sub-menu, we didn't get any error, but the sub-menu was not being displayed.

And when the limit was set higher then the total number of sub-menu, we got the error. Also this error will be thrown if each menu has different number of sub-menu.

Hence confirming this issue.

Thank you.

github-jira-sync-bot commented 9 months ago

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

m2-assistant[bot] commented 9 months ago

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

magento / magento2