Elm Dom Ports
Interface with the DOM manually in Elm.
Why?
It's popular at the moment to build web apps solely as "Single Page Apps", wherein a JavaScript application completely takes over the DOM. However, this isn't always the best solution. When you're just toggling a class to show/hide a menu, it may be overkill to use a Virtual DOM solution.
In this scenario, Elm Dom Ports exposes much of the underlying JavaScript DOM API, enabling you to manually modify the DOM using Elm. This empowers you to bring interactivity to your app in a jQuery-style manner, while adding the safety of Elm.
Quick Start
1. Install via NPM
$ npm install --save elm-dom-ports
elm-package.json
, import Ports/Dom.elm
2. In Add node_modules/elm-dom-ports/lib/elm
to your source-directories
:
// elm-package.json // ... "source-directories": "../../node_modules/elm-dom-ports/lib/elm" "./" // ...
3. Use it in your Elm code
update msg model = case msg of OpenMenu -> ( model , Ports.Dom.addClass ("#mobile_menu", "mobile-menu--opened") ) CloseMenu -> ( model , Ports.Dom.removeClass ("#mobile_menu", "mobile-menu--opened") ) FocusOnSearchBox -> ( model , Ports.Dom.focus "#search_box" ) PopulateSearchBox searchQuery -> ( model , Ports.Dom.setProperty ("#search_box", "value", Json.Encode.string searchQuery) ) HideContactForm -> ( model , Ports.Dom.setCssProperty ("#contact_form", "visibility", "hidden") )
4. Register your Elm app in JavaScript
Elm Router
Usingvar domPorts = ;elmRouterstartElm domPorts;
Without Elm Router
var domPorts = ;var myApp = ElmMyApp; domPorts;
API Reference
View the full API reference here.
Questions or Problems?
Feel free to create an issue in the GitHub issue tracker.