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 help link Vue component #19922

Merged
merged 11 commits into from Nov 2, 2022
Merged

Add help link Vue component #19922

merged 11 commits into from Nov 2, 2022

Conversation

peterhashair
Copy link
Contributor

@peterhashair peterhashair commented Oct 28, 2022

Description:

Fixes : #19909
Used like <div piwik-show-help-link message="test"></div>

Review

add help link vue
@peterhashair peterhashair added this to the 4.12.4 milestone Oct 28, 2022
@peterhashair
Copy link
Contributor Author

@snake14 can you try this, if that works for the DEV-3145

@sgiehl
Copy link
Member

sgiehl commented Oct 28, 2022

@peterhashair Shouldn't that one also change _menu.twig, so the component is automatically used there if some help text is defined for an entry?

update menu when _help define, show help icon
add help key
placeat: '#notificationContainer',
prepend: true,
});
},
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This shows the help notification well and clicking on a different help icon replaces the help text with that help text. However, there's one thing that this isn't doing that plugins/CoreHome/vue/src/ReportingMenu/ReportingMenu.vue does. When I click the same help icon twice, this code doesn't hide the purple notification. For example, from the Matomo dashboard, I select the Goals menu item and then click the help icon next to the Overview submenu to view the purple notification containing the help text. If I click that same help icon a second time, the purple notification is hidden.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @peterhashair . It now hides when I click the icon a second time.

Every once in a while there's some odd behaviour when I click on the help icon next to one submenu and then the icon next to another submenu. In some cases it hides the notification instead of replacing it. Sometimes I have to click the help icon multiple times. Although, it's enough of a fringe case that it's probably fine to let through.

@snake14
Copy link
Contributor

snake14 commented Nov 1, 2022

@peterhashair Thank you for your effort. This is looking really good. I left one more comment about something that isn't working quite as expected.

Peter and others added 7 commits November 2, 2022 09:47
add hide help message
update type string from null to empty
fix build build
fix vue build error
fix vue build
fix vue build
@peterhashair
Copy link
Contributor Author

peterhashair commented Nov 1, 2022

as described in the JIRA ticket. This issue may be out of scope.
when we click the help icon from the current nav item to another nav Item, it doesn’t navigate to the target nav as the main menu does. (eg: click visitors->overview(help icon) then click visitors->visits log (help icon) It uses ajax load the page items and shows the help text at the top. Because the plugin page items do not load through ajax only through traditional URLs. To implement this, we maybe need to add a widget container for all plugins.
Let me know if we want to implement this.

Copy link
Contributor

@snake14 snake14 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I noticed a little bit of strange behaviour, like sometimes having to click the help icon multiple times if I clicked a few icons in a row. However, I don't think that's the normal use case and it's probably fine to move forward.

@peterhashair peterhashair merged commit 69ac1b5 into 4.x-dev Nov 2, 2022
@peterhashair peterhashair deleted the 19909 branch November 2, 2022 20:00
@elabuwa elabuwa changed the title add help link vue componet Add help link Vue component Nov 22, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add help icon ability to subcategories in the Twig nav menu template
3 participants