components/window

Import

Import

import * as api from "@fungi.computer/caps/components/window";

Exports

Kind	Export	Description
Ttype alias	WindowFrameProps	Window presentation only. The host owns geometry, focus order and lifecycle.
Ttype alias	WindowBackAction	A host-owned request to go back inside the window’s content.
Ttype alias	WindowHeaderProps	Supply handleProps only when the title is an interactive layout handle.
Ttype alias	WindowActionsProps	Available callbacks determine available controls; no inert placeholder actions.
constconstant	WindowFrame	A clipped, rounded shell for either a tiled or floating application.
constconstant	WindowBody	The scrolling region stays inside the shell, beneath a stationary title bar.
constconstant	GameWindowContent	Reading rhythm for compact game-window blocks and action keys.
fnfunction	WindowSnapPreview()	Decorative snap destination. Geometry and visibility belong to the layout owner.
fnfunction	WindowHeader()	The handle, Back and actions are siblings, so presses never start a drag.
fnfunction	WindowActions()	Consistent icons, ordering and accessible names for host-owned commands.

WindowFramePropsTtype alias

Signature

type WindowFrameProps = HTMLAttributes<HTMLElement> & object;

Window presentation only. The host owns geometry, focus order and lifecycle.

Type Declaration

Name	Type	Description
active?	boolean	-
floating?	boolean	-
fitContent?	boolean	Shrink a floating panel to its contents, up to the host’s max-height.

---

WindowBackActionTtype alias

Signature

type WindowBackAction = object;

A host-owned request to go back inside the window’s content.

Properties

label

Signature

label: string;

Accessible name, e.g. “Back in Games”.

onBack

Signature

onBack: () => void;

Request going back; the host owns the history and the outcome.

Returns

void

hint?

Signature

optional hint?: string;

Tooltip text, e.g. the keyboard route to the same action.

---

WindowHeaderPropsTtype alias

Signature

type WindowHeaderProps = Omit<
  HTMLAttributes<HTMLElement>,
  "title" | "children"
> &
  object;

Supply handleProps only when the title is an interactive layout handle.

Type Declaration

Name	Type	Description
title	string	-
subtitle?	string	Where the content is now, shown after the title and truncated first.
icon?	ReactNode	-
actions?	ReactNode	-
back?	WindowBackAction	Present only while there is somewhere to go back to.
crumbs?	readonly WindowCrumb[]	The content’s path, shown in place of the title and subtitle. The last crumb is the current place; earlier ones are links, and a crumb with siblings is a switcher.
onCrumb()?	(crumbId, siblingId?) => void	Selected crumb, or the sibling chosen from a switcher crumb.
status?	readonly WindowStatus[]	Quiet facts about the view, such as “Valid” or “Saved”, with beads.
primary?	readonly WindowCommand[]	The view’s own commands, as buttons before the window controls.
menu?	readonly WindowCommand[]	Less common commands, behind a ⋯ menu.
onAction()?	(id) => void	A primary or menu command the person used, by its id.
popover?	HTMLElement | null	Where header menus open; the host’s popover layer.
density?	"regular" | "compact"	compact is a slim bar for tiled layouts; touch targets keep 44px.
handleProps?	Omit<ButtonHTMLAttributes<HTMLButtonElement>, "children" | "type">	-

---

WindowActionsPropsTtype alias

Signature

type WindowActionsProps = object;

Available callbacks determine available controls; no inert placeholder actions.

Properties

title

Signature

title: string;

floating?

Signature

optional floating?: boolean;

maximized?

Signature

optional maximized?: boolean;

onPromote?

Signature

optional onPromote?: () => void;

Request making this window the main tiled window.

Returns

void

onToggleFloating?

Signature

optional onToggleFloating?: () => void;

Request switching between floating and tiled placement.

Returns

void

onToggleMaximize?

Signature

optional onToggleMaximize?: () => void;

Request toggling maximized presentation.

Returns

void

onMinimize?

Signature

optional onMinimize?: () => void;

Request minimizing; the caller owns window visibility.

Returns

void

onClose?

Signature

optional onClose?: () => void;

Request closing; the caller owns disposal and removal.

Returns

void

onSelect?

Signature

optional onSelect?: () => void;

Select a compact game panel for reading on a narrow screen.

Returns

void

WindowFrameconstconstant

Signature

const WindowFrame: ForwardRefExoticComponent<
  HTMLAttributes<HTMLElement> & object & RefAttributes<HTMLElement>
>;

A clipped, rounded shell for either a tiled or floating application.

---

WindowBodyconstconstant

Signature

const WindowBody: ForwardRefExoticComponent<
  HTMLAttributes<HTMLDivElement> & RefAttributes<HTMLDivElement>
>;

The scrolling region stays inside the shell, beneath a stationary title bar.

---

GameWindowContentconstconstant

Signature

const GameWindowContent: ForwardRefExoticComponent<
  HTMLAttributes<HTMLDivElement> & RefAttributes<HTMLDivElement>
>;

Reading rhythm for compact game-window blocks and action keys.

WindowSnapPreview()fnfunction

Signature

function WindowSnapPreview(__namedParameters): Element;

Decorative snap destination. Geometry and visibility belong to the layout owner.

Parameters

Parameter	Type
__namedParameters	HTMLAttributes<HTMLDivElement>

Returns

Element

---

WindowHeader()fnfunction

Signature

function WindowHeader(__namedParameters): Element;

The handle, Back and actions are siblings, so presses never start a drag.

Parameters

Parameter	Type
__namedParameters	WindowHeaderProps

Returns

Element

---

WindowActions()fnfunction

Signature

function WindowActions(__namedParameters): Element;

Consistent icons, ordering and accessible names for host-owned commands.

Parameters

Parameter	Type
__namedParameters	WindowActionsProps

Returns

Element

References

WindowCommand

Re-exports WindowCommand

---

WindowCrumb

Re-exports WindowCrumb

---

WindowStatus

Re-exports WindowStatus