1.5.0 • Published 1 year ago

@justeat/f-image-tile v1.5.0

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
1 year ago

f-image-tile

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


npm version CircleCI Coverage Status Known Vulnerabilities


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

PropTypeDefaultDescription
hrefStringnullThe link URL
tileIdStringnullThe id of the tile
isSelectedBooleanfalseMarks the tile as selected
isLinkBooleanfalseComponent acts as a link, rather than default toggle
displayTextStringnullComponent display text
imgSrcString''Component image link
altTextString''Component image alt text
fallbackImageString''Component fallback image url

Events

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

EventDescription
toggleFilterFired when a tile is interacted with, toggles between selected and not selected
handleImgErrorFired there is an error with the component image

Development

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

1 year ago

1.4.0

2 years ago

1.3.1

3 years ago

1.3.0

3 years ago

1.2.0

3 years ago

1.1.0

3 years ago

1.0.1

3 years ago

1.0.0

3 years ago

0.14.0

3 years ago

0.13.1

3 years ago

0.12.0

3 years ago

0.13.0

3 years ago

0.11.1

3 years ago

0.11.0

3 years ago

0.10.1

3 years ago

0.10.2

3 years ago

0.10.3

3 years ago

0.10.0

3 years ago

0.3.0

3 years ago

0.9.0

3 years ago

0.8.0

3 years ago

0.9.2

3 years ago

0.9.1

3 years ago

0.5.0

3 years ago

0.4.0

3 years ago

0.7.0

3 years ago

0.6.0

3 years ago

0.5.1

3 years ago

0.2.0

4 years ago

0.1.0

4 years ago