Problem/Motivation

I find the current description of the toolbar settings somewhat confusing. It would be better to describe them more straightforwardly.

Steps to reproduce

1. Go to /admin/config/user-interface/admin-toolbar-tools (I understand that there is a separate issue to move this to /admin/config/user-interface/admin-toolbar)

Expected result:
a. The label for the check box corresponds to what happens when you check the box.
b. Hover intent is two words

Actual result:
a. Both the checked and un-checked states are reflected in the label
b. Hover intent is a single word

Proposed resolution

Change:

Enable/Disable the hoverintent functionality
Check it if you want to enable the hoverintent feature.
Enable/Disable local tasks display
Local tasks such as node edit and delete.

To:

Enable the hover intent functionality
Delay menu activation long enough to establish intent to use the menu.
Enable local tasks display
Show local tasks such as node edit and delete.

Remaining tasks

Go through the settings strings on the page, and check if they can be improved.

User interface changes

API changes

Data model changes

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

Comments

charles belov created an issue. See original summary.

charles belov’s picture

Issue summary: View changes
dydave’s picture

Version: 3.6.2 » 3.x-dev
StatusFileSize
new302.88 KB

Thank you very much Charles (@charles belov), as always, for your very constructive and helpful feedback.

No problem and thanks a lot for the suggestions. 👌

✅ OK for the requirements:

Expected result:
a. The label for the check box corresponds to what happens when you check the box.
b. Hover intent is two words

✅ OK for the labels on the Admin Toolbar Tools settings page at /admin/config/user-interface/admin-toolbar-tools:

Enable/Disable local tasks display
Local tasks such as node edit and delete.

🛑 KO But I can't seem to find:

Enable/Disable the hoverintent functionality
Check it if you want to enable the hoverintent feature.

I also searched module's code base and could not find these labels...
Could you please provide more details on where these textual elements could be found?

Otherwise, could you please review the Admin Toolbar settings form at /admin/config/user-interface/admin-toolbar?
In particular, the text hoverIntent appears multiple times.... See screenshot below:


 

Initially the idea behind using a single word was probably to reference the Javascript library and its corresponding effect.

However, if you have recommendations on replacing any occurrences of the word, with two words in the form, they would surely be greatly appreciated.
We would probably need to look more generally at replacing any occurrences of the word in form labels.

Just to let you know: We've already done a few rounds of improvements on these forms with @ressa and he could definitely be of great help to review and validate textual changes to these forms.
 

Ideally:
First, we would like to collect as many required changes as possible, so they could all be processed at once and tested exhaustively in a single round: Trying to minimize the amount of back and forths we might need on an issue like that.

Please let us know your suggestions of adjustments to be made to the forms and we will be glad to make the corresponding code changes.
Thanks in advance for your feedback and help!

ressa’s picture

Issue summary: View changes

Thanks @charles belov, these are great suggestions, and they improve the text.

But like @dydave suggests, ideally we should give the whole page a look-over, and tighten up the text strings more methodically.

I have added the strings in the Issue Summary, from the latest 3.x dev-release, maybe you can add your suggestions there? Thanks!

charles belov’s picture

Sorry about the delay in responding; I was out of office. I'm not sure where you were asking me to add my comments; I'll put them on this issue and if you want me to put them somewhere else please point me to that URL and I will be happy to copy my comments there.

Thank you for pushing various changes to the development version. Regarding the current wording:

I believe that it is an improvement to use camel case on "hoverIntent" so that it will be read properly by screen readers. However, I feel it is better to use less technical language than assume that the person doing the particular configuration is familiar with the JavaScript. I'd really prefer to see it as two separate words which describe the actual functionality rather than the internal name, just as Drupal usually describes the friendly name rather than the machine name.

I additionally added hyphens where hover intent is being used as a modifier for another word, and made one other suggested edit to focus on the behavior rather than on the technology which achieves that behavior.

So:

Toolbar hover-intent behavior
Provides a smoother user experience, where only menu items which are paused over are expanded, to avoid accidental activations.
Disable hover intent to respond instantly to the pointer position.
Enable hover intent
Hover intent timeout (ms)
milliseconds
Sets the hover-intent trigger timeout (steps of 250).
The higher the value, the longer the menu dropdown stays visible, after the mouse moves out (default: 500ms).

Separately, re "Hide or show the toolbar with shortcut (Alt + p)" that that is the key combination for Windows. On Mac it is Option + p. That said, I just tested it and it works.

ressa’s picture

Thanks, I just meant that to make it more systematic, it might be best if you could share your opinion on the individual strings, as I listed them in the Issue Summary here:

Remaining tasks

Go through the settings strings on the page, and check if they can be improved. Either add "OK", or the new suggestion below:"

  • The Admin Toolbar module provides [...]

But maybe your comment could work as well, let's see what @dydave thinks.

Actually, ideally you could create an MR, so that we can review your suggestions directly in the user interface ... that way, we don't have to guess which strings you want to update.

ressa’s picture

Thanks @charles belov, and for updating the documentation as well.

ressa’s picture

Issue summary: View changes

Remove list of strings from the Issue summary.

dydave’s picture

Status: Active » Needs review

Super nice feedback and help on this issue Charles (@charles belov) and @ressa, once again! 🤩
Great job! 🥳
Thanks a lot! 🙏

✅ OK
I have reviewed all the changes suggested at #5 and the ones in the Issue Summary and rolled them in merge request !198 👍

See additional commit:
https://git.drupalcode.org/issue/admin_toolbar-3564708/-/commit/fb24122d...

I "think", all the changes mentioned in this issue should now be included in this merge request, but it would be great if you could both maybe take another look... thus, moving issue to Needs review 🤞

Charles (@charles belov), could you please take another look at the forms and double check if we could have missed anything?

@ressa, if you could maybe try grepping and such, to see if we could have missed anything else, it would be super helpful as well. 😊
I don't think it would be necessary to change 'hoverIntent' in code comments. 👌

Feel free to add changes and edit directly any of the files from the merge request.

Any comments, reviews or testing feedback would be greatly appreciated. 🙏
Thanks in advance!

charles belov’s picture

@dydave Thank you for the check-in. Looks good to me. On my test on simplytest.me:

I see all the edits I expected to see.

ressa’s picture

Status: Needs review » Needs work

Thanks @dydave and @charles belov, these are great suggestions. I added two comments in the MR.

This is what I suggest about the shortcuts in bold:

AT shortcuts strong

Also, I see that both "hover intent" as well as "hover-intent" is used in the MR. Is this intentional @charles belov?

ressa’s picture

StatusFileSize
new59.98 KB

Adding image.

charles belov’s picture

@ressa: Regarding

Also, I see that both "hover intent" as well as "hover-intent" is used in the MR. Is this intentional @charles belov?

I can't seem to find where I used "hover intent" without the hyphen in the MR, but if I did then the differences are in fact deliberate. I acknowledge I based this on Associated-Press style, which may not be the style that the Drupal project uses.

"hover intent" without the hyphen is for when the phrase doesn't modify anything.

"hover-intent" with the hyphen is for when the phrase modifies another term, in this case, where it modifies the phrase "toolbar behaviors"

Hope this helps.

ressa’s picture

Status: Needs work » Needs review

Thanks for the fast feedback @charles belov. Great suggestion with using "show/hide-toolbar shortcut", and I have updated my suggestion.

If you agree with my suggestions in the MR, you can click "Apply suggestion" which will update the MR, followed by "Resolve thread", to signify that the changes have been made, and there are no remaining tasks ("unresolved").

Thanks for clarifying the "hover-intent" and "hover intent" differences. About seeing the different instances, they can be seen for example in the raw diff: https://git.drupalcode.org/project/admin_toolbar/-/merge_requests/198.diff

dydave’s picture

Great work on this Charles (@charles belov) and @ressa! Thanks a lot! 🙏

I'll take a step back and let Charles review the merge request, as suggested by @ressa, if possible, to apply suggestions and resolve threads.

I'm personally very happy with the suggested changes, putting the focus on non tech savvy users.
The forms definitely look much more refined compared to where they were a year ago 🥳

Once you're both happy with the changes in the MR, I'll be happy to hit the merge button. 😊

Thanks again!

charles belov’s picture

OK just loaded this in simplytest.me and I see where I used hover intent with and without hypens. Yes, I am happy with this. @ressa?

charles belov’s picture

Oops, one typo. Will fix.

charles belov’s picture

Okay, fixed and re-tested. Ready to go from my viewpoint. @ressa, is it ready for you?

ressa’s picture

Status: Needs review » Reviewed & tested by the community

Thanks for fast feedback @dydave and @charles belov :)

I do remember how strange I thought the UI for "Suggest change" was, and I should have linked to the Suggest changes GitLab doc page, my bad. There will be a lot of trial and error when learning to use the GitLab UI, and we have all been there.

I have added a new section to the "Editing a GitLab merge request" doc page called Accepting a suggested change. Since it's still fresh in your mind, feel free to clarify or expand the content, if you think it could be helpful for a user new to the concept.

I agree with @dydave that it's a clear improvement, and the MR is ready.

charles belov’s picture

@ressa You shouldn't have linked to the Suggest changes gitlab doc page because you didn't link to the Suggest changes gitlab doc page, and it's about 1% bad and I can deal with a 1%. (I know that sounds odd - it's something I learned in a self-improvement course.) That is, no worries.

It's annoying that they use hover to reveal functionality; that's a complaint I plan to submit to github itself.

But I did actually find the apply suggestions button; it's just that it didn't seem to work on first try.

dydave’s picture

Status: Reviewed & tested by the community » Fixed

Thanks a lot Charles (@charles belov) and @ressa, once again! 🙏

After doing another quick review of the merge request and a round of testing locally, since everything seemed to work as expected and all the jobs and tests were still passing 🟢, I went ahead and merged the changes above at #22. 🥳

This ticket is a great example of a constructive collaborative effort resulting in concrete changes bringing value to the community. 🤩
Additionally, it's been a great learning experience in terms of vocabulary guidelines and definitions. For example, I have a much better idea of how an 'On/Off' (boolean) checkbox config field label should be formatted and phrased.

At this point, we could probably consider that all the work expected in this ticket should have been completed, thus, marking as ✅Fixed, for now.
Feel free to let us know if you spot anything else or have more suggestions of improvements, it would definitely be very helpful.

Let's keep moving the work in other issues as well. 😅
Thanks again very much for your precious help making the module constantly better! 🙏

Special thanks to @ressa, once again, for the great documentation and use of Gitlab Suggestions.
I'll make sure to point contributors to the links and docs in this issue. 👍

Now that this issue is closed, review the contribution record.

As a contributor, attribute any organization that helped you, or if you volunteered your own time.

Maintainers, credit people who helped resolve this issue.

ressa’s picture

Thanks @dydave for a fast action, as always!

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.