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

[inlinehelp] Add inlineHelp Toggle Button control to modules and plugins #37915

Merged
merged 16 commits into from
Jun 10, 2022
Merged

[inlinehelp] Add inlineHelp Toggle Button control to modules and plugins #37915

merged 16 commits into from
Jun 10, 2022

Conversation

conseilgouz
Copy link
Contributor

@conseilgouz conseilgouz commented May 28, 2022

Summary of Changes

This PR adds inlineHelp toggle button to modules and plugins options to give users the capability to show/hide parameters descriptions.
This PR improves #35610 and #37849
Instead of always displaying descriptions for modules and plugins, it becomes a user choice. In case of a doubt about a parameter, just click on the button.

Note : it could be improved by adding this to all components. For example, Featured articles menu, Article Class has a 4 lines description, usefull once.

Testing Instructions

Apply PR #37849 before applying this PR.

  • Check that inlineHelp toogle button is present and working in modules parameters.
  • Check that inlineHelp toogle button is present and working in admin modules parameters.
  • Check that inlineHelp toogle button is present and working in plugins parameters.
  • Check that inlineHelp button is not shown if plugin has no description to display (for example content page break)

Actual result BEFORE applying this Pull Request

After #37849 , the default behaviour is "show all descriptions" for modules and plugins parameters if no inlineHelp toggle button is displayed.

Expected result AFTER applying this Pull Request

InlineHelp toogle button is displayed and working for modules/plugins if parameters have descriptions. It is hidden otherwise.

Documentation Changes Required

none

@richard67
Copy link
Member

@conseilgouz Does it need to apply #37849 , too, for testing this PR? If so, you should mention that in the testing instructions.

@conseilgouz
Copy link
Contributor Author

@conseilgouz Does it need to apply #37849 , too, for testing this PR? If so, you should mention that in the testing instructions.

Done

@conseilgouz conseilgouz changed the title [4.1] Add inlineHelp Toggle Button control to modules and plugins [inlinehelp] Add inlineHelp Toggle Button control to modules and plugins May 30, 2022
@Quy
Copy link
Contributor

Quy commented May 30, 2022

Edit Action Log - Joomla plugin.
Preferably don't display the Toggle Inline Help button as there are no settings to display inline help.

Edit CAPTCHA - Invisible reCAPTCHA plugin.
Click Toggle Inline Help button.
Nothing happens.

@Quy Quy added the Updates Requested Indicates that this pull request needs an update from the author and should not be tested. label May 31, 2022
@joomla-cms-bot joomla-cms-bot added the NPM Resource Changed This Pull Request can't be tested by Patchtester label Jun 1, 2022
@conseilgouz
Copy link
Contributor Author

conseilgouz commented Jun 1, 2022

Edit Action Log - Joomla plugin. Preferably don't display the Toggle Inline Help button as there are no settings to display inline help.

Button is now hidden if no description is available in xml

Edit CAPTCHA - Invisible reCAPTCHA plugin. Click Toggle Inline Help button. Nothing happens.

I was not able to reproduce this issue. When I click on button, descriptions are shown/hidden/shown....

@Quy Quy removed the Updates Requested Indicates that this pull request needs an update from the author and should not be tested. label Jun 1, 2022
@cyrezdev
Copy link
Contributor

cyrezdev commented Jun 7, 2022

@conseilgouz Have tested, but not working for plugins and admin modules, because the tag is not at the right place.
See my comment in files changed.
;-)

@conseilgouz
Copy link
Contributor Author

@conseilgouz Have tested, but not working for plugins and admin modules, because the tag is not at the right place. See my comment in files changed. ;-)

@cyrezdev : done

@cyrezdev
Copy link
Contributor

cyrezdev commented Jun 8, 2022

@conseilgouz Have tested, but not working for plugins and admin modules, because the tag is not at the right place. See my comment in files changed. ;-)

@cyrezdev : done

Modules admin needed too : https://github.com/joomla/joomla-cms/pull/37915/files#diff-39a20a749da8e579b9b531f02b6648028489795fda3094a78db422b4af5bc44a

If you test, you will see that it does not work with admin modules...

@cyrezdev
Copy link
Contributor

cyrezdev commented Jun 8, 2022

Apply PR #37849 before applying this PR.

Note: not needed to apply the PR #37849 before tested this one, as it is an improvement that will not change the behavior of your changes here. cc/ @richard67

@conseilgouz
Copy link
Contributor Author

@conseilgouz Have tested, but not working for plugins and admin modules, because the tag is not at the right place. See my comment in files changed. ;-)

@cyrezdev : done

Modules admin needed too : https://github.com/joomla/joomla-cms/pull/37915/files#diff-39a20a749da8e579b9b531f02b6648028489795fda3094a78db422b4af5bc44a

If you test, you will see that it does not work with admin modules...

Yes, I missed this one. Done. Thank You.

@cyrezdev
Copy link
Contributor

cyrezdev commented Jun 8, 2022

I have tested this item ✅ successfully on 473631f

Needs to apply script change manually when using com_patchtester.


This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/37915.

@Quy
Copy link
Contributor

Quy commented Jun 9, 2022

I have tested this item ✅ successfully on 473631f


This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/37915.

@Quy
Copy link
Contributor

Quy commented Jun 9, 2022

RTC


This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/37915.

@joomla-cms-bot joomla-cms-bot added the RTC This Pull Request is Ready To Commit label Jun 9, 2022
@bembelimen bembelimen merged commit b882341 into joomla:4.1-dev Jun 10, 2022
@bembelimen
Copy link
Contributor

Thx

@joomla-cms-bot joomla-cms-bot removed the RTC This Pull Request is Ready To Commit label Jun 10, 2022
@bembelimen bembelimen modified the milestones: Joomla 4.2.0, Joomla 4.1.5 Jun 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
NPM Resource Changed This Pull Request can't be tested by Patchtester
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants