Git Product home page Git Product logo

decss's Introduction

decss

decss converts CSS modules into React/Preact components. Thanks to simple CSS class naming convention it generates enum and boolean props for the component automatically so you can keep your code clean and tidy.

The runtime size is exactly 664 B.

๐Ÿ’ See Medium post for introduction and reasoning behind

Installation

If you want to use decss with webpack, install decss-loader:

npm install decss-loader --save-dev
# or
yarn add --dev decss-loader

To use the low-level API, or to manage the core library version, install decss:

npm install decss --save
# or
yarn add decss

Configuration

// ...
{
  test: /\.css$/,
  use: [
    'style',
    'decss/react', // ๐Ÿ‘ˆ Add loader (use 'decss/preact' for Preact)
    {
      loader: 'css',
      options: {
        modules: true, // ๐Ÿ‘ˆ You must enable modules to make it work
        importLoaders: 1,
        localIdentName: '[local]-[hash:base64:5]',
      }
    },
    'postcss'
  ],

  // or if you prefer classic:

  loader: 'style!decss/preact!css?modules&importLoaders=1&localIdentName=[local]-[hash:base64:5]&!postcss'
},
// ...

Usage

See low-level API docs for more implementation details.

React

import React from 'react'
import { Button } from './style.css'

function PanicButton ({ alreadyPanicking }) {
  return (
    <Button tag='button' color='red' disabled={alreadyPanicking}>
      Panic
    </Button>
  )
}

Preact

import { h } from 'preact'
import { Button } from './style.css'

function PanicButton ({ alreadyPanicking }) {
  return (
    <Button tag='button' color='red' disabled={alreadyPanicking}>
      Panic
    </Button>
  )
}

Convention

Component (.Component)

.Component is a component ๐Ÿคก The name must be in class-case, e.g. .FormInput, .UI.

In this example, .Button represents <Button />.

.Button {
  color: white;
}

Boolean Prop (.Component-propName)

.*-disabled is a boolean prop.

.Button-disabled {
  opacity: .5;
}

In the example, .Button-disabled is applied to the component when its disabled prop is truthy:

<Button disabled>
  Whatever
</Button>

Enum Prop (.Component-propName-option)

.*-color-gray is an enum prop.

.Button-color-red {
  background: red;
}

.Button-color-green {
  background: green;
}

.Button-color-red is applied to the component when its color prop equals "red":

<Button color='red'>
  Click Me
</Button>

Setting Default Value

To set the default value to certain enum option, use good ol' CSS:

.Button,
.Button-color-green {
  background: green;
}

Related

License

MIT ยฉ Sasha Koss

decss's People

Contributors

kossnocorp avatar leshakoss avatar

Watchers

 avatar  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.