mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/Popups
synced 2024-12-19 02:30:45 +00:00
b218a77ca4
The extension is out of beta and will be enabled by default now. Leaving some hints if we decide to also remove the feature flag. Bug: T282999 Bug: T351708 Change-Id: I1556b2f3592294d094770ede2c276eddeef8bbe9
41 lines
1.5 KiB
JavaScript
41 lines
1.5 KiB
JavaScript
/**
|
|
* @module isReferencePreviewsEnabled
|
|
*/
|
|
const canSaveToUserPreferences = require( './canSaveToUserPreferences.js' );
|
|
|
|
/**
|
|
* Given the global state of the application, creates a function that gets
|
|
* whether or not the user should have Reference Previews enabled.
|
|
*
|
|
* @param {mw.user} user The `mw.user` singleton instance
|
|
* @param {Object} userSettings An object returned by `userSettings.js`
|
|
* @param {mw.Map} config
|
|
*
|
|
* @return {boolean|null} Null when there is no way the popup type can be enabled at run-time.
|
|
*/
|
|
export default function isReferencePreviewsEnabled( user, userSettings, config ) {
|
|
// TODO: This and the final `mw.user.options` check are currently redundant. Only this here
|
|
// should be removed when the wgPopupsReferencePreviews feature flag is not needed any more.
|
|
if ( !config.get( 'wgPopupsReferencePreviews' ) ) {
|
|
return null;
|
|
}
|
|
|
|
// T265872: Unavailable when in conflict with (one of the) reference tooltips gadgets.
|
|
if ( config.get( 'wgPopupsConflictsWithRefTooltipsGadget' ) ||
|
|
config.get( 'wgPopupsConflictsWithNavPopupGadget' ) ||
|
|
// T243822: Temporarily disabled in the mobile skin
|
|
config.get( 'skin' ) === 'minerva'
|
|
) {
|
|
return null;
|
|
}
|
|
|
|
// For anonymous users, the code loads always, but the feature can be toggled at run-time via
|
|
// local storage.
|
|
if ( !canSaveToUserPreferences( user ) ) {
|
|
return userSettings.isReferencePreviewsEnabled();
|
|
}
|
|
|
|
// Registered users never can enable popup types at run-time.
|
|
return mw.user.options.get( 'popups-reference-previews' ) === '1' ? true : null;
|
|
}
|