Context Navigation

← Previous Ticket
Next Ticket →

#32860 closed Bug (fixed)

Improve accessibility of permalinks in Django docs

Reported by:	Tim McCurrach	Owned by:	Tim McCurrach
Component:	Documentation	Version:	3.2
Severity:	Normal	Keywords:
Cc:		Triage Stage:	Accepted
Has patch:	yes	Needs documentation:	no
Needs tests:	no	Patch needs improvement:	no
Easy pickings:	no	UI/UX:	no

Description

In the docs generated via make html:

The permalinks are not focusable
This is because they are hidden via visibility:hidden, and hidden elements are not focusable.

This provides a bad experience for people using the keyboard to navigate through the document.

The version of the docs generated for djangoproject.com is slightly better:

It uses opacity:0 to hide them.
This means they are focusable.
Currently they are still not visible when focused though.

This provides a confusing experience for sighted users who prefer keyboard navigation for accessability (or other) reasons. It means that when you 'tab through' the page, the focus seems to 'disappear' before re-appearing some number of tabs later.

I propose we update the CSS in both locations to provide focusable permalinks that are also visible whilst focused.

(I appologise if this is not the correct place to raise issues about djangoproject.com - I wasn't sure. But since it relates to the docs anyway, I figured there would be no harm in doing so.)