@jahed/bem
    TypeScript icon, indicating that this package has built-in type declarations

    1.2.12 • Public • Published

    @jahed/bem

    Travis npm Patreon Liberapay

    Functions for using BEM in CSS and CSS Modules.

    Installation

    # NPM 
    npm install @jahed/bem
     
    # Yarn 
    yarn add @jahed/bem

    Usage

    import { bem } from '@jahed/bem'
     
    const className = ".MyElement .MyElement--color--red .MyElement--active"
    // same as
    const className = bem('MyElement', {
      color: 'red',
      active: true,
      disabled: false
    })

    For more thorough examples, see the tests and blog posts linked above.

    API

    For complete API documentation, see the documentation website.

    bem(block: string, modifiers: object<string, (boolean|number|string)?>): string

    Generates BEM-compliant class names for the given block (or element) with modifiers.

    Examples


    bemModule(cssModuleLocals): bem

    Generates a bem-compliant function which maps the resulting class names to the given cssModuleLocals map.

    Examples


    join(...string): string

    Joins the given strings with a whitespace (), filtering any falsy values (such as undefined, null, false, '').

    Examples


    License

    MIT

    Install

    npm i @jahed/bem

    DownloadsWeekly Downloads

    33

    Version

    1.2.12

    License

    MIT

    Unpacked Size

    206 kB

    Total Files

    56

    Last publish

    Collaborators

    • jahed