https://github.com/garystorey/cssclass

A small dependency-free utility to combine css classes written in TypeScript
https://github.com/garystorey/cssclass

class classlist classnames css

Last synced: about 1 month ago
JSON representation

A small dependency-free utility to combine css classes written in TypeScript

• Host: GitHub
• URL: https://github.com/garystorey/cssclass
• Owner: garystorey
• License: mit
• Created: 2020-10-26T21:53:16.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2022-07-27T06:02:09.000Z (almost 4 years ago)
• Last Synced: 2025-03-27T19:04:10.859Z (about 1 year ago)
• Topics: class, classlist, classnames, css
• Language: TypeScript
• Homepage:
• Size: 570 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# cssclass

A small dependency-free utility to combine css classes written in TypeScript.

![Version](https://img.shields.io/github/package-json/v/garystorey/cssclass)

![Size](https://img.shields.io/bundlephobia/min/@garystorey/cssclass)

![License](https://img.shields.io/npm/l/@garystorey/cssclass)

![Leywords](https://img.shields.io/github/package-json/keywords/garystorey/cssclass)

## Installation

You can install either with `npm` or `yarn`:

```js

npm install @garystorey/cssclass

yarn add @garystorey/cssclass

```

## Usage

Example in JavaScript:

```js

import cssclass from '@garystorey/cssclass'

const value = 1

const classes = cssclass(`default`, {

  notadded: value === 0,

  added: value === 1,

})

console.log(classes)

// "default added"

```

Since `cssclass` is written in TypeScript, it includes its own types.

```ts

import { cssclass, CSSClassObject } from '@garystorey/cssclass'

const classObject: CSSClassObject = {

  notadded: value === 0,

  added: value === 1,

}

const value: number = 1

const classes = cssclass('default', classObject)

console.log(classes)

// "default added"

```

You can see it in action [on this CodeSandbox](https://codesandbox.io/s/cssclass-example-w1og5).