@vtmn/css
v3.0.2
Decathlon Design System - Vitamin global CSS styles library
0/weekUpdated 1 years agoApache-2.0Unpacked: 38.0 MB
Published by ossdecathlon
npm install @vtmn/css@vtmn/css
> Decathlon Design System - Vitamin Vitamin global CSS styles library
Install package
After installing npm or yarn, you can install @vtmn/css with this command:
``shwith npm
npm i -S @vtmn/css
with yarn
yarn add @vtmn/css
`
Or you can also install it with a CDN like
:`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-condensedwith 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
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
package.`sh
with npm
npm i -S @vtmn/iconswith 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
with this file.Usage
Once you have installed this package, you just have to import CSS styles!
With a bundler that supports CSS imports in JS files:
`javascript
import '@vtmn/css/dist/index.css';
`Otherwise include it in your HTML file:
html
`Development
All this package is generated with Tailwind CSS, a utility-first CSS framework that can be composed to build any design, directly in your markup.
Be careful, in order to use our library, you will have to prefix all CSS utility classes with
.To know all the use cases and their associated code, check out the showcase here.
For example:
`html
>
Hello
World!
🎉
`
For more details about CSS utility classes from this package, see Tailwind CSS documentation here.
Tailwind preset
Are you already using Tailwind CSS in your project? Do you want to take full advantage of all its features like functions & directives by building your own classes via
for example? Good news, we invit you to have a look at our package @vtmn/css-tailwind-preset which will explain you how to use Vitamin styles in a Tailwind CSS project.Optimizing for production
To make the development experience as productive as possible, Tailwind generates thousands of utility classes for you, most of which you probably won't actually use.
When building for production, you should always use PurgeCSS to tree-shake unused styles and optimize your final build size.
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.Playground
If you want to test Vitamin Tailwind CSS utility classes, see our live playground 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
License
Apache-2.0 © Decathlon