Codex/pt

Projetos da Função Wikimédia Codex Sistema de desenho para a Wikimédia com linhas diretrizes e um conjunto de ferramentas (códigos de desenho, componentes, e ícones) para criar interfaces do utilizador Grupo: Codex Steering Committee Membros da equipa: Derek Torsani, Roan Kattouw, Jan Drewniak Trabalho em atraso: #codex Atualizações: CHANGELOG.md

Codex é o sistema de desenho oficial para a Wikimedia . Este fornece um conjunto unificado de ferramentas, linhas diretrizes, e componentes para ajudar os programadores e desenhadores a criarem interfaces do utilizador consistentes, acessíveis e localizadas nos projetos da Wikimédia.

Codex enables contributors to use standardized UI components built with Vue.js or plain CSS —such as buttons, menus, dialogs, and icons. It ensures a consistent look and behavior for our products, so that they align with the visual style and functionality standards of Wikimedia. It supports both developers and designers in creating user-friendly and maintainable interfaces.

Visite o site da documentação oficial para detalhes completos do Codex, incluindo como o utilizar fora do MediaWiki.

Codex é o sistema recomendado de desenho da interface do utilizador, e foi incorporado no MediaWiki desde MediaWiki 1.39 . It is also available as a set of npm packages. The system is collaboratively developed by the Wikimedia Foundation , Wikimedia Deutschland, and volunteer contributors.

Codex's source code is hosted on Gerrit, and its development is tracked in Phabricator. Visit the full changelog and join our Contributor Telegram group to get involved.

Utilização básica

Codex provides a variety of components which skin, extension, and userscript authors can embed in their own user interfaces: buttons, checkboxes, toggle switches, dialogs, etc. Many of these components can be extensively customized.

 See the full list of Codex components (along with documentation and interactive demos).

CodexExample MediaWiki extension

The Codex/Steering Committee maintains the CodexExample MediaWiki extension that demonstrates how to use design tokens, components, and icons from Codex. This extension can be installed (it sets up a dedicated special page called Special:CodexExample with live demos), or you can study its source code for inspiration. See the project README.md page for more information on installation and use.

Usage with JavaScript

For improved page load performance, limit loading to a subset of Codex components for skins and extensions . See #Using a limited subset of components

Codex components are built using the Vue.js JavaScript framework. If you are developing a Vue application in MediaWiki, then it's easy to load Codex components from ResourceLoader using require(). You can load all of Codex at once, or just a limited subset of components.

Loading the entire library (recommended for use in userscripts)

"ext.myExtension.foo": {
	"dependencies": [ "@wikimedia/codex" ]
	"packageFiles": [
		"init.js",
		"MyComponent.vue"
	]
}

<!-- MyComponent.vue -->
<template>
	<cdx-button @click="doSomething">Clique-me!</cdx-button>
</template>

<script>
const { CdxButton } = require( '@wikimedia/codex' );

module.exports = exports = {
    name: "MyComponent",
    components: {
        CdxButton
    },
    methods: {
        doSomething() {
            //...
        }
    }
}
</script>

Loading a subset of Codex components (recommended for skins and extensions)

Declare the dependencies to only load a limited set of components; see section on advanced usage.

Utilizar sem o JavaScript (Componentes Codex apenas CSS)

Versão MediaWiki:

≥ 1.42

Many Codex components also support "CSS-only" usage. These components should appear visually identical to their JS-enabled counterparts, but they will offer more limited behavior.

Loading component styles

You can load the styles of a limited subset of Codex CSS components in the same way as you would for JS components, above. If you only need the styles, you can add the "codexStyleOnly": "true" option when you define your module.

"ext.myExtension.foo": {
	"class": "MediaWiki\\ResourceLoader\\CodexModule",
	"styles": "ext.myExtension.foo/styles.less",
	"codexStyleOnly": "true",
	"codexComponents": [
		"CdxButton",
		"CdxCard",
		"CdxCheckbox",
		"CdxProgressBar"
	]
}

Providing component markup

To use CSS-only Codex components, just ensure that the appropriate styles are loaded and then add the necessary markup to your page. For now, you'll have to do this by hand. You can find example markup in the "CSS-only usage" section on a component's documentation page (here is the markup for the Button component).

<div>
	<button class="cdx-button cdx-button--action-default">
		Botão predefinido
	</button>
</div>
<div>
	<button class="cdx-button cdx-button--action-progressive">
		Botão progressivo
	</button>
</div>
<div>
	<button class="cdx-button cdx-button--action-destructive">
		Botão destrutivo
	</button>
</div>

Using Codex in PHP

Codex PHP is still under development and is not yet recommended for wide-spread use in MediaWiki core (T399523). Breaking changes may be introduced until a stable version is released.

Codex PHP is a library for building CSS-only UI components using Codex, the Wikimedia design system, please see the Codex PHP documentation.

Installation

Install the Codex PHP library via Composer :

composer require wikimedia/codex

Example usage

Here’s an example of creating an Accordion component in PHP:

$accordion = $codex
			->accordion()
			->setTitle( "Exemplo de Acordeão" )
			->setDescription( "Este é um exemplo de um acordeão." )
			->setContentHtml(
				$codex
					->htmlSnippet()
					->setContent( "<p>Este é o conteúdo do acordeão.</p>" )
					->build()
			)
			->setOpen( false )
			->setAttributes( [
				"class" => "foo",
				"bar" => "baz",
			] )
			->build()
			->getHtml();

echo $accordion;

Advanced usage

Using a limited subset of components

Prioritize page load performance by using ResourceLoader to load only the necessary Codex components whenever possible.

The @wikimedia/codex ResourceLoader module provides the entire Codex library – all components, styles, etc. If you are developing a skin or an extension and you care about performance, you should consider using Codex's code-splitting feature. ResourceLoader allows you to specify a list of Codex components and load only the JS/CSS for those components plus their dependencies by help of CodexModule class.

Registering many modules is highly discouraged, even if they are not loaded by default. The addition of each module adds 44 bytes to every initial page load, so about 40 GiB of extra transfer to Wikimedia servers per day.

—ResourceLoader

To use this feature, define a custom ResourceLoader module (this is typically done in skin.json or extension.json) and specify a list of codexComponents:

"ext.myExtension.blockform": {
    "class": "MediaWiki\\ResourceLoader\\CodexModule",
    "codexComponents": [
        "CdxButton",
        "CdxCard",
        "CdxDialog",
        "CdxIcon",
        "CdxRadio",
        "CdxTextInput",
        "useModelWrapper"
    ],
    "packageFiles": [
        "init.js",
        "BlockForm.vue"
    ],
    "messages": [
		"block-target",
		"ipb-submit"
	]
}

This will generate a virtual file, codex.js, in your resources directory with the exports you need. You can then require the components and composables you requested from that virtual file:

// In resources/ext.myExtension/BlockForm.vue
const { CdxButton, CdxTextInput } = require( '../codex.js' );

If you only need CSS-only components and don't wish to load the component JavaScript, you can add "codexStyleOnly": true to the module definition.

Similarly, if you only need the JavaScript files and not styles, you can add "codexScriptOnly": "true". You should only do this if you're putting the styles in another, style-only module as described above.

See the CodexExample repository for more in-depth example of how to use Codex in a MediaWiki extension.

Utilizar ícones do Codex

For performance reasons, there is no ResourceLoader module named codex-icons containing all the icons from Codex. Such a module would be large and wasteful, since most users of Codex only need a handful of the 200+ icons. Instead, ResourceLoader provides a way for modules to embed the icons they need, similar to the code-splitting approach described above.

{
    "name": "icons.json",
    "callback": "MediaWiki\\ResourceLoader\\CodexModule::getIcons",
    "callbackParam": [
        // List the icons your module needs here, e.g.:
        "cdxIconArrowNext",
        "cdxIconBold",
        "cdxIconTrash"
    ]
}

Consulte também:

• lista de todos os ícones (nome e variantes)
• utilizar ícones em Vue

Utilizar códigos de desenho diretamente

Design tokens can be imported into Less stylesheets as variables. This may be useful if you are developing your own components or styles, and want them to integrate with Codex.

Codex design tokens should be imported from the mediawiki.skin.variables.less file.

@import 'mediawiki.skin.variables.less';

.my-feature {
    background-color: @background-color-base;
    color: @color-base;
}

See the full list of Codex's design tokens, broken down by category.

Codex Less mixins

Some Codex functionality is implemented using Less mixins. For example, the Link component is a Less mixin rather than a Vue component, and using icons in CSS-only components requires using a Less mixin (see also the documentation for using CSS-only components).

Using Codex Less mixins in MediaWiki and extensions works very similarly to using design tokens: simply import mediawiki.skin.variables.less, which makes all Codex mixins available, as well as the design tokens.

@import 'mediawiki.skin.variables.less';

.my-feature {
    a {
        .cdx-mixin-link-base();
    }
}

Utilizar Codex em scripts do utilizador

It is possible to use Codex in userscripts. However, there are some limitations that will require certain workarounds. Here are a few considerations to keep in mind when using Vue and Codex in userscripts:

• No .vue single-file component support; you must define components in plain .js files
• Everything needs to live in one file; userscripts don't provide a good way to load custom modules
• Define component templates using ES6 template literals
• Prefer global component registration for Codex components

Carregar Vue/Codex

You'll need to load Vue and Codex from ResourceLoader. The best way to do this is via mw.loader.using; the rest of your userscript code should live in a callback or promise chain.

mw.loader.using( '@wikimedia/codex' ).then( function( require ) {
    const Vue = require( 'vue' );
    const Codex = require( '@wikimedia/codex' );
} );

Utilizar Vue.createMwApp

Once you've loaded Vue and Codex, you must define a Vue app and mount it somewhere on the page. The exact location will vary depending on what you are trying to do. You can use MediaWiki's custom createMwApp method for this.

mw.loader.using( '@wikimedia/codex' ).then( function( require ) {
	//... require Vue and Codex as above.
	// Create an element to mount the Vue app.
	const mountPoint = document.body.appendChild( document.createElement( 'div' ) );
	// Create a Vue app and mount it to the target element.
	Vue.createMwApp( {
		// data, computed props, methods, etc. go here.
	} ).mount( mountPoint );
} );

Exemplos reais

The link below shows a complete example of a userscript which adds a portlet link to all Wiki pages that triggers a custom Codex Dialog component to launch when clicked. Feel free to copy this script to your own user page to use as a starting point.

https://en.wikipedia.org/wiki/User:EGardner_(WMF)/codex-hello-world.js

Here is another script using Codex :

https://en.wikipedia.org/wiki/User:JSherman_(WMF)/revertrisk.js

Release cycle

New versions of Codex are released ad hoc as needed, not on a specific schedule. When a new release is created, a patch is also submitted to MediaWiki core to use that new release. Since this is typically done on Tuesdays, the update to core will be deployed the following week (the next time the deployment train runs).

Using a custom version of Codex for development or testing

MediaWiki uses the latest release of Codex. If you need to use a different version for development or testing purposes, for example to test how an unmerged patch in Codex interacts with MediaWiki, you can point MediaWiki to your own version of Codex as follows:

1. Clone the Codex repository (if you haven't already), and check out the change you want to test.
2. Run npm install and npm run build-all in the root directory of the Codex repository.
3. Point $wgCodexDevelopmentDir to the root directory of the Codex repository. For example, if you cloned the Codex repository in the parent directory of the MediaWiki directory, add $wgCodexDevelopmentDir = MW_INSTALL_PATH . '../codex'; to LocalSettings.php
4. Test that it works by running mw.loader.load( '@wikimedia/codex' ) in the browser console. This should trigger a warning saying "You are using a local development version of Codex", and should not trigger any errors.

Once you have this set up, you can make additional changes to your Codex clone, but you have to run npm run build-all each time to make those changes take effect in MediaWiki.

To disable development mode and go back to using the latest release of Codex, comment out the line in LocalSettings.php that sets $wgCodexDevelopmentDir.