@justeat/f-self-exclusion
v1.4.0
Published
Fozzie Self Exclusion - Customers must be able to voluntarily self-exclude or nominate themselves for self exclusion for a specified time period or permanently (includes purchasing and marketing), and their account (associated to the email address or phon
Downloads
33
Maintainers
Keywords
Readme
f-self-exclusion
Customers must be able to voluntarily self-exclude or nominate themselves for self exclusion for a specified time period or permanently (includes purchasing and marketing), and their account (associated to the email address or phone number provided during self exclusions) must be blocked from purchasing alcohol and other items.
Usage
Installation
Install the module using npm or Yarn:
yarn add @justeat/f-self-exclusion
npm install @justeat/f-self-exclusion
Vue Applications
You can import it in your Vue SFC like this (please note that styles have to be imported separately):
import SelfExclusion from '@justeat/f-self-exclusion';
import '@justeat/f-self-exclusion/dist/f-self-exclusion.css';
export default {
components: {
SelfExclusion
}
}
If you are using Webpack, you can import the component dynamically to separate the self-exclusion
bundle from the main bundle.client.js
:
import '@justeat/f-self-exclusion/dist/f-self-exclusion.css';
export default {
components: {
// …
SelfExclusion: () => import(/* webpackChunkName: "self-exclusion" */ '@justeat/f-self-exclusion')
}
}
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 | Default | Description | |-------------------------|---------|---------|-------------------------------------------------------------------------------| | locale | String | en-AU | ----------- | | authToken | String | ------- | the users authorisation token | | smartGatewayBaseUrl | String | ------- | the smartgateway host | | showUnsavedChangesAlert | Boolean | false | property that controls showing of an alert when user navigates away from page | | privacyPolicyUrl | String | null | url to privacy policy page |
Events
The events that can be subscribed to are as follows (if any):
| Event | Description | | ----- | ----------- |
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-self-exclusion
package:
$ cd packages/components/pages/f-self-exclusion
Testing
To test all components, run from root directory.
To test only f-self-exclusion
, run from the ./fozzie-components/packages/components/pages/f-self-exclusion
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