API Reference

This document lists all classes, interfaces, and types available in MōBrowser that can be used for building modern and secure desktop applications with web technologies.

All items are grouped by category and sorted alphabetically. Click on any item name for detailed documentation.

Classes

Class	Description
`App`	Provides methods to manage application lifecycle.
`AppUpdate`	An available application update.
`Browser`	A browser instance is responsible for loading, rendering, and controlling the web content.
`BrowserWindow`	An application window that displays content of a `Browser` instance associated with it.
`CheckboxContextMenuItem`	A checkbox context menu item that can be checked or unchecked, and perform an action when clicked.
`CheckboxMenuItem`	A checkbox menu item that can be checked or unchecked, and perform an action when clicked.
`Clipboard`	The system clipboard manager.
`CommandLine`	Provides access to the application command line switches and their values.
`ContextMenu`	A context menu that contains a list of context menu items.
`ContextMenuElement`	A base class that implements the common functionality for all context menu elements.
`ContextMenuItem`	A context menu item that can be clicked to perform an action.
`ContextMenuItemBase`	A base class that implements the common functionality for all context menu items.
`ContextMenuItemWithRole`	A context menu item with a predefined role that may perform an action when clicked.
`Desktop`	Provides access to the desktop environment.
`DevTools`	The DevTools window that can be used to inspect and debug the browser.
`Dock`	Allows controlling application icon in the Dock on macOS.
`Download`	A download activity.
`GlobalShortcut`	The global keyboard shortcut manager.
`Ipc`	Provides Inter-Process Communication (IPC) capabilities between the renderer and main processes.
`KeyModifiers`	The key modifiers that can be pressed.
`Menu`	A menu that contains a list of menu items.
`MenuElement`	A base class that implements the common functionality for all menu elements.
`MenuItem`	A menu item that can be clicked to perform an action.
`MenuItemBase`	A base class that implements the common functionality for all menu items.
`MenuItemWithRole`	A menu item with predefined role.
`MenuWithRole`	A menu with predefined role that may contain a list of menu items.
`Tray`	A tray that can be used to display an icon and a menu in the system tray.

Interfaces

Interface	Description
`AlertParams`	Parameters for the alert dialog.
`AppUpdateDownloadResult`	The result of the application update download.
`BrowserWindowOptions`	Options for creating a new browser window.
`CheckboxContextMenuItemOptions`	Options for constructing a checkbox context menu item.
`CheckboxMenuItemOptions`	Options for constructing a checkbox menu item.
`ConfirmParams`	Parameters for the confirm dialog.
`ConsoleMessage`	The console message details.
`ContextMenuItemBaseOptions`	Options for constructing a context menu item.
`ContextMenuItemWithRoleOptions`	Options for constructing a context menu item with a role.
`ContextMenuOptions`	Options for constructing a context menu.
`DownloadProgress`	The progress of the download.
`FileFilter`	A file filter for a file open dialog.
`LaunchInfo`	Contains information about the application launch, such as whether it is the first run and the version of the application that was last launched.
`MenuItemBaseOptions`	Options for constructing a menu item.
`MenuItemWithRoleOptions`	Options for constructing a menu item with a role.
`MenuOptions`	Options for constructing a menu.
`MenuWithRoleOptions`	Options for constructing a menu with a role.
`MessageDialogButton`	A button in a message dialog.
`MessageDialogCheckbox`	A checkbox in a message dialog.
`MessageDialogOptions`	Options for opening a message dialog.
`MessageDialogResult`	The result of a message dialog.
`MessageDialogTextField`	A text field in a message dialog.
`MethodCodec`	Codec for a single RPC method: decodes request bytes and encodes response bytes.
`OpenDialogFeatures`	The features of a file open dialog.
`OpenDialogOptions`	Options for opening a file open dialog.
`OpenDialogResult`	The result of a file open dialog.
`OpenPopupParams`	Parameters for opening a popup window.
`Point`	A point in 2D space.
`PromptParams`	Parameters for the prompt dialog.
`Rect`	A rectangle in 2D space.
`SaveDialogFeatures`	The features of a file save dialog.
`SaveDialogOptions`	Options for opening a file save dialog.
`SaveDialogResult`	The result of a file save dialog.
`ServiceDescriptor`	Describes an RPC service: its name and the codecs for each method.
`ServiceInstance`	A service implementation with an attached {
`ShowContextMenuParams`	Parameters for showing a context menu.
`Size`	A size in 2D space.
`StartDownloadParams`	Parameters for starting a download.
`TrayOptions`	Options for constructing a tray.

Types

Type	Description
`AlertAction`	The action to be taken when the alert dialog is closed.
`ClipboardType`	The type of the clipboard data.
`CloseAction`	The action to be taken when the browser is about to close.
`ConfirmAction`	The action to be taken when the confirm dialog is closed.
`ConsoleMessageLevel`	The level of the console message.
`ContextMenuContentType`	The type of content that the context menu is being shown for.
`ContextMenuElementType`	The type of the context menu element.
`ContextMenuItemRole`	The list of supported context menu item roles.
`DownloadInterruptReason`	The reason for the download interruption.
`FilePath`	An absolute or relative path to a file on the local file system.
`MenuElementType`	The type of the menu element.
`MenuItemRole`	The list of supported menu item roles.
`MenuRole`	The list of supported menu roles.
`MessageDialogButtonType`	The type of the button.
`MessageDialogTextFieldType`	The type of the text field.
`MessageDialogType`	The type of the message dialog.
`MouseButton`	The type of mouse button.
`OpenDialogSelectionPolicy`	Defines what types of items the user can select in a file open dialog.
`OpenPopupAction`	The action to be taken when opening the popup window.
`PathName`	The path name that is used to get the path to specific directories using the `app.getPath()` method.
`PromptAction`	The action to be taken when the prompt dialog is closed.
`Shortcut`	A shortcut is a string in the format “CommandOrControl+Shift+F”.
`StartDownloadAction`	The action to be taken when starting a download.
`Theme`	The application theme.
`VibrancyEffect`	The vibrancy effect of the window on macOS.
`WindowButtonType`	The type of the window button.
`WindowDisplayPolicy`	The policy indicating how the window is displayed on multiple desktops.