Install the module using npm or Yarn:
yarn add @justeat/f-filter-pill
npm install @justeat/f-filter-pill
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')
}
}
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 |
---|
The events that can be subscribed to are as follows (if any):
Event | Description |
---|
Start by cloning the repository and installing the required dependencies:
$ git clone git@github.com:justeat/fozzie-components.git
$ cd fozzie-components
$ yarn
Change directory to the f-filter-pill
package:
$ cd packages/components/atoms/f-filter-pill
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.
yarn test
# 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