Giter VIP home page Giter VIP logo

css-module-npm-boilerplate's Introduction

css-module-npm-boilerplate

npm version

A boilerplate css module.

Fork this and create your own reusable css module to be imported into react, deku, riot, etc... components.

Check out more css modules at cssmodul.es

Compatible

CSS Modules is only compatible with camelCase. However deku and react have mappings to use normal class names.

This module has only camelCase classes so is compatible with:

Install

npm install css-module-npm-boilerplate --save-dev

Usage

import fancyButton from 'css-module-npm-boilerplate'

The fancy button css module has a .button and a color style .blue, .green or .red.

Add the classes to your elements to use the styles...

css modules

	return (
        <button className={styles.button + ' ' + styles.blue }>press me</button>
    );

react / deku css modules

	return (
        <button styleName='button blue'>press me</button>
    );

Example

Check out an example of using this css module here

Run it

cd example; npm install; npm start

Development

This is a simple boilerplate module which just exports the fancyButton.css module, so there is no build step.

If you wish to have multiple css modules exported, export the following from your index.js

var alerts = require('./lib/alerts.css'); 
var buttons = require('./lib/buttons.css'); 

module.exports = {
	buttons: buttons,
	alerts: alerts
};

If you wish to use sass, less, autoprefixer or post-css in your css module, you can use gulp or webpack as a build step:

License

MIT

css-module-npm-boilerplate's People

Contributors

jameszmartin avatar svnm avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.