Logo for jsDocs.io

classnames

  • Version 2.5.1
  • Published
  • 23.6 kB
  • No dependencies
  • MIT license

Install

npm i classnames
yarn add classnames
pnpm add classnames

Overview

A simple utility for conditionally joining classNames together

Index

Variables

Interfaces

Type Aliases

Variables

variable classNames

const classNames: ClassNames;

  • A simple JavaScript utility for conditionally joining classNames together.

Interfaces

interface ArgumentArray

interface ArgumentArray extends Array<Argument> {}

    interface ReadonlyArgumentArray

    interface ReadonlyArgumentArray extends ReadonlyArray<Argument> {}

      Type Aliases

      type Argument

      type Argument = Value | Mapping | ArgumentArray | ReadonlyArgumentArray;

        type Mapping

        type Mapping = Record<string, any>;

          type Value

          type Value = string | number | boolean | undefined | null;

            Package Files (1)

            Dependencies (0)

            No dependencies.

            Dev Dependencies (10)

            Peer Dependencies (0)

            No peer dependencies.

            Badge

            To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

            You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/classnames.

            • Markdown
              [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/classnames)
            • HTML
              <a href="https://www.jsdocs.io/package/classnames"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>