/jessie

Library for easier HTML elements composition

Primary LanguageSCSSISC LicenseISC

Jessie

This is a project for adding special syntax into Sass to define various dimensions based on the unit value.

Description

The unit is responsive value that express a width of a column in a grid with 64 (default) columns. The grid have 100vw width.

Firstly, you should call the init mixin that will define the global unit value. It has four optional parameters (all with default values):

@mixin init(
	$grid-columns: 64,
	$grid-width: 100vw,
	$min-unit-value: 10px,
	$max-unit-value: 25px
) {
	// ...
}

That mixin should be invoked once only in global scope.

@use "@halo-lab/jessie";

@include jessie.init();

Also, in JavaScript you should invoke calculateScrollbarWidth function. It is needed to rectify a value of 1vw for systems where sidebar takes some place in browser's window and 100vw makes a page expand under sidebar (Windows).

import { calculateScrollbarWidth } from "@halo-lab/jessie";

calculateScrollbarWidth();

Syntax

It is simple:

  • there is a dimensions block that can be either a count of the units or range in format from <number>|start (inclusive) to <number>|end (exclusive). You can omit either from part or end but not both.

The resulting value includes start column but it does not include end column.

  • former is followed by a borders block that can have either a minimum or a maximun value, or both with any CSS unit (px, em, % and so on.): [min <number>] [max <number>].

Definition of the dimension must be written inside a value function.

@use "@halo-lab/jessie";

body {
	width: jessie.value(8);
	// or
	width: jessie.value(from 1 to 9);
	// or
	width: jessie.value(to 9);
	// or if you want to add some constraints
	width: jessie.value(from 1 to 9 min 40px max 120px);
}

Word from author

Have fun! ✌️

Supported by Halo lab