Thijs/wiki.techinc.nl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

OOUI theme support

Browse source 
* Split off OOjs UI's module definitions to a separate file from
  Resources.php.
* Extend ResourceLoaderImageModule to support per-skin images and
  variants.
* Allow skins to specify their preferred OOjs UI theme using new
  skin registry attribute 'SkinOOUIThemes'. The default remains the
  'mediawiki' theme, 'apex' can also be chosen now.
* Implement custom ResourceLoaderOOUIImageModule which implements some
  special sauce required to shoehorn OOjs UI image set definitions into
  ResourceLoaderImageModule with skin-specific styles support.

Bug: T100895
Change-Id: I3fbacbce95126a4cc29221352f3ef846f41e7b1b
This commit is contained in:
Bartosz Dziewoński 2015-05-24 18:56:44 +02:00 committed by Jforrester
parent 54ed5d2096
commit 1fc57830e2
7 changed files with 258 additions and 196 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
autoload.php
View file

@ -997,6 +997,7 @@ $wgAutoloadLocalClasses = array(
'ResourceLoaderImage' => __DIR__ . '/includes/resourceloader/ResourceLoaderImage.php',
'ResourceLoaderImageModule' => __DIR__ . '/includes/resourceloader/ResourceLoaderImageModule.php',
'ResourceLoaderJqueryMsgDataModule' => __DIR__ . '/includes/resourceloader/ResourceLoaderJqueryMsgDataModule.php',
'ResourceLoaderOOUIImageModule' => __DIR__ . '/includes/resourceloader/ResourceLoaderOOUIImageModule.php',
'ResourceLoaderLanguageDataModule' => __DIR__ . '/includes/resourceloader/ResourceLoaderLanguageDataModule.php',
'ResourceLoaderLanguageNamesModule' => __DIR__ . '/includes/resourceloader/ResourceLoaderLanguageNamesModule.php',
'ResourceLoaderModule' => __DIR__ . '/includes/resourceloader/ResourceLoaderModule.php',

3
docs/extension.schema.json
View file

@ -611,6 +611,9 @@
"ValidSkinNames": {
"type": "object"
},
"SkinOOUIThemes": {
"type": "object"
},
"callback": {
"type": [
"array",

1
includes/resourceloader/ResourceLoader.php
View file

@ -247,6 +247,7 @@ class ResourceLoader {
// Register core modules
$this->register( include "$IP/resources/Resources.php" );
$this->register( include "$IP/resources/ResourcesOOUI.php" );
// Register extension modules
Hooks::run( 'ResourceLoaderRegisterModules', array( &$this ) );
$this->register( $config->get( 'ResourceModules' ) );

75
includes/resourceloader/ResourceLoaderImageModule.php
View file

@ -28,7 +28,7 @@
*/
class ResourceLoaderImageModule extends ResourceLoaderModule {
private $definition = null;
protected $definition = null;
/**
* Local base path, see __construct()
@ -73,21 +73,27 @@ class ResourceLoaderImageModule extends ResourceLoaderModule {
* 'selectorWithVariant' => [CSS selector template, variables: {prefix} {name} {variant}],
* // List of variants that may be used for the image files
* 'variants' => array(
* [theme name] => array(
* [variant name] => array(
* 'color' => [color string, e.g. '#ffff00'],
* 'global' => [boolean, if true, this variant is available
* for all images of this type],
* ),
* ...
* ),
* ...
* ),
* // List of image files and their options
* 'images' => array(
* [theme name] => array(
* [file path string],
* [file path string] => array(
* 'name' => [image name string, defaults to file name],
* 'variants' => [array of variant name strings, variants
* available for this image],
* ),
* ...
* ),
* ...
* ),
* )
@ -103,7 +109,7 @@ class ResourceLoaderImageModule extends ResourceLoaderModule {
/**
* Parse definition and external JSON data, if referenced.
*/
private function loadFromDefinition() {
protected function loadFromDefinition() {
if ( $this->definition === null ) {
return;
}
@ -151,6 +157,17 @@ class ResourceLoaderImageModule extends ResourceLoaderModule {
"Invalid list error. '$option' given, array expected."
);
}
if ( !isset( $option['default'] ) ) {
// Backwards compatibility
$option = array( 'default' => $option );
}
foreach ( $option as $skin => $data ) {
if ( !is_array( $option ) ) {
throw new InvalidArgumentException(
"Invalid list error. '$option' given, array expected."
);
}
}
$this->{$member} = $option;
break;
@ -194,9 +211,9 @@ class ResourceLoaderImageModule extends ResourceLoaderModule {
* @param string $name Image name
* @return ResourceLoaderImage|null
*/
public function getImage( $name ) {
public function getImage( $name, ResourceLoaderContext $context ) {
$this->loadFromDefinition();
$images = $this->getImages();
$images = $this->getImages( $context );
return isset( $images[$name] ) ? $images[$name] : null;
}
@ -204,21 +221,29 @@ class ResourceLoaderImageModule extends ResourceLoaderModule {
* Get ResourceLoaderImage objects for all images.
* @return ResourceLoaderImage[] Array keyed by image name
*/
public function getImages() {
public function getImages( ResourceLoaderContext $context ) {
$skin = $context->getSkin();
if ( !isset( $this->imageObjects ) ) {
$this->loadFromDefinition();
$this->imageObjects = array();
foreach ( $this->images as $name => $options ) {
}
if ( !isset( $this->imageObjects[ $skin ] ) ) {
$this->imageObjects[ $skin ] = array();
if ( !isset( $this->images[ $skin ] ) ) {
$this->images[ $skin ] = isset( $this->images[ 'default' ] ) ?
$this->images[ 'default' ] :
array();
}
foreach ( $this->images[ $skin ] as $name => $options ) {
$fileDescriptor = is_string( $options ) ? $options : $options['file'];
$allowedVariants = array_merge(
is_array( $options ) && isset( $options['variants'] ) ? $options['variants'] : array(),
$this->getGlobalVariants()
$this->getGlobalVariants( $context )
);
if ( isset( $this->variants ) ) {
if ( isset( $this->variants[ $skin ] ) ) {
$variantConfig = array_intersect_key(
$this->variants,
$this->variants[ $skin ],
array_fill_keys( $allowedVariants, true )
);
} else {
@ -232,11 +257,11 @@ class ResourceLoaderImageModule extends ResourceLoaderModule {
$this->localBasePath,
$variantConfig
);
$this->imageObjects[ $image->getName() ] = $image;
$this->imageObjects[ $skin ][ $image->getName() ] = $image;
}
}
return $this->imageObjects;
return $this->imageObjects[ $skin ];
}
/**
@ -244,21 +269,27 @@ class ResourceLoaderImageModule extends ResourceLoaderModule {
* for every image regardless of image options.
* @return string[]
*/
public function getGlobalVariants() {
public function getGlobalVariants( ResourceLoaderContext $context ) {
$skin = $context->getSkin();
if ( !isset( $this->globalVariants ) ) {
$this->loadFromDefinition();
$this->globalVariants = array();
if ( isset( $this->variants ) ) {
foreach ( $this->variants as $name => $config ) {
if ( isset( $config['global'] ) && $config['global'] ) {
$this->globalVariants[] = $name;
}
}
if ( !isset( $this->globalVariants[ $skin ] ) ) {
$this->globalVariants[ $skin ] = array();
if ( !isset( $this->variants[ $skin ] ) ) {
$this->variants[ $skin ] = isset( $this->variants[ 'default' ] ) ?
$this->variants[ 'default' ] :
array();
}
foreach ( $this->variants[ $skin ] as $name => $config ) {
if ( isset( $config['global'] ) && $config['global'] ) {
$this->globalVariants[ $skin ][] = $name;
}
}
}
return $this->globalVariants;
return $this->globalVariants[ $skin ];
}
/**
@ -273,7 +304,7 @@ class ResourceLoaderImageModule extends ResourceLoaderModule {
$script = $context->getResourceLoader()->getLoadScript( $this->getSource() );
$selectors = $this->getSelectors();
foreach ( $this->getImages() as $name => $image ) {
foreach ( $this->getImages( $context ) as $name => $image ) {
$declarations = $this->getCssDeclarations(
$image->getDataUri( $context, null, 'original' ),
$image->getUrl( $context, $script, null, 'rasterized' )
@ -371,7 +402,7 @@ class ResourceLoaderImageModule extends ResourceLoaderModule {
public function getModifiedTime( ResourceLoaderContext $context ) {
$this->loadFromDefinition();
$files = array();
foreach ( $this->getImages() as $name => $image ) {
foreach ( $this->getImages( $context ) as $name => $image ) {
$files[] = $image->getPath( $context );
}

77
includes/resourceloader/ResourceLoaderOOUIImageModule.php Normal file
View file

@ -0,0 +1,77 @@
<?php
/**
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
/**
* Secret special sauce.
*
* @since 1.26
*/
class ResourceLoaderOOUIImageModule extends ResourceLoaderImageModule {
protected function loadFromDefinition() {
if ( $this->definition === null ) {
return;
}
// Core default themes
$themes = array( 'default' => 'mediawiki' );
$themes += ExtensionRegistry::getInstance()->getAttribute( 'SkinOOUIThemes' );
$name = $this->definition['name'];
$rootPath = $this->definition['rootPath'];
$definition = array();
foreach ( $themes as $skin => $theme ) {
// TODO Allow extensions to specify this path somehow
$dataPath = $this->localBasePath . '/' . $rootPath . '/' . $theme . '/' . $name . '.json';
if ( file_exists( $dataPath ) ) {
$data = json_decode( file_get_contents( $dataPath ), true );
array_walk_recursive( $data['images'], function ( &$path ) use ( $rootPath, $theme ) {
// TODO Allow extensions to specify this path somehow
$path = $rootPath . '/' . $theme . '/' . $path;
} );
} else {
$data = array();
}
foreach ( $data as $key => $value ) {
switch ( $key ) {
case 'images':
case 'variants':
$definition[$key][$skin] = $data[$key];
break;
default:
if ( !isset( $definition[$key] ) ) {
$definition[$key] = $data[$key];
} elseif ( $definition[$key] !== $data[$key] ) {
throw new Exception( "Mismatched OOUI theme definitions are not supported: trying to load $key of $theme theme" );
}
break;
}
}
}
// Fields from definition silently override keys from JSON files
$this->definition += $definition;
parent::loadFromDefinition();
}
}

175
resources/Resources.php
View file

@ -1775,178 +1775,5 @@ return array(
/* OOjs UI */
// WARNING: OOjs-UI is NOT TESTED with older browsers and is likely to break
// if loaded in browsers that don't support ES5
'oojs-ui' => array(
'scripts' => array(
'resources/lib/oojs-ui/oojs-ui.js',
),
'skinScripts' => array(
'default' => 'resources/lib/oojs-ui/oojs-ui-mediawiki.js',
),
'dependencies' => array(
'es5-shim',
'oojs',
'oojs-ui.styles',
'oojs-ui.styles.icons',
'oojs-ui.styles.indicators',
'oojs-ui.styles.textures',
),
'messages' => array(
'ooui-dialog-message-accept',
'ooui-dialog-message-reject',
'ooui-dialog-process-continue',
'ooui-dialog-process-dismiss',
'ooui-dialog-process-error',
'ooui-dialog-process-retry',
'ooui-outline-control-move-down',
'ooui-outline-control-move-up',
'ooui-outline-control-remove',
'ooui-toolbar-more',
'ooui-toolgroup-collapse',
'ooui-toolgroup-expand',
),
'targets' => array( 'desktop', 'mobile' ),
),
'oojs-ui.styles' => array(
'position' => 'top',
'styles' => 'resources/src/oojs-ui-local.css', // HACK, see inside the file
'skinStyles' => array(
'default' => 'resources/lib/oojs-ui/oojs-ui-mediawiki-noimages.css',
),
'targets' => array( 'desktop', 'mobile' ),
),
'oojs-ui.styles.icons' => array(
'position' => 'top',
'class' => 'ResourceLoaderImageModule',
'localBasePath' => "$IP/resources/lib/oojs-ui/themes/mediawiki",
'data' => 'icons.json',
'selectorWithoutVariant' => '.oo-ui-icon-{name}, .mw-ui-icon-{name}:before',
'selectorWithVariant' => '.oo-ui-image-{variant} .oo-ui-icon-{name}, .oo-ui-image-{variant}.oo-ui-icon-{name}, .mw-ui-icon-{name}-{variant}:before, .mw-ui-hovericon:hover .mw-ui-icon-{name}-{variant}-hover:before, .mw-ui-hovericon.mw-ui-icon-{name}-{variant}-hover:hover:before',
),
'oojs-ui.styles.indicators' => array(
'position' => 'top',
'class' => 'ResourceLoaderImageModule',
'localBasePath' => "$IP/resources/lib/oojs-ui/themes/mediawiki",
'data' => 'indicators.json',
),
'oojs-ui.styles.textures' => array(
'position' => 'top',
'class' => 'ResourceLoaderImageModule',
'localBasePath' => "$IP/resources/lib/oojs-ui/themes/mediawiki",
'data' => 'textures.json',
),
'oojs-ui.styles.icons-alerts' => array(
'position' => 'top',
'class' => 'ResourceLoaderImageModule',
'localBasePath' => "$IP/resources/lib/oojs-ui/themes/mediawiki",
'data' => 'icons-alerts.json',
'selectorWithoutVariant' => '.oo-ui-icon-{name}, .mw-ui-icon-{name}:before',
'selectorWithVariant' => '.oo-ui-image-{variant} .oo-ui-icon-{name}, .oo-ui-image-{variant}.oo-ui-icon-{name}, .mw-ui-icon-{name}-{variant}:before, .mw-ui-hovericon:hover .mw-ui-icon-{name}-{variant}-hover:before, .mw-ui-hovericon.mw-ui-icon-{name}-{variant}-hover:hover:before',
),
'oojs-ui.styles.icons-content' => array(
'position' => 'top',
'class' => 'ResourceLoaderImageModule',
'localBasePath' => "$IP/resources/lib/oojs-ui/themes/mediawiki",
'data' => 'icons-content.json',
'selectorWithoutVariant' => '.oo-ui-icon-{name}, .mw-ui-icon-{name}:before',
'selectorWithVariant' => '.oo-ui-image-{variant} .oo-ui-icon-{name}, .oo-ui-image-{variant}.oo-ui-icon-{name}, .mw-ui-icon-{name}-{variant}:before, .mw-ui-hovericon:hover .mw-ui-icon-{name}-{variant}-hover:before, .mw-ui-hovericon.mw-ui-icon-{name}-{variant}-hover:hover:before',
),
'oojs-ui.styles.icons-editing-advanced' => array(
'position' => 'top',
'class' => 'ResourceLoaderImageModule',
'localBasePath' => "$IP/resources/lib/oojs-ui/themes/mediawiki",
'data' => 'icons-editing-advanced.json',
'selectorWithoutVariant' => '.oo-ui-icon-{name}, .mw-ui-icon-{name}:before',
'selectorWithVariant' => '.oo-ui-image-{variant} .oo-ui-icon-{name}, .oo-ui-image-{variant}.oo-ui-icon-{name}, .mw-ui-icon-{name}-{variant}:before, .mw-ui-hovericon:hover .mw-ui-icon-{name}-{variant}-hover:before, .mw-ui-hovericon.mw-ui-icon-{name}-{variant}-hover:hover:before',
),
'oojs-ui.styles.icons-editing-core' => array(
'position' => 'top',
'class' => 'ResourceLoaderImageModule',
'localBasePath' => "$IP/resources/lib/oojs-ui/themes/mediawiki",
'data' => 'icons-editing-core.json',
'selectorWithoutVariant' => '.oo-ui-icon-{name}, .mw-ui-icon-{name}:before',
'selectorWithVariant' => '.oo-ui-image-{variant} .oo-ui-icon-{name}, .oo-ui-image-{variant}.oo-ui-icon-{name}, .mw-ui-icon-{name}-{variant}:before, .mw-ui-hovericon:hover .mw-ui-icon-{name}-{variant}-hover:before, .mw-ui-hovericon.mw-ui-icon-{name}-{variant}-hover:hover:before',
),
'oojs-ui.styles.icons-editing-list' => array(
'position' => 'top',
'class' => 'ResourceLoaderImageModule',
'localBasePath' => "$IP/resources/lib/oojs-ui/themes/mediawiki",
'data' => 'icons-editing-list.json',
'selectorWithoutVariant' => '.oo-ui-icon-{name}, .mw-ui-icon-{name}:before',
'selectorWithVariant' => '.oo-ui-image-{variant} .oo-ui-icon-{name}, .oo-ui-image-{variant}.oo-ui-icon-{name}, .mw-ui-icon-{name}-{variant}:before, .mw-ui-hovericon:hover .mw-ui-icon-{name}-{variant}-hover:before, .mw-ui-hovericon.mw-ui-icon-{name}-{variant}-hover:hover:before',
),
'oojs-ui.styles.icons-editing-styling' => array(
'position' => 'top',
'class' => 'ResourceLoaderImageModule',
'localBasePath' => "$IP/resources/lib/oojs-ui/themes/mediawiki",
'data' => 'icons-editing-styling.json',
'selectorWithoutVariant' => '.oo-ui-icon-{name}, .mw-ui-icon-{name}:before',
'selectorWithVariant' => '.oo-ui-image-{variant} .oo-ui-icon-{name}, .oo-ui-image-{variant}.oo-ui-icon-{name}, .mw-ui-icon-{name}-{variant}:before, .mw-ui-hovericon:hover .mw-ui-icon-{name}-{variant}-hover:before, .mw-ui-hovericon.mw-ui-icon-{name}-{variant}-hover:hover:before',
),
'oojs-ui.styles.icons-interactions' => array(
'position' => 'top',
'class' => 'ResourceLoaderImageModule',
'localBasePath' => "$IP/resources/lib/oojs-ui/themes/mediawiki",
'data' => 'icons-interactions.json',
'selectorWithoutVariant' => '.oo-ui-icon-{name}, .mw-ui-icon-{name}:before',
'selectorWithVariant' => '.oo-ui-image-{variant} .oo-ui-icon-{name}, .oo-ui-image-{variant}.oo-ui-icon-{name}, .mw-ui-icon-{name}-{variant}:before, .mw-ui-hovericon:hover .mw-ui-icon-{name}-{variant}-hover:before, .mw-ui-hovericon.mw-ui-icon-{name}-{variant}-hover:hover:before',
),
'oojs-ui.styles.icons-layout' => array(
'position' => 'top',
'class' => 'ResourceLoaderImageModule',
'localBasePath' => "$IP/resources/lib/oojs-ui/themes/mediawiki",
'data' => 'icons-layout.json',
'selectorWithoutVariant' => '.oo-ui-icon-{name}, .mw-ui-icon-{name}:before',
'selectorWithVariant' => '.oo-ui-image-{variant} .oo-ui-icon-{name}, .oo-ui-image-{variant}.oo-ui-icon-{name}, .mw-ui-icon-{name}-{variant}:before, .mw-ui-hovericon:hover .mw-ui-icon-{name}-{variant}-hover:before, .mw-ui-hovericon.mw-ui-icon-{name}-{variant}-hover:hover:before',
),
'oojs-ui.styles.icons-location' => array(
'position' => 'top',
'class' => 'ResourceLoaderImageModule',
'localBasePath' => "$IP/resources/lib/oojs-ui/themes/mediawiki",
'data' => 'icons-location.json',
'selectorWithoutVariant' => '.oo-ui-icon-{name}, .mw-ui-icon-{name}:before',
'selectorWithVariant' => '.oo-ui-image-{variant} .oo-ui-icon-{name}, .oo-ui-image-{variant}.oo-ui-icon-{name}, .mw-ui-icon-{name}-{variant}:before, .mw-ui-hovericon:hover .mw-ui-icon-{name}-{variant}-hover:before, .mw-ui-hovericon.mw-ui-icon-{name}-{variant}-hover:hover:before',
),
'oojs-ui.styles.icons-media' => array(
'position' => 'top',
'class' => 'ResourceLoaderImageModule',
'localBasePath' => "$IP/resources/lib/oojs-ui/themes/mediawiki",
'data' => 'icons-media.json',
'selectorWithoutVariant' => '.oo-ui-icon-{name}, .mw-ui-icon-{name}:before',
'selectorWithVariant' => '.oo-ui-image-{variant} .oo-ui-icon-{name}, .oo-ui-image-{variant}.oo-ui-icon-{name}, .mw-ui-icon-{name}-{variant}:before, .mw-ui-hovericon:hover .mw-ui-icon-{name}-{variant}-hover:before, .mw-ui-hovericon.mw-ui-icon-{name}-{variant}-hover:hover:before',
),
'oojs-ui.styles.icons-moderation' => array(
'position' => 'top',
'class' => 'ResourceLoaderImageModule',
'localBasePath' => "$IP/resources/lib/oojs-ui/themes/mediawiki",
'data' => 'icons-moderation.json',
'selectorWithoutVariant' => '.oo-ui-icon-{name}, .mw-ui-icon-{name}:before',
'selectorWithVariant' => '.oo-ui-image-{variant} .oo-ui-icon-{name}, .oo-ui-image-{variant}.oo-ui-icon-{name}, .mw-ui-icon-{name}-{variant}:before, .mw-ui-hovericon:hover .mw-ui-icon-{name}-{variant}-hover:before, .mw-ui-hovericon.mw-ui-icon-{name}-{variant}-hover:hover:before',
),
'oojs-ui.styles.icons-movement' => array(
'position' => 'top',
'class' => 'ResourceLoaderImageModule',
'localBasePath' => "$IP/resources/lib/oojs-ui/themes/mediawiki",
'data' => 'icons-movement.json',
'selectorWithoutVariant' => '.oo-ui-icon-{name}, .mw-ui-icon-{name}:before',
'selectorWithVariant' => '.oo-ui-image-{variant} .oo-ui-icon-{name}, .oo-ui-image-{variant}.oo-ui-icon-{name}, .mw-ui-icon-{name}-{variant}:before, .mw-ui-hovericon:hover .mw-ui-icon-{name}-{variant}-hover:before, .mw-ui-hovericon.mw-ui-icon-{name}-{variant}-hover:hover:before',
),
'oojs-ui.styles.icons-user' => array(
'position' => 'top',
'class' => 'ResourceLoaderImageModule',
'localBasePath' => "$IP/resources/lib/oojs-ui/themes/mediawiki",
'data' => 'icons-user.json',
'selectorWithoutVariant' => '.oo-ui-icon-{name}, .mw-ui-icon-{name}:before',
'selectorWithVariant' => '.oo-ui-image-{variant} .oo-ui-icon-{name}, .oo-ui-image-{variant}.oo-ui-icon-{name}, .mw-ui-icon-{name}-{variant}:before, .mw-ui-hovericon:hover .mw-ui-icon-{name}-{variant}-hover:before, .mw-ui-hovericon.mw-ui-icon-{name}-{variant}-hover:hover:before',
),
'oojs-ui.styles.icons-wikimedia' => array(
'position' => 'top',
'class' => 'ResourceLoaderImageModule',
'localBasePath' => "$IP/resources/lib/oojs-ui/themes/mediawiki",
'data' => 'icons-wikimedia.json',
'selectorWithoutVariant' => '.oo-ui-icon-{name}, .mw-ui-icon-{name}:before',
'selectorWithVariant' => '.oo-ui-image-{variant} .oo-ui-icon-{name}, .oo-ui-image-{variant}.oo-ui-icon-{name}, .mw-ui-icon-{name}-{variant}:before, .mw-ui-hovericon:hover .mw-ui-icon-{name}-{variant}-hover:before, .mw-ui-hovericon.mw-ui-icon-{name}-{variant}-hover:hover:before',
),
// @see ResourcesOOUI.php
);

122
resources/ResourcesOOUI.php Normal file
View file

@ -0,0 +1,122 @@
<?php
/**
* Definition of OOjs UI ResourceLoader modules.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
die( 'Not an entry point.' );
}
// WARNING: OOjs-UI is NOT TESTED with older browsers and is likely to break
// if loaded in browsers that don't support ES5
return call_user_func( function () {
// Core default themes
$themes = array( 'default' => 'mediawiki' );
$themes += ExtensionRegistry::getInstance()->getAttribute( 'SkinOOUIThemes' );
$modules = array();
$modules['oojs-ui'] = array(
'scripts' => array(
'resources/lib/oojs-ui/oojs-ui.js',
),
'skinScripts' => array_combine(
array_keys( $themes ),
array_map( function ( $theme ) {
// TODO Allow extensions to specify this path somehow
return "resources/lib/oojs-ui/oojs-ui-$theme.js";
}, array_values( $themes ) )
),
'dependencies' => array(
'es5-shim',
'oojs',
'oojs-ui.styles',
'oojs-ui.styles.icons',
'oojs-ui.styles.indicators',
'oojs-ui.styles.textures',
),
'messages' => array(
'ooui-dialog-message-accept',
'ooui-dialog-message-reject',
'ooui-dialog-process-continue',
'ooui-dialog-process-dismiss',
'ooui-dialog-process-error',
'ooui-dialog-process-retry',
'ooui-outline-control-move-down',
'ooui-outline-control-move-up',
'ooui-outline-control-remove',
'ooui-toolbar-more',
'ooui-toolgroup-collapse',
'ooui-toolgroup-expand',
),
'targets' => array( 'desktop', 'mobile' ),
);
$modules['oojs-ui.styles'] = array(
'position' => 'top',
'styles' => 'resources/src/oojs-ui-local.css', // HACK, see inside the file
'skinStyles' => array_combine(
array_keys( $themes ),
array_map( function ( $theme ) {
// TODO Allow extensions to specify this path somehow
return "resources/lib/oojs-ui/oojs-ui-$theme-noimages.css";
}, array_values( $themes ) )
),
'targets' => array( 'desktop', 'mobile' ),
);
$imageSets = array(
// Comments for greppability
'icons', // oojs-ui.styles.icons
'indicators', // oojs-ui.styles.indicators
'textures', // oojs-ui.styles.textures
'icons-alerts', // oojs-ui.styles.icons-alerts
'icons-content', // oojs-ui.styles.icons-content
'icons-editing-advanced', // oojs-ui.styles.icons-editing-advanced
'icons-editing-core', // oojs-ui.styles.icons-editing-core
'icons-editing-list', // oojs-ui.styles.icons-editing-list
'icons-editing-styling', // oojs-ui.styles.icons-editing-styling
'icons-interactions', // oojs-ui.styles.icons-interactions
'icons-layout', // oojs-ui.styles.icons-layout
'icons-location', // oojs-ui.styles.icons-location
'icons-media', // oojs-ui.styles.icons-media
'icons-moderation', // oojs-ui.styles.icons-moderation
'icons-movement', // oojs-ui.styles.icons-movement
'icons-user', // oojs-ui.styles.icons-user
'icons-wikimedia', // oojs-ui.styles.icons-wikimedia
);
$rootPath = 'resources/lib/oojs-ui/themes';
foreach ( $imageSets as $name ) {
$module = array(
'position' => 'top',
'class' => 'ResourceLoaderOOUIImageModule',
'name' => $name,
'rootPath' => $rootPath,
);
if ( substr( $name, 0, 5 ) === 'icons' ) {
$module['selectorWithoutVariant'] = '.oo-ui-icon-{name}, .mw-ui-icon-{name}:before';
$module['selectorWithVariant'] = '.oo-ui-image-{variant} .oo-ui-icon-{name}, .oo-ui-image-{variant}.oo-ui-icon-{name}, .mw-ui-icon-{name}-{variant}:before, .mw-ui-hovericon:hover .mw-ui-icon-{name}-{variant}-hover:before, .mw-ui-hovericon.mw-ui-icon-{name}-{variant}-hover:hover:before';
}
$modules[ "oojs-ui.styles.$name" ] = $module;
}
return $modules;
} );