DEPRECATION: MediaWiki UI modules are to be replaced with Codex CSS components (gadgets)
Closed, ResolvedPublic

Actions

Assigned To

Authored By

	Jdlrobson
	Sep 15 2023, 10:49 PM

Description

NOTE: We are aware that templates use mw-ui-button markup. We are currently clarifying how this will be handled in T355242. There is no need for templates to make any changes at this point in time.

As part of the move to Vue.js and Codex, we are now deprecating the ResourceLoader mediawiki.ui modules that provide styles following the deprecation process in the new frontend stable policy guidelines. To help support this deprecation, we are now recommending that Codex markup is used instead and the styles for Codex markup is now loaded in Minerva and Vector skins. If you have a gadget or user script using mediawiki ui please take action.

Please let us know on this ticket if you have any questions or requests for things that would help you handle this migration or minimize disruption and provide input on what sort of timeline would be helpful.

How can I help?

If impacted please notify your local project's technical discussion forum e.g. technical village pump that this is happening.
Update templates, and any code that makes use of the MediaWiki UI markup / modules.

What's impacted?

Nothing will break at this point in time, but please follow any notices in your JavaScript developer console per developer responsibilities.
To see if you are impacted see this search query: https://global-search.toolforge.org/?q=mw%5C-ui%5C-%28button%7Cinput%7Cicon%7Ccheckbox%7Cradio%29&regex=1&namespaces=&title=.*%5C.js

Migration instructions

A migration guide has been provided at https://www.mediawiki.org/wiki/Codex/Migrating_from_MediaWiki_UI and this is linked to in the developer console.

Related Objects

Mentioned In: T355242: Determine a path forward for mediawiki.ui button styles in wikitext
T353488: mw.ui: button : Undressed in Wikisource main space
T346469: Is codex-search-styles stable for templates to use? What should templates do going forward?
T340263: Deprecate mediawiki.ui.button. Use Codex markup instead.
Mentioned Here: T355242: Determine a path forward for mediawiki.ui button styles in wikitext
T346469: Is codex-search-styles stable for templates to use? What should templates do going forward?

Event Timeline

Jdlrobson created this task.Sep 15 2023, 10:49 PM

Restricted Application added subscribers: Masumrezarock100, Aklapper. · View Herald TranscriptSep 15 2023, 10:49 PM

Jdlrobson moved this task from Announce in next Tech/News to Not ready to announce on the User-notice board.Sep 15 2023, 10:49 PM

Jdlrobson moved this task from Not ready to announce to Announce in next Tech/News on the User-notice board.

Jdlrobson mentioned this in T340263: Deprecate mediawiki.ui.button. Use Codex markup instead..Sep 15 2023, 10:56 PM

Jdlrobson mentioned this in T346469: Is codex-search-styles stable for templates to use? What should templates do going forward?.Sep 15 2023, 11:07 PM

Jdlrobson updated the task description. (Show Details)Sep 15 2023, 11:13 PM

Probably worth waiting for https://phabricator.wikimedia.org/T346469 before making an announcement

Izno subscribed.Sep 16 2023, 6:29 AM

Given that the description asks for templates to be updated, this shouldn’t go out before T346469 is resolved. Or split the notification: make one now about necessary changes to gadgets and user scripts, and another one once templates can also be updated.

Thanks @ tacsipacsi I agree.

I've limited this to gadgets and user scripts for now given the timeline for a decision on T346469.

Quiddity moved this task from Announce in next Tech/News to In current Tech/News draft on the User-notice board.Sep 21 2023, 10:49 PM

I assume modules and templates using the classes are also affected, right?
https://pl.wikipedia.org/w/index.php?search=insource%3A%2Fmw-ui%2F&title=Specjalna:Szukaj&profile=advanced&fulltext=1&ns8=1&ns10=1&ns828=1

provide input on what sort of timeline would be helpful.

Are we talking months or years here? :)

Codex markup is now loaded in Minerva and Vector skins.

What about other skins? Will the classes like cdx-button works for them? I'm not sure what do you mean by markup here.

See previous comments. Templates and modules don’t need to be updated yet, because they can’t. Everything else should load styles explicitly using ResourceLoader, which works on all skins.

Hey @Nux @Tacsipacsi for gadgets you can add @wikimedia/codex or codex-search-styles as a dependency to the gadget definition / mw.loader.using function if you are supporting skins other than Minerva and Vector 2022. If the gadget is a default one I suggest using the latter since it will already be loaded for anonymous users.

My understanding is gadgets can be updated right now. The thing that's not clear is how to migrate templates as templates cannot create markup that is supported by Codex.

Quiddity moved this task from In current Tech/News draft to Already announced/Archive on the User-notice board.Sep 28 2023, 6:07 PM

Samuele2002 subscribed.Nov 19 2023, 11:17 PM

Aklapper mentioned this in T353488: mw.ui: button : Undressed in Wikisource main space.Dec 17 2023, 4:03 AM

CCiufo-WMF updated the task description. (Show Details)Jan 19 2024, 9:24 PM

CCiufo-WMF mentioned this in T355242: Determine a path forward for mediawiki.ui button styles in wikitext.Jan 24 2024, 2:55 PM

Any reason this task is still open?

@Quiddity perhaps User-notice should have a herald rule that automatically archives tickets after they've been open for 3 months?

@Jdlrobson Great minds think alike! There is a bot for this, thanks to ladsgroup in Aug 2022! But it relies on the task being resolved. Copying from the description of https://phabricator.wikimedia.org/project/profile/1097/

User-notice-archive is an archive for User-notice to avoid the project getting extremely bloated and unloadable. A bot moves resolved tasks in "Already announced/Archive" column of User-notice, into the -archive, if they are not modified in the past ten days.

(Herald rules do not support such time-based activities)

Maintenance_bot edited projects, added User-notice-archive; removed User-notice.Thu, May 23, 7:31 PM

DEPRECATION: MediaWiki UI modules are to be replaced with Codex CSS components (gadgets) Closed, ResolvedPublic Actions