https://github.com/anthonyshort/deku

Render interfaces using pure functions and virtual DOM
https://github.com/anthonyshort/deku

Last synced: 25 days ago
JSON representation

Render interfaces using pure functions and virtual DOM

• Host: GitHub
• URL: https://github.com/anthonyshort/deku
• Owner: anthonyshort
• Created: 2014-08-08T04:32:23.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2018-07-10T06:28:41.000Z (over 6 years ago)
• Last Synced: 2024-05-14T19:06:35.129Z (6 months ago)
• Language: JavaScript
• Homepage: https://github.com/anthonyshort/deku/tree/master/docs
• Size: 2.46 MB
• Stars: 3,418
• Watchers: 89
• Forks: 130
• Open Issues: 35
• Metadata Files:
  • Readme: README.md
  • Contributing: docs/contributing.md

Awesome Lists containing this project

• awesome-github-star - deku

README

        
# Deku

[![version](https://img.shields.io/travis/dekujs/deku.svg?style=flat-square)](https://travis-ci.org/dekujs/deku)

[![version](https://img.shields.io/npm/v/deku.svg?style=flat-square)](https://www.npmjs.com/package/deku)

[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/feross/standard)

[![npm downloads](https://img.shields.io/npm/dm/deku.svg?style=flat-square)](https://www.npmjs.com/package/deku)

[![discord](https://img.shields.io/badge/Discord-Join%20Chat%20→-738BD7.svg?style=flat-square)](https://discord.gg/0gNkyCAVkDYsBaFe)

Deku is a library for rendering interfaces using pure functions and virtual DOM.

Instead of using classes and local state, Deku just uses functions and pushes the responsibility of all state management and side-effects onto tools like [Redux](http://redux.js.org/). It also aims to support only modern browsers to keep things simple.

It can be used in place of libraries like React and works well with Redux and other libraries in the React ecosystem.

Deku consists of 5 modules packaged together for convenience:

* `element`: Create virtual elements.

* `diff`: Compute the difference between two virtual elements. You can use this if you're creating a custom renderer.

* `dom`: Create DOM elements from virtual elements and update them using the result of a diff. You'll only use this directly if you're building your own app creator.

* `string`: Render a HTML string from virtual elements.

* `createApp`: Kickstart an app for the browser.

### Installation

```

npm install --save deku

```

We support the latest two versions of each browser. This means we only support IE10+.

[![Sauce Test Status](https://saucelabs.com/browser-matrix/deku.svg)](https://saucelabs.com/u/deku)

### Example

```js

/** @jsx element */

import {element, createApp} from 'deku'

import {createStore} from 'redux'

import reducer from './reducer'

// Dispatch an action when the button is clicked

let log = dispatch => event => {

  dispatch({

    type: 'CLICKED'

  })

}

// Define a state-less component

let MyButton = {

  render: ({ props, children, dispatch }) => {

    return {children}

  }

}

// Create a Redux store to handle all UI actions and side-effects

let store = createStore(reducer)

// Create an app that can turn vnodes into real DOM elements

let render = createApp(document.body, store.dispatch)

// Update the page and add redux state to the context

render(

  Hello World!,

  store.getState()

)

```

### Documentation

You can [read the documentation online](http://anthonyshort.me/deku/).

### License

The MIT License (MIT) Copyright (c) 2015 Anthony Short