@vtmn/css-tag

@vtmn/css-tag

Decathlon Design System - Vitamin specific CSS styles for tag component

Install package

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

# with npm
npm i -S @vtmn/css-tag

# with yarn
yarn add @vtmn/css-tag

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

<link rel="stylesheet" href="https://unpkg.com/@vtmn/css-tag" />

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 display icons, you will need to install @vtmn/icons package.

# with npm
npm i -S @vtmn/icons

# with yarn
yarn add @vtmn/icons

Then follow instructions in README of @vtmn/icons :

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 import CSS styles!

Without theming

If you don't need different themes, you can choose the specific CSS package without CSS variables.

With a bundler that supports CSS imports in JS files:

import '@vtmn/css-tag/dist/index.css';

Otherwise include it in your HTML file:

<link rel="stylesheet" href="./node_modules/@vtmn/css-tag/dist/index.css" />

With theming

If you need different themes, you can choose the specific CSS package with CSS variables. For this, be sure to install & import @vtmn/css-design-tokens before:

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

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

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

<link rel="stylesheet" href="https://unpkg.com/@vtmn/css-design-tokens" />

With a bundler that supports CSS imports in JS files:

import '@vtmn/css-design-tokens/dist/index.css';
import '@vtmn/css-tag/dist/index-with-vars.css';

Otherwise include it in your HTML file:

<link
  rel="stylesheet"
  href="./node_modules/@vtmn/css-design-tokens/dist/index.css"
/>
<link
  rel="stylesheet"
  href="./node_modules/@vtmn/css-tag/dist/index-with-vars.css"
/>

Development

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

Documentation

For more information about how this component is designed and how to use it in your application, check out the decathlon.design docs

Base 10 support

If your project uses the mathematical trick of basing the value of 1rem equals 10px, there is also an index-base10 output within the dist folder of this package.

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