README

`@vtmn/vue`

Decathlon Design System - Vitamin Vue components library

Install package

After installing npm or yarn, you can install @vtmn/vue with this command:

# with npm
npm i -S @vtmn/vue

# with yarn
yarn add @vtmn/vue

Install fonts

Roboto & Roboto Condensed fonts as described in Typography section will not be automatically loaded. Fortunately, there is a few easy ways to get started.

Shown below is a sample link markup used to load from a CDN:

<link
  rel="stylesheet"
  href="https://fonts.googleapis.com/css2?family=Roboto:wght@400;700&family=Roboto+Condensed:ital,wght@0,400;0,700;1,700&display=swap"
/>

You can also do it via CSS Import:

@import url('https://fonts.googleapis.com/css2?family=Roboto:wght@400;700&family=Roboto+Condensed:ital,wght@0,400;0,700;1,700&display=swap');

Otherwise, you can install them with typeface:

# with npm
npm i -S typeface-roboto typeface-roboto-condensed

# with yarn
yarn add typeface-roboto typeface-roboto-condensed

Then, you can import them in your entry-point:

import 'typeface-roboto';
import 'typeface-roboto-condensed';

Install icons (optional)

If you need to use Vue components with icons displayed (via props for icons in some components), you will need to install @vtmn/icons package.

# with npm
npm i -S @vtmn/icons
# with yarn
yarn add @vtmn/icons

Then, import the icon font in the entry point of your Vue application:

import '@vtmn/icons/dist/vitamix/font/vitamix.css';

Or you can also import it with a CDN like unpkg.com with this file.

Usage

Once you have installed this package, you first need to import CSS styles.

With a bundler that supports CSS imports in JS files:

import '@vtmn/vue/dist/style.css';

Otherwise include it in your HTML file:

<link rel="stylesheet" href="./node_modules/@vtmn/vue/dist/style.css" />

Once you have installed this package, you just have to import components you need in your Vue application!

Here is an example of the integration of VtmnButton component:

<template>
  <VtmnButton>Click</VtmnButton>
</template>

<script>
import { VtmnButton } from '@vtmn/vue';

export default {
  name: 'App',
  components: {
    VtmnButton,
  },
};
</script>

Development

To know all the use cases and their associated code, check out the showcase here.

Changelog

If you want to know the different changes between versions of this package, look at the changelog here.

@vtmn/vue

Usage no npm install needed!