Flow Router add-on for Community Packages Accounts

Community Packages Accounts is a suite of packages for the Meteor.js platform. It provides highly customizable user accounts UI templates for many different front-end frameworks. At the moment it includes forms for sign in, sign up, forgot password, reset password, change password, enroll account, and link or remove of many 3rd party services.

This package is an optional add-on for integration with Flow Router Extra and either Blaze Layout or Blaze React Component.

Prerequisites

meteor add communitypackages:flow-routing ostrio:flow-router-extra

For Blaze layouts:

meteor add pwix:blaze-layout

For blaze-to-react layouts (rendering Blaze templates inside React):

meteor add gadicc:blaze-react-component
meteor npm install react react-dom

Blaze Configuration

Firstly, please ensure that your app depends upon the Blaze Layout package.

Then, before you configure routes for User Accounts with Flow Router, you will need to make sure you have set a few default configuration items.

Assuming you have a main layout that looks like this:

<template name="myLayout">

  <div class="nav">
    {{> Template.dynamic template=nav}}
  </div>

  <div class="content">
    {{> Template.dynamic template=main}}
  </div>

  <footer>
    {{> Template.dynamic template=footer}}
  </footer>

</template>

You would configure this package to use it like this:

1AccountsTemplates.configure({
2    defaultLayoutType: 'blaze', // Optional, the default is 'blaze'
3    defaultTemplate: 'myCustomFullPageAtForm',
4    defaultLayout: 'myLayout',
5    defaultLayoutRegions: {
6        nav: 'myNav',
7        footer: 'myFooter'
8    },
9    defaultContentRegion: 'main'
10});

If you don't have extra content regions (nav, footer, etc) you should pass an empty object to defaultLayoutRegions key of the config.

1AccountsTemplates.configure({
2    defaultLayout: 'myLayout',
3    defaultLayoutRegions: {},
4    defaultContentRegion: 'main'
5});

communitypackages:flow-routing uses the internal fullPageAtForm built-in template for its forms by default. You can override it on a per-route basis (see below) or replace it with defaultTemplate: field as above (templates specified in route config will still take precedence). Omit defaultTemplate (or set to an empty string) to use the fullPageAtForm template built-in to your useraccounts UI package (ex material).

NOTE: The above configs must load BEFORE your AccountsTemplates routes are defined (next section).

React Configuration

To render Blaze-based UserAccounts templates inside a React layout, install the Blaze React Component package and React from npm:

meteor add gadicc:blaze-react-component
meteor npm install react react-dom

Before you configure routes, set default configuration items.

Assuming you have a main layout that looks like the following and you have <Nav /> and <Footer /> as your default nav/footer components:

1const MainLayout = ({ nav, main, footer }) => (
2  <div>
3    <header>
4      {nav || <Nav />}
5    </header>
6    <main>
7      {main}
8    </main>
9    <footer>
10      {footer || <Footer />}
11    </footer>
12  </div>
13);

You would then configure this package to use it like this:

1AccountsTemplates.configure({
2  defaultLayoutType: 'blaze-to-react',
3  defaultTemplate: 'fullPageAtForm',  // default
4  defaultLayout: MainLayout,
5  defaultLayoutRegions: {
6    nav: <Nav />,
7    footer: <Footer />
8  },
9  defaultContentRegion: 'main'
10});

If you don't have extra content regions (nav, footer, etc) you should pass an empty object to the defaultLayoutRegions key of the config.

1AccountsTemplates.configure({
2  defaultLayoutType: 'blaze-to-react',
3  defaultTemplate: 'myCustomFullPageAtForm',
4  defaultLayout: MainLayout,
5  defaultLayoutRegions: {},
6  defaultContentRegion: 'main'
7});

Please note that the template must be a Blaze template. It will be rendered into your React layout using Blaze React Component.

Your app must have a <div id="react-root"></div> element in the HTML body for React rendering.

NOTE: The above configs must load BEFORE your AccountsTemplates routes are defined (next section).

Routes

There are no routes provided by default, but you can easily configure routes for sign in, sign up, forgot password, reset password, change password, enroll account using AccountsTemplates.configureRoute.

The simplest way is to make the call passing in only a route code (available route codes are: signIn, signUp, changePwd, forgotPwd, resetPwd, enrollAccount).

This will set up the sign in route with a full-page form at /sign-in:

1AccountsTemplates.configureRoute('signIn');

You can also pass in more options to adapt it to your needs with:

1AccountsTemplates.configureRoute(route_code, options);

The following is a complete example of a custom route configuration:

Blaze

1// routes.js
2
3AccountsTemplates.configureRoute('signIn', {
4  layoutType: 'blaze',
5  name: 'signin',
6  path: '/login',
7  template: 'myLogin',
8  layoutTemplate: 'myLayout',
9  layoutRegions: {
10    nav: 'customNav',
11    footer: 'customFooter'
12  },
13  contentRegion: 'main',
14  redirect: '/user-profile'
15});

React

1// routes.jsx
2
3AccountsTemplates.configureRoute('signIn', {
4  layoutType: 'blaze-to-react',
5  name: 'signin',
6  path: '/login',
7  template: 'myLogin',
8  layoutTemplate: CustomLayout,
9  layoutRegions: {
10    nav: <CustomNav />,
11    footer: <CustomFooter />
12  },
13  contentRegion: 'main',
14  redirect: '/user-profile'
15});

All options are passed to FlowRouter.route() which then creates a new custom route (see the official Flow Router Extra documentation for more details).

The redirect field permits to specify where to redirect the user after successful form submit. Actually, redirect can be a function so that, for example, the following:

1AccountsTemplates.configureRoute('signIn', {
2    redirect: function(){
3        var user = Meteor.user();
4        if (user)
5          FlowRouter.go('/user/' + user._id);
6    }
7});

Default values for all fields are as follows:

Action	route_code	Route Name	Route Path	Template	Redirect after Timeout
change password	changePwd	atChangePwd	/change-password	fullPageAtForm
enroll account	enrollAccount	atEnrollAccount	/enroll-account	fullPageAtForm	X
forgot password	forgotPwd	atForgotPwd	/forgot-password	fullPageAtForm	X
reset password	resetPwd	atResetPwd	/reset-password	fullPageAtForm	X
sign in	signIn	atSignIn	/sign-in	fullPageAtForm
sign up	signUp	atSignUp	/sign-up	fullPageAtForm
verify email	verifyEmail	atVerifyEmail	/verify-email	fullPageAtForm	X
resend verification email	resendVerificationEmail	atResendVerificationEmail	/send-again	fullPageAtForm

Content Protection

If you want to protect a route by making sure a user is signed in, you can add the AccountsTemplates.ensureSignedIn check in your route's enter triggers like this:

1FlowRouter.route('/private', {
2  triggersEnter: [AccountsTemplates.ensureSignedIn],
3  action: function() {
4    BlazeLayout.render(...);
5  }
6});

If the user isn't signed in, they will be redirected to your sign in route and then redirected back to the original route after they have successfully signed in.

Or if you want to protect ALL routes in your app:

1FlowRouter.triggers.enter([AccountsTemplates.ensureSignedIn]);

Migration from useraccounts:flow-routing

If you are migrating from useraccounts:flow-routing v1.x, the following changes are required:

Replace Meteor packages:

meteor remove useraccounts:flow-routing kadira:flow-router kadira:blaze-layout
meteor add communitypackages:flow-routing ostrio:flow-router-extra pwix:blaze-layout

If using blaze-to-react layout type, also replace:

meteor remove kadira:react-layout gwendall:blaze-to-react
meteor add gadicc:blaze-react-component
meteor npm install react react-dom

And add <div id="react-root"></div> to your HTML body.

No code changes are needed for route configuration -- the API is identical.