f-media-element

provides ability to display text and an image in different orientations

Usage

Installation

Install the module using npm or Yarn:

yarn add @justeat/f-media-element

npm install @justeat/f-media-element

Vue Applications

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

import MediaElement from '@justeat/f-media-element';
import '@justeat/f-media-element/dist/f-media-element.css';

export default {
    components: {
        MediaElement
    }
}

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

import '@justeat/f-media-element/dist/f-media-element.css';

export default {
    components: {
        // …
        MediaElement: () => import(/* webpackChunkName: "media-element" */ '@justeat/f-media-element')
    }
}

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 MediaElement package:

$ cd packages/components//MediaElement

Testing

Unit, Integration and Contract

To test all components, run from root directory. To test only f-media-element, run from the ./fozzie-components/packages/f-media-element directory.

yarn test

Component Tests

# Run Component tests for all components
# Note: Ensure Storybook is not running when running the following commands
cd ./fozzie-components

yarn storybook:build
yarn storybook:serve-static
yarn test-component:chrome

OR

# Run Component tests for f-media-element
# Note: Ensure Storybook is not running when running the following commands
cd ./fozzie-components/packages/f-media-element
yarn test-component:chrome

Documentation to be completed once module is in stable state.