Extension:Bootstrap

MediaWiki extensions manual

Bootstrap Release status: stable
Implementation	Skin
Description	Provides the Bootstrap 4 web front-end framework
Author(s)	Stephan Gambke (F.trotttalk)
Maintainer(s)	Professional.Wiki
Latest version	4.2.0 (2020-05-07)
Compatibility policy	master
MediaWiki	1.27+
PHP	5.6+
Database changes	No
Composer	mediawiki/bootstrap
License	GNU General Public License 3.0 or later
Download	GitHub: project page git repository URL [help] commit history Note: No localisation updates are provided by translatewiki.net . README on GitHub Changelog on GitHub
Hooks used SetupAfterCache
Translate the Bootstrap extension if it is available at translatewiki.net
Check usage and version matrix.

The Bootstrap extension provides the Bootstrap 4 web front-end framework to MediaWiki. It can be activated directly or used from skins or extensions.

Currently Bootstrap version 4.3.1 is provided.

Installation

Until version ≤ 4.1.0 this extension required Composer for installation. Starting with version 4.2.0 two options are available:

From Tarball

• Download and place the file(s) in a directory called Bootstrap in your extensions/ folder.

• Add the following code at the bottom of your LocalSettings.php:

  wfLoadExtension( 'Bootstrap' );
  

•  Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Using Composer

1. If not already done, install Composer.
2. Add mediawiki/bootstrap: ~4.0 as a requirement to your "composer.local.json" file in the MediaWiki installation directory
3. Run composer update --no-dev "mediawiki/bootstrap"
4. Load the extension by adding the following line to LocalSettings.php: wfLoadExtension( 'Bootstrap' );
5.  Done – Navigate to "Special:Version" on your wiki to verify that the extension is successfully installed.

Usage

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.

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;
};

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

See also

Directly related

• the Bootstrap framework homepage
• the SASS/SCSS homepage
• the Chameleon skin that uses this extension
• the BootstrapComponents extension that uses this extension and lets editors utilize its potential inside wiki markup

Disambiguation

• the Bootstrap skin is another Bootstrap based skin independent from either extension