Vue.js/Guidelines

Get Vue.js from ResourceLoader
Developers should rely on the version of Vue that is already provided via ResourceLoader rather than bundling or vendoring their own copy of the library. Currently MW ships Vue 3 with the Compatibility Build included.

Developers of skins or extensions which list "vue" as a dependency in  or   can require the library as they would any other RL module.

Developers of gadgets, or of any feature where Vue is to be loaded conditionally, can load the Vue module on the client-side:

Use single-file components
MediaWiki supports Vue single-file components (aka  files) within any ResourceLoader module that is using the packageFiles feature. However, MediaWiki's support for single-file components (SFCs) is incomplete, and has the following limitations:

Files/tags: Scripts: Stylesheets/styles:
 * files are only supported in package modules (modules that use )
 * Self-closing tags for components (e.g. ) are not supported. Instead, you have to use open and close tags (e.g.  ).
 * Component tags using PascalCase (e.g. ) are not supported. Instead, you have to use kebab-case for component names (e.g.  ).
 * is not supported.
 * Pre-processors, such as  or   (TypeScript) are not supported.
 * Src Imports are not supported (but support for this feature could potentially be added, if developers find it useful).
 * ES6  and   are not supported. Instead of , use  ; instead of   use  . Other ES6 syntax is supported.
 * ES2016 and newer syntax is not supported. Notable examples of unsupported syntax include the spread operator in object literals, / , and  /.
 * Advanced style features, such as,  , and   in styles are not supported.
 * Unlike TypeScript, Less preprocessor via  is supported.
 * Less styles are processed using MediaWiki's Less processor, which uses an old version of Less! This means, though, that all the features supported in other Less files in MediaWiki are supported here too.
 * To access Codex design tokens and mixins inside Vue files, import MediaWiki skin variables  at the beginning of your style section.

If you try to use an unsupported SFC feature, ResourceLoader will throw an error at runtime. Unsupported JS or template syntax results in a lint error, so make sure you set up linting for your code to catch these, as well as other pitfalls and style guideline violations.

Initialise with
To mount your component to the DOM, use. This function works the same as, but adds shared MediaWiki-specific plugins for internationalisation and error logging. The code mounting your component should be in a simple init file that requires the top-level component (plus any stores and plugins) and mounts it to a placeholder div. Other logic and UI code should live in other files (for example, the top-level component) as much as possible. Conventionally, the top-level component file is called  and the init file is called , unless there are multiple entry points that each have their own top-level component.

A simple example of an init file would look like this:

A more complex init file that uses a custom plugin and a Pinia store would look like this:

Write Vue3-compatible code
MediaWiki uses the compatibility build of Vue 3. This means that Vue will try to provide compatibility with Vue 2 code by default, which breaks certain Vue 3 features (in particular  on components, and setting attributes to  ). To avoid this breakage, all new code written for Vue 3 (and old code that has been fully migrated to Vue 3) must set  and   in the component definition of every component, like this:

Once all old code written for Vue 2 has been migrated to Vue 3, MediaWiki will migrate to the non-compatibility build of Vue 3. Once that has happened, these compatConfig settings will no longer be necessary.

Don't rely on build tools or server-side rendering
In the wider Vue.js community, developers make frequent use of Node.js build tools like Vite, Rollup, Nuxt.js, etc. MediaWiki is a PHP application, and currently no Node.js service is available for use in production in WMF projects. For the time being, developers working with Vue in MediaWiki must limit themselves to client-side functionality only. The Design Systems Team is currently exploring ways to support a front-end build step or server-side component rendering, but this remains experimental.

Use Pinia for state management
Pinia is available in MediaWiki. Pinia is the new official state management library for use with Vue 3 and successor to Vuex 4. Pinia is recommended for new projects; for existing Vuex-based projects, MediaWiki also makes Vuex 4 available. See also the guide for Vuex to Pinia migrations.

Follow MediaWiki coding conventions
See MediaWiki's Vue coding conventions, which are largely based on the official Vue Style Guide. We use ESLint to enforce these conventions; see here for how to set up ESLint in your repository.