Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/studiointeract/accounts-ui
Accounts UI for React in Meteor 1.3+
https://github.com/studiointeract/accounts-ui
flow-router loginform meteor profile react react-router signup ssr
Last synced: 8 days ago
JSON representation
Accounts UI for React in Meteor 1.3+
- Host: GitHub
- URL: https://github.com/studiointeract/accounts-ui
- Owner: studiointeract
- License: mit
- Created: 2016-03-28T20:35:48.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2021-11-19T12:02:51.000Z (almost 3 years ago)
- Last Synced: 2024-04-13T20:24:01.030Z (7 months ago)
- Topics: flow-router, loginform, meteor, profile, react, react-router, signup, ssr
- Language: JavaScript
- Homepage:
- Size: 282 KB
- Stars: 196
- Watchers: 12
- Forks: 81
- Open Issues: 28
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# React Accounts UI
Current version 1.3.0
## Features
1. **[Easy to use](#using-react-accounts-ui)**, mixing the ideas of useraccounts configuration and accounts-ui that everyone already knows and loves.
2. **[Components](#available-components)** are everywhere, and extensible by replacing them on Accounts.ui.
3. **[Basic routing](#configuration)** included, redirections when the user clicks a link in an email or when signing in or out.
4. **[Unstyled](#styling)** is the default, no CSS included.
5. **[No password](#no-password-required)** sign up and sign in are included.
6. **[Extra fields](#extra-fields)** is now supported.
7. **[Extending](#create-your-own-styled-version)** to make your own custom form, for your app, or as a package, all components can be extended and customized.
8. **[States API](#example-setup-using-the-states-api)** makes it possible to use the form on different routes, say you want the login on one route and signup on another, just set the inital state and the links (either globally or per component by using the props).
9. **[React Router](#example-setup-using-react-router-meteor-13)** is fully supported, see the example how to use with React Router.
10. **[FlowRouter](#example-setup-using-flowrouter-meteor-13)** is fully supported, see the example how to use with FlowRouter.
11. **[Server Side Rendering](#example-setup-using-flowrouter-meteor-13)** is easily setup, see how it's done with FlowRouter (SSR). An example for React Router using [react-router-ssr](https://github.com/thereactivestack/meteor-react-router-ssr) coming shortly.
## Styling
This package does not by standard come with any styling, you can easily [extend and make your own](#create-your-own-styled-version), here are a couple versions we've made for the typical use case:
* [**Basic**](https://atmospherejs.com/std/accounts-basic) `std:accounts-basic`
* [**Semantic UI**](https://atmospherejs.com/std/accounts-semantic) `std:accounts-semantic`
* [**Bootstrap 3/4**](https://atmospherejs.com/std/accounts-bootstrap) `std:accounts-bootstrap`
* [**Ionic**](https://atmospherejs.com/std/accounts-ionic) `std:accounts-ionic`
* [**Material UI**](https://atmospherejs.com/zetoff/accounts-material-ui) `zetoff:accounts-material-ui`
* Add your styled version here [Learn how](#create-your-own-styled-version)
## Installation
`meteor add std:accounts-ui`
## Configuration
We support the standard [configuration in the account-ui package](http://docs.meteor.com/#/full/accounts_ui_config). But have extended with some new options.
### Accounts.ui.config(options)
`import { Accounts } from 'meteor/std:accounts-ui'`
Configure the behavior of ``
Example configuration:
```javascript
Accounts.config({
sendVerificationEmail: true,
forbidClientAccountCreation: false
});
Accounts.ui.config({
passwordSignupFields: 'EMAIL_ONLY',
loginPath: '/login',
signUpPath: '/signup',
resetPasswordPath: '/reset-password',
profilePath: '/profile',
onSignedInHook: () => FlowRouter.go('/general'),
onSignedOutHook: () => FlowRouter.go('/login'),
minimumPasswordLength: 6
});
```
### Version 1.2 also supports passing hooks through props to the component.
```js
import { Accounts } from 'meteor/std:accounts-ui';
console.log('user signed in') }
/>
```
**_Options:_**
* **requestPermissions** Object
Which [permissions](http://docs.meteor.com/#requestpermissions) to request from the user for each external service.
* **requestOfflineToken** Object
To ask the user for permission to act on their behalf when offline, map the relevant external service to true. Currently only supported with Google. See [Meteor.loginWithExternalService](http://docs.meteor.com/#meteor_loginwithexternalservice) for more details.
* **forceApprovalPrompt** Boolean
If true, forces the user to approve the app's permissions, even if previously approved. Currently only supported with Google.
* **passwordSignupFields** String
Which fields to display in the user creation form. One of `'USERNAME_AND_EMAIL'`, `'USERNAME_AND_OPTIONAL_EMAIL'`, `'USERNAME_ONLY'`, `'EMAIL_ONLY'`, `'USERNAME_AND_EMAIL_NO_PASSWORD'`, **`'EMAIL_ONLY_NO_PASSWORD'`** (**default**).
* **requireEmailVerification** Boolean
Set if the login *without password* should check if the user is verified before sending any login emails. Default is **false**.
* **minimumPasswordLength** Number
Set the minimum number of password length for your application. Default is **7**.
* **homeRoutePath** String
Set the path to where you would like the user to be redirected after a successful login or sign out.
* **loginPath** String
Change the default path a user should be redirected to after a clicking a link in a mail provided to them from the accounts system, it could be a mail set to them when they have reset their password, verifying their email if the setting for `sendVerificationEmail` is turned on ([read more on accounts configuration ](http://docs.meteor.com/#/full/accounts_config)). Can also be set as a property to the LoginForm, for i18n routes or other customization.
* **signUpPath** String
Set the path to where you would like the sign up links to link to rather than changing the state on the current page. Can also be set as a property to the LoginForm, for i18n routes or other customization.
* **resetPasswordPath** String
Set the path to where you would like the link to reset password to go to rather than changing the state on the current page. Can also be set as a property to the LoginForm, for i18n routes or other customization.
* **profilePath** String
Set the path to where you would like the link to the profile to go to rather than changing the state on the current page. Can also be set as a property to the LoginForm, for i18n routes or other customization.
* **changePasswordPath** String
Set the path to where you would like the link to change password to go to rather than changing the state on the current page. Can also be set as a property to the LoginForm, for i18n routes or other customization.
* **onSubmitHook** function(error, state)
Called when the LoginForm is being submitted: allows for custom actions to be taken on form submission. error contains possible errors occurred during the submission process, state specifies the LoginForm internal state from which the submission was triggered. A nice use case might be closing the modal or side-menu or dropdown showing LoginForm. You can get all the possible states by import `STATES` from this package.
* **onPreSignUpHook** function(options)
Called just before submitting the LoginForm for sign-up: allows for custom actions on the data being submitted. A nice use could be extending the user profile object accessing options.profile. to be taken on form submission. The plain text password is also provided for any reasonable use. If you return a promise, the submission will wait until you resolve it.
* **onPostSignUpHook** func(options, user)
Called client side, just after a successful user account creation, post submitting the form for sign-up: allows for custom actions on the data being submitted after we are sure a new user was successfully created.
* **onResetPasswordHook** function()
Change the default redirect behavior when the user clicks the link to reset their email sent from the system, i.e. you want a custom path for the reset password form. Default is **loginPath**.
* **onEnrollAccountHook** function()
Change the default redirect behavior when the user clicks the link to enroll for an account sent from the system, i.e. you want a custom path for the enrollment form. Learn more about [how to send enrollment emails](http://docs.meteor.com/#/full/accounts_sendenrollmentemail). Default is **loginPath**.
* **onVerifyEmailHook** function()
Change the default redirect behavior when the user clicks the link to verify their email sent from the system, i.e. you want a custom path after the user verifies their email or login with `EMAIL_ONLY_NO_PASSWORD`. Default is **profilePath**.
* **onSignedInHook** function()
Change the default redirect behavior when the user successfully login to your application, i.e. you want a custom path for the reset password form. Default is **profilePath**.
* **onSignedOutHook** function()
Change the default redirect behavior when the user signs out using the LoginForm, i.e. you want a custom path after the user signs out. Default is **homeRoutePath**.
* **emailPattern** new RegExp()
Change how emails are validated on the client, i.e. require specific domain or pattern for an email. Default is **new RegExp('[^@]+@[^@\.]{2,}\.[^\.@]+')**.
## No password required
This package provides a state that makes it possible to create and manage accounts without a password. The idea is simple, you always verify your email, so to login you enter your mail and the system emails you a link to login. The mail that is sent can be changed if needed, just [how you alter the email templates in accounts-base](http://docs.meteor.com/#/full/accounts_emailtemplates).
This is the default setting for **passwordSignupFields** in the [configuration](#configuration).
## Using React Accounts UI
### Example setup (Meteor 1.3)
`meteor add accounts-password`
`meteor add std:accounts-ui`
```javascript
import React from 'react';
import { Accounts } from 'meteor/std:accounts-ui';
Accounts.ui.config({
passwordSignupFields: 'EMAIL_ONLY_NO_PASSWORD',
loginPath: '/',
});
if (Meteor.isClient) {
ReactDOM.render(, document.body)
}
```
### Example setup using React Router (Meteor 1.3)
Following the [Application Structure from the Meteor Guide](http://guide.meteor.com/v1.3/structure.html).
`npm i --save react react-dom react-router`
`meteor add accounts-password`
`meteor add std:accounts-ui`
```javascript
import React from 'react';
import { render } from 'react-dom';
import { Router, Route, IndexRoute, browserHistory } from 'react-router';
import { Accounts, STATES } from 'meteor/std:accounts-ui';
import { App } from '../../ui/layouts/app.jsx';
import { Index } from '../../ui/components/index.jsx';
import { Hello } from '../../ui/pages/hello.jsx';
import { Admin } from '../../ui/pages/admin.jsx';
import { NotFound } from '../../ui/pages/not-found.jsx';
Meteor.startup( () => {
render(
} />
} />
,
document.getElementById( 'react-root' )
);
});
```
You can learn more about the remaining components here in the tutorial on [React Router Basics](https://themeteorchef.com/snippets/react-router-basics/) by the Meteor Chef.
### Example setup using FlowRouter (Meteor 1.3)
`npm i --save react react-dom`
`meteor add accounts-password`
`meteor add std:accounts-ui`
`meteor add kadira:flow-router-ssr`
```javascript
import React from 'react';
import { Accounts } from 'meteor/std:accounts-ui';
import { FlowRouter } from 'meteor/kadira:flow-router-ssr';
Accounts.ui.config({
passwordSignupFields: 'EMAIL_ONLY_NO_PASSWORD',
loginPath: '/login',
onSignedInHook: () => FlowRouter.go('/general'),
onSignedOutHook: () => FlowRouter.go('/')
});
FlowRouter.route("/login", {
action(params) {
mount(MainLayout, {
content:
});
}
});
```
### Example setup using the STATES api.
You can define the inital state you want in your route for the component,
as set the path where the links in the component link to, for example below we
have one route for /login and one for /signup.
`meteor add accounts-password`
`meteor add std:accounts-ui`
`meteor add softwarerero:accounts-t9n`
`meteor add kadira:flow-router-ssr`
```javascript
import React from 'react';
import { Accounts, STATES } from 'meteor/std:accounts-ui';
import { T9n } from 'meteor/softwarerero:accounts-t9n';
T9n.setLanguage('en');
Accounts.config({
sendVerificationEmail: true,
forbidClientAccountCreation: false
});
Accounts.ui.config({
passwordSignupFields: 'USERNAME_AND_OPTIONAL_EMAIL',
loginPath: '/login'
});
FlowRouter.route("/login", {
action(params) {
mount(MainLayout, {
content:
});
}
});
FlowRouter.route("/signup", {
action(params) {
mount(MainLayout, {
content:
});
}
});
```
## Create your own styled version
**To you who are a package author**, its easy to write extensions for `std:accounts-ui` by importing and export like the following example:
```javascript
// package.js
Package.describe({
name: 'author:accounts-bootstrap',
version: '1.0.0',
summary: 'Bootstrap – Accounts UI for React in Meteor 1.3',
git: 'https://github.com/author/accounts-bootstrap',
documentation: 'README.md'
});
Package.onUse(function(api) {
api.versionsFrom('1.3');
api.use('ecmascript');
api.use('std:accounts-ui');
api.imply('session');
api.mainModule('main.jsx');
});
```
```javascript
// package.json
{
"name": "accounts-bootstrap",
"description": "Bootstrap – Accounts UI for React in Meteor 1.3",
"repository": {
"type": "git",
"url": "https://github.com/author/accounts-bootstrap.git"
},
"keywords": [
"react",
"meteor",
"accounts",
"tracker"
],
"author": "author",
"license": "MIT",
"bugs": {
"url": "https://github.com/author/accounts-bootstrap/issues"
},
"homepage": "https://github.com/author/accounts-bootstrap",
"dependencies": {
"react": "^15.x",
"react-dom": "^15.x",
"tracker-component": "^1.3.13"
}
}
```
To install the dependencies added in your package.json run:
`npm i`
```javascript
// main.jsx
import React from 'react';
import PropTypes from 'prop-types';
import { Accounts, STATES } from 'meteor/std:accounts-ui';
/**
* Form.propTypes = {
* fields: PropTypes.object.isRequired,
* buttons: PropTypes.object.isRequired,
* error: PropTypes.string,
* ready: PropTypes.bool
* };
*/
class Form extends Accounts.ui.Form {
render() {
const { fields, buttons, error, message, ready = true} = this.props;
return (
evt.preventDefault() } className="accounts-ui">
);
}
}
class Buttons extends Accounts.ui.Buttons {}
class Button extends Accounts.ui.Button {}
class Fields extends Accounts.ui.Fields {}
class Field extends Accounts.ui.Field {}
class FormMessage extends Accounts.ui.FormMessage {}
// Notice! Accounts.ui.LoginForm manages all state logic
// at the moment, so avoid overwriting this one, but have
// a look at it and learn how it works. And pull
// requests altering how that works are welcome.
// Alter provided default unstyled UI.
Accounts.ui.Form = Form;
Accounts.ui.Buttons = Buttons;
Accounts.ui.Button = Button;
Accounts.ui.Fields = Fields;
Accounts.ui.Field = Field;
Accounts.ui.FormMessage = FormMessage;
// Export the themed version.
export { Accounts, STATES };
export default Accounts;
```
### Available components
* Accounts.ui.LoginForm
* Accounts.ui.Form
* Accounts.ui.Fields
* Accounts.ui.Field
* Accounts.ui.Buttons
* Accounts.ui.Button
* Accounts.ui.FormMessage
* Accounts.ui.PasswordOrService
* Accounts.ui.SocialButtons
## Extra fields
> Example provided by [@radzom](https://github.com/radzom).
```javascript
import { Accounts, STATES } from 'meteor/std:accounts-ui';
class NewLogin extends Accounts.ui.LoginForm {
fields() {
const { formState } = this.state;
if (formState == STATES.SIGN_UP) {
return {
firstname: {
id: 'firstname',
hint: 'Enter firstname',
label: 'firstname',
onChange: this.handleChange.bind(this, 'firstname')
},
...super.fields()
};
}
return super.fields();
}
translate(text) {
// Here you specify your own translation function, e.g.
return this.props.t(text);
}
signUp(options = {}) {
const { firstname = null } = this.state;
if (firstname !== null) {
options.profile = Object.assign(options.profile || {}, {
firstname: firstname
});
}
super.signUp(options);
}
}
```
And on the server you can store the extra fields like this:
```javascript
import { Accounts } from 'meteor/accounts-base';
Accounts.onCreateUser(function (options, user) {
user.profile = options.profile || {};
user.roles = {};
return user;
});
```
## Deprecations
### v1.2.11
* The use of FormMessage in Form has been deprecated in favor of using
FormMessages that handles multiple messages and errors.
See example: [Form.jsx#L43](imports/ui/components/Form.jsx#L43)
* Implementations of Accounts.ui.Field must render a message.
See example: [Field.jsx#L](imports/ui/components/Field.jsx#L64-L67)
## Credits
Made by the [creative folks at Studio Interact](http://studiointeract.com) and
[all the wonderful people using and improving this package](https://github.com/studiointeract/accounts-ui/graphs/contributors).