Naively Programmable Module
    Have ideas to improve npm?Join in the discussion! »

    dialogy
    TypeScript icon, indicating that this package has built-in type declarations

    0.2.2 • Public • Published

    dialogy Travis CI Build Status

    Show native dialogs.

    NPM Badge

    Install

    npm install dialogy

    Usage

    const dialogy = require("dialogy")
     
    dialogy.alert({ message: "Hello World" })
     
    const filePath = dialogy.openFile({
        filter: {
            patterns: ["*.txt"],
            description: "Text files"
        }
    })

    API

    dialogy.color(options?)

    Ask the user to select a color.

    options

    Type: object

    title

    Type: string
    Default: Choose a color

    The title of the dialog.

    defaultValue

    Type: string
    Default: #000000

    The default selected color of the dialog.

    dialogy.alert(options?)

    Show an alert box.

    options

    Type: object

    title

    Type: string
    Default: Info

    The title of the alert.

    message

    Type: string

    The message of the alert.

    defaultValue

    Type: boolean
    Default: true

    The default value of the dialog if no action is selected. The right dialog button has a value of true and the left dialog button has a value of false.

    icon

    Type: string
    Values: info | warning | error | question

    The icon to use in the dialog.

    buttons

    The buttons to show in the dialog.

    dialogy.saveFile(options?)

    Ask the user to choose a path to save a file in.

    options

    Type: object

    title

    Type: string
    Default: Save file

    The title of the dialog.

    defaultValue

    Type: string

    The default path to set.

    filter.patterns

    Type: string[]

    An array of patterns which shown files must match. Otherwise they are hidden when the filter is selected. A * can be used as a wildcard. For example: *.txt.

    filter.description

    Type: string

    The description of the filter to display. For example: Text Files (*.txt)

    dialogy.openFile(options?)

    Ask the user to select a file. Returns a string.

    Same options as dialogy.saveFile.

    dialogy.openFile.multiple(options?)

    Ask the user to select 1 or more files. Returns an array of strings.

    Same options as dialogy.saveFile.

    dialogy.folder(options?)

    Ask the user to select a folder. Returns a string.

    options

    Type: object

    title

    Type: string
    Default: Select folder

    The title of the dialog.

    defaultValue

    Type: string

    The default path to set.

    dialogy.input(options?)

    Ask the user for text input.

    options

    Type: object

    Same as dialogy.saveFile except for the following:

    defaultValue

    Type: string

    The default value to prefill in the dialog. Doesn't work if isPassword is true.

    isPassword

    Type: boolean

    Whether the input should be treated as a password. If set to true, the typed text will appear as dots.

    Install

    npm i dialogy

    DownloadsWeekly Downloads

    2

    Version

    0.2.2

    License

    MIT

    Unpacked Size

    14.2 kB

    Total Files

    8

    Last publish

    Collaborators

    • avatar