- Status changed to Fixed
4 months ago 8:18pm 30 July 2024 - ๐บ๐ธUnited States bsnodgrass
chrisfromredfin โ credited bsnodgrass โ .
- ๐บ๐ธUnited States chrisfromredfin Portland, Maine
- ๐ฉ๐ชGermany rkoller Nรผrnberg, Germany
That link to d.o fixes only one out of the three points listed in the proposed resolution. :/ Plus it is suboptimal if you have to leave your site and the pb search ui to look up the meaning of a category on a different site
- Status changed to Needs work
4 months ago 2:15pm 31 July 2024 - ๐บ๐ธUnited States chrisfromredfin Portland, Maine
Doh! I got overzealous.
- ๐ฎ๐ชIreland lostcarpark
Agree 100% that this is needed.
I think the first part has been completed as part of the category revamp, and the new categories have descriptions.
I'm not sure if the descriptions are currently fed to the Project Browser UI.
I think we need some way of accessing those descriptions in the UI. I think a visually hidden element for each label could solve it for screen readers. For non-screen reader users, we need to come up with a UI mechanism. They're a bit old-fashioned, but would tooltips work?
This would probably need to be a separate issue, but I think the descriptions should also be displayed to module maintainers when setting categories for their modules. I don't think we can expect module maintainers to go searching for category descriptions unless they are put in their eyeline when selecting the module categories.
- ๐ฎ๐ณIndia prashant.c Dharamshala
The description/summary about the categories on hover or click would be a very helpful thing not only to new users but also to developers, and site builders as well.
- Assigned to lostcarpark
- ๐ฎ๐ชIreland lostcarpark
I've started working on this. At the moment I just have it fetching the descriptions with the categories and adding to a span after the category labels. I plan to visually hide this so they'll still be available to screen readers, and I should be able to use that as the basis for providing tooltips.
- Merge request !560Show category descriptions in UI (Add description to category output). โ (Open) created by lostcarpark
- ๐ฉ๐ชGermany rkoller Nรผrnberg, Germany
the downside of tooltips is that a sighted user has to hover over the category title which is not necessarily expected for a list of categories to get the category descriptions there. how about making category titles directly visible instead? with nothing searched yet one option might be making the category descriptions part of the project browser "start page" as outlined in โจ Show curated content and links on the start page Instead of results without a search query being entered beforehand Active . each tile could provide the information about the category and quick refresher, as well as function as a link triggering an initial filtering of the project list without a search term entered, so the user gets all the modules associated with for example the accessibility category.
- ๐ฎ๐ชIreland lostcarpark
I have been working on a basic category tooltip.
I have the following working:
- The JSON API fetches the category descriptions as well as the titles.
- An additional span is placed inside the label containing the description. This is visually hidden so it will only be visible to screen readers.
- I've added a mouseover event to the checkbox and the title to show the tooltip.
- I've also added a focus event to the checkbox to show the tooltip, so moving over the checkboxes with the keyboard will cause the tooltips to be shown.
Some areas need work.
- I'm having some trouble getting the tests working. I think part of the problem is tests that check for the text of a category title are getting thrown by the extra element in the label. I think a possible fix would be to move the category title into a span (so the label would contain two child spans, one for the title, and another for the description). That should make it easier to isolate the title element.
- It would be nice if the tooltip appeared after a short delay, so it didn't show when moving over quickly, just when hovering.
- Moving the mouse over the categories quickly can result in more than one tooltip showing.
- Moving the mouse quickly produces some unsightly flickering as descriptions appear and are hidden.
- ๐ฎ๐ณIndia prashant.c Dharamshala
I also gave it a try, worked smoothly, and majorly the points mentioned in #21 in
Some areas need work.
are the major things(mostly usability).We could also consider to show it by:
- Displaying an (i) icon against each category name and showing the tooltip on hovering that only
- Showing the tooltip the way we are currently trying to show but show it to the right side so that the options below and above the hover option are not hidden
Thanks!
- ๐ช๐ธSpain fjgarlin
We don't seem to be testing this via PHPUnit/nightwatch (which might be fine), but note that we we want to test descriptions/tooltips, we might need to alter the fixtures used (so the real API endpoint is not queried for testing):
- https://git.drupalcode.org/project/project_browser/-/blob/2.0.x/tests/fi...
- https://git.drupalcode.org/project/project_browser/-/blob/2.0.x/tests/fi... - ๐บ๐ธUnited States leslieg
Is this RTBC and @fjgarlin didn't mark it or does it still need work?
- ๐ช๐ธSpain fjgarlin
Iโd say still โneeds workโ as there are actions/feedback not addressed yet.
- ๐บ๐ธUnited States pfrilling Minster, OH
The markup is changing in https://www.drupal.org/project/project_browser/issues/3485747 ๐ The multi-category filter needs to be an actual set of labeled checkboxes Active . This will likely need a rebase once that fix lands.