kick

Kick is a very small javascript binding library, inspired by rivets, tinybind, vue and knockout.js Original Size: 23 KB GZIP Size(compressed): 7.5 KB

jskick or kick is a variation of Rivets.js and tinybind, a lightweight data binding and templating system that facilitates building data-driven views. Inspired by many libraries like angular, react, angular-lite and vuejs. It is agnostic about every aspect of a front-end MV(C|VM|P) stack, making it easy to introduce it into your current workflow or to use it as part of your own custom front-end stack comprised of other libraries.

If you like short syntax, and symbols for binding html then you will love it.

Example

More examples coming soon --

Simple drag drop https://jsfiddle.net/riteshpahwa/ecn1fq6j/

Sortable list using jquery-ui https://stackblitz.com/edit/kick-sortlist?file=index.html (old example remake of knockoutjs)

ToDo MVC with jskick, play and pay attention to the simple syntax at https://stackblitz.com/edit/jskick-todo?file=index.html

Tristate checkbox https://stackblitz.com/edit/jskick-tricheckbox?file=index.html

Ace editor with jskick https://stackblitz.com/edit/jskick-ace?file=index.html

See kick in all action with the short syntax at https://stackblitz.com/edit/kick-js1

You can also run examples (in examples folder) by installing npm i http-server

Install

npm install jskick

Use in a script tag...

<script src="node_modules/jskick/dist/kick.min.js"></script>

... or import using a bundler like webpack

import kick from 'jskick'

Usage

		<section id="auction">
			<h3>{{ product.name }}</h3>
			<p>Current bid: {{ currentBid | money }}</p>

			<aside ?="timeLeft | lt 120">
				Hurry up! There is {{ timeLeft | time }} left.
			</aside>

			<button ^="hi(product.name)" class="btn btn-primary">Say Hi!</button> 
		</section>

var vm = {
    currentBid: 250.51, 
    timeLeft: 100, 
    product: {name: 'iPhone'}, 
    hi: function(name) {alert('Kick said hi! your product is ' + name); } 
  };

  kick.formatters.time = function(value){ 
      return value + ' minutes'; 
  }
  kick.formatters.money = {
    read: function(value) {
        return '$' + (value / 100).toFixed(2)
      },
      publish: function(value) {
        return Math.round(parseFloat(value) * 100)
      }
  }

  kick.bind('#auction', vm);

Play with above example at https://stackblitz.com/edit/jskick?file=index.html

Quick Reference for bindings

| Binder | Example | |---|---| | ^ or ^click |<a ^="userClicked()">Link</a>| | ^^ or ^dblclick |<a ^^="userDblClicked()">Link</a>| | ^_ or ^contextmenu |<a ^="userRightClicked()">Link</a>| | ^otherevent |<a ^mouseover="($event)">Link</a>| | ^@ or ^change |<input ^="userChanged()" type="text" @="model.property"></input>| | ^+ or ^focus |<input ^+="userFocused()" type="text" @="model.property"></input>| | ^- or ^blur |<input ^-="userBlurred()" type="text" @="model.property"></input>| | @ or @value |<input type="text" @="model.property"></input>)| | @x or @checked |<input type="checkbox" @x="model.isChecked"></input>)| | @-x or @unchecked |<input type="checkbox" @-x="model.isUnchecked"></input>)| | : or :text |<div :="model.textProperty"></div>| | :: or :html |<div ::="model.htmlProperty"></div>| | $ or :html |<div $="model.htmlProperty"></div>| | + or :show |<div +="model.isVisible"></div>| | - or :hide |<div -="model.isHidden"></div>| | ~ or :disabled |<input type="text" ~="model.isDisabled"></input>| | -~ or :enabled |<input type="text" -~="model.isEnabled"></input>| | ~~ or :enabled |<input type="text" ~~="model.isEnabled"></input>| | Foreach || | * |<div *="item in items"><div :="item.title"></div></div>| | * |<div *item="items"><div :="item.title"></div></div>| | Conditionals || | ? |<div ?="model.ifTrue">Hello World!</div>| | -? |<div -?="model.ifFalse">Hello World!</div>| | Classe || | . |<div .bg-primary="model.hasBG">Hello World!</div>| | -. |<div -.bg-primary="model.noBG">Hello World!</div>| |Style|| | .. |<div ..font-size="model.fontSize">Added font size style</div>| | -.. |<div -..font-size="model.remFontSize">Removed Font size style</div>|

Getting Started and Documentation

Documentation will be (is) available on the homepage. Learn by reading the Guide and refer to the Binder Reference to see what binders are available to you out-of-the-box.

Differences from Rivets.js / tinybind.js

• Public interface
  • Remove component feature -> incomplete, untested code. Use web components libraries like SkateJs or LitElement
  • Add not/negate formatter
  • Remove unless and unchecked binders in favor of combining not/negate formatters with if/checked binders
  • Remove computed feature - can be replaced by an identity formatter
  • Add ability to customize input event through event-name attribute
• Internal changes
  • Written in ES6 instead of coffeescript
  • Change how scope of iteration binder works. Instead of copying properties down to children, uses a prototype like approach
    • Related: 486 512 417
    • More info in the documentation
  • Change name of rv-each index property from index to $index
  • Change how to customize index name in each binder (using an attribute)
    • Related: 551 552
  • Do not bind publish, bind and unbind methods to binding instances
  • Register default binder through fallbackBinder option instead of * binder
  • Integrate sightglass into kick code base
  • Remove view.select method
  • Rename binding property args to arg and changed type from array to string
  • All binders like :?^ (as it used to be rv-*) attributes are removed after binding
  • Changes how observer is registered / notified. Instead of passing a function (sync), pass an object with a sync method

Building and Testing

First install any development dependencies.

$ npm install

Building

kick.js uses rollup as it's bundling / build tool. Run the following to compile the source into dist/.

$ npm run build

Testing

kick.js uses mocha as it's testing framework, alongside should for expectations and sinon for spies, stubs and mocks. Run the following to run the full test suite.

$ npm test

Building documentation

The documentation is built with harp which must be installed globally

$ cd docs
$ harp compile _harp ./

Contributing

Bug Reporting

1. Ensure the bug can be reproduced on the latest master.
2. Open an issue on GitHub and include an isolated JSFiddle or Stackblitz demonstration of the bug. The more information you provide, the easier it will be to validate and fix.

Pull Requests

1. Fork the repository and create a topic branch.
2. Make sure not to commit any changes under dist/ as they will surely cause conflicts for others later. Files under dist/ are only committed when a new build is released.
3. Include tests that cover any changes or additions that you've made.
4. Push your topic branch to your fork and submit a pull request. Include details about the changes as well as a reference to related issue(s).