@justeat/f-registration

f-registration

Registration Component.

---

---

Usage

Installation

Install the module using npm or Yarn:

yarn add @justeat/f-registration

npm install @justeat/f-registration

Vue Applications

You can import it in your Vue SFC like this (please note that styles have to be imported separately):

import RegistrationComponent from '@justeat/f-registration';
import '@justeat/f-registration/dist/f-registration.css';

export default {
    components: {
        RegistrationComponent
    }
}

If you are using Webpack, you can import the component dynamically to separate the f-registration bundle from the main bundle.client.js:

import '@justeat/f-registration/dist/f-registration.css';

export default {
    components: {
        // …
        RegistrationComponent: () => import(/* webpackChunkName: "vue-registration" */ '@justeat/f-registration')
    }
}

CSS styles

The component is using utility css styles from fozzie package. You need to make sure to @include trumps-utilities(); mixin to your application styles if you use beta version of fozzie package (>= v5.0.0-beta.0). If you are using main version (v4.X.X) styles should come out of the box.

Configuration

Props

Prop	Type	Default	Description
local	String	en-gb	Sets the translation file to use.
createAccountUrl	String	Required	URL to register a new user account.
createAccountTimeout	Number	1000	Timeout when submitting the registration form.
showLoginLink	Boolean	Required	If true, 'Already on Just Eat` login link will be displayed.
loginUrl	String	Required	URL to forward the user to on navigation to the login page.

Events

Event	Description
registration-create-account-success	Registration form has been successfully submitted.
registration-create-account-failure	Registration form submission has failed.
registration-create-account-start	User has begun interacting with registration form.
registration-create-account-inline-error	Validation on form fields has failed.
registration-visit-login-page	User clicked 'Already on Just Eat` login link.
registration-login-blocked	'FailedUserAuthentication' error has been returned when submitting the registration form.

Development

Start by cloning the repository and installing the required dependencies:

$ git clone [e-mail]:justeat/fozzie-components.git
$ cd fozzie-components
$ yarn

Change directory to the f-registration package:

$ cd packages/components/molecules/f-registration

Testing

Unit, Integration and Contract

To test all components, run from root directory. To test only f-registration, run from the ./fozzie-components/packages/f-registration directory.

yarn test

Running storybook

Storybook can be used to develop new and existing components.

To start storybook:

From the root directory run:

$ yarn storybook:serve

This will build and serve storybook at http://localhost:6006.