Comparing version 1.1.1 to 1.1.2
{ | ||
"name": "staballoy", | ||
"description": "Reactive Library for binding data to UI elements in Titanium Alloy", | ||
"version": "1.1.1", | ||
"version": "1.1.2", | ||
"main": "staballoy.js", | ||
"keywords": ["titanium","reactive","titanium-module"], | ||
"keywords": [ | ||
"titanium", | ||
"reactive", | ||
"titanium-module" | ||
], | ||
"author": "Rene Pot", | ||
@@ -20,2 +24,2 @@ "repository": { | ||
} | ||
} | ||
} |
# Staballoy | ||
Reactive UI framework for Titanium Alloy with event handling | ||
State Manager & Reactive UI framework for Titanium Alloy with event handling | ||
Why the name staballoy? Well.. to quote wikipedia | ||
> staballoys are metal alloys of a high proportion of depleted uranium with other metals, usually titanium | ||
It has the Titanium in it, is an alloy and uranium is a reactive metal. Sounds like the perfect name to me. | ||
| :warning: Breaking changes | | ||
|------------------------| | ||
| Version 1.0.0 introduced massive breaking changes as opposed to any 0.x version. Staballoy also no longer overrides the `Alloy.createController` method and therefore is completely compatible with any other framework. | | ||
## How does it work? | ||
Staballoy maintains an object of data, stored in `Ti.App.Properties`, any alteration in this data (by setting new properties) will cause the library to find any UI elements that need updating automatically. | ||
Staballoy maintains an object of data, stored in `Ti.App.Properties`, any alteration in this data (by setting the state) will cause the library to find any UI elements that need updating automatically. | ||
## Setup | ||
So enough talk, how do I install it? For **Alloy** projects go to the `lib` directory of your project, then run the following command `npm i staballoy`. | ||
So how do I install it? For **Alloy** projects go to the `lib` directory of your project (`app/lib`), then run the following command `npm i staballoy` for **Webpack** projects run the npm install in your app root. | ||
_Note: if your app doesn't have `node_modules` yet, run `npm init` first!_ | ||
_Note: if your Alloy app doesn't have `node_modules` yet, run `npm init` first!_ | ||
@@ -26,2 +16,4 @@ ## Getting/Setting data | ||
_Note: Setting an array will not merge the existing array in the same place, array's overwrite_ | ||
### Setting data | ||
@@ -28,0 +20,0 @@ To set data in staballoy, all you need to do is call the `set` method and provide any data you want to **add** to the dataset |
14669
160