80a111d0e4
We want the link that the user has clicked inside the TOC to be "active" (e.g. bolded) regardless of whether the browser's scroll position corresponds to that section. Therefore, we need to temporarily ignore section observer until the browser has finished scrolling to the section (if needed). However, because the scroll event happens asyncronously after the user clicks on a link and may not even happen at all (e.g. the user has scrolled all the way to the bottom and clicks a section that is already in the viewport), determining when we should resume section observer is a bit tricky. Because a scroll event may not even be triggered after clicking the link, we instead allow the browser to perform a maximum number of repaints before resuming sectionObserver. Per T297614#7687656, Firefox wasn't consistently activating the table of contents section that the user clicked even after waiting 2 frames. After further investigation, it sometimes waits up to 3 frames before painting the new scroll position so we have that as the limit. Bug: T297614 Change-Id: If3632529f58c15348a7200258f4f5999ea0dadc4 |
||
---|---|---|
.phan | ||
.storybook | ||
dev-scripts | ||
i18n | ||
includes | ||
resources | ||
screenshots | ||
skinStyles | ||
stories | ||
tests | ||
.eslintignore | ||
.eslintrc.json | ||
.gitignore | ||
.gitreview | ||
.nvmrc | ||
.phpcs.xml | ||
.stylelintignore | ||
.stylelintrc.json | ||
.svgo.config.js | ||
CODE_OF_CONDUCT.md | ||
COPYING | ||
Doxyfile | ||
README.md | ||
bundlesize.config.json | ||
composer.json | ||
jest.config.js | ||
jest.setup.js | ||
jsdoc.json | ||
package-lock.json | ||
package.json | ||
skin.json | ||
tsconfig.json |
README.md
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
useskinversion
: Likeuseskin
but for overriding the Vector skin version user preference and configuration. E.g., http://localhost:8181?useskin=vector&useskinversion=2.
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.