WindowProcessManagementService

Call

import { PLMainAPI } from "paperlib-api/api";

PLMainAPI.windowProcessManagementService.methodname(...);

Avaliable Methods

create

/**
 * Create Process with a BrowserWindow
 * @param id - window id
 * @param options - window options
 * @param eventCallbacks - callbacks for events
 * @param additionalHeaders - additional response headers for the window
 */
create(
    id: string,
    options: WindowOptions,
    eventCallbacks?: Record<string, (win: BrowserWindow) => void>,
    additionalHeaders?: Record<string, string>
): void;

destroy

/**
 * Destroy the window with the given id.
 * @param windowId - The id of the window to be destroyed
 */
destroy(windowId: string): Promise<void>;

fireServiceReady

/**
 * Fire the serviceReady event. This event is fired when the service of the window is ready to be used by other processes.
 * @param windowId - The id of the window that fires the event
 */
fireServiceReady(windowId: string): Promise<void>;

show

/**
 * Show the window with the given id.
 * @param windowId - The id of the window to be shown
 */
show(windowId: string): Promise<void>;

hide

/**
 * Hide the window with the given id.
 * @param windowId - The id of the window to be hidden
 */
hide(windowId: string, restoreFocus?: boolean): Promise<void>;

minimize

/**
 * Minimize the window with the given id.
 * @param windowId - The id of the window to be minimized
 */
minimize(windowId: string): Promise<void>;

maximize

/**
 * Maximize the window with the given id.
 * @param windowId - The id of the window to be maximized
 */
maximize(windowId: string): Promise<void>;

close

/**
 * Close the window with the given id.
 * @param windowId - The id of the window to be closed
 */
close(windowId: string): Promise<void>;

forceClose

/**
 * Force close the window with the given id.
 * @param windowId - The id of the window to be force closed
 */
forceClose(windowId: string): Promise<void>;

changeTheme

/**
 * Change the theme of the app.
 * @param theme - The theme to be changed to
 */
changeTheme(theme: APPTheme): Promise<void>;

isDarkMode

/**
 * Check if the app is in dark mode.
 * @returns Whether the app is in dark mode
 */
isDarkMode(): Promise<boolean>;

resize

/**
 * Resize the window with the given id.
 * @param windowId - The id of the window to be resized
 * @param width - The width of the window
 * @param height - The height of the window
 */
resize(windowId: string, width: number, height: number): Promise<void>;

getScreenSize

/**
 * Get the size of the screen.
 * @returns The size of the screen
 */
getScreenSize(): Promise<{
    width: number;
    height: number;
}>;

isFocused

/**
 * Whether the window is focused.
 * @param windowId - The id of the window to be checked
 */
isFocused(windowId: string): Promise<boolean>;

setParentWindow

/**
 * Set parent as current window's parent window.
 * @param parentId - The id of the parent window
 * @param currentId - The id of the current window
 */
setParentWindow(parentId: string | null, currentId: string): void;

getBounds

/**
 * Return the window's current bounds.
 * @param windowId - The id of the window to be checked
 */
getBounds(windowId: string): Electron.Rectangle | undefined;

setBounds

/**
 * Set the window's current bounds.
 * @param windowId - The id of the window to be set
 * @param bounds - The bounds of the window to be set
 */
setBounds(windowId: string, bounds: Partial<Rectangle>): void;

hasParentWindow

/**
 * Return whether the window has a parent.
 * @param windowId - The id of the window to be checked
 */
hasParentWindow(windowId: string): boolean;

setAlwaysOnTop

/**
 * Set whether the window should show always on top of other windows.
 * @param windowId - The id of the window to be set
 * @param flag - Whether the window should show always on top of other windows
 */
setAlwaysOnTop(windowId: string, flag: boolean): void;

center

/**
 * Move the window to the center of the screen.
 * @param windowId - The id of the window to be set
 */
center(windowId: string): void;

Events

Event ID	Callback Value	Description
serviceReady	{key: 'serviceReady', value: windowId}	When the service of the window is ready to be used by other processes
requestPort	{key: 'requestPort', value: senderProcessId}	When a process is requesting MessagePort
destroyed	{key: 'destroyed', value: windowId}	When the window is destroyed
any window ID	{key: windowId, value: event}	event: ready-to-show, blur, focus, close, show, created

The main renderer window's ID is rendererProcess. If you want to listen to the blur event of the main renderer window, you can do this:

import { PLMainAPI } from "paperlib-api";

PLMainAPI.windowProcessManagementService.on("rendererProcess", (event) => {
  if (event.value === "blur") {
    // do something
  }
});