react-concat-classname

react-concat-classnames

A light-weight, zero-dependent className builder for React.

Installation

npm:

npm i react-concat-classnames

Yarn:

yarn add react-concat-classnames

pnpm:

pnpm add react-concat-classnames

Usage

This library supports both global class names and CSS modules.

Global Class Names

The default export, concat will concatenate truthy strings only.

import concat from "react-concat-classnames";

const variant = "filled";
const color = "blue";
const size = null;

concat("button", "variant-" + variant, "color-" + color); // "button variant-filled color-blue"
concat("avatar", size, "round"); // "avatar round" (size was omitted because it was null)

CSS Modules

concatModule will map all of its arguments to a style object, then filter for truthy strings.

import { concatModule } from "react-concat-classnames";
import styles from "./styles.module.css";

// The styles object may look like this:
const styles = {
    // Button styles
    "button": "myButton",
    "variant-filled": "buttonFilled",
    "color-blue": "buttonBlue",

    // Avatar styles
    "avatar": "myAvatar",
    "round": "avatarRound"
};

const variant = "filled";
const color = "blue";
const size = null;

concatModule(styles, "button", "variant-" + variant, "color-" + color); // "myButton buttonFilled buttonBlue"
concatModule(styles, "avatar", size, "round"); // "myAvatar avatarRounded"

Baking CSS Modules

Additionally, you may "bake" a style object into concatModule:

import { buildConcatModule } from "react-concat-classnames";
import styles from "./styles.module.css";

const className = buildConcatModule(styles);

// ... variables ...

className("button", "variant-" + variant, "color-" + color); // "myButton buttonFilled buttonBlue"
className("avatar", size, "round"); // "myAvatar avatarRounded"

License

This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain. We make this dedication for the benefit of the public at large and to the detriment of our heirs and successors. We intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

For more information, please refer to https://unlicense.org/