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

module-clsx

v1.0.0

Published

Class names generator for css modules in BEM style

Downloads

1,153

Readme

module-clsx

Simple and fast BEM class names helper for CSS Modules. Inspired by clsx and bem-cn

Installation

$ npm install module-clsx --save

or

$ yarn add module-clsx

Usage

.element {
    &_modifier {
        disaply: block;
    }
    &_modifier_value {
        display: flex;
    }
}
import block from 'module-clsx'
import styles from './Component.module.scss'

const b = block(styles)

Element

b('element');
// => 'element_HASH' 
b('element', { modifier: true });
// => 'element_HASH element_modifier_HASH'
b('element', { modifier: 'value' });
// => 'element_HASH element_modifier_value_HASH'
b('element', 'mixin');
// 'element_HASH mixin'
b('element', { modifier: 'value' }, 'mixin');
//=> 'element_HASH element_modifier_value_HASH mixin'
b('element', { modifier: 'value' }, 'mixin', null, false, undefined, 'mix');
//=> 'element_HASH element_modifier_value_HASH mixin mix'

React example

import React from 'react'
import block from 'bem-clsx'
import styles from './UserInfo.module.scss'

interface IProps {
  userName: string
  avatarUrl: string
  online: boolean
  className?: string
}

const b = block(styles)

const UserInfo: React.FC<IProps> = ({
  className,
  userName,
  avatarUrl,
  online
 }) => (
   <div className={b('root', className)}>
     <img className={b('avatar')} src={avatarUrl}/>
     <span className={b('name', { active: online })}>{userName}<span>
     <div className={b('status', { online })}/>
   </div>
 )

If props className is user-info and online is true, the result would be the following HTML:

<div class="root_HASH user-info">
  <img class="avatar_HASH" src="https://images.com/test" />
  <span class="name_HASH name_active_HASH">Some User</span>
  <div class="status_HASH status_online_HASH" />
</div>

Custom separators

For using custom element and modifier separators, you can easily create your own module that calls the original with configuration options:

// ./src/helpers/bem.ts
import block from 'module-clsx'

const  customConfig  = {
  modifierSeparator: '--',
  modifierValueSeparator: '-',
}

const customBlock = (styles: {[key: string]: string}) => (
  block(styles, customConfig)
)

export default customBlock

Now you can use this function in your application. Example:

import block from 'helpers/bem'
import styles from './Component.module.scss'

const b = block(styles)

b('element', { modifier: 'value' }, 'mixin', null, false, undefined, 'mix') 
// => 'element_HASH element--modifier-value_HASH mixin mix'

Default options

{
  modifierSeparator: '_',
  modifierValueSeparator: '_',
}

License

The package is available as open source under the terms of the MIT License.