Skip to content

a11y reading options bar#5340

Draft
StephDriver wants to merge 42 commits into
r-v1.9.xfrom
b-5337-a11y-user-text-format
Draft

a11y reading options bar#5340
StephDriver wants to merge 42 commits into
r-v1.9.xfrom
b-5337-a11y-user-text-format

Conversation

@StephDriver

Copy link
Copy Markdown
Member

closes #5337

@StephDriver StephDriver changed the base branch from master to r-v1.9.x June 9, 2026 15:30
@StephDriver

StephDriver commented Jun 9, 2026

Copy link
Copy Markdown
Member Author

This is effectively a 'focused reading' styling

  • basic functionality
    • article pages
    • news items
    • cms pages
    • preprints
    • accessibility information page
  • make persistent (as per a11y-mode as a model)
  • theme by theme visual styling tweaks
  • screen reader testing and updates

Extras:

  • preprint OLH theme bug that didn't display preprint html (but material version did) - one line fix included.

@StephDriver StephDriver self-assigned this Jun 16, 2026
@StephDriver

StephDriver commented Jun 16, 2026

Copy link
Copy Markdown
Member Author

Limitations / Future Development.

  • Initially I introduced options for custom colours, but making the colour pickers accessible to both keyboard and screen-reader users across all three themes became a major piece of work which is out of scope for this issue. So I have left the code side of the customisation for use in future, but it is just not wired up to the templates. Note - the custom colour pickers work fine by mouse. see 3f070e9

  • This has been created as a generic feature, which could be added to any page, however the targets on each page need to be set individually. So for this first version I have focused on areas of high text content (article, preprint, CMS, news item).

  • Material reading bar is not fully screen-reader accessible. But it is as accessible as the Material Nav - the limitation is Material itself. The state of items in the reading bar is announced, but the drop-downs do not have a menu popup collapsed or menu popup expanded state announced to user. This is the same as with the Material Nav.

@StephDriver StephDriver force-pushed the b-5337-a11y-user-text-format branch from 64d0182 to 9147cc4 Compare June 22, 2026 12:02
@StephDriver

Copy link
Copy Markdown
Member Author

Screenshots

Non-article pages

image

Article pages

Also include the draw-attention animation toggle, cite, email and print options, depending on settings. And material doesn't have the cite modals.

image

Pre-set colours and fonts

I've created a doc to describe how to amend the fonts and colours, they are kept in src/core/text_formats.py for easy editing. Also see note about custom colours above.

image image

Toggles

I've copied the Italics toggle from the previous dyslexia mode, and added one for dark mode which swaps the foreground and background of the current text colours, and one for the draw attention highlighting which is a way to suppress the animation on using an internal page link that briefly draws attention by highlighting the landing element.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Extend dyslexia mode to more reading text format options

1 participant