README

Gaudiamus CSS

CSS framework builder using SCSS

Also see our online guide & playground

CSS grid
utility based
more than customizable: build your own solution

What is Gaudiamus?

Gaudiamus is a utility generator to jump-start your custom CSS ambitions. While you can use it out of the box as a CSS-framework, the power lies in the ability to roll your own solution.

Quick Start

See gaudiamus-starter for the easiest start.

Installation

The recommended way of using Gaudiamus is downloading it via the npm repository:

npm i gaudiamus-css or yarn add gaudiamus-css

It's also possible to do it from a CDN. However, this way does not provide all the Gaudiamus benefits neither enable its "build-your-own" CSS behavior/framework goal.

jsDelivr https://cdn.jsdelivr.net/npm/gaudiamus-css@latest/css/gaudiamus.min.css

unpkg https://unpkg.com/gaudiamus-css@latest/css/gaudiamus.min.css

Basic usage

/* main.scss */
$primaryColor: #16ca24;

@import "../node_modules/gaudiamus-css/scss";

Make it yours - all variables:

/* main.scss */

/* Grid */
$grid-container-prefix: 'grid';
$columns: 12;
$items: 6;
$breakpoint-map: ("md":768px,"lg":1024px);
$placement-key: "place";
$placement-map: ("x":"justify-self", "y":"align-self");
$placement-properties:("start":"start","end":"end","center":"center","stretch":"stretch");


/* Spacing & utility generator */
$baseSpacing: 20px;
$spacingUnit: 'rem';
$spacingStep: .25;
$numSpacingUnits: 5;


$shorthand-map: ("t":"top","b":"bottom","r":"right","l":"left","x":(1:"left",2:"right"),"y":(1:"top",2:"bottom"));
$property-map: ("m":"margin","p":"padding");
$position-key:"position";
$position-map:("relative","absolute","fixed");

$height-width-unit-map:("p":"%");
$height-width-value-map:("25", "50", "75", "100");


/* Colors */
$primaryColor: #258cc7;
$accentColor: #21d593;
$successColor: #1f921f;
$warningColor: #c92d2d;
$gray: rgba(0,0,0,.2);
$white: #e8e5e5;
$black: #101010;

$color-class-map:("bg":"background-color","text":"color","b":"border-color");

$color-map:(
        "primary":$primaryColor,
        "accent":$accentColor,
        "success":$successColor,
        "warning":$warningColor,
        "transparent":transparent,
        "gray": $gray,
        "white": $white,
        "black": $black
);

/*
*  lighten/darken
*/

$lighten-map:(
        "light": 25%,
        "lighter": 50%,

);

$darken-map:(
        "dark": 25%,
        "darker": 50%,
);

/*
* Opacity
*/
$opacity-map: ("50":.5,"75":.75,"85":.85,"90":.9,"95":.95);

/*
* State
*/

$state-map:("focus","hover","active");




/* Shading & borders */

$depth: 3;
$spread: 4px;

$border-key: "b";
$rounded-key: "rounded";
$raise-key: "raise";

$cursor-key: "cursor";
$cursor-map:("pointer":"pointer");



//@import "components/form";

/* Typography */

$fontSize-map:(
        "sm":3,
        "default":4,
        "md":5,
        "lg":7,
        "xl":9,
        "xxl":12
);
$decoration-map:("underline","none");
$weight-map:("light":200,"strong":700);

$display-key: "d";
$display-map: ("hidden":"none", "flex":"flex", "block":"block");
$flex-key: "f";
$flex-map: ("1":"1");

@import "../node_modules/gaudiamus-css/scss";

Usage no npm install needed!