Skip to content
A Redux plugin for the Aurelia framework
TypeScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.vscode
src
.gitignore
.npmignore
.typingsrc
LICENSE
README.md
package.json
tsconfig.json
typings.json

README.md

aurelia-redux-plugin

A Redux plugin for the Aurelia framework.

Install

npm install --save aurelia-redux-plugin

Configure

Simply include aurelia-redux-plugin as a plugin in your aurelia config.

import { createStore } from 'redux';
import { rootReducer } from '../reducers';

export function configure(aurelia) {
  aurelia.use
    .standardConfigurtion()
    .developmentLogging()
    .plugin('aurelia-redux-plugin', {
      store: createStore(rootReducer)
    });
}

You can also provide the store during your applications main component lifecycle.

import { inject } from 'aurelia-framework';
import { Store } from 'aurelia-redux-plugin';
import { createStore } from 'redux';
import { rootReducer } from '../reducers';

@inject(Store)
class MyApp {
  constructor(store: Store) {
    store.provideStore(createStore(rootReducer));
  }
}

The plugin lets you supply your own store instead of wrapping an api to create it for you. Simply create your store and provide it to the plugin. Note, this plugin has no control over your reducers or action creators. It is merely an adapter to Aurelia's binding engine and an adapter to your view model and services to select data and dispatch events. How you create/organize your data/reducers/actions is up to you.

Options

  • store: Redux.Store: An already created store to use.
  • async: boolean = false: Whether to enable basic async functionality. This means the dispatch method can handle promises and functions (thunks). This is disabled by default as it can interfere with other middleware like redux-thunk or redux-promise. Note, it does not cover all functionality of redux-thunk.

Using the Store

The store can be injected using Aurelia's dependency inject container. The wrapped store contains the same API as a typical redux store.

import { inject } from 'aurelia-framework';
import { Store } from 'aurelia-redux-plugin';

@inject(Store)
class MyViewModel {
  constructor(private store: Store) {}

  setFirstName(name: string): void {
    this.store.dispatch({ type: 'SET_FIRST_NAME', payload: 'Jimmy Joe Joe' });
  }
}

Using the Dispatch Decorator

Using the store directly is easy, but you can make this more declarative by using the dispatch decorator.

import { dispatch } from 'aurelia-redux-plugin';

class MyViewModel {
  @dispatch('SET_FIRST_NAME')
  setFirstName: (payload: { payload: string}) => void;
}

This dispatchs an action that looks like this { type: 'SET_FIRST_NAME', payload: 'Fran' }. You can also provide other options to get more control over action creation.

import { dispatch } from 'aurelia-redux-plugin';

const setFirstName = (name: string) => ({ type: 'SET_FIRST_NAME', payload: name });

class MyViewModel {
  // Using an action creator
  @dispatch(setFirstName)
  setFirstName: (name: string) => void;
}

const vm = new MyViewModel();

vm.setFirstName('Steven'); // Dispatches { type: 'SET_FIRST_NAME', payload: 'Steven' }

You can provide an optional creator on the class that will delegate the dispatch action.

import { dispatch } from 'aurelia-redux-plugin';

const setFirstName = (name: string) => ({ type: 'SET_FIRST_NAME', payload: name });

class MyViewModel {
  // Using an action creator
  @dispatch(setFirstName, { creator: 'firstNameCreator' })
  setFirstName: (name: string) => void;

  firstNameCreator(dispatch: Function, name: string): void {
    // The dispatch function is prebound to the supplied action creator.
    dispatch(name.toUpperCase());
  }
}

const vm = new MyViewModel();

vm.setFirstName('Steven'); // Dispatches { type: 'SET_FIRST_NAME', payload: 'STEVEN' }

Selectors

You can assign a selector to property by using the select decorator.

import { select } from 'aurelia-redux-plugin';

// Assuming state
const state = {
  activeUser: {
    name: 'Sven'
  } 
};

class ActiveUser {
  @select('activeUser.name')
  name: string;
}

// The activeUser class will report -> 'Sven'.

Ideally you will use selector functions to generate your derived data.

import { select } from 'aurelia-redux-plugin';

// Assuming state
const state = {
  activeUser: 1,
  entities: {
    users: {
      1: { name: 'Joe' },
      2: { name: 'Blorg' },
      3: { name: 'Khan' }
    }  
  } 
};

const getAllUserNames = state => state.entities.users.map(u => u.name);

class ActiveUser {
  @select(getAllUserNames)
  userNames: string[];
}

// userNames will return ['Joe', 'Blorg', 'Khan']

You can provide an invoke option to use a method on your view model as the selector. This allows you to use local state in your selectors. Whether you think that's a good idea is up to you ;)

import { select } from 'aurelia-redux-plugin';

class ActiveUser {
  userId: number = 1; 
  
  @select('getUser', { invoke: true })
  user: User;

  private getUser(state: any): User {
    return state.entities[this.userId];
  }
}

// activeUser.user will return { name: 'Joe' }

You can also provide an optional subscribe option to be notified when the value has changed.

class ActiveUser {
  @select(getAllUserNames, { subscribe: true })
  userNames: string[];

  userNamesChanged(newValue: string[], oldValue?: string[]): void {
    // Do something here  
  }
}

What's supported

  • Selectors
  • Memoized selectors (Supports selector libraries like reselect)
  • Basic async dispatch and thunks (opt-in)
  • Dispatch shorthand methods
  • Change notification with selectors
  • Aurelia observer adapter for properties decorated with a selector
  • Store access through dependency injection

What's not supported

  • Multiple stores (currently only a single store is supported for application)

Inspired By

ng2-redux

You can’t perform that action at this time.