electron-dynamic-prompt v1.0.3

electron-dynamic-prompt

Electron helper to prompt for dynamic fields

Usage

yarn add electron-dynamic-prompt

prompt([options, parentBrowserWindow]).then(...).catch(...)

Example

const prompt = require('electron-prompt');

prompt({
    modal: false,
    title: 'Dialog Title',
    header: 'Dialog Title',
    description: 'Dialog description',
    height: 380,
    fields: [
        {
            id: 'field1',
            label: 'Field 1',
            type: 'input',
            attrs: {
                placeholder: 'Field 1',
                required: true
            }
        },
        {
            id: 'field2',
            label: 'Field 2',
            type: 'input',
            attrs: {
                type: 'password',
                placeholder: 'Field 1',
                required: true
            }
        }
    ],
    validator: (args) => new Promise((resolve, reject) => {
        if(args.field1 == 'abcd' && args.field2 == '1234') {
            resolve()
        } else {
            reject('Invalid username or password')
        }
    })
})
.then((r) => {
    if(r === null) {
        console.log('user cancelled');
    } else {
        console.log('result', r);
    }
})
.catch(console.error);

Documentation

Primary method:

prompt([options, parentBrowserWindow]).then(...).catch(...)

Options object (optional)

If not supplied, it uses the defaults listed in the table above.

parentBrowserWindow (optional)

The window in which to display the prompt on. If not supplied, the parent window of the prompt will be null.