Class: FieldsetLayout

.ui.FieldsetLayout(configopt)

new FieldsetLayout(configopt)

FieldsetLayouts are composed of one or more FieldLayouts, which each contain an individual widget and, optionally, a label. Each Fieldset can be configured with a label as well. For more information and examples, please see the [OOjs UI documentation on MediaWiki][1].

Parameters:
Name Type Attributes Description
config Object <optional>

Configuration options

Properties
Name Type Attributes Description
items Array.<OO.ui.FieldLayout> <optional>

An array of fields to add to the fieldset. See OO.ui.FieldLayout for more information about fields.
help string | OO.ui.HtmlSnippet <optional>

Help text. When help text is specified, a "help" icon will appear in the upper-right corner of the rendered field; clicking it will display the text in a popup. For important messages, you are advised to use notices, as they are always shown.
$overlay jQuery <optional>

Passed to OO.ui.PopupButtonWidget for help popup, if help is given. See .
Mixes In:
Source:
Example
// Example of a fieldset layout
    var input1 = new OO.ui.TextInputWidget( {
        placeholder: 'A text input field'
    } );

    var input2 = new OO.ui.TextInputWidget( {
        placeholder: 'A text input field'
    } );

    var fieldset = new OO.ui.FieldsetLayout( {
        label: 'Example of a fieldset layout'
    } );

    fieldset.addItems( [
        new OO.ui.FieldLayout( input1, {
            label: 'Field One'
        } ),
        new OO.ui.FieldLayout( input2, {
            label: 'Field Two'
        } )
    ] );
    $( 'body' ).append( fieldset.$element );

[1]: https://www.mediawiki.org/wiki/OOjs_UI/Layouts/Fields_and_Fieldsets

Extends

Methods

getClosestScrollableElementContainer() → {HTMLElement}

Get closest scrollable container.

Inherited From:
Source:
Returns:

Closest scrollable container

Type
HTMLElement

getData() → {Mixed}

Get element data.

Inherited From:
Source:
Returns:

Element data

Type
Mixed

getElementDocument() → {HTMLDocument}

Get the DOM document.

Inherited From:
Source:
Returns:

Document object

Type
HTMLDocument

getElementGroup() → {OO.ui.mixin.GroupElement|null}

Get group element is in.

Inherited From:
Source:
Returns:

Group element, null if none

Type
OO.ui.mixin.GroupElement | null

getElementId() → {string}

Ensure that the element has an 'id' attribute, setting it to an unique value if it's missing, and return its value.

Inherited From:
Source:
Returns:
Type
string

getElementWindow() → {Window}

Get the DOM window.

Inherited From:
Source:
Returns:

Window object

Type
Window

getTagName() → {string}

Get the HTML tag name.

Override this method to base the result on instance information.

Inherited From:
Source:
Returns:

HTML tag name

Type
string

isElementAttached() → {boolean}

Check if the element is attached to the DOM

Inherited From:
Source:
Returns:

The element is attached to the DOM

Type
boolean

isVisible() → {boolean}

Check if element is visible.

Inherited From:
Source:
Returns:

element is visible

Type
boolean

(protected) restorePreInfuseState(state)

Restore the pre-infusion dynamic state for this widget.

This method is called after #$element has been inserted into DOM. The parameter is the return value of #gatherPreInfuseState.

Parameters:
Name Type Description
state Object
Inherited From:
Source:

scrollElementIntoView(configopt) → {jQuery.Promise}

Scroll element into view.

Parameters:
Name Type Attributes Description
config Object <optional>

Configuration options
Inherited From:
Source:
Returns:

Promise which resolves when the scroll is complete

Type
jQuery.Promise

setData(data)

Set element data.

Parameters:
Name Type Description
data Mixed

Element data
Inherited From:
Source:

setElementGroup(group)

Set group element is in.

Parameters:
Name Type Description
group OO.ui.mixin.GroupElement | null

Group element, null if none
Inherited From:
Source:

setElementId(id)

Set the element has an 'id' attribute.

Parameters:
Name Type Description
id string
Inherited From:
Source:

supports(methods) → {boolean}

Check if element supports one or more methods.

Parameters:
Name Type Description
methods string | Array.<string>

Method or list of methods to check
Inherited From:
Source:
Returns:

All methods are supported

Type
boolean

toggle(showopt)

Toggle visibility of an element.

Parameters:
Name Type Attributes Description
show boolean <optional>

Make element visible, omit to toggle visibility
Inherited From:
Source:
Fires:
  • event:visible

updateThemeClasses()

Update the theme-provided classes.

Inherited From:
Source: