@vtmn/web-components

Decathlon Design System - Vitamin Web Components library

Install package

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

# with npm
npm i -S @vtmn/css-design-tokens @vtmn/web-components

# with yarn
yarn add @vtmn/css-design-tokens @vtmn/web-components

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 Web 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 React 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 just have to define custom elements in your entry point:

In a HTML file:

<link
  rel="stylesheet"
  href="./node_modules/@vtmn/css-design-tokens/dist/index.css"
/>
<script type="module">
  import { defineCustomElements } from './node_modules/@vtmn/web-components/dist/esm/loader.js';
  defineCustomElements();
</script>

Or you can also install it with a CDN like unpkg.com:

<link
  rel="stylesheet"
  href="https://unpkg.com/@vtmn/css-design-tokens/dist/index.css"
/>
<script type="module">
  import { defineCustomElements } from 'https://unpkg.com/@vtmn/web-components/dist/esm/loader.js';
  defineCustomElements();
</script>

Or, in a JavaScript file:

import '@vtmn/css-design-tokens/dist/index.css';
import { defineCustomElements } from '@vtmn/web-components/dist/esm/loader.js';
defineCustomElements();

Then, use a Vitamin Custom Element directly in your HTML. For example:

<vtmn-button onclick="console.log('clicked')">Click</vtmn-button>

Development

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

For more details about Custom Elements from Web Components specification, see the MDN documentation 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