Page MenuHomeWickedGov Phorge
Files F1432399

TabPanelLayout.php
No OneTemporary
Actions

Size
2 KB
Referenced Files
None
Subscribers
None

TabPanelLayout.php
View Options

<?php
namespace OOUI;
/**
* TabPanelLayouts are used within IndexLayouts to create tab panels that
* users can select and display from the index's optional TabSelectWidget
* navigation. TabPanels are usually not instantiated directly, rather extended to include the
* required content and functionality.
*
* Each tab panel must have a unique symbolic name, which is passed to the constructor.
*/
class TabPanelLayout extends PanelLayout {
/**
* @var string
*/
protected $name;
/**
* @var string|HtmlSnippet|null
*/
protected $label;
/**
* @var bool
*/
protected $active;
/**
* @var array Config for a {@see TabOptionWidget}
*/
protected $tabItemConfig;
/**
* @param string $name Unique symbolic name of tab panel
* @param array $config Configuration options
* - string|HtmlSnippet $config['label'] Label for tab panel's tab
* - array $config['tabItemConfig'] Additional config for the {@see TabOptionWidget} that
* represents this panel in an {@see IndexLayout}
*/
public function __construct( $name, array $config = [] ) {
// Allow passing positional parameters inside the config array
if ( is_array( $name ) && isset( $name['name'] ) ) {
$config = $name;
$name = $config['name'];
}
$config = array_merge( [ 'scrollable' => true ], $config );
// Parent constructor
parent::__construct( $config );
// Initialization
$this->name = $name;
$this->label = $config['label'] ?? null;
$this->tabItemConfig = $config['tabItemConfig'] ?? [];
$this->addClasses( [ 'oo-ui-tabPanelLayout' ] );
$this->setAttributes( [
'role' => 'tabpanel',
] );
}
/** @inheritDoc */
public function getConfig( &$config ) {
$config['name'] = $this->name;
$config['label'] = $this->label;
if ( $this->tabItemConfig ) {
$config['tabItemConfig'] = $this->tabItemConfig;
}
// scrollable default has changed to true
if ( !$this->hasClass( 'oo-ui-panelLayout-scrollable' ) ) {
$config['scrollable'] = false;
} else {
unset( $config['scrollable'] );
}
return parent::getConfig( $config );
}
/**
* @return string
*/
public function getName() {
return $this->name;
}
/**
* @return array
*/
public function getTabItemConfig() {
return $this->tabItemConfig;
}
/**
* @return string|HtmlSnippet|null
*/
public function getLabel() {
return $this->label;
}
/**
* @param bool $active
*/
public function setActive( $active ) {
$this->active = $active;
$this->removeClasses( [ 'oo-ui-tabPanelLayout-active' ] );
if ( $active ) {
$this->addClasses( [ 'oo-ui-tabPanelLayout-active' ] );
}
}
}

File Metadata

Mime Type
text/x-php
Expires
Sat, May 16, 21:43 (1 d, 7 h)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
88/97/6df7c7a4b0a90f9d350e0337e65a
Default Alt Text
TabPanelLayout.php (2 KB)

Event Timeline