Page MenuHomePhabricator
Create Task
Maniphest T317162

Add a class to the <html> element with the current Codex version
Open, Needs TriagePublic
Actions

Description

As we were figuring out how to handle T312594, which required style changes in both Codex and Vector, @Jdlrobson suggested we add a class to the <html> element specific to the current version of Codex (e.g. codex-v-[version]). That way, applications could write styles that target a specific version, avoiding breaking changes like the ones introduced in this particular case.

We'd like to explore this idea, and implement the solution inside MediaWiki if possible. The codex package could export a VERSION variable, and MediaWIki could grab that version number and add the CSS class.

Related Objects

Event Timeline

AnneT created this task.Sep 6 2022, 8:39 PM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptSep 6 2022, 8:39 PM
AnneT mentioned this in T315588: [EPIC] Make it easier to use Codex, improve designer and developer experience.Sep 6 2022, 8:41 PM
ldelench_wmf added a parent task: T315588: [EPIC] Make it easier to use Codex, improve designer and developer experience.Sep 15 2022, 5:51 PM
Volker_E subscribed.Sep 20 2022, 7:17 AM

I'm not the biggest fan of this idea. Caching issues are problematic, but further polluting the root classes doesn't sound like the best way forward to me. Imagine we gonna end up with version classes of every library or extension.
Current state is horrifying to me from dev experience to orient what's going on:

image.png (194×2 px, 93 KB)

and Vector 2022:
image.png (190×2 px, 98 KB)

Jdlrobson added a comment.Sep 21 2022, 6:06 PM

Current state is horrifying to me from dev experience to orient what's going on:

The issue is we have too many features flags/preferences, but this seems off-topic (we're working on reducing these by shipping features).

I'm not the biggest fan of this idea. Caching issues are problematic, but further polluting the root classes doesn't sound like the best way forward to me

What would you suggest instead? Perhaps Codex elements themselves could be versioned somehow? It's not just about caching it's about risk. As we swap out incompatible Codex versions we risk UI regressions without a better strategy for clients e.g. Vector using server side rendering to manage the transition from one version to another.

ldelench_wmf triaged this task as Medium priority.Sep 22 2022, 9:13 PM
ldelench_wmf moved this task from Inbox to Needs Refinement on the Design-System-Team board.
ldelench_wmf removed a parent task: T315588: [EPIC] Make it easier to use Codex, improve designer and developer experience.Feb 17 2023, 11:46 PM
ldelench_wmf moved this task from Inbox to Codex Adoption on the Codex board.
egardner raised the priority of this task from Medium to Needs Triage.Oct 2 2023, 9:15 PM
egardner moved this task from Needs Refinement to Backlog on the Design-System-Team board.
Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL