Manage states in AngularJS
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
dist
src
test
.DS_Store
.gitignore
LICENSE
README.md
bower.json
gulpfile.js
package.json

README.md

#angular-state-manager

Stop the AngularJS spaghetti code! Instead of this:

// random variables all over the place
$scope.adding = false;

$scope.startAddingItem = function() {
	$scope.adding = true;
}

$scope.stopAddingItem = function(name) {
	myService.add(name);
	$scope.adding = false;
}

Write this:

// use controllerAs sytnax
var vm = this;

// create a new group of "states"
vm.states = stateManager.group('items');

vm.states()
	// here, we have a state where we're adding items
	.state(function() {
		return {
			name: 'adding',
			// when we're done, the only thing we need to do is update myService
			done: function(subject, model) {
				myService.add(model);
			}
		}
	})
	.config(function() {
		return {
			scope: vm
		}
	});

Content

  1. Technical Info
  2. Description
  3. Using It

Technical Info

v0.8.1 pre-release

Download at: dist --> state-manager[.min].js

Dependencies: AngularJS@1.3.14 (not tested in any other version)

Browser support: IE9+, all other modern browsers

Description

Creates a separate layer for managing states within a controller.

Using it

Example app using stateManager (see it live)

Tutorials coming soon...

Basic usage:

<!-- EXAMPLE 001: index.html -->
<div ng-controller="MainController as vm" ng-repeat="item in vm.items" ng-click="vm.states('editing').start({model: item})">{{item.name}}</div>

<input type="text" ng-model="vm.models.commentsForItemBeingEdited" ng-show="vm.states('editing').isActive()">
<button ng-click="vm.states('editing').done()">Save</button>
<button ng-click="vm.states('editing').stop()">Cancel</button>

<!-- EXAMPLE 002: wouldn't show any behavior; simply for demo purposes on how to bind a scope's model to the stateManager -->
<input type="text" ng-model="vm.models.commentsForItemBeingEdited" value="Hello World!" />

<!-- notice the model has to be passed in as a string, but the subject is an actual scope object -->
<button ng-click="vm.states('addingComments').start({subject: vm.someObject, model:'vm.models.commentsForItemBeingEdited'})">Start</button>

<button ng-click="vm.states('addingComments').done()">Save Comments</button>
// my.module.js
// First, add the module as a dependency

angular.module('my',['stateManager']);

// main.controller.js
// Then, inject the factory (of the same name) into your controller
main.$inject = ['stateManager'];

angular.module('my').controller('main',main);

function main(stateManager) {
	// your controller logic
}

// Then, inside the controller...
var vm = this;

// initialize it
vm.states = stateManager.group('list');

// add some states
vm.states()
	.state(function(name, states) {
	
		console.log(name) // ==> 'list'
		console.log(states.count()) // ==> 0
		
		return {
			name: 'editing',
			start: function(subject) {
				console.log(subject); // ==> item from ng-repeat
			}		
		};
	})
	.state(function(name, states) {
		console.log(states.count()) // ==> 1
		
		return {
			name: 'addingComments',
			start: function(subject,model) {
				// from EXAMPLE 002
				console.log(subject); // ==> no subject; was never declared in the start function up top
				console.log(model); // ==> 'Hello World!'
			},
			done: function(subject,model) {
				subject.set('comments',model); // ==> vm.someObject.comments = 'Hello World!'
			}		
		};
	})
	.state(function() {
		return {
			name: 'editingDescription'
		};
	});
	
// configure it
vm.states()
	.config(function() {
		var group = ['addingComments','editingDescription'];
		
		return {
			scope: vm,
			exclusive: group,
			children: {
				editing: group
			}
		};
	});
	
/*
	stateManager's model namespace is reserved for stateManager, since it 're-builds' models
	every time .start() or .done() runs
	
	For example, if using this namespace for your stateManager models:
	vm.models.someModel // ==> 'foo'
	
	Then, DO NOT create an object in the controller like this:
	vm.models = {
		anotherModel: 'bar'
	}
	... because vm.models.anotherModel will be overwritten
	
	Instead, use a separate namespace in the controller, such as:
	vm.someNameSpace = {
		anotherModel: 'bar'
	}
	... this will NOT be overwritten by stateManager
*/

// object from EXAMPLE 002
vm.someObject = {
	comments: '';
}

Semantic Versioning
X.Y.Z

If X = 0, then Y = new backwards incompatible API, Z = backwards compatible update or bug fix
If X > 0, then X = new backwards incompatible API, Y = new backwards compatible API feature, Z = bug fix


Last updated 20 March 2015

The MIT License (MIT) Copyright © 2015 Joshua Beam