Override Aria Instructions

  • Resolved Daniel Schutzsmith

    (@schutzsmith)


    2 years, 2 months ago

    We’ve gone through accessibility testing with people using screen readers and they’ve all flagged the relevanssi ajax search aria instructions to be too lengthy and overwhelming.

    I looked through documentation but didn’t see a way to override this. Is there a hook we could use to change that text?

    Currently this is what it is in the plugin
    'aria_instructions' => __( 'Type search criteria. Please note, when autocomplete results are available use up and down arrows to review and enter to go to the desired page. Touch device users, explore by touch or with swipe gestures.', 'relevanssi-live-ajax-search' ),

    Thanks for any help!

Viewing 3 replies - 1 through 3 (of 3 total)
  • Plugin Author Mikko Saari

    (@msaari)

    There’s no way to modify it with a hook, but it’s internationalized so that you can change it in a translation. I’m not sure, but it may be possible to add an English translation that will change the text.

    Anyway, I can add a hook in the next version. I’m also open to suggestions on improving the existing text for all users. I’m unfamiliar with screen reader use, and this part of the plugin is legacy from the original SearchWP Live Ajax Search I haven’t touched.

    What would be a better text?

    Thread Starter Daniel Schutzsmith

    (@schutzsmith)

    OK, thanks! For now I edited the text in the plugin itself. I’m not sure of the best text but all I know is that testers say it is too long.

    Plugin Author Mikko Saari

    (@msaari)

    Is it possible the problem isn’t the text but how it’s added to the form? I was looking for how to improve the text, and the current text is from the UK government accessibility guidelines (their accessible autocomplete element uses the same text). That would suggest someone has thought about that text.

    However, in the example form, the instructions are not in the aria-label attribute of the input element, but in a separate span element (with a display: none) after the input. I wonder if that would be a better solution; maybe that way, the text wouldn’t be so annoying.

Viewing 3 replies - 1 through 3 (of 3 total)
  • The topic ‘Override Aria Instructions’ is closed to new replies.

Tags