f-popover

Renders recieved content as a popover.

Please note that this component is only a wrapper with the base styles for the popover. Styles for hidden and active state, for popover width etc should be defined in a consuming app/component.

Usage

Installation

Install the module using npm or Yarn:

yarn add @justeat/f-popover

npm install @justeat/f-popover

Vue Applications

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

import VPopover from '@justeat/f-popover';
import '@justeat/f-popover/dist/f-popover.css';

export default {
    components: {
        VPopover
    }
}

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

import '@justeat/f-popover/dist/f-popover.css';

export default {
    components: {
        // …
        VPopover: () => import(/* webpackChunkName: "v-popover" */ '@justeat/f-popover')
    }
}

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 f-popover package:

$ cd packages/components/atoms/f-popover

Testing

Unit, Integration and Contract

To test all components, run from root directory. To test only f-popover, run from the ./fozzie-components/packages/components/atoms/f-popover 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-popover
# Note: Ensure Storybook is not running when running the following commands
cd ./fozzie-components/packages/components/atoms/f-popover
yarn test-component:chrome

Documentation to be completed once module is in stable state.