@justeat/f-image-tile

f-image-tile

An interactive tile component containing an image, text and link.

---

---

Usage

Installation

Install the module using npm or Yarn:

yarn add @justeat/f-image-tile

npm install @justeat/f-image-tile

Vue Applications

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

import ImageTile from '@justeat/f-image-tile';
import '@justeat/f-image-tile/dist/f-image-tile.css';

export default {
    components: {
        ImageTile
    }
}

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

import '@justeat/f-image-tile/dist/f-image-tile.css';

export default {
    components: {
        // …
        ImageTile: () => import(/* webpackChunkName: "image-tile" */ '@justeat/f-image-tile')
    }
}

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
href	String	null	The link URL
tileId	String	null	The id of the tile
isSelected	Boolean	false	Marks the tile as selected
isLink	Boolean	false	Component acts as a link, rather than default toggle
displayText	String	null	Component display text
imgSrc	String	''	Component image link
altText	String	''	Component image alt text
fallbackImage	String	''	Component fallback image url

Events

The events that can be subscribed to are as follows (if any):

Event	Description
toggleFilter	Fired when a tile is interacted with, toggles between selected and not selected
handleImgError	Fired there is an error with the component image

Development

Start by cloning the repository and installing the required dependencies:

$ git clone [e-mail]:justeat/fozzie-components.git
$ cd fozzie-components
$ yarn

Change directory to the f-image-tile package:

$ cd packages/components/atoms/f-image-tile

Testing

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