mirror of
https://gerrit.wikimedia.org/r/mediawiki/skins/Vector.git
synced 2024-11-24 07:43:47 +00:00
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
502 lines
15 KiB
JSON
502 lines
15 KiB
JSON
{
|
|
"name": "Vector",
|
|
"version": "1.0.0",
|
|
"author": [
|
|
"[https://www.mediawiki.org/wiki/Reading/Web/Team Readers Web Team]",
|
|
"Trevor Parscal",
|
|
"Roan Kattouw",
|
|
"Alex Hollender",
|
|
"Bernard Wang",
|
|
"Clare Ming",
|
|
"Jan Drewniak",
|
|
"Jon Robson",
|
|
"Nick Ray",
|
|
"Sam Smith",
|
|
"Stephen Niedzielski",
|
|
"Volker E."
|
|
],
|
|
"url": "https://www.mediawiki.org/wiki/Skin:Vector",
|
|
"descriptionmsg": "vector-skin-desc",
|
|
"namemsg": "skinname-vector",
|
|
"license-name": "GPL-2.0-or-later",
|
|
"type": "skin",
|
|
"requires": {
|
|
"MediaWiki": ">= 1.38.0"
|
|
},
|
|
"ValidSkinNames": {
|
|
"vector-2022": {
|
|
"class": "SkinVector22",
|
|
"args": [
|
|
{
|
|
"name": "vector-2022",
|
|
"templateDirectory": "includes/templates",
|
|
"responsive": true,
|
|
"link": {
|
|
"text-wrapper": {
|
|
"tag": "span"
|
|
}
|
|
},
|
|
"bodyClasses": [
|
|
"skin-vector",
|
|
"skin-vector-search-vue"
|
|
],
|
|
"messages": [
|
|
"tooltip-p-logo",
|
|
"vector-opt-out-tooltip",
|
|
"vector-opt-out",
|
|
"vector-action-toggle-sidebar",
|
|
"vector-main-menu-tooltip",
|
|
"vector-menu-checkbox-expanded",
|
|
"vector-menu-checkbox-collapsed",
|
|
"vector-jumptosearch",
|
|
"vector-jumptocontent",
|
|
"search",
|
|
"searchbutton",
|
|
"searcharticle",
|
|
"searchsuggest-search",
|
|
"sitesubtitle",
|
|
"sitetitle",
|
|
"tagline"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"vector": {
|
|
"class": "SkinVector",
|
|
"@args": "See SkinVector::__construct for more detail.",
|
|
"args": [
|
|
{
|
|
"name": "vector",
|
|
"templateDirectory": "includes/templates",
|
|
"responsive": true,
|
|
"link": {
|
|
"text-wrapper": {
|
|
"tag": "span"
|
|
}
|
|
},
|
|
"messages": [
|
|
"tooltip-p-logo",
|
|
"vector-opt-out-tooltip",
|
|
"vector-opt-out",
|
|
"navigation-heading",
|
|
"vector-action-toggle-sidebar",
|
|
"vector-main-menu-tooltip",
|
|
"vector-menu-checkbox-expanded",
|
|
"vector-menu-checkbox-collapsed",
|
|
"vector-jumptonavigation",
|
|
"vector-jumptosearch",
|
|
"vector-jumptocontent",
|
|
"search",
|
|
"searchbutton",
|
|
"searcharticle",
|
|
"searchsuggest-search",
|
|
"sitesubtitle",
|
|
"sitetitle",
|
|
"tagline"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"SkinLessImportPaths": {
|
|
"vector-2022": "resources/mediawiki.less",
|
|
"vector": "resources/mediawiki.less"
|
|
},
|
|
"MessagesDirs": {
|
|
"Vector": [
|
|
"i18n"
|
|
]
|
|
},
|
|
"AutoloadClasses": {
|
|
"SkinVector": "includes/SkinVector.php",
|
|
"SkinVectorLegacy": "includes/SkinVectorLegacy.php",
|
|
"SkinVector22": "includes/SkinVector22.php"
|
|
},
|
|
"AutoloadNamespaces": {
|
|
"Vector\\": "includes/"
|
|
},
|
|
"ConfigRegistry": {
|
|
"vector": "GlobalVarConfig::newInstance"
|
|
},
|
|
"Hooks": {
|
|
"ResourceLoaderSiteModulePages": "Vector\\Hooks::onResourceLoaderSiteModulePages",
|
|
"ResourceLoaderSiteStylesModulePages": "Vector\\Hooks::onResourceLoaderSiteStylesModulePages",
|
|
"SkinPageReadyConfig": "Vector\\Hooks::onSkinPageReadyConfig",
|
|
"GetPreferences": "Vector\\Hooks::onGetPreferences",
|
|
"PreferencesFormPreSave": "Vector\\Hooks::onPreferencesFormPreSave",
|
|
"LocalUserCreated": "Vector\\Hooks::onLocalUserCreated",
|
|
"OutputPageBodyAttributes": "Vector\\Hooks::onOutputPageBodyAttributes",
|
|
"MakeGlobalVariablesScript": "Vector\\Hooks::onMakeGlobalVariablesScript"
|
|
},
|
|
"@note": "When modifying skins.vector.styles definition, make sure the installer still works",
|
|
"ResourceModules": {
|
|
"skins.vector.user": {
|
|
"class": "Vector\\ResourceLoader\\VectorResourceLoaderUserModule"
|
|
},
|
|
"skins.vector.user.styles": {
|
|
"class": "Vector\\ResourceLoader\\VectorResourceLoaderUserStylesModule"
|
|
},
|
|
"skins.vector.search": {
|
|
"dependencies": [
|
|
"mediawiki.Uri",
|
|
"wvui-search"
|
|
],
|
|
"packageFiles": [
|
|
"resources/skins.vector.search/skins.vector.search.js",
|
|
"resources/skins.vector.search/instrumentation.js",
|
|
"resources/skins.vector.search/App.vue",
|
|
{
|
|
"name": "resources/skins.vector.search/config.json",
|
|
"callback": "Vector\\Hooks::getVectorWvuiSearchResourceLoaderConfig"
|
|
}
|
|
],
|
|
"messages": [
|
|
"searchbutton",
|
|
"searchresults",
|
|
"vector-searchsuggest-containing"
|
|
]
|
|
},
|
|
"skins.vector.styles.legacy": {
|
|
"class": "ResourceLoaderSkinModule",
|
|
"features": {
|
|
"normalize": true,
|
|
"elements": true,
|
|
"logo": true,
|
|
"content-media": true,
|
|
"content-links": true,
|
|
"content-links-external": false,
|
|
"interface": true,
|
|
"interface-message-box": true,
|
|
"interface-category": true,
|
|
"content-tables": true,
|
|
"i18n-ordered-lists": true,
|
|
"i18n-all-lists-margins": true,
|
|
"i18n-headings": true
|
|
},
|
|
"targets": [
|
|
"desktop",
|
|
"mobile"
|
|
],
|
|
"styles": [
|
|
"resources/common/common.less",
|
|
"resources/skins.vector.styles.legacy/skin-legacy.less"
|
|
]
|
|
},
|
|
"skins.vector.styles": {
|
|
"class": "ResourceLoaderSkinModule",
|
|
"features": {
|
|
"normalize": true,
|
|
"elements": true,
|
|
"content-links": true,
|
|
"content-links-external": false,
|
|
"content-media": true,
|
|
"content-tables": true,
|
|
"interface": true,
|
|
"interface-message-box": true,
|
|
"interface-category": true,
|
|
"i18n-ordered-lists": true,
|
|
"i18n-all-lists-margins": true,
|
|
"i18n-headings": true
|
|
},
|
|
"targets": [
|
|
"desktop",
|
|
"mobile"
|
|
],
|
|
"styles": [
|
|
"resources/common/common.less",
|
|
"resources/skins.vector.styles/skin.less"
|
|
],
|
|
"lessMessages": [
|
|
"parentheses-start",
|
|
"parentheses-end"
|
|
]
|
|
},
|
|
"skins.vector.icons.js": {
|
|
"selectorWithVariant": ".mw-ui-icon-wikimedia-{name}-{variant}:before",
|
|
"selectorWithoutVariant": ".mw-ui-icon-wikimedia-{name}:before",
|
|
"useDataURI": false,
|
|
"defaultColor": "#000",
|
|
"class": "ResourceLoaderOOUIIconPackModule",
|
|
"variants": [],
|
|
"icons": [
|
|
"edit",
|
|
"editLock",
|
|
"halfStar",
|
|
"history",
|
|
"speechBubbles",
|
|
"star",
|
|
"unStar",
|
|
"wikiText"
|
|
]
|
|
},
|
|
"skins.vector.icons": {
|
|
"selectorWithVariant": ".mw-ui-icon-wikimedia-{name}-{variant}:before",
|
|
"selectorWithoutVariant": ".mw-ui-icon-wikimedia-{name}:before",
|
|
"useDataURI": false,
|
|
"defaultColor": "#000",
|
|
"class": "ResourceLoaderOOUIIconPackModule",
|
|
"variants": {
|
|
"progressive": {
|
|
"color": "#36c",
|
|
"global": true
|
|
}
|
|
},
|
|
"icons": [
|
|
"language",
|
|
"ellipsis",
|
|
"userAvatar",
|
|
"userTalk",
|
|
"sandbox",
|
|
"search",
|
|
"settings",
|
|
"labFlask",
|
|
"unStar",
|
|
"watchlist",
|
|
"userContributions",
|
|
"logIn",
|
|
"logOut",
|
|
"imageGallery",
|
|
"userGroup"
|
|
]
|
|
},
|
|
"skins.vector.es6": {
|
|
"es6": true,
|
|
"packageFiles": [
|
|
"resources/skins.vector.es6/main.js",
|
|
"resources/skins.vector.es6/searchToggle.js",
|
|
"resources/skins.vector.es6/stickyHeader.js",
|
|
"resources/skins.vector.es6/scrollObserver.js",
|
|
"resources/skins.vector.es6/AB.js",
|
|
"resources/skins.vector.es6/tableOfContents.js",
|
|
"resources/skins.vector.es6/sectionObserver.js",
|
|
"resources/skins.vector.es6/deferUntilFrame.js",
|
|
{
|
|
"name": "resources/skins.vector.es6/config.json",
|
|
"callback": "Vector\\Hooks::getVectorResourceLoaderConfig"
|
|
}
|
|
],
|
|
"dependencies": [
|
|
"mediawiki.user",
|
|
"skins.vector.icons.js",
|
|
"mediawiki.page.ready",
|
|
"mediawiki.page.watch.ajax",
|
|
"mediawiki.util",
|
|
"mediawiki.experiments"
|
|
]
|
|
},
|
|
"skins.vector.js": {
|
|
"packageFiles": [
|
|
"resources/skins.vector.js/skin.js",
|
|
{
|
|
"name": "resources/skins.vector.js/config.json",
|
|
"callback": "Vector\\Hooks::getVectorResourceLoaderConfig"
|
|
},
|
|
"resources/skins.vector.js/dropdownMenus.js",
|
|
"resources/skins.vector.js/sidebar.js",
|
|
"resources/skins.vector.legacy.js/collapsibleTabs.js",
|
|
"resources/skins.vector.legacy.js/vector.js",
|
|
"resources/skins.vector.js/languageButton.js",
|
|
"resources/skins.vector.js/searchLoader.js"
|
|
],
|
|
"dependencies": [
|
|
"skins.vector.icons.js",
|
|
"mediawiki.page.ready",
|
|
"mediawiki.util"
|
|
],
|
|
"messages": [ "vector-search-loader" ]
|
|
},
|
|
"skins.vector.legacy.js": {
|
|
"packageFiles": [
|
|
"resources/skins.vector.legacy.js/skin-legacy.js",
|
|
"resources/skins.vector.legacy.js/collapsibleTabs.js",
|
|
"resources/skins.vector.legacy.js/vector.js"
|
|
],
|
|
"dependencies": [
|
|
"mediawiki.page.ready",
|
|
"mediawiki.util"
|
|
]
|
|
}
|
|
},
|
|
"ResourceFileModulePaths": {
|
|
"localBasePath": "",
|
|
"remoteSkinPath": "Vector"
|
|
},
|
|
"ResourceModuleSkinStyles": {
|
|
"vector-2022": {
|
|
"+ext.echo.styles.alert": "skinStyles/ext.echo.styles.alert.less",
|
|
"+mediawiki.action.view.redirectPage": "skinStyles/mediawiki.action.view.redirectPage.less",
|
|
"+mediawiki.notification": "skinStyles/mediawiki.notification.less",
|
|
"+oojs-ui-core.styles": "skinStyles/ooui.less",
|
|
"mediawiki.special": "skinStyles/mediawiki.special.less",
|
|
"+ext.relatedArticles.readMore": "skinStyles/ext.relatedArticles.readMore.less",
|
|
"+ext.uls.compactlinks": "skinStyles/ext.uls.compactlinks.less",
|
|
"+ext.uls.interface": "skinStyles/ext.uls.interface.less"
|
|
},
|
|
"vector": {
|
|
"+ext.echo.styles.alert": "skinStyles/ext.echo.styles.alert.less",
|
|
"jquery.tipsy": "skinStyles/jquery.tipsy.less",
|
|
"jquery.ui": [
|
|
"skinStyles/jquery.ui/jquery.ui.core.css",
|
|
"skinStyles/jquery.ui/jquery.ui.theme.css",
|
|
"skinStyles/jquery.ui/jquery.ui.accordion.css",
|
|
"skinStyles/jquery.ui/jquery.ui.autocomplete.css",
|
|
"skinStyles/jquery.ui/jquery.ui.button.css",
|
|
"skinStyles/jquery.ui/jquery.ui.datepicker.css",
|
|
"skinStyles/jquery.ui/jquery.ui.dialog.css",
|
|
"skinStyles/jquery.ui/jquery.ui.menu.css",
|
|
"skinStyles/jquery.ui/jquery.ui.progressbar.css",
|
|
"skinStyles/jquery.ui/jquery.ui.resizable.css",
|
|
"skinStyles/jquery.ui/jquery.ui.selectable.css",
|
|
"skinStyles/jquery.ui/jquery.ui.slider.css",
|
|
"skinStyles/jquery.ui/jquery.ui.tabs.css",
|
|
"skinStyles/jquery.ui/jquery.ui.tooltip.css"
|
|
],
|
|
"+mediawiki.action.view.redirectPage": "skinStyles/mediawiki.action.view.redirectPage.less",
|
|
"+mediawiki.notification": "skinStyles/mediawiki.notification.less",
|
|
"+oojs-ui-core.styles": "skinStyles/ooui.less",
|
|
"mediawiki.special": "skinStyles/mediawiki.special.less",
|
|
"+ext.relatedArticles.readMore": "skinStyles/ext.relatedArticles.readMore.less",
|
|
"+ext.uls.compactlinks": "skinStyles/ext.uls.compactlinks.less",
|
|
"+ext.uls.interface": "skinStyles/ext.uls.interface.less"
|
|
}
|
|
},
|
|
"config": {
|
|
"VectorSearchHost": {
|
|
"value": "",
|
|
"description": "Override default search API. Can be used with $wgDisableTextSearch and $wgSearchForwardUrl to mimic user experience on production."
|
|
},
|
|
"VectorUseIconWatch": {
|
|
"value": true
|
|
},
|
|
"VectorMaxWidthOptions": {
|
|
"value": {
|
|
"exclude": {
|
|
"mainpage": false,
|
|
"querystring": {
|
|
"action": "history",
|
|
"diff": "*"
|
|
},
|
|
"namespaces": [
|
|
-1,
|
|
14
|
|
]
|
|
},
|
|
"include": [
|
|
"Special:Preferences"
|
|
]
|
|
},
|
|
"description": "options for configuring where where max-width should and should not apply. More details can be found in Hooks::shouldDisableMaxWidth PHP documentation."
|
|
},
|
|
"VectorResponsive": {
|
|
"value": false,
|
|
"description": "@var boolean When wgVectorDefaultSkinVersion is set to 2, turn Vector into a responsive skin by applying a view port and disabling the min-width"
|
|
},
|
|
"VectorShowSkinPreferences": {
|
|
"value": true,
|
|
"description": "@var boolean Show skin-specific user preferences on the Special:Preferences appearance tab when true and hide them otherwise."
|
|
},
|
|
"VectorDefaultSkinVersion": {
|
|
"value": "1",
|
|
"description": "@var string:['2'|'1'] The version ('2' for latest, '1' for legacy) of the Vector skin to use for anonymous users and as a fallback. The value is _not_ persisted."
|
|
},
|
|
"VectorDefaultSkinVersionForExistingAccounts": {
|
|
"value": "1",
|
|
"description": "@var string:['2'|'1'] The version ('2' for latest, '1' for legacy) of the Vector skin to use when an existing user has not specified a preference. This configuration is not used for new accounts (see VectorDefaultSkinVersionForNewAccounts) and is impermanent. In the future, this field may contains versions such as \"beta\" which when specified and the BetaFeatures extension is installed, and the user is enrolled, the latest version is used otherwise legacy. The value is _not_ persisted."
|
|
},
|
|
"VectorDefaultSkinVersionForNewAccounts": {
|
|
"value": "1",
|
|
"description": "@var string:['2'|'1'] The version ('2' for latest, '1' for legacy) of the Vector skin to **set** for newly created user accounts. **The value is persisted as a user preference.** This configuration is not used for preexisting accounts (see VectorDefaultSkinVersionForExistingAccounts) and only ever executed once at new account creation time."
|
|
},
|
|
"VectorSkinMigrationMode": {
|
|
"value": true,
|
|
"description": "@internal. For usage to fulfil [[phab:T291098]]"
|
|
},
|
|
"VectorWvuiSearchOptions": {
|
|
"value": {
|
|
"showThumbnail": true,
|
|
"showDescription": true
|
|
}
|
|
},
|
|
"VectorDefaultSidebarVisibleForAuthorisedUser": {
|
|
"value": true
|
|
},
|
|
"VectorDefaultSidebarVisibleForAnonymousUser": {
|
|
"value": false
|
|
},
|
|
"VectorLanguageInHeader": {
|
|
"value": {
|
|
"logged_in": true,
|
|
"logged_out": true
|
|
},
|
|
"description": "@var array Moves the language links from the sidebar into a menu beside the page title. Also moves the indicators to the line below, next to the tagline (siteSub)."
|
|
},
|
|
"VectorLanguageInMainPageHeader": {
|
|
"value": {
|
|
"logged_in": false,
|
|
"logged_out": false
|
|
},
|
|
"description": "@var When `VectorLanguageInHeader` is enabled, determines whether the Main Page's language button should be at the top or bottom of the content. The default position on the main page is at the bottom."
|
|
},
|
|
"VectorLanguageAlertInSidebar": {
|
|
"value": {
|
|
"logged_in": false,
|
|
"logged_out": false
|
|
},
|
|
"description": "@var When `VectorLanguageAlertInSidebar` is enabled, the language switch alert box is shown in the sidebar."
|
|
},
|
|
"VectorLanguageInHeaderTreatmentABTest": {
|
|
"value": false,
|
|
"description": "@var boolean Enables or disables the language in header treatment A/B test. See https://phabricator.wikimedia.org/T280825 and associated tasks for additional detail."
|
|
},
|
|
"VectorStickyHeader": {
|
|
"value": {
|
|
"logged_in": true,
|
|
"logged_out": false
|
|
},
|
|
"description": "@var array Enables a persistent header that allows quick access to user links, editing tools, search and other links while scrolling down a page"
|
|
},
|
|
"VectorStickyHeaderEdit": {
|
|
"value": {
|
|
"logged_in": false,
|
|
"logged_out": false
|
|
},
|
|
"description": "@var array Enables the edit icons if $wgVectorStickyHeader is true."
|
|
},
|
|
"VectorWebABTestEnrollment": {
|
|
"value": {
|
|
"name": "vector.sticky_header",
|
|
"enabled": false,
|
|
"buckets": {
|
|
"unsampled": {
|
|
"samplingRate": 0.1
|
|
},
|
|
"control": {
|
|
"samplingRate": 0.3
|
|
},
|
|
"stickyHeaderDisabled": {
|
|
"samplingRate": 0.3
|
|
},
|
|
"stickyHeaderEnabled": {
|
|
"samplingRate": 0.3
|
|
}
|
|
}
|
|
},
|
|
"description": "An associative array of A/B test configs keyed by parameters noted in mediawiki.experiments.js."
|
|
},
|
|
"VectorDisableSidebarPersistence": {
|
|
"value": false,
|
|
"description": "@var boolean Temporary feature flag that disables saving the sidebar expanded/collapsed state as a user-preference (triggered via clicking the main menu icon). This is intended as a temporary kill-switch in the event that the DB is overloaded with writes to the user_options table."
|
|
},
|
|
"VectorTableOfContents": {
|
|
"value": {
|
|
"default": false
|
|
},
|
|
"description": "@var When `VectorTableOfContents` is enabled, the sticky table of contents is shown."
|
|
}
|
|
},
|
|
"ServiceWiringFiles": [
|
|
"includes/ServiceWiring.php"
|
|
],
|
|
"manifest_version": 2
|
|
}
|