OOUI/Elements

From MediaWiki.org
Jump to: navigation, search

The most basic component of the OOUI library is called an element (OO.ui.Element), which is an object that represents a rendering in the DOM—a button or an icon, for example, or anything that is visible to a user. Unlike widgets, plain elements usually do not have events connected to them and can't be interacted with.

Every OOUI element has an $element property, which is a jQuery selection of its rendered contents. Note that OOUI uses the $ prefix for the names of all variables and properties that refer to jQuery selections of DOM elements. The $element property is extremely useful, and is used, for example, when creating OOUI widgets and appending them to the DOM.

Example[edit]

// Create a <div></div> element object with the text “Sample Text“ and class `sample`
var e = new OO.ui.Element( {
	tag: 'div',
	text: 'Sample Text',
	classes: [ 'sample' ]
} );

// Append the element to the DOM
$( 'body' ).append( e.$element );

The resulting HTML will look like this:

<body>
	<div class="sample">Sample Text</div>
</body>

See also[edit]

See Group elements for more information about GroupElements.