Download the PHP package mwstake/mediawiki-component-alertbanners without Composer
On this page you can find all versions of the php package mwstake/mediawiki-component-alertbanners. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download mwstake/mediawiki-component-alertbanners
More information about mwstake/mediawiki-component-alertbanners
Files in mwstake/mediawiki-component-alertbanners
Package mediawiki-component-alertbanners
Short Description Provides an API for showing banners above the content of a page
License GPL-3.0-only
Informations about the package mediawiki-component-alertbanners
MediaWiki Stakeholders Group - Components
AlertBanners for MediaWiki
Provides an API for showing banners above the content of a page
This code is meant to be executed within the MediaWiki application context. No standalone usage is intended.
Use in a MediaWiki extension
Add "mwstake/mediawiki-component-alertbanners": "~2.0"
to the require
section of your composer.json
file.
Since 2.0 explicit initialization is required. This can be achived by
- either adding
"callback": "mwsInitComponents"
to yourextension.json
/skin.json
- or calling
mwsInitComponents();
within you extensions/skins customcallback
method
See also mwstake/mediawiki-componentloader
.
Implement a provider
Create a class that implements MWStake\MediaWiki\Component\AlertBanners\IAlertProvider
. For convenience you may want to derive directly from the abstract base class MWStake\MediaWiki\Component\AlertBanners\AlertProviderBase
Register a provider
There are two ways to register a provider:
- Using the
mwsgAlertBannersProviderRegistry
GlobalVars configuraton - Using the hook
MWStakeAlertBannersRegisterProviders
On both cases a ObjectFactory specification must be provided.
Example 1: GlobalVars
Example 2: Hookhandler
Use in client code
Load mwstake.component.alertbanners
ResourceLoader module.
Available methods:
mwstake.alerts.add( id: string, $elem: jQuery, type: string )
: Inject a alert boxmwstake.alerts.remove( id: string )
: Remove a alert box