electron-util/distribution/shared/url-menu-item.d.ts

Useful utilities for Electron apps and modules

import { type MenuItemConstructorOptions } from 'electron';
export type OpenUrlMenuItemOptions = {
    /**
    URL to be opened when the menu item is clicked.
    */
    readonly url: string;
} & Readonly<MenuItemConstructorOptions>;
/**
Accepts the same options as [`new MenuItem()`](https://electronjs.org/docs/api/menu-item) in addition to a `url` option.
If you specify the `click` option, its handler will be called before the URL is opened.

@returns A `MenuItemConstructorOptions` that creates a menu item, which opens the given URL in the browser when clicked.

@example
```
import {Menu} from 'electron';
import {openUrlMenuItem} from 'electron-util';

const menu = Menu.buildFromTemplate([
    {
        label: 'Help',
        submenu: [
            openUrlMenuItem({
                label: 'Website',
                url: 'https://sindresorhus.com'
            })
        ]
    }
]);

Menu.setApplicationMenu(menu);
*/
export declare const openUrlMenuItem: (options: Readonly<OpenUrlMenuItemOptions>) => MenuItemConstructorOptions;