Object-Oriented User Interface
OOUI\MenuLayout Class Reference

MenuLayouts combine a menu and a content PanelLayout panel. More...

+ Inheritance diagram for OOUI\MenuLayout:
+ Collaboration diagram for OOUI\MenuLayout:

Public Member Functions

 __construct (array $config=[])
 getConfig (&$config)
 toggleMenu ( $showMenu)
 setMenuPosition ( $position)
 setMenuPanel (PanelLayout $menuPanel)
 setContentPanel (PanelLayout $contentPanel)
- Public Member Functions inherited from OOUI\Element
 getTagName ()
 Get the HTML tag name. More...
 toggle ( $show=null)
 Toggle visibility of an element. More...
 getData ()
 Get element data. More...
 setData ( $data)
 Set element data. More...
 supports ( $methods)
 Check if element supports one or more methods. More...
 registerConfigCallback (callable $func)
 Register an additional function to call when building the config. More...
 toString ()
 Render element into HTML. More...
- Public Member Functions inherited from OOUI\Tag
 __construct ( $tag='div')
 Create element. More...
 hasClass ( $class)
 Check for CSS class. More...
 addClasses (array $classes)
 Add CSS classes. More...
 removeClasses (array $classes)
 Remove CSS classes. More...
 toggleClasses (array $classes, $toggle=null)
 Toggle CSS classes. More...
 getTag ()
 getAttribute ( $key)
 Get HTML attribute value. More...
 setAttributes (array $attributes)
 Add HTML attributes. More...
 setValue ( $value)
 Set value of input element ('value' attribute for most, element content for textarea). More...
 removeAttributes (array $keys)
 Remove HTML attributes. More...
 removeContent (... $content)
 Remove any items that match by reference. More...
 appendContent (... $content)
 Add content to the end. More...
 prependContent (... $content)
 Add content to the beginning. More...
 clearContent ()
 Remove all content. More...
 getElementGroup ()
 Get group element is in. More...
 setElementGroup ( $group)
 Set group element is in. More...
 setInfusable ( $infusable)
 Enable widget for client-side infusion. More...
 isInfusable ()
 Get client-side infusability. More...
 ensureInfusableId ()
 Ensure that this given Tag is infusable and has a unique id attribute. More...
 __toString ()
 Magic method implementation. More...

Protected Attributes

Tag $menuWrapper
Tag $contentWrapper
PanelLayout $menuPanel
PanelLayout $contentPanel
string $menuPosition
bool $expanded
- Protected Attributes inherited from OOUI\Element
mixed $data = null
 Element data.
bool $visible = true
array $ownClasses = []
 Strings of the CSS classes explicitly configured for this element (as opposed to $classes, which contains all classes for this element).
callable[] $configCallbacks = []
- Protected Attributes inherited from OOUI\Tag
string $tag = ''
 Tag name for this instance. More...
array $attributes = []
 Attributes. More...
array $classes = []
 Classes. More...
array $content = []
 Content. More...
GroupElement null $elementGroup = null
 Group. More...
bool $infusable = false
 Infusion support. More...

Additional Inherited Members

- Static Public Member Functions inherited from OOUI\Element
static warnDeprecation ( $message='')
 Emits a deprecation warning with provided message. More...
static getDir (Tag $element)
 Get the direction of the user interface for a given element. More...
static setDefaultDir ( $dir)
 Set the default direction of the user interface. More...
static configFromHtmlAttributes (array $attrs)
 A helper method to massage an array of HTML attributes into a format that is more likely to work with an OOUI PHP element, camel-casing attribute names and setting values of boolean ones to true. More...
- Static Public Member Functions inherited from OOUI\Tag
static generateElementId ()
 Generate a unique ID for element. More...
static isSafeUrl ( $url)
 Check whether user-supplied URL is safe, that is, whether outputting it will not result in XSS vulnerability. More...
- Static Public Attributes inherited from OOUI\Element
static string $tagName = 'div'
 HTML tag name. More...
static string $defaultDir = 'ltr'
 Default text direction, used for some layout calculations. More...
- Protected Member Functions inherited from OOUI\Element
 getJavaScriptClassName ()
 The class name of the JavaScript version of this widget. More...
 getGeneratedAttributes ()

Detailed Description

MenuLayouts combine a menu and a content PanelLayout panel.

The menu is positioned relative to the content (after, before, top, or bottom)

Constructor & Destructor Documentation

◆ __construct()

OOUI\MenuLayout::__construct ( array  $config = [])
array$configConfiguration options
  • PanelLayout $config['menuPanel'] Menu panel
  • PanelLayout $config['contentPanel'] Content panel
  • bool $config['expanded'] Expand content to fill the parent element (default: true)
  • bool $config['showMenu'] Show menu (default: true)
  • string $config['menuPosition'] top, after, bottom, before (default: before) @phpcs:ignore Generic.Files.LineLength @phan-param array{menuPanel:PanelLayout,contentPanel:PanelLayout,expanded?:bool,showMenu?:bool,menuPosition?:string} $config

Reimplemented from OOUI\Layout.

Reimplemented in OOUI\IndexLayout.

Member Function Documentation

◆ setContentPanel()

OOUI\MenuLayout::setContentPanel ( PanelLayout  $contentPanel)

◆ setMenuPanel()

OOUI\MenuLayout::setMenuPanel ( PanelLayout  $menuPanel)

◆ setMenuPosition()

OOUI\MenuLayout::setMenuPosition (   $position)

◆ toggleMenu()

OOUI\MenuLayout::toggleMenu (   $showMenu)

The documentation for this class was generated from the following file: