Add comment to pinnableElement isPinned method

Follow-up from the review of 856718 which requested a comment be added to the
isPinned method pointing to future plans with TOC.

[1] https://gerrit.wikimedia.org/r/c/mediawiki/skins/Vector/+/856718/28..38/resources/skins.vector.es6/pinnableElement.js#53

Change-Id: I899b6741e2407fe66aaaba8617974a9d58237ee6
This commit is contained in:
Nicholas Ray 2022-12-14 15:19:16 -07:00
parent 1323b82aa3
commit a8aeb62a93

View file

@ -48,6 +48,10 @@ function bindPinnableToggleButtons( header ) {
* @return {boolean} Returns true if the element is pinned and false otherwise.
*/
function isPinned( header ) {
// In the future, consider delegating to `features.isEnabled()` if and when
// TOC (T316060, T325032) and all pinnable elements use the
// `vector-feature-{name}-pinned-enabled` naming convention for the body
// class.
return header.classList.contains( PINNED_HEADER_CLASS );
}