PanelCollapserOverlay
A panel collapse implementation that adds the ability to reveal the collapsed panel as a floating overlay.
Configs
8
Configs
8By default, the following three events will hide the revealed overlay:
mousedownoutside of the revealed overlaymouseoutof the revealed overlayfocusoutof the revealed overlay
This can be configured per event type, for example:
// Don't hide on mouseout, only on click out
autoClose : {
mousedown : true,
mouseout : false,
focusout : false
}
Configure as a boolean to apply the same value for all events.
If the mousedown property is a selector string, clicks on elements matching that selector
will also close the revealed overlay:
// Close when clicking outside, but not when clicking grid cells - those should not close the overlay
autoClose : {
mousedown : ':not(.b-grid-cell)',
mouseout : false,
focusout : false
}
Note that if creating a whitelist using :not(), the :not() expression must encapsulate
your whitelist selector.
If the revealed overlay was shown using the recollapseTool then moving the mouse outside of the revealed overlay hides the revealed overlay.
Configure this as false to disable auto hiding, making overlayed
state permanent, and changeable using the toggleReveal method.
| Parameter | Type | Description |
|---|---|---|
mousedown | Boolean | String |
|
mouseout | Boolean |
|
focusout | Boolean |
|
The number of milliseconds to wait once the mouse leaves a revealed panel before returning to an unrevealed state. Clicking outside the revealed panel will immediately return the panel to its collapsed state.
This may be disabled by configuring autoClose.mouseout as false.
If this value is negative, the panel will not automatically recollapse due to the mouse leaving, however, clicks outside the panel will still recollapse it.
If this value is null, the panel will not automatically recollapse for either outside clicks or if
the mouse leaves the panel.
The reveal/hide tool which slides the collapsed panel over the top of the UI.
The type of this instance should not be changed but the tool instance can be
configured in other ways via this config property.
Properties
3
Properties
3Class hierarchy
Other
The reveal/hide tool which slides the collapsed panel over the top of the UI.
Functions
1
Functions
1Toggles the revealed state of the Panel to match the passed boolean flag.
| Parameter | Type | Description |
|---|---|---|
state | Boolean | If not specified, this method toggles current state. Otherwise, pass |