Page MenuHomeWickedGov Phorge
Files F1432177

TabIndexedElement.php
No OneTemporary
Actions

Size
3 KB
Referenced Files
None
Subscribers
None

TabIndexedElement.php
View Options

<?php
namespace OOUI;
/**
* Element supporting "sequential focus navigation" using the 'tabindex' attribute.
*
* @abstract
*/
trait TabIndexedElement {
/**
* Tab index value.
*
* @var int|null
*/
protected $tabIndex = null;
/**
* @var Element
*/
protected $tabIndexed;
/**
* @param array $config Configuration options
* - string|int|null $config['tabIndex'] Tab index value. Use 0 to use default ordering,
* use -1 to prevent tab focusing, use null to suppress the `tabindex` attribute.
* (default: 0)
*/
public function initializeTabIndexedElement( array $config = [] ) {
// Properties
$this->tabIndexed = $config['tabIndexed'] ?? $this;
// Initialization
$this->setTabIndex( $config['tabIndex'] ?? 0 );
$this->registerConfigCallback( function ( &$config ) {
if ( $this->tabIndex !== 0 ) {
$config['tabIndex'] = $this->tabIndex;
}
} );
}
/**
* Set tab index value.
*
* @param string|int|null $tabIndex Tab index value or null for no tab index
* @return $this
*/
public function setTabIndex( $tabIndex ) {
$tabIndex = preg_match( '/^-?\d+$/', $tabIndex ) ? (int)$tabIndex : null;
if ( $this->tabIndex !== $tabIndex ) {
$this->tabIndex = $tabIndex;
$this->updateTabIndex();
}
return $this;
}
/**
* Update the tabIndex attribute, in case of changes to tabIndex or disabled
* state.
*
* @return $this
*/
public function updateTabIndex() {
$disabled = $this->isDisabled();
if ( $this->tabIndex !== null ) {
// Do not index over disabled elements
$this->tabIndexed->setAttributes( [ 'tabindex' => $disabled ? -1 : $this->tabIndex ] );
if ( $disabled ) {
// ChromeVox and NVDA do not seem to inherit this from parent elements
$this->tabIndexed->setAttributes( [ 'aria-disabled' => 'true' ] );
} else {
$this->tabIndexed->removeAttributes( [ 'aria-disabled' ] );
}
} else {
$this->tabIndexed->removeAttributes( [ 'tabindex', 'aria-disabled' ] );
}
return $this;
}
/**
* Get tab index value.
*
* @return int|null Tab index value
*/
public function getTabIndex() {
return $this->tabIndex;
}
/**
* Get an ID of a focusable element of this widget, if any, to be used for `<label for>` value.
*
* If the element already has an ID then that is returned, otherwise unique ID is
* generated, set on the element, and returned.
*
* @return string|null The ID of the focusable element
*/
public function getInputId() {
$id = $this->tabIndexed->getAttribute( 'id' );
if ( !$this->isLabelableNode( $this->tabIndexed ) ) {
return null;
}
if ( $id === null ) {
$id = Tag::generateElementId();
$this->tabIndexed->setAttributes( [ 'id' => $id ] );
}
return $id;
}
/**
* Whether the node is 'labelable' according to the HTML spec
* (i.e., whether it can be interacted with through a `<label for="…">`).
* See: <https://html.spec.whatwg.org/multipage/forms.html#category-label>.
*
* @param Tag $tag
* @return bool
*/
private function isLabelableNode( Tag $tag ) {
$labelableTags = [ 'button', 'meter', 'output', 'progress', 'select', 'textarea' ];
$tagName = strtolower( $tag->getTag() );
if ( $tagName === 'input' && $tag->getAttribute( 'type' ) !== 'hidden' ) {
return true;
}
if ( in_array( $tagName, $labelableTags, true ) ) {
return true;
}
return false;
}
/**
* @return bool
*/
abstract public function isDisabled();
/**
* @param callable $func
*/
abstract public function registerConfigCallback( callable $func );
}

File Metadata

Mime Type
text/x-php
Expires
Sat, May 16, 21:29 (1 d, 11 h)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
b9/f3/d268a36fe1401ac8048128ed3137
Default Alt Text
TabIndexedElement.php (3 KB)

Event Timeline