mirror of
https://github.com/correl/elm-mdl.git
synced 2024-11-27 11:09:53 +00:00
71 lines
3.1 KiB
Markdown
71 lines
3.1 KiB
Markdown
# Material Design Components in Elm
|
|
|
|
Port of Google's
|
|
[Material Design Lite](https://www.getmdl.io/)
|
|
CSS/JS implementation of the
|
|
[Material Design Specification](https://www.google.com/design/spec/material-design/introduction.html).
|
|
|
|
Live demo
|
|
[here](https://debois.github.io/elm-mdl/).
|
|
|
|
MDL is implemented primarily through CSS, with a little bit of Javascript
|
|
adding and removing CSS classes in response to DOM events. This port
|
|
re-implements the CSS parts in Elm, but relies on the CSS of MDL verbatim.
|
|
|
|
*CAUTION*! This is an early and incomplete prototype. Use at your own risk.
|
|
|
|
|
|
### Get Started
|
|
|
|
Build the demo:
|
|
|
|
> elm-make examples/Demo.elm
|
|
|
|
This will construct a file `index.html`; open that in your browser.
|
|
|
|
The library has a tiny native component (for measuring geometry of rendered
|
|
elements, a necessity for re-implementing MDL ripple-animations), and so
|
|
cannot be in the elm-package library. If you wish to use the library, I
|
|
know no better way than to copy `Material.elm` and `Material/*` to your
|
|
own project.
|
|
|
|
### Embedding in your own HTML.
|
|
|
|
Initial page load of the demo will produce a flicker, which can only be
|
|
avoided if you set up the MDL css to load before elm does. Use the file
|
|
`page.html` as a template. To build the demo in this mode, comment out
|
|
[line 153 in `examples/Demo.elm`](https://github.com/debois/elm-mdl/blob/master/examples/Demo.elm#L153)
|
|
and build the demo like this:
|
|
|
|
> elm-make examples/Demo.elm --output elm.js
|
|
|
|
This will produce a file `elm.js`. Open the file
|
|
[`page.html`](https://raw.githubusercontent.com/debois/elm-mdl/master/page.html) in your
|
|
browser; this file will set up MDL css and load `elm.js`.
|
|
|
|
### Contribute
|
|
|
|
Please do! The easiest place to start is to add more CSS-only components. These require no porting of Javascript, just putting together css-classes as instructed by the [MDL Component Documentation](https://www.getmdl.io/components/index.html). Take a look at
|
|
|
|
- [Badges](https://www.getmdl.io/components/index.html#badges-section)
|
|
- [Cards](https://www.getmdl.io/components/index.html#cards-section)
|
|
- [Dialogs](https://www.getmdl.io/components/index.html#dialog-section)
|
|
- [Footers](https://www.getmdl.io/components/index.html#layout-section/footer)
|
|
- [Lists](https://www.getmdl.io/components/index.html#lists-section)
|
|
- [Shadows](https://github.com/google/material-design-lite/tree/v1.1.2/src/shadow)
|
|
|
|
The remaining components, use Javascript
|
|
in various ways. Toggles seem to use Javascript exclusively to insert ripple-animations and __might__ be easy to implement using the `Ripple.elm`
|
|
component:
|
|
|
|
- [Toggles](https://www.getmdl.io/components/index.html#toggles-section)
|
|
|
|
The rest I haven't looked at; they may or may not be straightforward to port
|
|
to Elm.
|
|
|
|
- [Tables](https://www.getmdl.io/components/index.html#tables-section)
|
|
- [Spinners](https://www.getmdl.io/components/index.html#loading-section)
|
|
- [Sliders](https://www.getmdl.io/components/index.html#sliders-section)
|
|
- [Menus](https://www.getmdl.io/components/index.html#menus-section)
|
|
- [Snackbars](https://www.getmdl.io/components/index.html#snackbar-section)
|
|
- [Tooltips](https://www.getmdl.io/components/index.html#tooltips-section)
|