MediaWiki\Skins\Vector\Components\VectorComponentPinnableHeader Class Reference

VectorComponentPinnableHeader component. More...

Inheritance diagram for MediaWiki\Skins\Vector\Components\VectorComponentPinnableHeader:

Collaboration diagram for MediaWiki\Skins\Vector\Components\VectorComponentPinnableHeader:

Public Member Functions
	__construct (MessageLocalizer $localizer, bool $pinned, string $id, string $featureName, ?bool $moveElement=true, ?string $labelTagName='div')
	getTemplateData ()
	@inheritDoc

Detailed Description

VectorComponentPinnableHeader component.

Constructor & Destructor Documentation

__construct()

MediaWiki\Skins\Vector\Components\VectorComponentPinnableHeader::__construct	(	MessageLocalizer	$localizer,
		bool	$pinned,
		string	$id,
		string	$featureName,
		?bool	$moveElement = true,
		?string	$labelTagName = 'div' )

Parameters

MessageLocalizer	$localizer
bool	$pinned
string	$id	Pinnable element id, by convention this should include the vector- prefix e.g. vector-page-tools or vector-toc.
string	$featureName	Pinned and unpinned states will persist for logged-in users by leveraging features.js to manage the user preference storage and the toggling of the body class. This name should NOT contain the "vector-" prefix.
bool | null	$moveElement
string | null	$labelTagName	Element type of the label. Either a 'div' or a 'h2' in the case of the pinnable ToC.

Member Function Documentation

getTemplateData()

MediaWiki\Skins\Vector\Components\VectorComponentPinnableHeader::getTemplateData

(

)

@inheritDoc

Implements MediaWiki\Skins\Vector\Components\VectorComponent.

---

The documentation for this class was generated from the following file:

• includes/Components/VectorComponentPinnableHeader.php