f-filter-pill

Fozzie Filter Pill - An interactive component for filter toggles.

Usage

Installation

Install the module using npm or Yarn:

yarn add @justeat/f-filter-pill

npm install @justeat/f-filter-pill

Vue Applications

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

import FilterPill from '@justeat/f-filter-pill';
import '@justeat/f-filter-pill/dist/f-filter-pill.css';

export default {
    components: {
        FilterPill
    }
}

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

import '@justeat/f-filter-pill/dist/f-filter-pill.css';

export default {
    components: {
        // …
        FilterPill: () => import(/* webpackChunkName: "filter-pill" */ '@justeat/f-filter-pill')
    }
}

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-filter-pill package:

$ cd packages/components/atoms/f-filter-pill

Testing

To test all components, run from root directory. To test only f-filter-pill, run from the ./fozzie-components/packages/components/atoms/f-filter-pill 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

Documentation to be completed once module is in stable state.