npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

properclass

v1.6.1

Published

React className utility following BEM conventions

Downloads

8

Readme

properclass

Coverage Status

Designed for use in your React components, properclass is a utility for composing html class names which follow BEM conventions.

npm install properclass --save

Create a couple of components...

import { createComposer } from 'properclass';

const eggComposer = createComposer('Egg').modifier({ size: props => props.size });
const yolkComposer = eggComposer.element('yolk').modifier({ runny: props => props.isRunny })

const Egg = ({ children, ...props }) => (
  <div className={ eggComposer(props) } >
    { children }
  </div>
);

const Yolk = props => (
  <div className={ yolkComposer(props) } />
);

Now let's render some eggs...

<Egg size='big' >
  <Yolk />
</Egg>

<Egg>
  <Yolk isRunny >
</Egg>

<!-- ** Result ** -->

<div class="Egg Egg--size-big" >
  <div class="Egg__yolk" ></div>
</div>

<div class="Egg" >
  <div class="Egg__yolk Egg__yolk--runny" ></div>
</div>

Also available as an es7 decorator...

import React from 'react';
import { decorator as properclass } from 'properclass';

@properclass({
  block: 'Egg',
  element: 'yolk',
  modifier: {
    runny: props => props.isRunny
  }
})
class Yolk extends React.Component {
  render () {
    return (
      <div {...this.props} />
    );
  }
}

Easy integration with css modules...

import React from 'react';
import createComposer from 'properclass/lib/createComposer';
import decorator from 'properclass/lib/decorator';
import eggStyles from 'styles/Egg.css';

const composer = createComposer('Egg', { styleMap: eggStyles }).element('yolk');

@decorator({
  block: 'Egg',
  element: 'yolk',
  options: {
    styleMap: eggStyles
  }
})
class Yolk extends React.Component {
  ...
}

Customize separators to suit your style...

import { createComposer } from 'properclass';

const classicBemComposer = createComposer('Egg', {
  elementSeparator: '__',
  modifierSeparator: '_',
  modifierValueSeparator: '-'
});

API

properclass.decorator(decoratorOptions : object)
properclass.createBlockDecorator(blockName : string, options : ?composerOptions) : blockDecorator
  • param blockName The className of this block
  • param options options to the className composer, see composerOptions.
  • returns blockDecorator a properclass.decorator function with decoratorOptions.block and decoratorOptions.options set with the given arguments.
properclass.createComposer(blockName : string, options : ?composerOptions) : composer
  • param blockName The className of this block.
  • param options options to the className composer, see composerOptions.
  • returns composer a composer function, see composer.
composer(props : ?object<string,any>) : string
  • param props An object to be used by any functions declared in the map passed to composer.modifier, see modifierOptions.
  • returns className the resolved className including the element and modifier clases if specified.
composer.element(elementName : string) : composer
  • param elementName the name of this element.
  • returns composer a new composer function representing this element within the original block.
composer.modifier(modifiers : modifierOptions) : composer
  • param modifiers a string, array of strings or object of modifier classNames to add to this block/element. See modifierOptions.
  • returns composer a new composer function with the applied modifiers.
composer.toString(props : ?object) : string
  • param props Props to pass to functional modifiers
  • returns className The className for this composer.
decoratorOptions : object
  • prop block : string The className of the block. Required.
  • prop element : ?string The name of the element
  • prop modifier : ?modifierOptions Options to composer.modifier, see modifierOptions.
  • prop options : ?composerOptions Additional options to the composer, see composerOptions.
modifierOptions : string | string[] | object<string,any>
  • string When modifierOptions is a string, compser() will always yield a className with the given modifier name.
assert.equal(
  createComposer('Spider').modifier('man')(),
  'Spider Spider--man';
);
  • string[] When modifierOptions is an array of strings, composer() will always yield modifiers for each given modifier name.
assert.equal(
  createComposer('Lucky').modifier(['sexy', 'winners'])(),
  'Lucky Lucky--sexy Lucky--winners'
);
  • object<string,any> When modifierOptions is a map, composer() will yield modifier classNames for each key in the map.
    • Keys mapping to true values yield a className with the format 'BlockName--key'.
    • Keys mapping to null|undefined|false or empty string are omitted
    • Keys mapping to string values yield a className with the format 'BlockName--key-value'
    • Keys mapping to function values apply these cases to the return value.
const options = {
  flavour: 'banana',
  size: null,
  'better-than-yours': props => props.bringsAllTheBoysToTheYard
};

assert.equal(
  createComposer('Milkshake').modifier(options)({ bringsAllTheBoysToTheYard: true }),
  'Milkshake Milkshake--flavour-banana Milkshake--better-than-yours'
);
composerOptions : object
  • prop styleMap : object<string,string> | function(string) : string An object or function mapping the final classNames for an element.
  • prop elementSeparator : string The separator pattern for block/element.
    • default '__'
  • prop modifierSeparator : string The separator pattern for block|element/modifier.
    • default '--'
  • prop modifierValueSeparator : string The separator pattern for modifierKey/modifierValue.
  • default '-'
  • prop suppressWarnings : boolean Suppress warning messages when classNames contain invalid characters.
  • default false

Examples

createBlockDecorator

import React, { Component } from 'react';
import { createBlockDecorator } from 'properclass';
import styles from 'styles/Egg.css';

const properclass = createBlockDecorator('Egg', { styleMap: styles });

@properclass()
class Egg extends Component {
  ...
}

@properclass({ element: 'yolk', modifier: { ... } })
class Yolk extends Component {
  ...
}