1
0
mirror of https://github.com/Chalarangelo/mini.css.git synced 2025-08-01 19:40:35 +02:00
6
Documentation
Angelos Chalaris edited this page 2016-10-07 16:16:42 +03:00

Note: This page is for developers interested in developing their own flavors, using the tools provided in the Sass(SCSS) files. If you are looking for documentation on how to use the framework, head over to the demo pages.

Getting started

To develop your own flavor, you can grab the default flavor file and build your own flavor any way you want. If you want to add more styles via mixins or enable specific components, check out the list of modules below to find what you are looking for and add it to your flavor.

Module list

Below is a complete list of modules with descriptions, approximate sizes (gzipped and based on the default flavor with all styles) and links to their respective Sass files as well as wiki pages.

Core modules:

Module Contents Links Size
Base normalize.css & basic typography code / wiki 1200 bytes
Button button styles code / wiki 430 bytes
Form form styles code / wiki 520 bytes
Grid grid system code / wiki 450 bytes
Nav navigation bar and components code / wiki 530 bytes
Table table styles code / wiki 250 bytes
Utility utility and helper classes code / wiki 480 bytes

Extra modules:

Module Contents Links Size
Label label and badge styles code / wiki 210 bytes
Tab tabbed navigation code / wiki 350 bytes
Modal modal dialog prompts code / wiki 310 bytes
Dropdown dropdown menu for navigation bar code / wiki 160 bytes
Collapse collapse and accordion components code / wiki 290 bytes
Progress progress bar styles code / wiki 200 bytes
Spinner spinner styles code / wiki 320 bytes
Carousel image slideshow component code / wiki 390 bytes
Utility utility and experimental classes code / wiki 920 bytes

Tweaking existing mixins

A few styles are pre-defined in some mixins. If you would like to tweak those, you can directly edit the Sass file that contains the mixins and change whatever you would like.

Developing new components

Anyone can develop new components for the framework. If you develop something you think is worthwhile, please share it with the community. Help mini.css grow!