iresults/styles-lib

Sass library with utilities

0.1.0 2024-03-26 12:03 UTC

This package is auto-updated.

Last update: 2024-03-26 12:07:26 UTC


README

Sass library with utilities

Installation

composer

{
    "require": {
        "iresults/styles-lib": "*"
    }
}

Usage

Before the some of the libraries features can be used, the breakpoints, container widths and grid have to be configured:

$grid-breakpoints: (
    xs: 0,
    sm: 576px,
    md: 768px,
    lg: 992px,
    xl: 1200px,
    xxl: 1400px,
);
$container-max-widths: (
    xs: 100%,
    sm: 100px,
    md: 200px,
    lg: 300px,
    xl: 400px,
    xxl: 500px,
    xxxl: 600px,
);
$grid-configuration: (
    columns: 12,
    gap: 1rem,
);
@include lib.configure(
    $grid-breakpoints,
    $container-max-widths,
    $grid-configuration
);

Examples

@include lib.configure(/* ... */);

@include lib.debug-grid();
@include lib.debug-screen-breakpoints();

body::before {
    width: lib.rem-calc(16px);
    height: lib.unit-strip(16px);
}

.container {
    @include lib.container-apply-widths();
}

.container-with-extra {
    @include lib.container-apply-widths(20px);
}

Media-query mixins

@include lib.configure(/* ... */);

body {
    font-size: 16px;

    // Screen width `sm` and above
    @include lib.screen-min(sm) {
        font-size: 18px;
    }

    // Up to and including `lg` screen
    @include lib.screen-max(lg) {
        font-size: 24px;
    }

    // Same as `@include lib.screen-max(lg)`
    @include lib.screen-max-lg() {
        font-size: 24px;
    }

    // Only for `md` screen
    @include lib.screen-screen(md) {
        font-size: 22px;
    }
}

apply utilities

@include lib.configure(/* ... */);

.element {
    // Set the `width` for the given screen only (100% width for `xs` and 80% for `sm`)
    @include lib.screen-utility-apply-properties-for-screens(
        width,
        (
            xs: 100%,
            sm: 80%,
        )
    );

    // Set the `width` for the given screen and above (100% width for `xs` and 80% for `sm`, `md`, …)
    @include lib.screen-utility-apply-properties-for-min-screens(
        width,
        (
            xs: 100%,
            sm: 80%,
        )
    );
}