components/window
Type Aliases
Section titled “Type Aliases”WindowFrameProps
Section titled “WindowFrameProps”WindowFrameProps =
HTMLAttributes<HTMLElement> > &object
Window presentation only. The host owns geometry, focus order and lifecycle.
Type Declaration
Section titled “Type Declaration”active?
Section titled “active?”
optionalactive?:boolean
floating?
Section titled “floating?”
optionalfloating?:boolean
variant?
Section titled “variant?”
optionalvariant?:"molded"|"ink"
molded is the App shell. ink draws the frame in the theme’s ink line with a
hard offset shadow, for game windows that sit over pixel art.
fitContent?
Section titled “fitContent?”
optionalfitContent?:boolean
Shrink a floating panel to its contents, up to the host’s max-height.
WindowHeaderProps
Section titled “WindowHeaderProps”WindowHeaderProps =
Omit<HTMLAttributes<HTMLElement>>,"title"|"children"> > &object
Supply handleProps only when the title is an interactive layout handle.
Type Declaration
Section titled “Type Declaration”title:
string
optionalicon?:ReactNode
actions?
Section titled “actions?”
optionalactions?:ReactNode
handleProps?
Section titled “handleProps?”
optionalhandleProps?:Omit<ButtonHTMLAttributes<HTMLButtonElement>>,"children"|"type">>
WindowActionsProps
Section titled “WindowActionsProps”WindowActionsProps =
object
Available callbacks determine available controls; no inert placeholder actions.
Properties
Section titled “Properties”title:
string
floating?
Section titled “floating?”
optionalfloating?:boolean
maximized?
Section titled “maximized?”
optionalmaximized?:boolean
onPromote?
Section titled “onPromote?”
optionalonPromote?: () =>void
Request making this window the main tiled window.
Returns
Section titled “Returns”void
onToggleFloating?
Section titled “onToggleFloating?”
optionalonToggleFloating?: () =>void
Request switching between floating and tiled placement.
Returns
Section titled “Returns”void
onToggleMaximize?
Section titled “onToggleMaximize?”
optionalonToggleMaximize?: () =>void
Request toggling maximized presentation.
Returns
Section titled “Returns”void
onMinimize?
Section titled “onMinimize?”
optionalonMinimize?: () =>void
Request minimizing; the caller owns window visibility.
Returns
Section titled “Returns”void
onClose?
Section titled “onClose?”
optionalonClose?: () =>void
Request closing; the caller owns disposal and removal.
Returns
Section titled “Returns”void
onSelect?
Section titled “onSelect?”
optionalonSelect?: () =>void
Select a compact game panel for reading on a narrow screen.
Returns
Section titled “Returns”void
Variables
Section titled “Variables”WindowFrame
Section titled “WindowFrame”
constWindowFrame:ForwardRefExoticComponent<HTMLAttributes<HTMLElement> > &object&RefAttributes<HTMLElement>>>>
A clipped, rounded shell for either a tiled or floating application.
WindowBody
Section titled “WindowBody”
constWindowBody:ForwardRefExoticComponent<HTMLAttributes<HTMLDivElement> > &RefAttributes<HTMLDivElement>>>>
The scrolling region stays inside the shell, beneath a stationary title bar.
GameWindowContent
Section titled “GameWindowContent”
constGameWindowContent:ForwardRefExoticComponent<HTMLAttributes<HTMLDivElement> > &RefAttributes<HTMLDivElement>>>>
Reading rhythm for compact game-window blocks and action keys.
Functions
Section titled “Functions”WindowSnapPreview()
Section titled “WindowSnapPreview()”WindowSnapPreview(
__namedParameters):Element
Decorative snap destination. Geometry and visibility belong to the layout owner.
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”HTMLAttributes<HTMLDivElement>
Returns
Section titled “Returns”Element
WindowHeader()
Section titled “WindowHeader()”WindowHeader(
__namedParameters):Element
The handle and actions are siblings, so action presses never start a drag.
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”Returns
Section titled “Returns”Element
WindowActions()
Section titled “WindowActions()”WindowActions(
__namedParameters):Element
Consistent icons, ordering and accessible names for host-owned commands.
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”Returns
Section titled “Returns”Element