[This documentation is preliminary and is subject to change.]
Applies to: Metro style apps only
Displays lightweight UI that is either information, or requires user interaction. Unlike a dialog, a Flyout can be light dismissed by clicking or tapping off of it.
Syntax
<div data-win-control="WinJS.UI.Flyout"></div>
var object = new WinJS.UI.Flyout(element, options);
Members
The Flyout object has these types of members:
Events
The Flyout object has these events.
| Event | Description |
|---|---|
| afterhide Event |
Raised immediately after a flyout is fully hidden. |
| aftershow Event |
Raised immediately after a flyout is fully shown. |
| beforehide Event |
Raised just before hiding a flyout. |
| beforeshow Event |
Raised just before showing a flyout. |
Methods
The Flyout object has these methods.
| Method | Description |
|---|---|
| addEventListener |
Registers an event handler for the specified event. |
| Flyout |
Creates a new Flyout object. |
| hide Method |
Hides the Flyout, if visible, regardless of other states. |
| removeEventListener |
Removes an event handler that the addEventListener method registered. |
| show Method |
Shows the Flyout, if hidden, regardless of other states. |
Properties
The Flyout object has these properties.
| Property | Description |
|---|---|
|
Gets or sets the default alignment to be used for this Flyout. | |
|
Gets or sets the default anchor to be used for this Flyout. | |
|
Gets the DOM element that hosts the Flyout. | |
|
Gets a value that indicates whether the Flyout is hidden or in the process of becoming hidden. | |
|
Gets or sets the default placement to be used for this Flyout. |
Remarks
Styling the Flyout
CSS classes
To customize the Flyout, you can define your own styles for these CSS classes (defined by the Windows Library for JavaScript style sheets):
| CSS class | Description |
|---|---|
|
win-flyout |
Styles the entire Flyout. |
Requirements
|
Minimum supported client | Windows 8 Release Preview |
|---|---|
|
Minimum supported server | Windows Server 2012 |
|
Namespace |
WinJS.UI |
|
Library |
|
Build date: 5/22/2012
