Skip to content

Latest commit

 

History

History
176 lines (134 loc) · 10.7 KB

README.md

File metadata and controls

176 lines (134 loc) · 10.7 KB
Raw

Artoo (R2-D2) npm

This utility droid provides a set of single-purpose, responsive and functional helpers for writing CSS within the Galaxy.

Installation

$ npm install --save-dev @theholocron/artoo

Table of Contents

Usage

There are a few things that are provided with this library. At its core, this is a (S)CSS mixin library using dart-sass modules. By default, mixins are available in a namespace based on the basename of the URL, so check out below for ways to import. Each of these will produce a CSS class that can then be used within your HTML.

// _index.scss

// include all utilities with 'artoo' as the namespace
// calls all mixins and will include in CSS output
@use "./node_modules/@theholocron/artoo/src" as artoo;

// use all utilities with a different set of breakpoints
// calls all mixins and will include in CSS output
@use "./node_modules/@theholocron/artoo/src" as artoo with (
    $breakpoints: (
        "xs": "0",
        "sm": "480px",
        "md": "768px",
        "lg": "1024px",
        "xl": "1280px",
    )
);

// include only a specific group of mixins
@use "@theholocron/artoo/src/text" as *;
// call the mixins from this group
@include text-reset();
@include text-underline();

// use only a specific mixin
@use "@theholocron/artoo/src/positioning/clearfix";
// call the mixin you want to use
@include clearfix();
// call the mixin you want, but override this breakpoints
@include clearfix(
    $breakpoints: (
        "xs": "0",
        "sm": "480px",
        "md": "768px",
        "lg": "1024px",
        "xl": "1280px",
    )
);

The previous examples are only a sample of what utilities are available.

If you only want the CSS, there are several configurations you can choose. The following uses unpkg as a CDN, so all of the rules apply to retrieving a specific version or file. But also provided in the dist directory are a set of compiled CSS files in both compressed and non-compressed forms. The entire library is provided as well as each directories as described below.

  • The [@<semver>] is an optional field that allows you to pick a specific version, or if you omit it will grab the latest tagged version.
  • The [min] is optional as well, but highly recommended if you're going to call the CSS file directly in your HTML, as its minified.
  • The <type> is a required field that allows one to pick a specific group to include or include the entire set. The following are allowed types:
    • artoo - the entire collection
    • a11y - only include accessible
    • box-model - only include box model
    • images - only include images
    • positioning - only include positioning
    • text - only include text
<link rel="stylesheet" href="https://unpkg.com/@theholocron/artoo[@<semver>]/dist/<type>.[min].css" />

Once you've determined how you're going to include the files, then copy the code below, swapping out the <property-name> for one of the ones in a collection listed above (check each README for a list of the actual properties). By default the <property-name> is not responsive, but if you add any one of the keywords (xs, sm, md, lg, xl) preceded with a dash - and combine it with -up for sizes at that break point and up, or -down for sizes at that breakpoint and down, or -only for the range between that particularly break point, you can make it responsive.

<div class="<property-name>[-<breakpoint keyword>]">Text</div>

Where to Find Documentation

The best way to find out what's available is to check out the source code or test but you can also take a look at the-holocron.github.io/artoo or the README which have been generated by SassDoc and sassdoc-to-markdown.

  • A11Y - A11Y is a module of CSS that lets deal with accessibility concerns.
  • Box Model - Box model is a module of CSS that defines the rectangular boxes—including their padding and margin—that are generated for elements and arranged according to the visual formatting model.
  • Images - Images is a module of CSS that defines what types of images can be used (the <image> type, containing URLs, gradients and other types of images), how to resize them and how they, and other replaced content, interact with the different layout models.
  • Positioning - Positioning is a module of CSS that defines how to position elements on the page.
  • Text - Text is a module of CSS that defines how to perform text manipulation, like line breaking, justification and alignment, white-space handling, and text transformation.

How We Track Changes Keep a Changelog

This project uses a CHANGELOG and GitHub releases which contains a curated, chronologically ordered list of notable changes for each version of a project. Read more about changelogs.

How We Version semantic-release

We use SemVer for its versioning providing us an opt-in approach to releases. This means we add a version number according to the spec, as you see below. So rather than force developers to consume the latest and greatest, they can choose which version to consume and test any newer ones before upgrading. Please the read the spec as it goes into further detail.

Given a version number MAJOR.MINOR.PATCH, increment the:

  • MAJOR version when you make incompatible API changes.
  • MINOR version when you add functionality in a backward-compatible manner.
  • PATCH version when you make backward-compatible bug fixes.

Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.

How to Contribute Conventional Commits

Have a bug or a feature request? Looking to contribute to advance the project? Read our contribution guide or maintenance guide first in order to understand how we do things around here. Or you could look at some of our other guides below:

How do I… (click to expand)

Where to Find Support Contributor Covenant

Looking to talk to someone or need some help? Please read our support guidelines.

Tools We Use

References

License License: GPL v3

©2020 GNU General Public License v3. See LICENSE for specifics.