Go to file
bwang 687c6a50d8 Improve heading structure and heading semantics by removing redundant headings and labels for modern Vector
- Apply aria-hidden to h3 in Menu template, ensuring the nav landmarks are still properly labeled, but no longer reading duplicate labels to screenreaders
- Remove "Navigation menu" h2 element, which is not needed as the nav landmarks are already labeled
- Remove searchbox h3 element, which is redundant with the search landmark
- Scope all changes to modern vector

Bug: T265993
Change-Id: I4e5da7a0699160fa57234bd126b75243e0157778
2021-09-14 10:47:05 -05:00
.phan Upgrade to newer phan 2019-03-20 19:37:59 -07:00
.storybook Update UserLinks and SearchBox storybook stories to match prod 2021-08-05 10:08:31 -05:00
dev-scripts Improve readability of anon user menu for screenreaders 2021-08-26 12:58:10 -05:00
i18n Localisation updates from https://translatewiki.net. 2021-09-03 08:16:26 +02:00
includes Improve heading structure and heading semantics by removing redundant headings and labels for modern Vector 2021-09-14 10:47:05 -05:00
resources Improve heading structure and heading semantics by removing redundant headings and labels for modern Vector 2021-09-14 10:47:05 -05:00
screenshots Add skin screenshot for the installer 2017-08-11 15:37:34 -04:00
skinStyles Update ULS button states to be consistent with other quiet buttons 2021-08-31 10:59:59 -05:00
stories Build the sticky header skeleton 2021-09-01 12:32:31 -07:00
tests Simplify how we generate icons and button classes in Vector 2021-09-03 19:25:31 +00:00
.eslintignore Replace Grunt tasks with npm scripts in package.json 2020-02-27 16:32:12 +01:00
.eslintrc.json ESLint: remove redundant disable of one-var rule 2021-07-17 01:38:26 +00:00
.gitignore [Storybook] Fix PNG/SVG asset resolution. 2020-09-25 12:52:05 +02:00
.gitreview Use track=1 instead of defaultbranch=master in .gitreview 2016-10-24 17:30:32 -07:00
.nvmrc .nvmrc: Update to Node 12.21.0 as CI has migrated 2021-06-04 14:45:10 -07:00
.phpcs.xml build: Updating mediawiki/mediawiki-codesniffer to 33.0.0 2020-11-17 23:33:50 +01:00
.stylelintignore Replace Grunt tasks with npm scripts in package.json 2020-02-27 16:32:12 +01:00
.stylelintrc.json build: Bump devDependencies to latest 2018-02-26 10:29:23 -08:00
.svgo.config.js build: Update SVGO to latest v2.2.2 and re-crush SVGs 2021-03-25 09:19:42 -07:00
bundlesize.config.json Spoof aria-expanded for dropdown menus using checkbox hack 2021-09-01 16:12:26 -06:00
CODE_OF_CONDUCT.md build: Updating mediawiki/mediawiki-codesniffer to 22.0.0 2018-09-04 01:45:34 +00:00
composer.json build: Updating dependencies 2021-07-24 01:35:45 +00:00
COPYING Use the plain-text GPL and fix 'license-name' to match SPDX conventions 2015-01-29 17:04:29 +01:00
Doxyfile docs: Generate documentation with Doxygen 2020-02-24 16:49:38 +00:00
jsdoc.json Integrate WVUI search into Vector 2020-12-08 13:27:12 -08:00
package-lock.json build: Updating npm dependencies 2021-08-25 14:46:31 +00:00
package.json Use centralized MediaWiki typescript definition 2021-07-26 21:27:12 +00:00
README.md Add nvm to README 2020-10-19 18:07:12 +00:00
skin.json Add userGroup to skins.vector.icons 2021-09-03 14:37:29 +02:00
tsconfig.json build: Updating eslint-config-wikimedia to 0.19.0 2021-03-15 04:57:07 +00:00

Vector Skin

Installation

See https://www.mediawiki.org/wiki/Skin:Vector.

Configuration options

See skin.json.

Development

Node version

It is recommended to use nvm to use the version of node defined in .nvmrc during local development. This ensures consistency amongst development environments.

Coding conventions

We strive for compliance with MediaWiki conventions:

https://www.mediawiki.org/wiki/Manual:Coding_conventions

Additions and deviations from those conventions that are more tailored to this project are noted at:

https://www.mediawiki.org/wiki/Reading/Web/Coding_conventions

URL query parameters

Skin preferences

Vector defines skin-specific user preferences. These are exposed on Special:Preferences when the VectorShowSkinPreferences configuration is enabled. The user's preference state for skin preferences is used for skin previews and any other operation unless specified otherwise.

Version

Vector defines a "version" preference to enable users who prefer the December 2019 version of Vector to continue to do so without any visible changes. This version is called "Legacy Vector." The related preference defaults are configurable via the configurations prefixed with VectorDefaultSkinVersion. Version preference and configuration may be overridden by the useskinversion URL query parameter.

Pre-commit tests

A pre-commit hook is installed when executing npm install. By default, it runs npm test which is useful for automatically validating everything that can be in a reasonable amount of time. If you wish to defer these tests to be executed by continuous integration only, set the PRE_COMMIT environment variable to 0:

$ export PRE_COMMIT=0
$ git commit

Or more succinctly:

$ PRE_COMMIT=0 git commit

Skipping the pre-commit tests has no impact on Gerrit change identifier hooks.

Hooks

See hooks.txt.