f-status-banner

Global status page

Usage

Installation

Install the module using npm or Yarn:

yarn add @justeat/f-status-banner

npm install @justeat/f-status-banner

Vue Applications

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

import StatusBanner from '@justeat/f-status-banner';
import '@justeat/f-status-banner/dist/f-status-banner.css';

export default {
    components: {
        StatusBanner
    }
}

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

import '@justeat/f-status-banner/dist/f-status-banner.css';

export default {
    components: {
        // …
        StatusBanner: () => import(/* webpackChunkName: "status-banner" */ '@justeat/f-status-banner')
    }
}

The package also has dependencies that need to be installed by consuming components/applications:

| Dependency | Command to install | Styles to include | | ----- | ----- | ----- | | f-searchbox | yarn add @justeat/f-searchbox | import '@justeat/f-searchbox/dist/f-searchbox.css'; |

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 | | ----- | ----- | ------- | ----------- |

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-status-banner package:

$ cd packages/components/organisms/f-status-banner

Testing

Unit, Integration and Contract

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

yarn test

Component Tests

# Run Component tests for all components
# Note: Ensure Storybook is not running when running the following commands
cd ./fozzie-components

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

OR

# Run Component tests for f-status-banner
# Note: Ensure Storybook is not running when running the following commands
cd ./fozzie-components/packages/components/organisms/f-status-banner
yarn test-component:chrome

Documentation to be completed once module is in stable state.