https://github.com/jamesmacaulay/zelkova

Elm-style FRP for Clojure and ClojureScript
https://github.com/jamesmacaulay/zelkova

Last synced: 4 days ago
JSON representation

Elm-style FRP for Clojure and ClojureScript

• Host: GitHub
• URL: https://github.com/jamesmacaulay/zelkova
• Owner: jamesmacaulay
• License: mit
• Created: 2014-10-17T00:41:11.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2016-05-11T14:15:48.000Z (over 8 years ago)
• Last Synced: 2024-10-12T13:10:57.788Z (about 1 month ago)
• Language: Clojure
• Homepage:
• Size: 544 KB
• Stars: 403
• Watchers: 26
• Forks: 9
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Zelkova

**This project is unmaintained.**

[![Clojars Project](http://clojars.org/jamesmacaulay/zelkova/latest-version.svg)](http://clojars.org/jamesmacaulay/zelkova)

[![Build Status](https://travis-ci.org/jamesmacaulay/zelkova.svg)](https://travis-ci.org/jamesmacaulay/zelkova)

[Elm](http://elm-lang.org/)-style FRP for Clojure and ClojureScript.

Here's a [conference talk with some demos](https://www.youtube.com/watch?v=rOKOCAkHNYw)!

Here's a [mailing list on Google Groups](https://groups.google.com/d/forum/zelkova-frp)!

## Bullet points

* signal graphs are static, just like in Elm ([why?](https://www.youtube.com/watch?v=Agu6jipKfYw))

* core.async is used to wire up running graphs

* you can run as many signal graphs as you want at the same time

* graphs can share signal nodes because each signal is just a "recipe" value decoupled from the state of any running graph

* works in both Clojure and ClojureScript, but ClojureScript is currently better supported with implementations for [keyboard](https://github.com/jamesmacaulay/zelkova/blob/master/src/jamesmacaulay/zelkova/keyboard.cljc), [mouse](https://github.com/jamesmacaulay/zelkova/blob/master/src/jamesmacaulay/zelkova/mouse.cljc), and [window](https://github.com/jamesmacaulay/zelkova/blob/master/src/jamesmacaulay/zelkova/window.cljc) signals (basically straight ports from the Elm libraries)

* pairs really well with immediate-mode rendering (e.g. [React](http://facebook.github.io/react/)-based systems like [Om](https://github.com/swannodette/om) or [Reagent](http://holmsand.github.io/reagent/))

* [transducer pipelines](https://github.com/jamesmacaulay/zelkova/blob/779deaa1c9563171871a040f3dca619f0e7ed755/test/jamesmacaulay/zelkova/signal_test.cljc#L477-L494)!!

## What does it look like?

```clojure

(ns my-app.ui

  (:require [jamesmacaulay.zelkova.signal :as z]

            [jamesmacaulay.zelkova.keyboard :as keyboard]

            [jamesmacaulay.zelkova.mouse :as mouse]))

(def saved-points-signal

  (let [shift-clicks (z/keep-when keyboard/shift mouse/clicks)]

    (->> mouse/position

         (z/sample-on shift-clicks)

         (z/reductions conj #{}))))

(def saved-points-atom

  (z/pipe-to-atom saved-points-signal))

```

## Documentation

[The docs](http://jamesmacaulay.github.io/zelkova/doc/api/index.html).

## Examples

* [Quil Flyer](http://jamesmacaulay.github.io/zelkova-quil-flyer/resources/public/index.html) ([source](https://github.com/jamesmacaulay/zelkova-quil-flyer))

* [Om Search](http://jamesmacaulay.github.io/zelkova-om-searcher/resources/public/index.html) ([source](https://github.com/jamesmacaulay/zelkova-om-searcher))

* [Todo MVC](http://jamesmacaulay.github.io/zelkova-todomvc/) ([source](https://github.com/jamesmacaulay/zelkova-todomvc/blob/master/src/cljs/zelkova_todomvc/core.cljs))

* [Mario](http://jamesmacaulay.github.io/zelkova/examples/mario/resources/public/) ([source](https://github.com/jamesmacaulay/zelkova/blob/gh-pages/examples/mario/src/mario/core.cljs))

* [Drag and Drop](http://jamesmacaulay.github.io/zelkova/examples/drag_and_drop/resources/public/) ([source](https://github.com/jamesmacaulay/zelkova/blob/gh-pages/examples/drag_and_drop/src/drag_and_drop/core.cljs))

## License

Copyright © 2014-2015

Distributed under the MIT License.