gravy-bind
TypeScript icon, indicating that this package has built-in type declarations

1.3.0 • Public • Published

GravyBind Version Downloads Build Status

Hassle-free one-way binding for predominantly server-side apps

[ npm | GitHub | Demo ]

Quick Start

Add a reference to the script

<script type="text/javascript" src="https://unpkg.com/gravy-bind/dist.browser/index.js"></script>

Create a binder

let binder = new GravyBinder();

Or provide a variable scope (default is just window)

const binder = new GravyBinder({firstName: '', lastName:''});

Or limit scanning to just part of the DOM tree

const binder = new GravyBinder(myScope, document.getElementById('rootNode'));

Start binding stuff!

<input data-in="this.firstName">
<b>You entered:</b>
<span data-display="this.firstName"></span>

What is it?

Say hello to GravyBind! This utility lets you bind things in your HTML to JavaScript variables.

Let me start off by saying that this is not a good alternative to anything more fully-featured like Vue or React. This is meant for simple scenarios where you want to just add some dynamism to an application that's either simpler or older without making major changes or making a big mess.

In the case I originally created this for, we had a .NET Core MVC project with jQuery spaghetti that was quickly becoming a nightmare to maintain as the app's complexity increased. I needed a simple way to update things like display values, class bindings, and native HTML validation properties in a more declarative way than a bunch of random query selectors. GravyBind uses data attributes to handle binding, so your markup and bindings are in the same place and it's easy to see how things are connected. There is no change tracker, it literally refreshes all the bindings when you tell it to so this probably isn't the most optimized thing around. Feel free to open a pull request if you have some performance improvements in mind.

Again, if you're building a new app, I strongly recommend using a popular frontend framework or library. However when limitations prevent that, this can come in handy.

With that out of the way, let's take a look at what this can do!

Docs & Demo

See the demo page for usage and examples: gravybind.halomademeapc.com

Planned Features

  • Loops and templating
  • Radio button support
  • Two-way binding on inputs

Changelog

  • 1.2.0 Add support for dynamically registering binding types, add more built-in bindings
  • 1.1.0 Replace eval calls with new Function, limit JavaScript scope of evaluations

Readme

Keywords

Package Sidebar

Install

npm i gravy-bind

Weekly Downloads

121

Version

1.3.0

License

ISC

Unpacked Size

17.5 kB

Total Files

6

Last publish

Collaborators

  • halomademeapc