API
Methods for accessing ToDesktop Menu Bar App specfic functionality.
This package exposes a number of methods for accessing ToDesktop Menu Bar App specfic functionality.
| Function | Description |
|---|---|
| enlarge(size) | Enlarges the MenuBar view. |
| shrink() | Restores the MenuBar app to it's pre-defined size. |
Enlarges the MenuBar view.
Signature:
Electron Developers import { menuBar } from "@todesktop/client-core"
menuBar.enlarge(size?: {
width: number;
height: number;
}): Promise<void>;
| Parameter | Type | Description |
|---|---|---|
| size | ｛ width: number; height: number; ｝ | Specifies the width and height to resize to. If not specified the window will be resized to 800x1000. |
Returns:
Promise<void>
Restores the MenuBar app to it's pre-defined size.
Signature:
import { menuBar } from "@todesktop/client-core"
menuBar.shrink(): Promise<void>;
Returns:
Promise<void>
| Variable | Description |
|---|---|
| on |
Signature:
on: (event: "*" | MenuBarEvent, callback: (...any: any[]) => void) => Promise<() => Promise<void>>
Signature:
export declare type MenuBarEvent = "show" | "hide";
| Type Alias | Description |
|---|---|
| MenuBarEvent |