Page MenuHomePhabricator

Unify ReadingLists CSS class names across project
Closed, ResolvedPublic1 Estimated Story Points

Description

Background

We've partly inherited/partly caused a mess in CSS class names for the same feature:
Compare for example reading-list__errorbox vs readinglists-container.
This confusion has also already lead to an error in code by team members: a.reading-list-bookmark.

Goal

For better developer experience, inclusion and internationalization let's settle on one way to name the same cause.
Proposal: reading-lists*
Our own guidelines are verbose on making code readable for the biggest audience, ensuring that non-native speakers immediately now what words are meant, assistive technology can emphasize them correctly and developers can rely on not having to know two ways to name the same thing.
Additionally plural seems most sensitive for a) future plans of developing the feature and b) the name already used in the extension.

Acceptance criteria for done

  • Rename all CSS classes to the chosen unified name
  • Update the Jest tests accordingly

Event Timeline

Change #1190484 had a related patch set uploaded (by VolkerE; author: VolkerE):

[mediawiki/extensions/ReadingLists@master] styles: Unify on a single class name "reading-lists-..."

https://gerrit.wikimedia.org/r/1190484

aude set the point value for this task to 1.Sep 23 2025, 4:40 PM

Change #1190484 merged by jenkins-bot:

[mediawiki/extensions/ReadingLists@master] styles: Unify on a single class name "reading-lists-..."

https://gerrit.wikimedia.org/r/1190484

Need someone to sign this off - perhaps @Jdrewniak or myself?