f-account-info

The account information page

Usage

Installation

Install the module using npm or Yarn:

yarn add @justeat/f-account-info

npm install @justeat/f-account-info

Vue Applications

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

import AccountInfo from '@justeat/f-account-info';
import '@justeat/f-account-info/dist/f-account-info.css';

export default {
    components: {
        AccountInfo
    }
}

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

import '@justeat/f-account-info/dist/f-account-info.css';

export default {
    components: {
        // …
        AccountInfo: () => import(/* webpackChunkName: "account-info" */ '@justeat/f-account-info')
    }
}

Configuration

Props

There may be props that allow you to customise its functionality.

The props that can be defined are as follows (if any):

| Prop | Type | Required | Description | | ----- | ----- | ------- | ----------- | | authToken | string | false | the users authorisation token | | isAuthFinished | boolean | true | a flag indicating if the authorisation process has completed | | smartGatewayBaseUrl | string | true | the smartgateway host | | loginPath | string | false | the redirect path if the GET fails with a 403, if not supplied then will not redirect |

Development

Start by cloning the repository and installing the required dependencies:

$ git clone [email protected]:justeat/fozzie-components.git
$ cd fozzie-components
$ yarn

Change directory to the f-account-info package:

$ cd packages/components/pages/f-account-info

Testing

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

Unit and Integration tests

yarn test

Component and Accessibility Tests

# Note: Ensure Storybook is running when running the following commands
cd ./fozzie-components

yarn storybook:build
yarn storybook:serve-static
yarn test-component:chrome

Accessibility tests

yarn test-a11y:chrome

Documentation to be completed once module is in stable state.