Nothing's plumb meaningless
Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

alef

0.1.13 • Public • Published

Alef

Alef is a fast and modular library to handle styling in JavaScript.
It is dynamic by design and renders your styles depending on your application state.

It generates CSS and therefore supports all common CSS features such as media queries, pseudo classes, keyframes and font-faces. It also renders on server-side with ease and ships with a powerful plugin API adding e.g. automatic vendor prefixing or fallback value support.

Alef can be used with React or with any other view library. React Native support has been removed.

Improvements from Fela

  • Entire codebase converted to TypeScript
  • Shorter classnames generated using a Base64 alphabet (instead of just numbers)
  • Will no longer generate problematic classnames (such as those likely to be blocked by ad-blockers)
  • Performance enhancements (including API-breaking changes)
  • Removed support for React Native
  • Removed some Angular stuff that I don't care about
  • Uses tabs for indentation

Installation

We're busy refactoring and hitting the delete key, so you can't install it (yet).

Features

  • Dynamic styling
  • Universal rendering
  • Dead code elimination
  • High performance
  • Minimal CSS output
  • Framework-agnostic
  • Pseudo classes & Media queries
  • Child & Attribute selectors
  • Vendor prefixing
  • Component theming
  • Many useful plugins
  • Local namespace

The Gist

Alef is all about rendering styles, especially so called rules. A universal renderer will help us to render styles of all kind. Once rendered into a DOM node, a change listener will subscribe to changes and automatically add new rules.
The following example illustrates the key parts of Alef though it only shows the very basics.

import { createRenderer } from 'alef'
import { render } from 'alef-dom'
 
// rules are just plain functions of props
// returning a valid object of style declarations
const rule = props => ({
  fontSize: props.fontSize + 'px',
  marginTop: props.margin ? '15px' : 0,
  color: 'red',
  lineHeight: 1.4,
  ':hover': {
    color: 'blue',
    fontSize: props.fontSize + 2 + 'px'
  },
  // nest media queries and pseudo classes
  // inside the style object
  '@media (min-height: 300px)': {
    backgroundColor: 'gray',
    ':hover': {
      color: 'black'
    }
  }
})
 
// creates a new renderer to render styles
const renderer = createRenderer()
 
// rendering the rule returns a className reference
// which can be attached to any element
const className = renderer.renderRule(rule, { fontSize: 12 })
 
// it uses atomic css design to reuse styles
// on declaration base and to keep the markup minimal
console.log(className) // => a b c d e f h
 
// renders all styles into the DOM
render(renderer)

Documentation

The Fela documentation should be a good start, although don't actually try to use Alef unless you are me.

Who's using Alef?

Nobody except for me...which should be a good thing.

License

Alef is licensed under the MIT License.
Documentation is licensed under Creative Common License.
Created by @as-com, based on excellent work by @rofrischmann and other contributors.

install

npm i alef

Downloadsweekly downloads

18

version

0.1.13

license

MIT

last publish

collaborators

  • avatar