Improve and clarify the microcopy for the search field placeholder

Created on 2 November 2022, about 2 years ago
Updated 13 October 2023, about 1 year ago

Problem/Motivation

The placeholder text for the search field is sort of confusing: Module Name, Keyword(s), etc.. Module name is clear but what are keyword(s) in the context of Project Browser and what does etc refer to - which other options are available to search for that etc refers to (aka what is actually indexed and queryable)?
The only searches that lead to results were when i've searched for actual module names. But when I've searched for example for the core (experimental) category term there were actually no results (even with the option show all on each filter type). The placeholder text implies a lot of possibilities for potential queries but in reality even if i pick a word from a module description visible in one of the cards on the screen or a category there won't be any results?

*The issue spun off โœจ Change layout to make plugin-specific content more clear Fixed as a follow-up.

Steps to reproduce

- go to /admin/modules/browse
- take a look at the search fields placeholder text before you enter anything

Proposed resolution

Due to the questions in the problem/motivation section i was unable to come up with an appropriate suggestion yet.

Remaining tasks

  • โœ… File an issue about this project
  • โ˜ Manual Testing
  • โ˜ Code Review
  • โ˜ Accessibility Review
  • โ˜ Automated tests needed/written?
๐Ÿ“Œ Task
Status

Needs review

Version

1.0

Component

User experience

Created by

๐Ÿ‡ฉ๐Ÿ‡ชGermany rkoller Nรผrnberg, Germany

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

  • ๐Ÿ‡บ๐Ÿ‡ธUnited States chrisfromredfin Portland, Maine
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia divya.sejekan

    Tested using MR!320 latest.
    The Placeholder text now changed to 'Enter Module name here' and is visible in the search filed

    Testing Steps
    - go to /admin/modules/browse
    - take a look at the search field placeholder text before you enter anything

    Keeping this in review state for approval

  • Status changed to RTBC 9 months ago
  • ๐Ÿ‡บ๐Ÿ‡ธUnited States kurttrowbridge

    Hello! I'm looking at this during Florida DrupalCamp 2024, and freshly installed Project Browser with the MR applied. The placeholder text appears as expected, both in the visual output of the search field and in the DOM as a placeholder attribute. Screenshot attached of the visual output.

    Going to mark this as RTBC. Thanks!

  • Status changed to Postponed 9 months ago
  • ๐Ÿ‡บ๐Ÿ‡ธUnited States chrisfromredfin Portland, Maine

    I think we need to hold off on pushing this through, due to the nature of what's being searched *right now* versus what's going to be searched when there's a real Search API-backed instance running. "Module name" is good with the current mock situation, but we need to think about what this text should *actually* be against the live backend, and that we don't quite know yet.

    Though, I anticipate it would be project name & project description (title & body) at a minimum.

    I might suggest just "Keyword(s)..." as the placeholder, but I'm curious if that makes sense given what other folks do, and what some UI people think.

  • Status changed to Needs work about 2 months ago
  • ๐Ÿ‡บ๐Ÿ‡ธUnited States chrisfromredfin Portland, Maine

    Moving back to NW. With the real d.o backend up and running - we're searching and finding based on the Elasticsearch config at d.o - what should this keyword filter be for microcopy?

    I suggest "Keyword(s)..." - but I would like consensus on something, then this is an easy/novice issue to work on.

  • ๐Ÿ‡บ๐Ÿ‡ธUnited States leslieg

    Using "Enter Module name here" is technical and not something that our target audience would necessarily understand.

    After discussing with Chris, I suggest keeping it simple and using a few examples as the placeholder.. (e.g. image gallery, spam protection) to give users an idea of how it can be used.

    Also suggest that we change the label from "Search for modules" to just "Search " as it can now search for recipes and eventually themes, etc.

  • ๐Ÿ‡ฉ๐Ÿ‡ชGermany rkoller Nรผrnberg, Germany

    already asked over on slack, but what would be the elements that are queried and or could be queried with elastic search? the title, the body field, anything else? guess that list of elements should inform the decision how to label things.

  • ๐Ÿ‡ช๐Ÿ‡ธSpain fjgarlin

    Screenshots of the current Search API index configuration are attached. Only title has a bump of 8, rest 1. No other custom code is written anywhere.

  • ๐Ÿ‡บ๐Ÿ‡ธUnited States chrisfromredfin Portland, Maine

    Deciphering this, it's CURRENTLY

    • Title (weight/boost 8)
    • Body (weight/boost 1)
    • Categories (weight/boost 1)
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia narendraR Jaipur, India

    Should we change version to 2.0.x here?

  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia narendraR Jaipur, India

    After discussion with Chris, moving it to 2.0.x

  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia narendraR Jaipur, India

    As we now have a list of elements that can be queried, can we decide on naming the placeholder, keeping recipes and future themes in mind?

  • ๐Ÿ‡บ๐Ÿ‡ธUnited States chrisfromredfin Portland, Maine

    I would recommend the label become "Search" and the placeholder be examples of what to search for, like Leslie suggests. I propose something close to "(e.g. image gallery, spam protection, Gin theme)" - I'm not sure that we can/should be promoting a particular theme in that way, however, it's really great because there are also modules that work with Gin today so that the example is relevant even before there is a theme browser.

    If people can throw a few ideas around, or just +1 this one, I think we can just decide (it can always be changed later).

  • ๐Ÿ‡ช๐Ÿ‡ธSpain fjgarlin

    Good suggestion up there, but I would not put anything "theme" related as we are only looking for modules (https://git.drupalcode.org/project/project_browser/-/blob/2.0.x/src/Plug...) in the default plugin.

  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia narendraR Jaipur, India

    Re #20, I think placeholder text should change based on plugin or it should be such that it applies to all plugins.

  • ๐Ÿ‡ฉ๐Ÿ‡ชGermany rkoller Nรผrnberg, Germany

    big +1 for the point made in #20 ๐Ÿ“Œ Improve and clarify the microcopy for the search field placeholder Needs review by @fjgarlin (and alsothank you for the search api index configuration screenshots in #14 ๐Ÿ“Œ Improve and clarify the microcopy for the search field placeholder Needs review ).

    in regards of the suggestion in #19 ๐Ÿ“Œ Improve and clarify the microcopy for the search field placeholder Needs review , I am uncertain whether it makes sense to provide a few module names as examples. that way a user would ask the same question i've asked in #13 ๐Ÿ“Œ Improve and clarify the microcopy for the search field placeholder Needs review , what is actually searched in. to provide some sort of "inspiration" and priming to the user i guess something like โœจ Show curated content and links on the start page Instead of results without a search query being entered beforehand Active might be the more impactful approach?

    For this issue it might be good to illustrate the current aural interface for the search field (search.mp4) and the downsides of placeholder text have also be noted ( see https://www.smashingmagazine.com/2018/06/placeholder-attribute/). Two suggestions come to my mind for now:

    • go with the suggestion from chris in #19 ๐Ÿ“Œ Improve and clarify the microcopy for the search field placeholder Needs review using Search as the label, but instead of providing a list of module suggestions tell the user what is actually searched. so the placeholder text would state something like "...the module description and title on drupal.org" . that way the input field label and placeholder complement each other and get announced in one single sentence in the aural interface as an additional plus?
    • "simply" drop the placeholder and just go with the label for the input field.

    Will think of more options, and run it by the other in the drupalisms group as well as the ux group. but as chris said the label and the placeholder are not set in stone and could still changed in a followup.

  • ๐Ÿ‡บ๐Ÿ‡ธUnited States chrisfromredfin Portland, Maine

    I don't want to have to change code if we change d.o's mechanism for indexing. I think it needs to be more generic, and providing examples of things to type in to search for is a good way around that. To that end, I say we just do "spam protection, image gallery" and scrap the theme. if we'd rather, we can change one of those examples to an actual module name, like "recaptcha, image gallery" or add it "spam protection, image gallery, Google Tag" or something.

  • I have updated the placeholder and label according to the discussion on the issue.But i still think @narendrar made a valid point in #20 ๐Ÿ“Œ Improve and clarify the microcopy for the search field placeholder Needs review that we should consider the recipes as well as the search component is generic.I'll mark this NR for another round of review.

  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia narendraR Jaipur, India

    Changes seem in line with comment #23, hence marking it as RTBC.

  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia narendraR Jaipur, India
  • ๐Ÿ‡ฉ๐Ÿ‡ชGermany rkoller Nรผrnberg, Germany

    Sorry, I've taken a look at the latest state of the MR, the placeholder text in the current form is not helpful at all. For contrib modules the placeholder text tells the following: as a person new to drupal, it tells me nothing at all. i dont know what field group mean and recaptcha also doesnt ring a bell, i only know there are captchas on the web. as a person experienced with drupal, it tells me ah i am able to search for module names and nothing else but module names in this field. and searching for either recaptcha or field group in recipes provides me zero results, same for the core modules.

  • ๐Ÿ‡บ๐Ÿ‡ธUnited States phenaproxima Massachusetts

    I wonder if we are overthinking this.

    I think most people know what to do when presented with a search query box. It's the commonest of patterns. You enter some text there, it finds stuff that matches. I don't think they need to know that it searches module names, descriptions, whatever. That's the job of the app to figure out.

    So IMHO there need not be any placeholder text at all. I think this might be a case where trying to be too helpful will actually be less helpful.

  • ๐Ÿ‡บ๐Ÿ‡ธUnited States chrisfromredfin Portland, Maine

    Oof, yes, overthink. I thought placeholder text was a "recommended" pattern but actually if it's not adding clarity, yes, just boot it and leave it "Search" as the label. That solves it across every plugin. Thanks for the light, @phenaproxima - sometimes we need to be reminded we're too deep in the weeds, but we're too deep in the weeds to see out.

  • Removed the placeholder.Ready for review

  • ๐Ÿ‡บ๐Ÿ‡ธUnited States phenaproxima Massachusetts

    Looks okay to me!

  • ๐Ÿ‡บ๐Ÿ‡ธUnited States chrisfromredfin Portland, Maine

    Wonderful! A bigger victory than the code suggests. :)

    Meanwhile, we have to find a way to not bikeshed language decisions. But, this works! When in doubt, make it more minimal.

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

Production build 0.71.5 2024