😷 A minimal high order function for building user interfaces
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

Vomit

Build Status Gitter NPM Downloads pledge

vomit

Vomit is a JavaScript library for building stateless user interfaces.

  • Declarative: Vomit leverages JavaScript template strings to create interactive UIs. Logic is written in JavaScript instead of templates, making your code more predictable, simple to understand and easier to debug.
  • Component-Based: Build encapsulated components and compose them to make complex UIs. Everything is as simple as a function call!
  • Async: Vomit has been built with promises and streams at its core. Dealing with IO bounds has never been so easy!
  • Easy to learn: Simple is better! We don't make any assumptions about your coding style or technology stack. 5 minutes are enough to learn Vomit!

Try it online!

Usage

var vomit = require('vomit')

function stopwatch(start) {
  // create timer dynamic component
  var timer = vomit(clock)

  // update timer dom element every second
  setInterval(() => timer(++start), 1000)

  // return timer dom element
  return timer(start)
}

// create timer static component
function clock(seconds) {
  return vomit`<div>Seconds Elapsed: ${seconds}</div>`
}

document.body.appendChild(stopwatch(0));

Vomit does not force you into any syntax/API but instead uses the power of JavaScript template literals built in your browser. Quickly create DOM element that you can compose with Objects, Arrays, other DOM elements, Functions, Promises and even Streams.

Check out examples and docs for more information.

Installation

npm install vomit --save

NPM

Features

Vomit stands for Virtual dOM IT sucks and ironically uses a virtual dom strategy based on real DOM to efficiently update your components . Other features are:

  • Separate and optimize rendering of static and dynamic content
  • HTML5 Web Component
  • Server side rendering (check out steroid)
  • Works with SVG
  • 3kb minified + gzipped, ideal for mobile and to include as dependency
  • Share the same core engine than the MVVM library brick

You'll find Vomit disgustingly easy to learn. Please check out our 5 minutes tutorial to get started,

Question

For questions and feedback please use the Gitter chat room or our twitter account. For support, bug reports and or feature requests please make sure to read our community guideline and use the issue list of this repo and make sure it's not present yet in our reporting checklist.

Contribution

Vomit is an open source project and would not exist without its community. If you want to participate please make sure to read our guideline before making a pull request. If you have any vomit-related project, component or other let everyone know on our chat room or in our wiki.

License

The MIT License (MIT)

Copyright (c) 2016 Olivier Wietrich

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.