Placeholders and help text in the fieldmapper editor

Bug #2021862 reported by Stephanie Leary
22
This bug affects 6 people
Affects Status Importance Assigned to Milestone
Evergreen
Fix Released
Medium
Unassigned
3.11
Confirmed
Medium
Unassigned

Bug Description

In the fm-editor component, form fields' labels come from the placeholder text in the IDL. The same text is also used as a placeholder in the text inputs, with “...” added to the end.

We should move away from using placeholders altogether for accessibility and usability reasons. They make fields look as though they’re already filled in, making it hard to scan the page for empty fields. Low-contrast placeholders are hard to read; high-contrast placeholders are indistinguishable from user-added input.

Fieldmapper inputs can also have help text for additional hints and instructions, but these are visible only in tooltips next to the labels. This is important information and it should not be hidden in a tooltip. We should move this to a persistently visible location near the input field.

Revision history for this message
Stephanie Leary (stephanieleary) wrote :

Here's a branch that removes the placeholders, places the help text below the input (though it falls first in the source order, for screen reader users' benefit), and cleans up the labeling and placement of the Translate button. Screenshot attached.
https://git.evergreen-ils.org/?p=working/Evergreen.git;a=shortlog;h=refs/heads/user/sleary/lp2021862-fieldmapper-placeholders-hints

Changed in evergreen:
assignee: Stephanie Leary (stephanieleary) → nobody
tags: added: pullrequest
Revision history for this message
Tiffany Little (tslittle) wrote :

Adding a link to bug 1906862 because I think this would fix that one too.

Andrea Neiman (aneiman)
Changed in evergreen:
status: New → Confirmed
importance: Undecided → Medium
milestone: none → 3.11.1
Revision history for this message
Galen Charlton (gmc) wrote :

Noting for anybody testing this that an interface demonstrating moving field-level help text away from a popover is the EDI account form available from the provider record (note: not from Acquisitions Administration | EDI Accounts). I.e., /eg2/en-US/staff/acq/provider/$ID/edi_accounts

Revision history for this message
Stephanie Leary (stephanieleary) wrote :

Thanks, Galen, that's really helpful. Looking at that screen, I think we should adjust the size and color of the help text -- while Bootstrap actually passes contrast requirements for once, I think it's awfully small and light.

As you test, I would suggest changing the .form-text font-size to 1em and the color to #555 in your inspector. Let me know if you'd like me to update the branch.

tags: added: ux-form-hints ux-forms
Changed in evergreen:
milestone: 3.11.1 → 3.12-beta
Revision history for this message
Blake GH (bmagic) wrote :

merge conflict against main today: Open-ILS/src/eg2/src/app/share/fm-editor/fm-editor.component.html
please rebase.

tags: added: needsrebase
Revision history for this message
Stephanie Leary (stephanieleary) wrote :

Rebased!

tags: removed: needsrebase
Changed in evergreen:
assignee: nobody → Terran McCanna (tmccanna)
Revision history for this message
Terran McCanna (tmccanna) wrote :

Getting merge conflicts again today :/

tags: added: needsrebase
Changed in evergreen:
assignee: Terran McCanna (tmccanna) → nobody
Revision history for this message
Stephanie Leary (stephanieleary) wrote :

Rebased! Thanks, Terran.

tags: removed: needsrebase
Changed in evergreen:
milestone: 3.12-beta → 3.12-rc
Revision history for this message
Terran McCanna (tmccanna) wrote :

Nobody was fast enough to get this reviewed and merged, Stephanie - now it needs a rebase again!

tags: added: needsrebase
Revision history for this message
Stephanie Leary (stephanieleary) wrote :

No problem, Terran. There's an org unit selector in there, so it had changed. Rebased and updated on the same branch.

tags: removed: needsrebase
Changed in evergreen:
milestone: 3.12-rc → 3.next
Changed in evergreen:
milestone: 3.next → 3.12.1
Changed in evergreen:
milestone: 3.12.1 → 3.12.2
Changed in evergreen:
milestone: 3.12.2 → 3.12.3
Revision history for this message
Galen Charlton (gmc) wrote :

I've pushed a rebased signoff branch to working/user/gmcharlt/lp2021862_signoff.

The branch includes a follow-up implementing the style changes suggested by Stephanie in comment #4 (and the color changes also fixes a contrast issue on the zebra-striped rows. It also includes a change from me to italicize the help text.

tags: added: signedoff
Revision history for this message
Jane Sandberg (sandbergja) wrote :

Thanks, Stephanie and Galen. I've pushed this to rel_3_12 and above before we get any more merge conflicts! Big improvement!

Changed in evergreen:
status: Confirmed → Fix Committed
Changed in evergreen:
status: Fix Committed → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Duplicates of this bug

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.