# cocoa-dialog

> Display common GUI dialogs on macOS using [cocoaDialog](https://github.com/cocoadialog/cocoadialog)

<img src="screenshot.png" width="540">

*Issues regarding the GUI should be opened on the cocoaDialog [issue tracker](https://github.com/cocoadialog/cocoadialog/issues).*

## Install

```sh
npm install cocoa-dialog
```

## Usage

```js
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](http://mstratman.github.io/cocoadialog/#documentation3.0).

#### options

Type: `object`

Any of the options defined in the [cocoaDialog docs](http://mstratman.github.io/cocoadialog/#documentation3.0) can be used in a camel-cased form.

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

## Related

- [error-dialog](https://github.com/sindresorhus/error-dialog) - Display an error in a GUI dialog