Astarisx

Astarisx

Highly Composable MVVM Framework for React

Download

Currently v0.11.1

Productive

Astarisx was inspired by React. So it feels like React. There's no need to change your coding style to suit the framework, making it easy to comprehend and quick to learn. It helps seperate concerns with an approach that is intuitive and fluid and was designed with maintainability in mind. Astarisx reduces the complexity of applying incremental enhancements as your application evolves.

Highly Composable

Astarisx View's are stateless and completely decoupled from their Owner Component, making them highly composable. Without changing a line of code, Astarisx Views can be moved anywhere within your application. A View can even be completely removed without breaking your application. Teams can work independently of one another with the confidence that their work will easily integrate into the larger application.

Single Source of Truth

State is presented to Views as a single data model. It is the Single Source of Truth (SSoT). The SSoT is the Application's Data Context and is accessible from anywhere within the application. Communicating between components is no longer an issue, as every component has knowledge of the entire Application's state at any one time. You are guaranteed to have the latest copy of the Application's state when and where you need it.

PushState Router

Astarisx comes with an optional pushState router out of the box and reduces the complexity in integrating client-side pushState routing into your application. Routing configuration and logic is moved out of the View and into the Business Logic Layer where it belongs. Astarisx uses Page, a micro client-side router inspired by the Express router, written by TJ Holowaychuk the creator of Express, amongst other things.

MediaQueryList Notifications

Astarisx is able to receive MediaQueryList Notifications within JavaScript. So as screen size or orientation changes, the application can be notified and respond to it from within your JavaScript code. This may be handy, for example, if you would like to make an ajax request based on a screen's orientation. You could even do some, or all, of your Responsive Design in JavaScript rather than in CSS.

Accelerated Animation

Easily incorporate super smooth page transitions into your application with AstarisxAnimate mixin. AstarisxAnimate uses Velocity, an accelerated JavaScript animation library. Use pre-defined transitions or create your own. Harness the full potential of Velocity to add some flare to your application.

Overview

Astarisx helps implement the Model-View-ViewModel (MVVM) pattern, which was developed by Microsoft in 2005 and is a specialization of the Presentation Model. React's role is to provide the View (UI) within the MVVM pattern, whilst Astarisx provides the Models and ViewModels with which the UI will interact.

Models store Domain State and Data Domain Logic. A ViewModel stores View State and Business Logic, it acts as the "View's Model", and is referred to as the Data Context. The View (UI) is completely decoupled from Business Logic.

Astarisx exposes Data Context's to the UI. The UI invokes actions on Data Context's, resulting in a transition to a new state. The Astarisx State Manager manages the state transition and passes the newly created state back to the UI. Every Astarisx View gets a copy of the current state, which is the Single Source of Truth for the entire application. An Astarisx View is a self contained React component. They differ from regular React components, in that they are stateless and completely decoupled from their Owner. They do not require any props to be passed in to function, making them highly composable.

The main object of Astarisx is to ease client side application development. The benefits of using Astarisx include ease of learning enabling you to be productive in a short period of time. Astarisx Views are stateless and highly composable, enabling the Separation of Concerns for easier maintenance, collaboration and unit testing. The Single Source of Truth is accessible from anywhere within your application which makes Astarisx Applications easier to reason about.

Simple Application

/* Model */ var Todo = Astarisx.createModelClass({ description: { get: function(){ return this.$state.description; } } });
/* ViewModel */ var TodoModel = require("../models/todo"); var Todo = function(){ return new TodoModel().apply(this, arguments); }; var TodosViewModel = Astarisx.createViewModelClass({ todosList: { kind: 'array', get: function(){ return this.$state.todosList; } }, addTodo: function(){ var newTodo = new Todo({ description: this.currentDescription }); var next = this.$state.todosList.concat(newTodo); this.setState({ todosList: next, currentDescription: "" }); }, currentDescription: { get: function(){ return this.$state.currentDescription; }, set: function(newVal){ this.setState({ currentDescription: newVal }); } } });
/* ControllerViewModel */ var ControllerViewModel = Astarisx.createCVMClass({ //Specify a ViewModel's dataContext todos: { viewModel: require('./todos'), get: function(){ return this.$state.todos; } } });
/* UI */ var TodoList = React.createClass({ //Make component an Astarisx view mixins: [Astarisx.mixin.view], render: function(){ var todos = this.state.appContext.todos; var list = todos.todosList.map(function(todo){ return <li>{todo.description}</li>; }); return <ul>{list}</ul>; } }); var UI = React.createClass({ //Make component an Astarisx UI mixins: [Astarisx.mixin.ui], componentWillMount: function(){ this.initializeAppContext({ controllerViewModel: ControllerViewModel }); }, addTodo: function(e){ e.preventDefault(); this.state.appContext.todos.addTodo(); }, updateDescription: function(e){ var todos = this.state.appContext.todos; todos.currentDescription = e.target.value; }, render: function(){ //reference the todos dataContext var todos = this.state.appContext.todos; return (<form> <fieldset> <label htmlFor="task">TODO</label> <input ref="inputFld" id="task" type="text" placeholder="Enter Task" onChange={this.updateDescription} value={todos.currentDescription} /> <button onClick={this.addTodo}>Add</button> </fieldset> <TodoList /> </form>); } });

Download

Stand-alone

"Astarisx" is exposed as a global variable. Download it.

<script src="astarisx.min.js"></script>

Bower

$ bower install astarisx

CommonJS

$ npm install astarisx

AMD

require(['./astarisx.min.js'], function(Astarisx){ // Do something with Astarisx });

License

The MIT License (MIT)

Copyright © 2014-2015 Entrendipity Pty. Ltd.

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.