Custom Vector theme/skin for GolemWiki, our instance of MediaWiki
Go to file
Nicholas Ray 93745e4800 Add search to sticky header
Per T289724#7342741, server renders an anchor tag pointing to #p-search
into the "button-start" bucket of the sticky header.

In the future after T289718, this anchor will then acts as a button when
the search module is loaded and searchToggle executes.

* skins.vector.search was modified to accomodate instantiating multiple
search components (one in the main header and one in the sticky
header).

* searchToggle.js was modified to accept a searchToggle element as a
param which the caller can then instantiate when ideal. For the sticky
header toggle, this needs to happen *after* the search module loads.
Before then, the toggle will act as a link.

* Drops one jQuery usage from searchToggle so that it can be jQuery
free. Because the native .closest method is used, IE11 support is also
dropped. However, the script feature detects and returns early if the
API isn't available.

* Makes App.vue accept an `id` prop so that multiple instances of it can
be created.

Bug: T289724
Change-Id: I1c5e6eee75918a0d06562d07c31fdcbd5a4ed6d5
2021-09-14 16:58:07 -07:00
.phan Upgrade to newer phan 2019-03-20 19:37:59 -07:00
.storybook [storybook] Document button usage and update broken stories 2021-09-07 21:23:33 +00:00
dev-scripts [Storybook] Add Header component 2021-09-14 18:33:10 +00:00
i18n Localisation updates from https://translatewiki.net. 2021-09-14 08:34:45 +02:00
includes Add search to sticky header 2021-09-14 16:58:07 -07:00
resources Add search to sticky header 2021-09-14 16:58:07 -07:00
screenshots Add skin screenshot for the installer 2017-08-11 15:37:34 -04:00
skinStyles Remove obsolete code for non-supported browsers 2021-09-13 15:24:11 -07:00
stories Add search to sticky header 2021-09-14 16:58:07 -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: Updating stylelint-config-wikimedia to 0.11.1 2021-09-04 17:38:00 +00:00
.svgo.config.js build: Update SVGO to latest v2.2.2 and re-crush SVGs 2021-03-25 09:19:42 -07:00
CODE_OF_CONDUCT.md build: Updating mediawiki/mediawiki-codesniffer to 22.0.0 2018-09-04 01:45:34 +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
README.md Add nvm to README 2020-10-19 18:07:12 +00:00
bundlesize.config.json Spoof aria-expanded for dropdown menus using checkbox hack 2021-09-01 16:12:26 -06:00
composer.json build: Updating composer dependencies 2021-09-10 22:54:21 +00:00
jsdoc.json Add search to sticky header 2021-09-14 16:58:07 -07:00
package-lock.json [storybook] Document button usage and update broken stories 2021-09-07 21:23:33 +00:00
package.json [Storybook] Add Header component 2021-09-14 18:33:10 +00:00
skin.json Add history and talk page icons to sticky header 2021-09-14 12:34:47 -07:00
tsconfig.json [storybook] Document button usage and update broken stories 2021-09-07 21:23:33 +00:00

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

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.