This repository has been archived by the owner. It is now read-only.
Highly Composable MVVM Framework for React
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

Astarisx

Highly Composable MVVM Framework for React.

Click here for the Astarisx Website and Documentation

Build Status License

Highly Composable UI Components

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.

Built in 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.

Example Code

Create your Model

/* todo.js */
var Todo = Astarisx.createModelClass({
  description: {
    get: function(){
      return this.$state.description;
    }
  }
});

Create your ViewModel

/* todos.js */
var TodoModel = require("../models/todo");

// Model Constructor
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
      });
    }
  }
});

Create a ControllerViewModel

/* controllerViewModel.js */
var CVM = Astarisx.createCVMClass({
  //Specify a ViewModel's dataContext
  //This is referenced from the View
  todos: {
    viewModel: require('./todos'),
    get: function(){
      return this.$state.todos;
    }
  }
});

Build your View Components in React

class TodoList extends React.Component {
  constructor(props){
    super(props);
    this.state = {
      todos: Astarisx.state.appContext.todos
    };
  }
  componentDidMount(){
    Astarisx.register(this);
  }
  componentWillUnmount(){
    Astarisx.unregister(this);
  }
  render(){
    /*
      No props are passed in.
      All state is stored
      in this.state.appContext
    */
    // reference the todos data context
    let todos = this.state.todos;
    let list = todos.todosList.map(function(todo){
      return <li>{todo.description}</li>;
    });
    return <ul>{list}</ul>;
  }
};

var cvm = require('../viewModels/controllerViewModel');
class UI = React.createClass({
  componentWillMount(){
    //Initialize the application context
    Astarisx.init({
      controllerViewModel: cvm
    });
  }

  componentWillUnmount(){
    Astarisx.dispose();
  }

  addTodo(e){
    e.preventDefault();
    //Invoke action on dataContext
    this.state.todos.addTodo();
  }

  updateDescription(e){
    /*
      Assign value to currentDescription
      defined in the todos dataContext.
      This would usually be a field
      in a Model. We're doing this here
      to keep the demo simple.
    */
    let todos = this.state.todos;
    todos.currentDescription = e.target.value;
  }

  render(){
    //reference the todos dataContext
    let todos = this.state.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>
      {/*
        No props are passed
        to the TodoList component
      */}
      <TodoList />
    </form>);
  }
};

Usage

Astarisx can be loaded as:

  • standalone. Astarisx is exposed as a global variable
 <script src="astarisx.min.js"></script>
  • a Node.js module
$ npm install astarisx
  • a Bower module
$ bower install astarisx
  • a RequireJS module
require(['./astarisx.min.js'], function (Astarisx) {
    // Do something with Astarisx
});

Astarisx Website and Documentation

Author

Frank Panetta - Follow @fattenap

License

The MIT License (MIT)

Copyright (c) 2014-2015 Entrendipity Pty Ltd

Copyright (c) 2015-2018 Zuudo 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.