Fly-JSS

Optimized library to create "Atomic CSS in JS" inspired in Stylex at Facebook to prevent duplication of class names using CXS below.

Installation

To use the library you need to install the package typing the next command.

$ npm i fly-jss
$ yarn add fly-jss

Usage

The main way to use styles is instancing the method create of module. After we use the method props to pass arguments. You can see more examples here.

import fly, { css } from "fly-jss";

// Create base styles in object
const styles = fly.create({
 primary: {
   background: "blue",
   borderRadius : "20px",
 },
 flat: {
   border: "2px solid aqua",
 },
 text : {
   color : "red",
 }
});

// Create base styles as string
const styles = fly.create({
 primary: css`
   background: blue;
   borderRadius: 20px;
 `,
 flat: css`border: 2px solid aqua`,
 text: css`color: red` 
});


/**
 * Using styles passing arguments
 */
function Buttons() {
  return(
    <div> 
      <button className={styles("primary","text")}>Primary button</button>
      <button className={styles("text")}>Secondary button</button>
    </div>
  )
}

/**
 * Passing arguments how object
 * the names are key of styles created, if the value is true it class will be added.
 */
function Button() {
  return(
    <button className={styles({
      primary : false,
      flat : true,
    })}>
     Dynamic button
    </button>
  )
}

Whe can create dynamic styles using a method in a property.

import fly from "fly-jss";

// Create dynamic base styles
const styles = fly.createDynamic({
  button: ([r, g, b]) => ({
    background: `rgb(${r},${g},${b})`
  })
});

/**
 * Prevent duplication of class names generated
 */
function App() {
  const button1 = styles({
    button: [40, 50, 200]
  });
  const button2 = styles({
    button: [100, 250, 20]
  });

  return (
    <div>
      <button className={button1}>BUTTON 1</button>
      <button className={button2}>BUTTON 2</button>
    </div>
  );
}

export default App;

API

create()

Create a instance of styles. You can create some property how an object.

const styles = fly.create({
  prop1 : {
    // object styles
  },
  prop2 : {
    // object styles
  },
})

createDynamic()

Create a instance of dynamic styles. You can create all properties how a function.

const styles = fly.createDynamic({
  prop3 : (params) => ({
    // object styles
  })
})

styles(...name, {...name} )

Get a list properties created in the instance of styles. If you want to have a dynamic property this would cause an error.

// Get all properties
styles("prop1", "prop2")

// Get the prop1
styles("prop1", false && "prop2")

// Get props as object
styles({
  prop1 : true,
  prop2 : true
})

If you want to get a dynamic styles use the self name and pass a object with the name and value.

const styles = fly.createDynamic({
  square : (size) => ({
    width : size,
    height: size
  })
})

styles({
  square: "20px"
})

css

Create a string of styles and return an object style parsed

import { css } from "fly-jss"

const styles = css`
  background:blue;
  color:white;
  border-radius: 10px;
`
console.log(styles)

compose(...styles)

Compose diferents styles

import fly from "fly-jss"

fly.compose(
  styles("prop1"),
  styles("prop2"),
  styles({
    square : "20px"
  })
)

The project uses below CXS, a library with high performance, deduplicates repeated styles and zero dependencies. If you wank to know most about this subject, in the next link Atomic CSS-in-JS you can learn how work it methodology.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Jhony Vega 💻 📖 ⚠️

This project follows the all-contributors specification. Contributions of any kind welcome!