krisajenkins/elm-dialog

A modal dialog widget for Elm.


License
MIT
Install
elm-package install krisajenkins/elm-dialog 4.0.3

Documentation

Elm Dialog - A Modal Dialog Widget for Elm

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

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

Screenshot

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

Installation

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

$ elm package install krisajenkins/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

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.