Flyout

A popup surface anchored to another component that opens/closes on interaction and hosts arbitrary content.

FlyoutComponent · type key standard.flyout · Layouts

new FlyoutComponent("flyout")

Properties

Property	Type	Default	Binding	Description
`IsOpen` SetIsOpen · BindIsOpen	`bool?`	`false`	two-way	Whether the flyout is open; two-way, so an anchor click, an outside click or Escape syncs back.
`FlyoutPlacement` SetFlyoutPlacement · BindFlyoutPlacement	`UIPopupPlacement?`	`UIPopupPlacement.BottomStart`	one-way	The preferred placement of the flyout relative to its anchor.
`CloseOnBackdrop` SetCloseOnBackdrop · BindCloseOnBackdrop	`bool?`	`true`	one-way	Whether clicking outside the flyout closes it.
`CloseOnEscape` SetCloseOnEscape · BindCloseOnEscape	`bool?`	`true`	one-way	Whether pressing Escape closes the flyout.

Events

OnOpen(string command): Registers a command to invoke when the flyout is opened.
OnOpen(string command, params KeyValuePair<string, UIActionArgument>[] arguments): Registers a command with bound arguments to invoke when the flyout is opened.
OnOpenLiteral(string command, params KeyValuePair<string, object>[] arguments): Registers a command with literal arguments to invoke when the flyout is opened.
OnClose(string command): Registers a command to invoke when the flyout is closed.
OnClose(string command, params KeyValuePair<string, UIActionArgument>[] arguments): Registers a command with bound arguments to invoke when the flyout is closed.
OnCloseLiteral(string command, params KeyValuePair<string, object>[] arguments): Registers a command with literal arguments to invoke when the flyout is closed.

Methods

SetAnchor(IVisualComponent component): Sets the anchor region the flyout is positioned relative to.
SetContent(IVisualComponent component): Sets the content region shown inside the flyout.
Open(): Sets FlyoutComponent.IsOpen to true.
Close(): Sets FlyoutComponent.IsOpen to false.

Common properties (16) — layout, visibility, theme, and the rest every component shares

Property	Type	Default	Binding	Description
`Visibility` SetVisibility · BindVisibility	`UIResponsive<UIVisibility>?`	`Visible`	one-way	What the component does with the room it was given, optionally overridden per breakpoint (e.g. collapsed from a given width up).
`Enabled` SetEnabled · BindEnabled	`bool?`	`true`	one-way	Whether the component responds to input; false dims it and marks it, and its subtree, inert.
`Theme` SetTheme · BindTheme	`UIThemeMode?`	`null`	one-way	The theme mode forced on this component's subtree, or `null` to inherit the ambient theme.
`HorizontalAlignment` SetHorizontalAlignment · BindHorizontalAlignment	`UIAlignment?`	`UIAlignment.Stretch`	one-way	Where the component sits within its grid cell along the horizontal axis.
`VerticalAlignment` SetVerticalAlignment · BindVerticalAlignment	`UIAlignment?`	`UIAlignment.Stretch`	one-way	Where the component sits within its grid cell along the vertical axis.
`Width` SetWidth · BindWidth	`UIResponsive<UILayoutLength>?`	`null`	one-way	The component width, optionally overridden per breakpoint.
`MinWidth` SetMinWidth · BindMinWidth	`UIResponsive<UILayoutLength>?`	`null`	one-way	The component minimum width, optionally overridden per breakpoint.
`MaxWidth` SetMaxWidth · BindMaxWidth	`UIResponsive<UILayoutLength>?`	`null`	one-way	The component maximum width, optionally overridden per breakpoint.
`Height` SetHeight · BindHeight	`UIResponsive<UILayoutLength>?`	`null`	one-way	The component height, optionally overridden per breakpoint.
`MinHeight` SetMinHeight · BindMinHeight	`UIResponsive<UILayoutLength>?`	`null`	one-way	The component minimum height, optionally overridden per breakpoint.
`MaxHeight` SetMaxHeight · BindMaxHeight	`UIResponsive<UILayoutLength>?`	`null`	one-way	The component maximum height, optionally overridden per breakpoint.
`ZIndex` SetZIndex · BindZIndex	`int?`	`0`	one-way	The stacking order within the visual tree.
`Margin` SetMargin · BindMargin	`UIResponsive<UIThickness>?`	`null`	one-way	The outer spacing around the component, optionally overridden per breakpoint.
`Placement` SetPlacement · BindPlacement	`UIResponsive<UIGridPlacement>?`	`null`	one-way	The grid placement, optionally overridden per breakpoint.
`Loading` SetLoading · BindLoading	`bool?`	`false`	one-way	Whether the component is in loading state — a live state a controller turns on and off.
`ShowContextMenu` SetShowContextMenu · BindShowContextMenu	`bool?`	`true`	one-way	Whether a right-click opens the `IVisualComponent.ContextMenu`; on a host with rows, whether it opens any row's. Off, the menu stays in the tree and nothing opens it.