Skip to content

Getting Started

Vinicius Reif Biavatti edited this page Feb 21, 2022 · 4 revisions

NPM

To install TuiCss package into your project you can use the following command:

$ npm install tuicss

Download

If you are not using NPM, you can just download the repository content to your project.

Import

To use the library in your web application, you need just to import the files into your html pages with the html importation directives. The files are localizated in dist folder, and this folder has this structure:

dist  
  \- fonts
  \- images
  \- tuicss.css  
  \- tuicss.js  
  \- tuicss.min.css  
  \- tuicss.min.js  

If you downloaded the TuiCss, you just need the content of this folder. Put this folder in you application structure, and after this, choose the file to import (source or minified). This is an example of importation code:

<link rel="stylesheet" href="dist/tuicss.min.css"/>
<script src="dist/tuicss.min.js"></script>

Notes

The fonts folder needs to be in the same directory of imported css file. It is necessary if the main font was changed to "DOS" font in the variables.scss file. Check Custom Theme page for more details.

The images folder needs to be in the same directory of imported css file too, because some classes are targeting the images of this folder. If this folder was not in the correct place, this classes will be crashed and not works fine.

Clone this wiki locally