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 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 | 1× 2346× 1736× 1736× 2346× 2346× 2346× 2346× 2346× 2346× 2346× 2346× 2346× 2346× 2346× 2346× 2346× 2346× 2346× 2346× 2346× 2346× 1154× 1192× 2346× 2346× 2346× 2346× 2346× 2346× 2346× 2346× 2346× 1× 1× 1× 1× 1× 3146× 1× 3146× 1× 1824× 1824× 1824× 1216× 1216× 608× 608× 1824× 1824× 1824× 1× 2346× 2346× 2346× 64× 2346× 386× 386× 1960× 128× 128× 1832× 1832× 2346× 2346× 2346× 2346× 1× 2346× 2346× 2346× 1× 2346× 2346× 2346× 1× 4692× 4692× 4692× 1696× 2996× 2996× 1696× 608× 1696× 1216× 1× 1440× 720× 720× | /** * FieldLayouts are used with OO.ui.FieldsetLayout. Each FieldLayout requires a field-widget, * which is a widget that is specified by reference before any optional configuration settings. * * Field layouts can be configured with help text and/or labels. Labels are 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. * Please see the [OOUI documentation on MediaWiki] [1] for examples and more information. * * [1]: https://www.mediawiki.org/wiki/OOUI/Layouts/Fields_and_Fieldsets * * @class * @extends OO.ui.Layout * @mixins OO.ui.mixin.LabelElement * @mixins OO.ui.mixin.TitledElement * * @constructor * @param {OO.ui.Widget} fieldWidget Field widget * @param {Object} [config] Configuration options * @cfg {string} [align='left'] Alignment of the label: 'left', 'right', 'top' or 'inline' * @cfg {Array} [errors] Error messages about the widget, which will be displayed below the widget. * The array may contain strings or OO.ui.HtmlSnippet instances. * @cfg {Array} [notices] Notices about the widget, which will be displayed below the widget. * The array may contain strings or OO.ui.HtmlSnippet instances. * @cfg {string|OO.ui.HtmlSnippet} [help] 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. * @cfg {jQuery} [$overlay] Passed to OO.ui.PopupButtonWidget for help popup, if `help` is given. * See <https://www.mediawiki.org/wiki/OOUI/Concepts#Overlays>. * * @throws {Error} An error is thrown if no widget is specified */ OO.ui.FieldLayout = function OoUiFieldLayout( fieldWidget, config ) { // Allow passing positional parameters inside the config object if ( OO.isPlainObject( fieldWidget ) && config === undefined ) { config = fieldWidget; fieldWidget = config.fieldWidget; } // Make sure we have required constructor arguments Iif ( fieldWidget === undefined ) { throw new Error( 'Widget not found' ); } // Configuration initialization config = $.extend( { align: 'left' }, config ); // Parent constructor OO.ui.FieldLayout.parent.call( this, config ); // Mixin constructors OO.ui.mixin.LabelElement.call( this, $.extend( {}, config, { $label: $( '<label>' ) } ) ); OO.ui.mixin.TitledElement.call( this, $.extend( {}, config, { $titled: this.$label } ) ); // Properties this.fieldWidget = fieldWidget; this.errors = []; this.notices = []; this.$field = this.isFieldInline() ? $( '<span>' ) : $( '<div>' ); this.$messages = $( '<ul>' ); this.$header = $( '<span>' ); this.$body = $( '<div>' ); this.align = null; Iif ( config.help ) { this.popupButtonWidget = new OO.ui.PopupButtonWidget( { $overlay: config.$overlay, popup: { padded: true }, classes: [ 'oo-ui-fieldLayout-help' ], framed: false, icon: 'info' } ); if ( config.help instanceof OO.ui.HtmlSnippet ) { this.popupButtonWidget.getPopup().$body.html( config.help.toString() ); } else { this.popupButtonWidget.getPopup().$body.text( config.help ); } this.$help = this.popupButtonWidget.$element; } else { this.$help = $( [] ); } // Events this.fieldWidget.connect( this, { disable: 'onFieldDisable' } ); // Initialization Iif ( config.help ) { // Set the 'aria-describedby' attribute on the fieldWidget // Preference given to an input or a button ( this.fieldWidget.$input || this.fieldWidget.$button || this.fieldWidget.$element ).attr( 'aria-describedby', this.popupButtonWidget.getPopup().getBodyId() ); } if ( this.fieldWidget.getInputId() ) { this.$label.attr( 'for', this.fieldWidget.getInputId() ); } else { this.$label.on( 'click', function () { this.fieldWidget.simulateLabelClick(); }.bind( this ) ); } this.$element .addClass( 'oo-ui-fieldLayout' ) .toggleClass( 'oo-ui-fieldLayout-disabled', this.fieldWidget.isDisabled() ) .append( this.$body ); this.$body.addClass( 'oo-ui-fieldLayout-body' ); this.$header.addClass( 'oo-ui-fieldLayout-header' ); this.$messages.addClass( 'oo-ui-fieldLayout-messages' ); this.$field .addClass( 'oo-ui-fieldLayout-field' ) .append( this.fieldWidget.$element ); this.setErrors( config.errors || [] ); this.setNotices( config.notices || [] ); this.setAlignment( config.align ); // Call this again to take into account the widget's accessKey this.updateTitle(); }; /* Setup */ OO.inheritClass( OO.ui.FieldLayout, OO.ui.Layout ); OO.mixinClass( OO.ui.FieldLayout, OO.ui.mixin.LabelElement ); OO.mixinClass( OO.ui.FieldLayout, OO.ui.mixin.TitledElement ); /* Methods */ /** * Handle field disable events. * * @private * @param {boolean} value Field is disabled */ OO.ui.FieldLayout.prototype.onFieldDisable = function ( value ) { this.$element.toggleClass( 'oo-ui-fieldLayout-disabled', value ); }; /** * Get the widget contained by the field. * * @return {OO.ui.Widget} Field widget */ OO.ui.FieldLayout.prototype.getField = function () { return this.fieldWidget; }; /** * Return `true` if the given field widget can be used with `'inline'` alignment (see * #setAlignment). Return `false` if it can't or if this can't be determined. * * @return {boolean} */ OO.ui.FieldLayout.prototype.isFieldInline = function () { // This is very simplistic, but should be good enough. return this.getField().$element.prop( 'tagName' ).toLowerCase() === 'span'; }; /** * @protected * @param {string} kind 'error' or 'notice' * @param {string|OO.ui.HtmlSnippet} text * @return {jQuery} */ OO.ui.FieldLayout.prototype.makeMessage = function ( kind, text ) { var $listItem, $icon, message; $listItem = $( '<li>' ); if ( kind === 'error' ) { $icon = new OO.ui.IconWidget( { icon: 'alert', flags: [ 'warning' ] } ).$element; $listItem.attr( 'role', 'alert' ); } else Eif ( kind === 'notice' ) { $icon = new OO.ui.IconWidget( { icon: 'notice' } ).$element; } else { $icon = ''; } message = new OO.ui.LabelWidget( { label: text } ); $listItem .append( $icon, message.$element ) .addClass( 'oo-ui-fieldLayout-messages-' + kind ); return $listItem; }; /** * Set the field alignment mode. * * @private * @param {string} value Alignment mode, either 'left', 'right', 'top' or 'inline' * @chainable */ OO.ui.FieldLayout.prototype.setAlignment = function ( value ) { Eif ( value !== this.align ) { // Default to 'left' Iif ( [ 'left', 'right', 'top', 'inline' ].indexOf( value ) === -1 ) { value = 'left'; } // Validate if ( value === 'inline' && !this.isFieldInline() ) { value = 'top'; } // Reorder elements if ( value === 'top' ) { this.$header.append( this.$help, this.$label ); this.$body.append( this.$header, this.$field ); } else if ( value === 'inline' ) { this.$header.append( this.$help, this.$label ); this.$body.append( this.$field, this.$header ); } else { this.$header.append( this.$label ); this.$body.append( this.$header, this.$help, this.$field ); } // Set classes. The following classes can be used here: // * oo-ui-fieldLayout-align-left // * oo-ui-fieldLayout-align-right // * oo-ui-fieldLayout-align-top // * oo-ui-fieldLayout-align-inline Iif ( this.align ) { this.$element.removeClass( 'oo-ui-fieldLayout-align-' + this.align ); } this.$element.addClass( 'oo-ui-fieldLayout-align-' + value ); this.align = value; } return this; }; /** * Set the list of error messages. * * @param {Array} errors Error messages about the widget, which will be displayed below the widget. * The array may contain strings or OO.ui.HtmlSnippet instances. * @chainable */ OO.ui.FieldLayout.prototype.setErrors = function ( errors ) { this.errors = errors.slice(); this.updateMessages(); return this; }; /** * Set the list of notice messages. * * @param {Array} notices Notices about the widget, which will be displayed below the widget. * The array may contain strings or OO.ui.HtmlSnippet instances. * @chainable */ OO.ui.FieldLayout.prototype.setNotices = function ( notices ) { this.notices = notices.slice(); this.updateMessages(); return this; }; /** * Update the rendering of error and notice messages. * * @private */ OO.ui.FieldLayout.prototype.updateMessages = function () { var i; this.$messages.empty(); if ( this.errors.length || this.notices.length ) { this.$body.after( this.$messages ); } else { this.$messages.remove(); return; } for ( i = 0; i < this.notices.length; i++ ) { this.$messages.append( this.makeMessage( 'notice', this.notices[ i ] ) ); } for ( i = 0; i < this.errors.length; i++ ) { this.$messages.append( this.makeMessage( 'error', this.errors[ i ] ) ); } }; /** * Include information about the widget's accessKey in our title. TitledElement calls this method. * (This is a bit of a hack.) * * @protected * @param {string} title Tooltip label for 'title' attribute * @return {string} */ OO.ui.FieldLayout.prototype.formatTitleWithAccessKey = function ( title ) { if ( this.fieldWidget && this.fieldWidget.formatTitleWithAccessKey ) { return this.fieldWidget.formatTitleWithAccessKey( title ); } return title; }; |