npm package: @justeat/f-image-tile
Description: Fozzie Image Tile - An interactive tile component containing an image, text and link.
Latest version: 1.5.0

<div align="center">

# f-image-tile

<img width="125" alt="Fozzie Bear" src="../../../../bear.png" />

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


</div>

---

[![npm version](https://badge.fury.io/js/%40justeat%2Ff-image-tile.svg)](https://badge.fury.io/js/%40justeat%2Ff-image-tile)
[![CircleCI](https://circleci.com/gh/justeat/fozzie-components.svg?style=svg)](https://circleci.com/gh/justeat/workflows/fozzie-components)
[![Coverage Status](https://coveralls.io/repos/github/justeat/f-image-tile/badge.svg)](https://coveralls.io/github/justeat/f-image-tile)
[![Known Vulnerabilities](https://snyk.io/test/github/justeat/f-image-tile/badge.svg?targetFile=package.json)](https://snyk.io/test/github/justeat/f-image-tile?targetFile=package.json)

---

## Usage

### Installation

Install the module using npm or Yarn:

```sh
yarn add @justeat/f-image-tile
```

```sh
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):

```js
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`:

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

```sh
$ git clone git@github.com:justeat/fozzie-components.git
$ cd fozzie-components
$ yarn
```

Change directory to the `f-image-tile` package:

```sh
$ 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

```sh
yarn test
```

### Component and Accessibility Tests

```bash
# 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
```