# all files / src/layouts/ ActionFieldLayout.js

100% Statements 14/14
83.33% Branches 5/6
100% Functions 1/1
100% Lines 14/14

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79

    1×

    608×
    608×
    608×
    608×

    608×

    608×
    608×
    608×

    608×

    608×

    608×

    608×

    1×
     /**
     * ActionFieldLayouts are used with OO.ui.FieldsetLayout. The layout consists of a field-widget, a button,
     * and an optional label and/or help text. The field-widget (e.g., a {@link OO.ui.TextInputWidget TextInputWidget}),
     * is required and is specified before any optional configuration settings.
     *
     * Labels can be aligned in one of four ways:
     *
     * - **left**: The label is placed before the field-widget and aligned with the left margin.
     *   A left-alignment is used for forms with many fields.
     * - **right**: The label is placed before the field-widget and aligned to the right margin.
     *   A right-alignment is used for long but familiar forms which users tab through,
     *   verifying the current field with a quick glance at the label.
     * - **top**: The label is placed above the field-widget. A top-alignment is used for brief forms
     *   that users fill out from top to bottom.
     * - **inline**: The label is placed after the field-widget and aligned to the left.
     *   An inline-alignment is best used with checkboxes or radio buttons.
     *
     * Help text is accessed via a help icon that appears in the upper right corner of the rendered field layout when help
     * text is specified.
     *
     *     @example
     *     // Example of an ActionFieldLayout
     *     var actionFieldLayout = new OO.ui.ActionFieldLayout(
     *         new OO.ui.TextInputWidget( {
     *             placeholder: 'Field widget'
     *         } ),
     *         new OO.ui.ButtonWidget( {
     *             label: 'Button'
     *         } ),
     *         {
     *             label: 'An ActionFieldLayout. This label is aligned top',
     *             align: 'top',
     *             help: 'This is help text'
     *         }
     *     );
     *
     *     $( 'body' ).append( actionFieldLayout.$element );
     *
     * @class
     * @extends OO.ui.FieldLayout
     *
     * @constructor
     * @param {OO.ui.Widget} fieldWidget Field widget
     * @param {OO.ui.ButtonWidget} buttonWidget Button widget
     * @param {Object} config
     */
    OO.ui.ActionFieldLayout = function OoUiActionFieldLayout( fieldWidget, buttonWidget, config ) {
    	// Allow passing positional parameters inside the config object
    	Eif ( OO.isPlainObject( fieldWidget ) && config === undefined ) {
    		config = fieldWidget;
    		fieldWidget = config.fieldWidget;
    		buttonWidget = config.buttonWidget;
    	}

    	// Parent constructor
    	OO.ui.ActionFieldLayout.parent.call( this, fieldWidget, config );

    	// Properties
    	this.buttonWidget = buttonWidget;
    	this.$button = $( '<span>' );
    	this.$input = this.isFieldInline() ? $( '<span>' ) : $( '<div>' );

    	// Initialization
    	this.$element
    		.addClass( 'oo-ui-actionFieldLayout' );
    	this.$button
    		.addClass( 'oo-ui-actionFieldLayout-button' )
    		.append( this.buttonWidget.$element );
    	this.$input
    		.addClass( 'oo-ui-actionFieldLayout-input' )
    		.append( this.fieldWidget.$element );
    	this.$field
    		.append( this.$input, this.$button );
    };

    /* Setup */

    OO.inheritClass( OO.ui.ActionFieldLayout, OO.ui.FieldLayout );