sindresorhus / cocoa-dialog

Display common GUI dialogs on macOS using cocoaDialog

cocoa-dialog

Display common GUI dialogs on macOS using cocoaDialog

Issues regarding the GUI should be opened on the cocoaDialog issue tracker.

Install

npm install cocoa-dialog

Usage

import cocoaDialog from 'cocoa-dialog';

const result = await cocoaDialog('msgbox', {
	title: 'Unicorn',
	icon: 'favorite',
	text: 'What do you want?',
	button1: 'Gimme rainbow',
	button2: 'Magicalifify'
});

if (result === '1') {
	console.log('button1 clicked');
} else if (result === '2') {
	console.log('button2 clicked');
}

API

cocoaDialog(type, options)

Returns a Promise for result and resolves when the dialog is dismissed.

type

Type: string
Values:

• bubble
• msgbox
• ok-msgbox
• yesno-msgbox
• inputbox
• standard-inputbox
• secure-inputbox
• secure-standard-inputbox
• fileselect
• filesave
• textbox
• progressbar
• dropdown
• standard-dropdown

See the cocoaDialog docs.

options

Type: object

Any of the options defined in the cocoaDialog docs can be used in a camel-cased form.

For example, ‑‑informative‑text should be informativeText: true.

Related

• error-dialog - Display an error in a GUI dialog

cocoa-dialog's Issues

Deprecate in favor of cocoadialog?

I'm actually one of the maintainers at https://github.com/mstratman/cocoadialog and had been creating my own Node.js wrapper locally for a while.

I finally published it recently and it's now available here: https://github.com/unicorn-fail/node-cocoadialog

I was just doing some surfing for marketing purposes and just saw this package.

I think it would make sense to deprecate this one.

Thoughts?

It's possible to use with Electron?

Hey, I would like to know if there's a way to use this module in Electron apps.

Thank you!