FrameDom

Unofficial

Both Official Unofficial

Both Own Inherited

DOM elements for the custom window frame (title bar) on desktop.

Import:

import type { FrameDom } from '@obsidian-typings/obsidian-catalyst-latest';

Signature:

export interface FrameDom

Constructor

new FrameDom(electronWindow: ElectronBrowserWindow, win: Window)

Constructor.

To get the constructor instance, use getFrameDomConstructor from obsidian-typings/implementations.

Properties

	Property	Type	Description
	eWin	ElectronBrowserWindow	Reference to the Electron browser window.
	isMac	boolean	Whether the current platform is macOS.
	leftButtonContainerEl	HTMLDivElement	Container for window control buttons on the left side.
	requestUpdateStatus	Debouncer<[], void>	Debounced request to update the window status indicators in the title bar.
	titleBarEl	HTMLDivElement	The title bar element.
	titleBarInnerEl	HTMLDivElement	Inner container of the title bar.
	titleBarTextEl	HTMLDivElement	Element displaying the title bar text.
	win	Window	Reference to the window object.

Methods

	Method	Returns	Description
	updateStatus()	void	Update the window status indicators in the title bar.
	updateTitle()	void	Update the displayed title in the title bar.

---

Links to this page:

• frameDom
• getFrameDomConstructor
• Window