node package manager
Easy collaboration. Discover, share, and reuse code in your team. Create a free org »

voxelcss

voxelcss

Voxel.css with updated architecture, robust tests, and npm availability

npm Build Status Build status Coverage Status bitHound Overall Score Known Vulnerabilities

Installation

npm install voxelcss

Note: The associated styles are bundled with the JavaScript and added into the head section at runtime.

Usage

AMD (Require.js)

Add to paths attrbute of requirejs config file and require in code

// config.js 
requirejs.config({
    paths: {
        voxelcss: 'path/to/node_modules/voxelcss/dist/voxelcss'
    }
});
 
// main.js 
define(function(require) {
    'use strict';
    const Voxelcss = require('voxelcss');
});

Browser global

Add script tag to your html (code will be available via window.voxelcss)

<!DOCTYPE html>
<html lang="en">
    <head>...</head>
    <body>
        <script src="path/to/node_modules/voxelcss/dist/voxelcss.js"></script> 
    </body>
</html>

Examples

Under construction

Features

  • Completely compatible with voxel.css
  • JavaScript and CSS are all bundled together into one file!
  • CSS is processed by cssnext and minified with cssnano to provide auto-prefixed styles with a minimal footprint and maximum compatibility.
  • Code functionality is verified by tests written using Jest
  • Code standards are enforced by ESLint
  • Functionality and standards are enforced locally and on remote CI servers (including visual regression tests)!

Contributing

Under construction

Setup

# clone repository
git clone git@github.com/jhwohlgemuth/voxelcss.git
cd voxelcss
# install project dependencies
npm install
# verify voxelcss installed correctly by running tests
npm test
# to use the "design" and "dev" tasks, install browser-sync and stmux, respectively
npm install  browser-sync stmux --global

Workflow Tasks

  • npm run dev run test and lint tasks in watch mode using stmux
  • npm test run tests
  • npm run test:watch run tests (watch mode)
  • npm run lint lint code
  • npm run lint:watch lint code (watch mode)
  • npm run design open browser to see "live" changes

Roadmap

Credits

License

FOSSA Status