Usage

Installation

Add the module to your project

yarn add @justeat/f-vue-icons

Vue Applications

// Only import what you need!
import { AlertIcon, PaymentAmexIcon, ... } from '@justeat/f-vue-icons'

Within the context of a Vue app, that will look like:

<template>
    <alert-icon />
    <payment-amex-icon />
</template>


<script>
import { AlertIcon, PaymentAmexIcon, ... } from '@justeat/f-vue-icons';

export default {
    components: {
        AlertIcon,
        PaymentAmexIcon
    }
};
</script>

Tree shaking

By using ES imports like import { AlertIcon } from '@justeat/f-vue-icons' with Webpack v4 or Rollup, unused exports in this module will be automatically eliminated.

If you can't use a tree-shaking compatible build tool, then you can use the per-file icons from icons directory, e.g. import AlertIcon from '@justeat/f-vue-icons/icons/AlertIcon'.

Browser Support

The component extends @justeat/browserslist-config-fozzie package for the list of browsers to support.

Contributing

Before staring please read our contributing guide

Adding new icons

This package uses our @justeat/f-icons svg library and compiles component files on build.

To build new icon components you need to add new svgs to @justeat/f-icons, publish the package, than bump the f-icons version here and build the module.

Building the Module

Run yarn build to compile the module.

Running the Tests

Run yarn test to run the tests.

Icon list

You can check the list of all the icons in our Storybook.

Credits

This package was heavily inspired by the excellent vue-feather-icons package.