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

@ptkhanh94npm/odio-repellendus-veniam

v1.0.0

Published

**@ptkhanh94npm/odio-repellendus-veniam** is a JavaScript library that provides utility functions for generating CSS class names in both BEM (Block, Element, Modifier) and hyphenated conventions. This library is part of the **csduck libraries collection**

Downloads

3

Readme

@ptkhanh94npm/odio-repellendus-veniam

@ptkhanh94npm/odio-repellendus-veniam is a JavaScript library that provides utility functions for generating CSS class names in both BEM (Block, Element, Modifier) and hyphenated conventions. This library is part of the csduck libraries collection.

Table of Contents

Installation

You can install this library using npm or yarn:

npm install @ptkhanh94npm/odio-repellendus-veniam
# or
yarn add @ptkhanh94npm/odio-repellendus-veniam

Usage

BEM (Block, Element, Modifier) Convention

generateBEMClassName(config: BEMBlockConfigs): string

The generateBEMClassName function generates BEM block class names based on the provided configuration. It follows the BEM convention, which consists of blocks, elements, and modifiers, all separated by double underscores (__) and double hyphens (--).

Example:

const classNames = generateBEMClassName({
  block: 'block',
  element: 'element',
  modifier: 'modifier',
  extend: 'mt-5',
});

// Result: 'block__element block__element--modifier mt-5'

Config Types:

| Property | Type | Description | |-----------|----------------------------------------------------------------------------------| --- | | block?: | string \| (undefined \| string)[] | The block name. | | element?: | string \| (undefined \| string)[] | The element name. | | modifier?: | string \| ModifierDeclaration \| (undefined \| string \| ModifierDeclaration)[] | The modifier name. | | extend?: | string | The class name to extend. |

Additional Types:

| Type | Type Definition | Description | |-----------|----------------------------------------------------------------------------------|----------------------------------------------------------------------| | ModifierDeclaration | { name: string, condition?: boolean } | in case you want to condition the modifier and give it a custom name |

Hyphenated Convention

generateHyphenClassName(config: HyphenBlockConfigs): string The generateHyphenClassName function generates class names using a hyphenated convention. It takes a configuration object where you can specify variants for each block. Variants are hyphenated to the block name if they are not undefined or if a condition is met.

Example:

const classNames = generateHyphenClassName({
  btn: ['primary', { name: 'lg', condition: window.innerWidth > 768 }],
});

// Result: 'btn btn-primary' (default) or 'btn btn-primary btn-lg' (window.innerWidth > 768)

note: In the hyphenated convention, class names use kebab-case (hyphen-separated) instead of camelCase (js variables naming convention).

Additional Types:

| Type | Type Definition | Description | |-----------|----------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------| | HyphenBlockConfigs | { [blockName: string]: (string \| HyphenVariant \| (undefined \| string \| HyphenVariant)[]) } | The config values that passed to the generateHyphenClassName function. | | HyphenVariant | { name: string, condition?: boolean } | in case you want to condition the variant and give it a custom name |

Contribution

Contributions and bug reports are welcome! Feel free to open issues or submit pull requests on the GitHub repository.

License

This project is licensed under the MIT License. See the LICENSE file for details.