@vtmn/react

> Decathlon Design System - Vitamin React components library

Install package

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

``sh


with npm

npm i -S @vtmn/react

with yarn

yarn add @vtmn/react
`

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.

You can install them with FontSource:

`sh


with npm

npm i -S @fontsource/roboto @fontsource/roboto-condensed

with yarn

yarn add @fontsource/roboto @fontsource/roboto-condensed
`

Then, within your app entry file or site component, import it in:

`javascript
import '@fontsource/roboto'; // Defaults to weight 400
import '@fontsource/roboto/400.css'; // Specify weight
import '@fontsource/roboto/400-italic.css'; // Specify weight and style
`

In order to enhance performance of your app, please read about font subsetting. FontSource explains it here.

Otherwise, you can also load them through CDN:

`html
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"
/>
`

Finally, you can also import them via CSS import:

`css
@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');
`

Usage

$3

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

Here is an example of the integration of VtmnButton component:

`javascript
import { VtmnButton } from '@vtmn/react';

const MyComponent = () => (
console.log('clicked')}>Click
);
`

If you need to display icons, you will need to import @vtmn/icons icon font like this:

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

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

$3

This library is made to give you a standard. However, it is quite possible to modify components by passing them new props & styles.

To do this, there are a multitude of solutions.

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.

I have an issue, what should I do?

Please file the issue here.

Contributing

See the contributing docs.

License

Apache-2.0 © Decathlon