UI-Router for React - Sample Application
JavaScript CSS Other
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

UI-Router 1.0 React Sample Application

http://ui-router.github.io/sample-app-react/#/mymessages/inbox/5648b50cc586cac4aed6836f

Travis badge Greenkeeper badge

This sample app is intended to demonstrate a non-trivial ui-router react application.

  • Multiple sub-modules
  • Managed state lifecycle
  • Application data lifecycle
  • Authentication (simulated)
  • Authenticated and unauthenticated states
  • REST data retrieval (simulated)

Visualizer

We're using the State and Transition Visualizer to visually represent the current state tree, as well as the transitions between states. Explore how transitions work by hovering over them, and clicking to expand details (params and resolves).

Note how states are entered when they were previously not active, exited and re-entered when parameters change, and how parent states whose parameters did not change are retained. Each of these (exited, entered, retained) correspond to a Transition Hook.

Structure

The application is written in ES6, and utilizes ES6 modules. We are loading the modules using SystemJS and es6-module-loader in the browser (note: currently, we are also transpiling in the browser, but will be transpiling at build-time in the future for better performance/smaller payload).

There are many ways to structure a ui-router app. We aren't super opinionated on application structure. Use what works for you. We organized ours in the following way:

  • Sub-module (feature) organization
    • Each feature gets its own directory.
    • Features contain states and all its components.
    • Router/state components live in the feature directory.
    • "Dumb" components used only within a feature live in a components subdirectory
  • Leveraging ES6 modules
    • Each state is defined in its own file
    • Each component is defined in its own file
    • Components export themselves
    • Components are then imported into states where they are composed into the state definition.
    • States export themselves
    • The router.config.js imports all states and registers them with the stateRegistry

UI-Router Patterns

  • Defining custom, app-specific global behaviors
    • Add metadata to a state, or state tree
    • Check for metadata in transition hooks
    • Example: redirectTo
      • If a transition directly to a state with a redirectTo property is started, the transition will be redirected to the state which the property names.
    • Example: global/requiresAuth.hook.js
      • If a transition to a state with a truthy data.authRequired: true property is started and the user is not currently authenticated
  • Defining a default substate for a top-level state
    • Example: declaring redirectTo: 'mymessages.messagelist' in mymessages/states.js (mymessages state)
  • Defining a default parameter for a state
    • Example: folderId parameter defaults to 'inbox' in mymessages/states.js (messagelist state)
  • Application data lifecycle
    • Data loading is managed by the state declaration, via the resolve: block
    • Data is fetched before the state is entered
    • Data is fetched according to state parameters
    • The state is entered when the data is ready
    • The resolved data is injected into the components via props
    • The resolve data remains loaded until the state is exited