mirror of
https://gerrit.wikimedia.org/r/mediawiki/skins/Vector.git
synced 2024-09-23 10:21:40 +00:00
aba94865c2
This patch removes the old style rules for .vector-toc-pinned after one week of cache. Also removes 'data-name' which was no longer used Bug: T325032 Change-Id: I7c8d8e51a61646151706b71a1733b1daac5dbd45
81 lines
2.3 KiB
PHP
81 lines
2.3 KiB
PHP
<?php
|
|
namespace MediaWiki\Skins\Vector\Components;
|
|
|
|
use MessageLocalizer;
|
|
|
|
/**
|
|
* VectorComponentPinnableHeader component
|
|
*/
|
|
class VectorComponentPinnableHeader implements VectorComponent {
|
|
/** @var MessageLocalizer */
|
|
private $localizer;
|
|
/** @var bool */
|
|
private $pinned;
|
|
/** @var string */
|
|
private $id;
|
|
/** @var string */
|
|
private $featureName;
|
|
/**
|
|
* @var bool
|
|
* Flag controlling if the pinnable element should be automatically moved in the DOM when pinned/unpinned
|
|
*/
|
|
private $moveElement;
|
|
/**
|
|
* @var string
|
|
*/
|
|
private $labelTagName;
|
|
|
|
/**
|
|
* @param MessageLocalizer $localizer
|
|
* @param bool $pinned
|
|
* @param string $id Pinnable element id, by convention this should include the `vector-`
|
|
* prefix e.g. `vector-page-tools` or `vector-toc`.
|
|
* @param 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.
|
|
* @param bool|null $moveElement
|
|
* @param string|null $labelTagName Element type of the label. Either a 'div' or a 'h2'
|
|
* in the case of the pinnable ToC.
|
|
*/
|
|
public function __construct(
|
|
MessageLocalizer $localizer,
|
|
bool $pinned,
|
|
string $id,
|
|
string $featureName,
|
|
?bool $moveElement = true,
|
|
?string $labelTagName = 'div'
|
|
) {
|
|
$this->localizer = $localizer;
|
|
$this->pinned = $pinned;
|
|
$this->id = $id;
|
|
$this->featureName = $featureName;
|
|
$this->moveElement = $moveElement;
|
|
$this->labelTagName = $labelTagName;
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
public function getTemplateData(): array {
|
|
$messageLocalizer = $this->localizer;
|
|
$data = [
|
|
'is-pinned' => $this->pinned,
|
|
'label' => $messageLocalizer->msg( $this->id . '-label' ),
|
|
'label-tag-name' => $this->labelTagName,
|
|
'pin-label' => $messageLocalizer->msg( 'vector-pin-element-label' ),
|
|
'unpin-label' => $messageLocalizer->msg( 'vector-unpin-element-label' ),
|
|
'data-pinnable-element-id' => $this->id,
|
|
'data-feature-name' => $this->featureName
|
|
];
|
|
if ( $this->moveElement ) {
|
|
// Assumes consistent naming standard for pinnable elements and their containers
|
|
$data = array_merge( $data, [
|
|
'data-unpinned-container-id' => $this->id . '-unpinned-container',
|
|
'data-pinned-container-id' => $this->id . '-pinned-container',
|
|
] );
|
|
}
|
|
return $data;
|
|
}
|
|
}
|