f-contact-preferences

Fozzie user contact preferences form component

Usage

Installation

Install the module using npm or Yarn:

yarn add @justeat/f-contact-preferences

npm install @justeat/f-contact-preferences

Vue Applications

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

import ContactPreferences from '@justeat/f-contact-preferences';
import '@justeat/f-contact-preferences/dist/f-contact-preferences.css';

export default {
    components: {
        ContactPreferences
    }
}

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

import '@justeat/f-contact-preferences/dist/f-contact-preferences.css';

export default {
    components: {
        // …
        ContactPreferences: () => import(/* webpackChunkName: "contact-preferences" */ '@justeat/f-contact-preferences')
    }
}

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 |

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-contact-preferences package:

$ cd packages/components/organisms/f-contact-preferences

Testing

To test all components, run from root directory. To test only f-contact-preferences, run from the ./fozzie-components/packages/components/organisms/f-contact-preferences 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
```bash
yarn test-a11y:chrome