diff options
Diffstat (limited to 'vendor/oojs/oojs-ui/src/layouts/PanelLayout.js')
-rw-r--r-- | vendor/oojs/oojs-ui/src/layouts/PanelLayout.js | 55 |
1 files changed, 55 insertions, 0 deletions
diff --git a/vendor/oojs/oojs-ui/src/layouts/PanelLayout.js b/vendor/oojs/oojs-ui/src/layouts/PanelLayout.js new file mode 100644 index 00000000..9183f597 --- /dev/null +++ b/vendor/oojs/oojs-ui/src/layouts/PanelLayout.js @@ -0,0 +1,55 @@ +/** + * PanelLayouts expand to cover the entire area of their parent. They can be configured with scrolling, padding, + * and a frame, and are often used together with {@link OO.ui.StackLayout StackLayouts}. + * + * @example + * // Example of a panel layout + * var panel = new OO.ui.PanelLayout( { + * expanded: false, + * framed: true, + * padded: true, + * $content: $( '<p>A panel layout with padding and a frame.</p>' ) + * } ); + * $( 'body' ).append( panel.$element ); + * + * @class + * @extends OO.ui.Layout + * + * @constructor + * @param {Object} [config] Configuration options + * @cfg {boolean} [scrollable=false] Allow vertical scrolling + * @cfg {boolean} [padded=false] Add padding between the content and the edges of the panel. + * @cfg {boolean} [expanded=true] Expand the panel to fill the entire parent element. + * @cfg {boolean} [framed=false] Render the panel with a frame to visually separate it from outside content. + */ +OO.ui.PanelLayout = function OoUiPanelLayout( config ) { + // Configuration initialization + config = $.extend( { + scrollable: false, + padded: false, + expanded: true, + framed: false + }, config ); + + // Parent constructor + OO.ui.PanelLayout.super.call( this, config ); + + // Initialization + this.$element.addClass( 'oo-ui-panelLayout' ); + if ( config.scrollable ) { + this.$element.addClass( 'oo-ui-panelLayout-scrollable' ); + } + if ( config.padded ) { + this.$element.addClass( 'oo-ui-panelLayout-padded' ); + } + if ( config.expanded ) { + this.$element.addClass( 'oo-ui-panelLayout-expanded' ); + } + if ( config.framed ) { + this.$element.addClass( 'oo-ui-panelLayout-framed' ); + } +}; + +/* Setup */ + +OO.inheritClass( OO.ui.PanelLayout, OO.ui.Layout ); |