| 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 |
1×
736×
736×
736×
736×
736×
736×
736×
736×
736×
736×
736×
632×
104×
736×
308×
736×
308×
736×
736×
1×
1×
1160×
1160×
764×
764×
764×
1160×
1×
1×
736×
18×
736×
736×
736×
664×
72×
736×
736×
1×
1×
732×
732×
1×
732×
732×
1×
1×
1×
| /**
* MenuLayouts combine a menu and a content {@link OO.ui.PanelLayout panel}. The menu is positioned
* relative to the content (after, before, top, or bottom) and its size is customized with the
* #menuSize config. The content area will fill all remaining space.
*
* If menu size needs to be overridden, it can be accomplished using CSS similar to the snippet
* below. MenuLayout's CSS will override the appropriate values with 'auto' or '0' to display the
* menu correctly. If `menuPosition` is known beforehand, CSS rules corresponding to other positions
* may be omitted.
*
* .oo-ui-menuLayout-menu {
* width: 200px;
* height: 200px;
* }
*
* .oo-ui-menuLayout-content {
* top: 200px;
* left: 200px;
* right: 200px;
* bottom: 200px;
* }
*
* @example
* let menuLayout;
* const menuPanel = new OO.ui.PanelLayout( {
* padded: true,
* expanded: true,
* scrollable: true
* } ),
* contentPanel = new OO.ui.PanelLayout( {
* padded: true,
* expanded: true,
* scrollable: true
* } ),
* select = new OO.ui.SelectWidget( {
* items: [
* new OO.ui.OptionWidget( {
* data: 'before',
* label: 'Before'
* } ),
* new OO.ui.OptionWidget( {
* data: 'after',
* label: 'After'
* } ),
* new OO.ui.OptionWidget( {
* data: 'top',
* label: 'Top'
* } ),
* new OO.ui.OptionWidget( {
* data: 'bottom',
* label: 'Bottom'
* } )
* ]
* } ).on( 'select', function ( item ) {
* menuLayout.setMenuPosition( item.getData() );
* } );
*
* menuLayout = new OO.ui.MenuLayout( {
* position: 'top',
* menuPanel: menuPanel,
* contentPanel: contentPanel
* } );
* menuLayout.$menu.append(
* menuPanel.$element.append( '<b>Menu panel</b>', select.$element )
* );
* menuLayout.$content.append(
* contentPanel.$element.append(
* '<b>Content panel</b>',
* '<p>Note that the menu is positioned relative to the content panel: ' +
* 'top, bottom, after, before.</p>'
* )
* );
* $( document.body ).append( menuLayout.$element );
*
* @class
* @extends OO.ui.Layout
*
* @constructor
* @param {Object} [config] Configuration options
* @param {OO.ui.PanelLayout} [config.menuPanel] Menu panel
* @param {OO.ui.PanelLayout} [config.contentPanel] Content panel
* @param {boolean} [config.expanded=true] Expand the layout to fill the entire parent element.
* @param {boolean} [config.showMenu=true] Show menu
* @param {string} [config.menuPosition='before'] Position of menu: `top`, `after`, `bottom` or `before`
*/
OO.ui.MenuLayout = function OoUiMenuLayout( config ) {
// Configuration initialization
config = $.extend( {
expanded: true,
showMenu: true,
menuPosition: 'before'
}, config );
// Parent constructor
OO.ui.MenuLayout.super.call( this, config );
this.menuPanel = null;
this.contentPanel = null;
this.expanded = !!config.expanded;
/**
* Menu DOM node
*
* @property {jQuery}
*/
this.$menu = $( '<div>' );
/**
* Content DOM node
*
* @property {jQuery}
*/
this.$content = $( '<div>' );
// Initialization
this.$menu.addClass( 'oo-ui-menuLayout-menu' );
this.$content.addClass( 'oo-ui-menuLayout-content' );
this.$element.addClass( 'oo-ui-menuLayout' );
if ( config.expanded ) {
this.$element.addClass( 'oo-ui-menuLayout-expanded' );
} else {
this.$element.addClass( 'oo-ui-menuLayout-static' );
}
if ( config.menuPanel ) {
this.setMenuPanel( config.menuPanel );
}
if ( config.contentPanel ) {
this.setContentPanel( config.contentPanel );
}
this.setMenuPosition( config.menuPosition );
this.toggleMenu( config.showMenu );
};
/* Setup */
OO.inheritClass( OO.ui.MenuLayout, OO.ui.Layout );
/* Methods */
/**
* Toggle menu.
*
* @param {boolean} [showMenu] Show menu, omit to toggle
* @chainable
* @return {OO.ui.MenuLayout} The layout, for chaining
*/
OO.ui.MenuLayout.prototype.toggleMenu = function ( showMenu ) {
showMenu = showMenu === undefined ? !this.showMenu : !!showMenu;
if ( this.showMenu !== showMenu ) {
this.showMenu = showMenu;
this.$element
.toggleClass( 'oo-ui-menuLayout-showMenu', this.showMenu )
.toggleClass( 'oo-ui-menuLayout-hideMenu', !this.showMenu );
this.$menu.attr( 'aria-hidden', this.showMenu ? 'false' : 'true' );
}
return this;
};
/**
* Check if menu is visible
*
* @return {boolean} Menu is visible
*/
OO.ui.MenuLayout.prototype.isMenuVisible = function () {
return this.showMenu;
};
/**
* Set menu position.
*
* @param {string} position Position of menu, either `top`, `after`, `bottom` or `before`
* @chainable
* @return {OO.ui.MenuLayout} The layout, for chaining
*/
OO.ui.MenuLayout.prototype.setMenuPosition = function ( position ) {
if ( [ 'top', 'bottom', 'before', 'after' ].indexOf( position ) === -1 ) {
position = 'before';
}
this.$element.removeClass( 'oo-ui-menuLayout-' + this.menuPosition );
this.menuPosition = position;
if ( this.menuPosition === 'top' || this.menuPosition === 'before' ) {
this.$element.append( this.$menu, this.$content );
} else {
this.$element.append( this.$content, this.$menu );
}
this.$element.addClass( 'oo-ui-menuLayout-' + position );
return this;
};
/**
* Get menu position.
*
* @return {string} Menu position
*/
OO.ui.MenuLayout.prototype.getMenuPosition = function () {
return this.menuPosition;
};
/**
* Set the menu panel.
*
* @param {OO.ui.PanelLayout} menuPanel Menu panel
*/
OO.ui.MenuLayout.prototype.setMenuPanel = function ( menuPanel ) {
this.menuPanel = menuPanel;
this.$menu.append( this.menuPanel.$element );
};
/**
* Set the content panel.
*
* @param {OO.ui.PanelLayout} contentPanel Content panel
*/
OO.ui.MenuLayout.prototype.setContentPanel = function ( contentPanel ) {
this.contentPanel = contentPanel;
this.$content.append( this.contentPanel.$element );
};
/**
* Clear the menu panel.
*/
OO.ui.MenuLayout.prototype.clearMenuPanel = function () {
this.menuPanel = null;
this.$menu.empty();
};
/**
* Clear the content panel.
*/
OO.ui.MenuLayout.prototype.clearContentPanel = function () {
this.contentPanel = null;
this.$content.empty();
};
/**
* Reset the scroll offset of all panels and the tab select widget
*
* @inheritdoc
*/
OO.ui.MenuLayout.prototype.resetScroll = function () {
if ( this.menuPanel ) {
this.menuPanel.resetScroll();
}
if ( this.contentPanel ) {
this.contentPanel.resetScroll();
}
return this;
};
|