Page Menu
Home
WickedGov Phorge
Search
Configure Global Search
Log In
Files
F6121996
VectorComponentStickyHeader.php
No One
Temporary
Actions
Download File
Edit File
Delete File
View Transforms
Subscribe
Flag For Later
Award Token
Size
4 KB
Referenced Files
None
Subscribers
None
VectorComponentStickyHeader.php
View Options
<?php
namespace
MediaWiki\Skins\Vector\Components
;
use
MediaWiki\Message\Message
;
use
MessageLocalizer
;
/**
* VectorComponentStickyHeader component
*/
class
VectorComponentStickyHeader
implements
VectorComponent
{
private
const
TALK_ICON
=
[
'icon'
=>
'speechBubbles'
,
'id'
=>
'ca-talk-sticky-header'
,
'event'
=>
'talk-sticky-header'
];
private
const
SUBJECT_ICON
=
[
'icon'
=>
'article'
,
'id'
=>
'ca-subject-sticky-header'
,
'event'
=>
'subject-sticky-header'
];
private
const
HISTORY_ICON
=
[
'icon'
=>
'wikimedia-history'
,
'id'
=>
'ca-history-sticky-header'
,
'event'
=>
'history-sticky-header'
,
];
// Event and icon will be updated depending on watchstar state
private
const
WATCHSTAR_ICON
=
[
'id'
=>
'ca-watchstar-sticky-header'
,
'event'
=>
'watch-sticky-header'
,
'icon'
=>
'wikimedia-star'
,
'is-quiet'
=>
true
,
'tabindex'
=>
'-1'
,
// With the original watchstar, this class is applied to the <li> element
// thats the parent of the actual watchlink. In the sticky header we dont use
// the same markup, so its directly applied to the watchlink element
'class'
=>
'mw-watchlink'
];
private
const
EDIT_VE_ICON
=
[
'id'
=>
'ca-ve-edit-sticky-header'
,
'event'
=>
've-edit-sticky-header'
,
'icon'
=>
'wikimedia-edit'
,
];
private
const
EDIT_WIKITEXT_ICON
=
[
'id'
=>
'ca-edit-sticky-header'
,
'event'
=>
'wikitext-edit-sticky-header'
,
'icon'
=>
'wikimedia-wikiText'
,
];
private
const
EDIT_PROTECTED_ICON
=
[
'href'
=>
'#'
,
'id'
=>
'ca-viewsource-sticky-header'
,
'event'
=>
've-edit-protected-sticky-header'
,
'icon'
=>
'wikimedia-editLock'
,
];
/** @var MessageLocalizer */
private
$localizer
;
/** @var VectorComponent */
private
$search
;
/** @var VectorComponent|null */
private
$langButton
;
/** @var bool */
private
$visualEditorTabPositionFirst
;
/**
* @param MessageLocalizer $localizer
* @param VectorComponent $searchBox
* @param VectorComponent|null $langButton
* @param bool $visualEditorTabPositionFirst
*/
public
function
__construct
(
MessageLocalizer
$localizer
,
VectorComponent
$searchBox
,
$langButton
=
null
,
bool
$visualEditorTabPositionFirst
=
false
)
{
$this
->
search
=
$searchBox
;
$this
->
langButton
=
$langButton
;
$this
->
localizer
=
$localizer
;
$this
->
visualEditorTabPositionFirst
=
$visualEditorTabPositionFirst
;
}
/**
* @param mixed $key
* @return Message
*/
private
function
msg
(
$key
):
Message
{
return
$this
->
localizer
->
msg
(
$key
);
}
/**
* Creates array of Button components in the sticky header
*
* @return array
*/
private
function
getIconButtons
()
{
$icons
=
[
self
::
TALK_ICON
,
self
::
SUBJECT_ICON
,
self
::
HISTORY_ICON
,
self
::
WATCHSTAR_ICON
,
];
$icons
[]
=
$this
->
visualEditorTabPositionFirst
?
self
::
EDIT_VE_ICON
:
self
::
EDIT_WIKITEXT_ICON
;
$icons
[]
=
$this
->
visualEditorTabPositionFirst
?
self
::
EDIT_WIKITEXT_ICON
:
self
::
EDIT_VE_ICON
;
$icons
[]
=
self
::
EDIT_PROTECTED_ICON
;
$iconButtons
=
[];
foreach
(
$icons
as
$icon
)
{
$iconButtons
[]
=
new
VectorComponentButton
(
// Button labels will be populated in stickyHeader.js
""
,
$icon
[
'icon'
],
$icon
[
'id'
],
$icon
[
'class'
]
??
''
,
[
'tabindex'
=>
'-1'
,
'data-event-name'
=>
$icon
[
'event'
],
],
'quiet'
,
'default'
,
true
,
'#'
);
}
return
$iconButtons
;
}
/**
* Creates button data for the "Add section" button in the sticky header
*
* @return VectorComponentButton
*/
private
function
getAddSectionButton
()
{
return
new
VectorComponentButton
(
$this
->
msg
(
[
'vector-2022-action-addsection'
,
'skin-action-addsection'
]
)->
text
(),
'speechBubbleAdd-progressive'
,
'ca-addsection-sticky-header'
,
''
,
[
'tabindex'
=>
'-1'
,
'data-event-name'
=>
'addsection-sticky-header'
],
'quiet'
,
'progressive'
,
false
,
'#'
);
}
/**
* Creates button data for the "search" button in the sticky header
*
* @param array $searchBoxData
* @return VectorComponentButton
*/
private
function
getSearchButton
(
$searchBoxData
)
{
return
new
VectorComponentButton
(
$this
->
msg
(
'search'
),
'search'
,
null
,
'vector-sticky-header-search-toggle'
,
[
'tabindex'
=>
'-1'
,
'data-event-name'
=>
'ui.'
.
$searchBoxData
[
'form-id'
]
.
'.icon'
],
'quiet'
,
'default'
,
true
);
}
/**
* @inheritDoc
*/
public
function
getTemplateData
():
array
{
$iconButtonData
=
array_map
(
static
function
(
$btn
)
{
return
$btn
->
getTemplateData
();
},
$this
->
getIconButtons
()
);
$buttonData
=
$this
->
langButton
?
[
$this
->
langButton
->
getTemplateData
()
]
:
[];
$buttonData
[]
=
$this
->
getAddSectionButton
()->
getTemplateData
();
$searchBoxData
=
$this
->
search
->
getTemplateData
();
$searchButtonData
=
$this
->
getSearchButton
(
$searchBoxData
)->
getTemplateData
();
return
[
'array-icon-buttons'
=>
$iconButtonData
,
'array-buttons'
=>
$buttonData
,
'data-button-start'
=>
$searchButtonData
,
'data-search'
=>
$searchBoxData
,
];
}
}
File Metadata
Details
Attached
Mime Type
text/x-php
Expires
Oct 7 2026, 06:20 (6 w, 3 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
7c/ac/8c7b1e15187ba2b9682ba56f415b
Default Alt Text
VectorComponentStickyHeader.php (4 KB)
Attached To
Mode
rMWPROD MediaWiki Production
Attached
Detach File
Event Timeline
Log In to Comment