maosaico

Import

Import

import * as api from "@fungi.computer/maosaico";

Exports

Kind	Export	Description
Ttype alias	BentoOptions	Host-owned placements and the callback receiving completed intents.
Ttype alias	BentoBinding	Renderable frames and interaction attributes for host-owned tiles.
Ttype alias	MaosaicoLayer	Shell paint order. Window ranks are local to the windows root.
Ttype alias	Point	Coordinates relative to the host’s container.
Ttype alias	Size	Dimensions in the host’s coordinate units.
Ttype alias	Frame	A container-relative origin and dimensions.
Ttype alias	Bounds	Available container dimensions.
Ttype alias	Minima	Smallest dimensions the host permits for a pane.
Ttype alias	SnapSide	Edge or corner used to derive a snapped frame.
Ttype alias	MaosaicoItem	A mounted pane’s stable identity and initial geometry.
Ttype alias	MaosaicoItemOptions	Interaction mode and layout participation for a mounted pane.
Ttype alias	MaosaicoItemBinding	Geometry, focus state and host element interactions for a pane.
Ttype alias	TilingLayout	Named strategies for dividing the host’s available bounds.
Ttype alias	TilingOptions	Layout strategy and spacing supplied by the host.
constconstant	MaosaicoRegion	The host positions the region; Maosaico owns its isolated layer and modality.
fnfunction	useMaosaicoBento()	Captured, cell-snapped previews. Only a completed gesture proposes host-owned changes.
fnfunction	MaosaicoLayers()	Mount inside the shell’s positioned container, outside clipped panes. Roots are pointer-transparent; interactive portal content enables pointers. The host supplies Stipe’s stylesheet and retains content and focus ownership.
fnfunction	useLayer()	Null until the shell root mounts (also during SSR); body outside a shell.
fnfunction	usePointerDrag()	One captured pointer; cancellation and unmount share the same release path.
fnfunction	MaosaicoRoot()	Omit tiling to retain floating frames. Main size is a preference, in pixels.
fnfunction	useMaosaicoLayout()	Layout commands keep content and DOM ownership with the caller.
fnfunction	useMaosaicoItem()	Register a mounted pane and bind its geometry and captured-pointer lifecycle.

BentoOptionsTtype alias

Signature

type BentoOptions = BentoGeometry & object;

Host-owned placements and the callback receiving completed intents.

Type Declaration

Name	Type	Description
placements	readonly BentoPlacement[]	Current committed tile positions and spans.
onChange()	(ops) => void	Receive operations for a completed gesture or keyboard action.
enabled?	boolean	Set false to disable pointer and keyboard edits.

---

BentoBindingTtype alias

Signature

type BentoBinding = object;

Renderable frames and interaction attributes for host-owned tiles.

Properties

frames

Signature

frames: ReturnType<typeof bentoFrames>;

Current committed or preview geometry.

preview

Signature

preview: boolean;

Whether frames include a live, non-stale gesture preview.

previewId

Signature

previewId: string | null;

Tile being previewed, or null.

bind

Signature

bind: (id, kind) => DOMAttributes<HTMLElement>;

Bind a tile’s move or resize interaction to a host element.

Parameters

Parameter	Type
id	string
kind	"move" | "resize"

Returns

DOMAttributes<HTMLElement>

---

MaosaicoLayerTtype alias

Signature

type MaosaicoLayer =
  "desktop" | "windows" | "chrome" | "popover" | "dialog" | "toast" | "tooltip";

Shell paint order. Window ranks are local to the windows root.

---

PointTtype alias

Signature

type Point = object;

Coordinates relative to the host’s container.

Properties

x

Signature

x: number;

Horizontal coordinate.

y

Signature

y: number;

Vertical coordinate.

---

SizeTtype alias

Signature

type Size = object;

Dimensions in the host’s coordinate units.

Properties

width

Signature

width: number;

Horizontal extent.

height

Signature

height: number;

Vertical extent.

---

FrameTtype alias

Signature

type Frame = Point & Size;

A container-relative origin and dimensions.

---

BoundsTtype alias

Signature

type Bounds = Size;

Available container dimensions.

---

MinimaTtype alias

Signature

type Minima = Size;

Smallest dimensions the host permits for a pane.

---

SnapSideTtype alias

Signature

type SnapSide =
  "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right";

Edge or corner used to derive a snapped frame.

---

MaosaicoItemTtype alias

Signature

type MaosaicoItem = object;

A mounted pane’s stable identity and initial geometry.

Properties

id

Signature

id: string;

Identity used for registration and commands.

frame

Signature

frame: Frame;

Initial floating frame; later changes use layout commands.

minima

Signature

minima: Minima;

Minimum dimensions kept current while the pane is mounted.

---

MaosaicoItemOptionsTtype alias

Signature

type MaosaicoItemOptions = object;

Interaction mode and layout participation for a mounted pane.

Properties

kind?

Signature

optional kind?: "drag" | "resize";

Defaults to dragging; resize changes dimensions instead of origin.

participating?

Signature

optional participating?: boolean;

Defaults to true; false retains geometry but excludes the pane from layout.

---

MaosaicoItemBindingTtype alias

Signature

type MaosaicoItemBinding = object;

Geometry, focus state and host element interactions for a pane.

Properties

frame

Signature

frame: Frame;

Visible layout frame, falling back to the pane’s floating geometry.

stackingStyle

Signature

stackingStyle: Pick<React.CSSProperties, "zIndex">;

Merge into the window’s style, inside the windows layer.

visible

Signature

visible: boolean;

Whether this pane has a frame in the current arrangement.

active

Signature

active: boolean;

Whether this pane is last in focus order.

props

Signature

props: React.DOMAttributes<HTMLElement>;

Pointer attributes to spread onto the pane’s interaction element.

focus

Signature

focus: () => void;

Bring the pane to the top of focus order.

Returns

void

snap

Signature

snap: (side) => void;

Snap the pane to a container edge or corner.

Parameters

Parameter	Type
side	SnapSide

Returns

void

restore

Signature

restore: () => void;

Restore the pane’s retained floating frame.

Returns

void

---

TilingLayoutTtype alias

Signature

type TilingLayout = "main-left" | "main-top" | "columns" | "rows" | "grid";

Named strategies for dividing the host’s available bounds.

---

TilingOptionsTtype alias

Signature

type TilingOptions = object;

Layout strategy and spacing supplied by the host.

Properties

layout?

Signature

optional layout?: TilingLayout;

Defaults to main-left.

mainSize?

Signature

optional mainSize?: number;

Preferred main-pane extent; defaults to half the container’s extent.

gap?

Signature

optional gap?: number;

Space between panes; defaults to eight coordinate units.

MaosaicoRegionconstconstant

Signature

const MaosaicoRegion: ForwardRefExoticComponent<
  HTMLAttributes<HTMLDivElement> & object & RefAttributes<HTMLDivElement>
>;

The host positions the region; Maosaico owns its isolated layer and modality.

useMaosaicoBento()fnfunction

Signature

function useMaosaicoBento(options): BentoBinding;

Captured, cell-snapped previews. Only a completed gesture proposes host-owned changes.

Parameters

Parameter	Type
options	BentoOptions

Returns

BentoBinding

---

MaosaicoLayers()fnfunction

Signature

function MaosaicoLayers(__namedParameters): ReactElement;

Mount inside the shell’s positioned container, outside clipped panes. Roots are pointer-transparent; interactive portal content enables pointers. The host supplies Stipe’s stylesheet and retains content and focus ownership.

Parameters

Parameter	Type	Description
__namedParameters	{ children?: ReactNode; onDismiss?: () => void; }	-
__namedParameters.children?	ReactNode	Host content rendered alongside the overlay roots.
__namedParameters.onDismiss?	() => void	Light-dismiss transient overlays on host blur or focus entering a window.

Returns

ReactElement

---

useLayer()fnfunction

Signature

function useLayer(layer): HTMLElement | null;

Null until the shell root mounts (also during SSR); body outside a shell.

Parameters

Parameter	Type
layer	MaosaicoLayer

Returns

HTMLElement | null

---

usePointerDrag()fnfunction

Signature

function usePointerDrag(
  handlers,
  enabled?,
  signal?,
): DOMAttributes<HTMLElement>;

One captured pointer; cancellation and unmount share the same release path.

Parameters

Parameter	Type	Default value	Description
handlers	{ begin: (event) => boolean; move: (dx, dy, event) => void; end: (cancel) => void; }	undefined	-
handlers.begin	(event) => boolean	undefined	Return true to accept the captured pointer gesture.
handlers.move	(dx, dy, event) => void	undefined	Receive incremental pointer movement in client-coordinate pixels.
handlers.end?	(cancel) => void	undefined	Complete the gesture; true denotes cancellation or lost capture.
enabled?	boolean	true	-
signal?	AbortSignal	undefined	-

Returns

DOMAttributes<HTMLElement>

---

MaosaicoRoot()fnfunction

Signature

function MaosaicoRoot(__namedParameters): Element;

Omit tiling to retain floating frames. Main size is a preference, in pixels.

Parameters

Parameter	Type	Description
__namedParameters	{ bounds: Size; tiling?: TilingOptions; containerRef?: RefObject<HTMLElement | null>; children?: ReactNode; }	-
__namedParameters.bounds	Size	Available container dimensions in host coordinates.
__namedParameters.tiling?	TilingOptions	Optional tiling strategy; omission preserves floating frames.
__namedParameters.containerRef?	RefObject<HTMLElement | null>	The positioned workspace element; supplying it enables container-relative edge snapping.
__namedParameters.children?	ReactNode	Host-owned content rendered inside the layout context.

Returns

Element

---

useMaosaicoLayout()fnfunction

Signature

function useMaosaicoLayout(): object;

Layout commands keep content and DOM ownership with the caller.

Returns

Name	Type	Default value	Description
stackingStyle	object	-	Decorations rank immediately above every window, inside the windows region.
stackingStyle.zIndex	number	state.order.length	Rank above every pane in the windows region.
mode	"tiled" | "floating"	-	Whether the root supplied a tiling strategy.
order	readonly string[]	-	Stable order of participating tiles.
interacting	boolean	-	Whether a frame or divider gesture is active.
snapPreview	| { side: SnapSide; frame: Frame; } | null	-	Candidate floating-frame snap, hidden while tiled or zoomed.
activeId	string | null	-	Most recently focused participating pane, or null.
zoomedId	string | null	state.zoomed	Pane expanded to fill the root, or null.
tabGroups	string[][]	arrangement.tabGroups	Overflow panes sharing layout slots.
divider	| { props: DOMAttributes<HTMLElement>; axis: "x" | "y"; position: number; min: number; max: number; } | null	-	Divider geometry and pointer attributes, or null.
focus()	(id) => void	state.focus	Focus a registered pane.
swap()	(first, second) => void	state.swap	Swap two participating panes in tiling order.
zoom()	(id) => void	state.zoom	Expand a pane or clear expansion with null.
resizeMain()	(size) => void	-	Set the main-pane extent within current divider bounds.

---

useMaosaicoItem()fnfunction

Signature

function useMaosaicoItem(item, options?): MaosaicoItemBinding;

Register a mounted pane and bind its geometry and captured-pointer lifecycle.

Parameters

Parameter	Type
item	MaosaicoItem
options	MaosaicoItemOptions

Returns

MaosaicoItemBinding

References

arrangeBento

Re-exports arrangeBento

---

applyBentoOps

Re-exports applyBentoOps

---

bentoFrames

Re-exports bentoFrames

---

BentoColumns

Re-exports BentoColumns

---

BentoPlacement

Re-exports BentoPlacement

---

BentoOp

Re-exports BentoOp

---

BentoGeometry

Re-exports BentoGeometry