Extension:BootstrapComponents

From Linux Web Expert

MediaWiki extensions manual
File:OOjs UI icon advanced-invert.svg
BootstrapComponents
Release status: stable
Implementation Parser extension
Description Aims to provide editors with an easy access to certain components introduced by Bootstrap 4
Author(s) Tobias Oetterer (Oetterertalk)
Latest version 5.1.1 (2023-09-07)
MediaWiki 1.35+
PHP 7.4+
Database changes No
Composer mediawiki/bootstrap-components
License GNU General Public License 3.0 or later
Download

GitHub:


README
RELEASE-NOTES
Example
Parameters

  • $wgBootstrapComponentsDisableSourceLinkOnImageModal
  • $wgBootstrapComponentsEnableCarouselGalleryMode
  • $wgBootstrapComponentsModalReplaceImageTag
  • $wgBootstrapComponentsWhitelist
Tags
see components.md
Hooks used
Quarterly downloads Lua error in Module:Extension at line 172: bad argument #1 to 'inNamespace' (unrecognized namespace name 'skin').
Public wikis using Lua error in Module:Extension at line 172: bad argument #1 to 'inNamespace' (unrecognized namespace name 'skin').

The BootstrapComponents extension provides editors with an easy access to certain components introduced by Bootstrap 4.

Installation

There are two ways you can install this extension: you can use Composer for installation, activation, and dependency management or you can do this all manually.

This extension requires the Bootstrap extension on version 4.0 or later to be installed. Using composer to install BootstrapComponents will take care of this.

Composer

This is the easiest and recommended approach.

Just run the following command: 

COMPOSER=composer.local.json composer require mediawiki/bootstrap-components "^5.0"

It will add the following to composer.local.json: 

{
	"require": {
		"mediawiki/bootstrap-components": "^5.0"
	}
}

Manually (Not recommended)

You need to download and activate the extension yourself. Also, you need to take care of dependencies.

  • First, you should take care of dependencies. That means installing the Bootstrap extension. See there for details on how to do this.
  • Then you need to download this extension, by cloning its repository using git. Venture into your extensions directory and run:
git clone https://github.com/oetterer/BootstrapComponents

You can also download the archive and extract it yourself.

Activation

Since release 4.0, you have to enable the extension in your configuration manually. Previously, this would automatically be done by Composer. Please add the following line to your LocalSettings.php: 

wfLoadExtension( 'Bootstrap' );
wfLoadExtension( 'BootstrapComponents' );

Configuration

You can change some of the behaviour of this extension with the following four settings inside your wiki's configuration. Just add the corresponding line to your "LocalSettings.php" file.

$wgBootstrapComponentsWhitelist

Default setting is true.

This allows you to enable all, some, or none of the components inside your wiki code.

If you want all components available, set this to true: 

$wgBootstrapComponentsWhitelist = true;

If you want only a selection of components, set this to an array containing the whitelisted components. For a list of all components, please refer to the documentation. 

$wgBootstrapComponentsWhitelist = [ 'card', 'tooltip', 'modal' ];

When using modals[1], you might want to disable popovers[2]. See known issues for more.

To disable all components simply set this to false.

$wgBootstrapComponentsModalReplaceImageTag

Default setting is false.

You can have this extension change the normal image handling in your wiki. If you set this to true, all image tags not containing a link= parameter will be converted into a modal. So when you click on the image, instead of being referred to the corresponding page in the file namespace, a modal opens up showing the image with a possible caption (if you provided one) and a link to the source page of the file.

Example: 

$wgBootstrapComponentsModalReplaceImageTag = true;

Most regular options that can be used with images are recognized and processed accordingly. Please see the help page for images.

Even after enabling this option you can suppress image modals on a given page by adding the magic word __NOIMAGEMODAL__ somewhere on the page. If you want to suppress modal conversion for an individual image, give it the css class no-modal.

Example: 

[[File:NormalImage.png|class=no-modal|alt=normal|This image is displayed normally]]

Please see known issues for additional information.

$wgBootstrapComponentsDisableSourceLinkOnImageModal

Default setting is false.

When using image modals (thus having $wgBootstrapComponentsModalReplaceImageTag set to true) enabling this suppresses the source link in the footer section of the modal.

$wgBootstrapComponentsEnableCarouselGalleryMode

Default setting is true.

This adds the mode carousel to the ‎<gallery>-tag which, when used turns your gallery into a carousel. For Information on how to use galleries, please see the gallery documentation.

Examples

See also

Notes

  1. ↑ modal matches an element that is in a state in which it excludes all interaction with elements outside it until the interaction has been dismissed
  2. ↑ popover elements will appear above all other elements


Retrieved from "https://www.linuxwebexpert.com/wiki/index.php?title=Extension:BootstrapComponents&oldid=25302"