@vtmn/css-list

> Decathlon Design System - Vitamin specific CSS styles for list component

Install package

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

``sh


with npm

npm i -S @vtmn/css-list

with yarn

yarn add @vtmn/css-list
`

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

`html

`

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

Install icons (optional)

If you need to display icons, you will need to install @vtmn/icons package.

`sh


with npm

npm i -S @vtmn/icons

with yarn

yarn add @vtmn/icons
`

Then follow instructions in README of @vtmn/icons :

`javascript
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!

$3

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:

`javascript
import '@vtmn/css-list/dist/index.css';
`

Otherwise include it in your HTML file:

`html

`

$3

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:

`sh


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:

`html

`

With a bundler that supports CSS imports in JS files:

`javascript
import '@vtmn/css-design-tokens/dist/index.css';
import '@vtmn/css-list/dist/index-with-vars.css';
`

Otherwise include it in your HTML file:

`html
rel="stylesheet"
href="./node_modules/@vtmn/css-design-tokens/dist/index.css"
/>
rel="stylesheet"
href="./node_modules/@vtmn/css-list/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