Help:Including additional CSS and JS

This help page will explain the recommended ways to include additional CSS and JavaScript on your community.

ImportJS

MediaWiki:ImportJS provides an interface for including articles that contain scripts - both local and from Dev Wiki - on a community.

The wiki does not need custom JS enabled for ImportJS to work.

Usage

MediaWiki:ImportJS provides a plain text article in which to specify JavaScript article names. All local files and Dev Wiki imports must be in the MediaWiki namespace to work. When stating files to import, the MediaWiki namespace should not be included in the name. The system attempts to load each line, ignoring invalid titles. Thus you can achieve comments by prefixing a line with //, or #, or any other invalid title character. Example:

//local JS file, located at "MediaWiki:Cat.js"
Cat.js

// Dev Wiki script, located at "MediaWiki:UploadMultipleFiles.js"
dev:UploadMultipleFiles.js

JavaScript review: The ImportJS feature of the Content Review extension bypasses the need for the JavaScript review process, allowing the immediate addition or removal of a community's JavaScript imports.

The functionality of ImportJS is similar to this of importArticles, which can import several articles from local and external communities, bundling them into one network request and minifying them. Both importArticles and ImportJS reduce file size and web traffic, effectively making a community with a large number of additional files load much more quickly.

Load order

When using ImportJS, the pages within will be loaded last. The full load order is:

1. Common.js
2. Fandomdesktop.js
3. Imported scripts through Common.js
4. Imported scripts through Fandomdesktop.js
5. ImportJS

CSS imports

@import method

Using the @import, styles can be imported from any CSS file hosted on a wiki or on other websites (ending with .css on the url and contains changes for the default skin elements on the file). The syntax is as follows:

@import "path_to_file_to_import.css"

Per the above example, to import Local.css into Common.css, place this at the top of your Common.css file (it must be before any other rules):

@import "/load.php?articles=MediaWiki:Local.css&only=styles&mode=articles";

For a non-English wiki, include the language path at the start of the URL:

@import "/de/load.php?articles=MediaWiki:Local.css&only=styles&mode=articles";

An alternative way, which will make it easier to spot files loaded in the "Network" tab of your browser's "Web Developer" tool is to use:

@import url("/MediaWiki:Local.css?ctype=text/css&action=raw");

You can read more on this method here.

importArticles

In lieu of the above method, importArticles will only be discussed here in regards to CSS imports. For JS imports, please see this page.

importArticles can still be used to import CSS styles. However, they will be subject to JS review since it has to be done through JavaScript. Additionally, loading CSS in this way creates a flicker effect as the CSS is applied after the page is initially displayed. For best results, use the @import method.

Example

Importing a local CSS file through importArticles:

importArticles({
    type: "style",
    article: "MediaWiki:Local.css"
});

See also

• Help:Including additional CSS and JS/technical
• Help:CSS and JS customization
• Help:Advanced CSS and JS
• Help:CSS and JS pages

Further help and feedback

• Browse and search other help pages at Help:Contents
• Check Fandom Community Central for sources of further help and support
• Check Contacting Fandom for how to report any errors or unclear steps in this article