Extension:Bootstrap

From mediawiki.org
This page is a translated version of the page Extension:Bootstrap and the translation is 78% complete.
Manuel des extensions MediaWiki
OOjs UI icon advanced-invert.svg
Bootstrap
État de la version : stable
Implémentation Habillage
Description Fournit le framework web front-end Bootstrap 4
Auteur(s) Stephan Gambke (F.trottdiscussion)
Maintenance Professional Wiki
Dernière version 4.6.0 (2022-03-30)
Politique de compatibilité Le master conserve la compatibilité arrière.
MediaWiki 1.29+
PHP 5.6+
Modifie la base
de données
Non
Composer mediawiki/bootstrap
Licence Licence publique générale GNU v3.0 ou supérieur
Téléchargement
README on GitHub
Changelog on GitHub

L'extension Bootstrap fournit le framework web front-end Bootstrap 4 (version 4.6.1) à MediaWiki. Il peut être activé directement ou utilisé à partir de skins ou d'extensions.

Installation

See the installation instructions for information on how to install this extension.

Utilisation

Within a skin

Use \Bootstrap\BootstrapManager::getInstance() to get the singleton managing the Bootstrap framework.

With the returned object,

  • add Bootstrap modules using addBootstrapModule(), addCoreBootstrapModules(), and addAllBootstrapModules()
  • set SCSS variables using setScssVariable() and setScssVariables()
  • add style files using addStyleFile()
  • add cache trigger files using addCacheTriggerFile()

Finally to add the Bootstrap styles and javascript to the page use $out->addModuleStyles( 'ext.bootstrap.styles' ) for styles and $out->addModules( 'ext.bootstrap.scripts' ) for scripts.

For an example on how to include Bootstrap styles in a skin have a look at the Chameleon skin.

Standalone

To simply enable Bootstrap styles on all pages add the following code to your "LocalSettings.php" file:

$wgHooks['SetupAfterCache'][] = function(){
	\Bootstrap\BootstrapManager::getInstance()->addAllBootstrapModules();
	return true;
};


$wgHooks['ParserAfterParse'][]=function( Parser &$parser, &$text, StripState &$stripState ){
	$parser->getOutput()->addModuleStyles( ['ext.bootstrap.styles'] );
	$parser->getOutput()->addModules( ['ext.bootstrap.scripts'] );
	return true;
};

Known issues

Effect on Universal Language Selector

If you have the Universal Language Selector (ULS) extension installed, installing the Bootstrap extension will make the ULS's dropdown-menu look disordered and break its search bar (screenshot on GitHub). However, this can be fixed by adding the following code to MediaWiki:Common.css:

.uls-language-list {
        display: block;
}

.uls-search {
        display: block;
}

Voir aussi