Elm Dialog - A Modal Dialog Widget for Elm

This is a fork of krisajenkins/elm-dialog which aims to support WAI-ARIA.

Elm modal dialog boxes that fits in neatly with the Elm architecture.

API Differences from krisajenkins/elm-dialog

The containerId field is added to Dialog.Config:

type alias Config msg =
    { closeMessage : Maybe msg
    , containerClass : Maybe String
    , containerId : Maybe String
    , header : Maybe (Html msg)
    , body : Maybe (Html msg)
    , footer : Maybe (Html msg)
    }

Aims

• ✓ Fit in neatly with the Elm architecture.
• ✓ Dialogs should have all the power of regular views.
• ✓ Dialogs should work equally well with sub-components and sub-sub-...-components.
• Dialogs should not rely on external CSS. (Not yet. Still relies on Bootstrap.)
• Dialogs should be optionally animated. (Not yet. It's straightforward but not documented/demo'd.)

Examples

See the examples/ directory for two fully-worked examples:

• examples/Simple/App.elm (live demo)
• examples/Advanced/App.elm (live demo)

Installation

From your top-level directory - the one with elm-package.json in - call:

$ elm package install jackwillis/elm-dialog

Usage

See the Elm package for full usage docs.

Migration

v3 to v4

v4 version added a containerClass field to the Config record. You can set this to containerClass = Nothing until you need it.

Building

With node-test-runner installed,

make

will run the whole build and test suite.

Credits

Thanks to Emilien Taque for ideas & support. Thanks to Mike Onslow for the containerClass feature.

License

Copyright © 2016 Kris Jenkins

Distributed under the MIT license.