https://github.com/m-avagyan/classcraft
Seamlessly craft and conditionally concatenate class names for your web elements.
https://github.com/m-avagyan/classcraft
class classnames crafting javascript merging typescript
Last synced: 3 months ago
JSON representation
Seamlessly craft and conditionally concatenate class names for your web elements.
- Host: GitHub
- URL: https://github.com/m-avagyan/classcraft
- Owner: m-avagyan
- License: mit
- Created: 2023-10-14T20:27:11.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2023-10-15T08:20:56.000Z (over 1 year ago)
- Last Synced: 2025-01-27T15:45:08.313Z (4 months ago)
- Topics: class, classnames, crafting, javascript, merging, typescript
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/classcraft
- Size: 47.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# classcraft
Seamlessly craft and conditionally concatenate class names for your web elements.
## Installation
```bash
npm install classcraft --save
```
or
```bash
yarn add classcraft
```
## Usage
```typescript
import classcraft from "classcraft";
const classes = classcraft("foo", { bar: true, baz: false });
console.log(classes); // Outputs: "foo bar"
```
## Examples
### Simple Usage
```typescript
import React from "react";
import classcraft from "classcraft";
function Button({ primary, disabled, children }) {
return (
{children}
);
}
export default Button;
```
### Advanced Usage
```typescript
import React from "react";
import classcraft from "classcraft";
function Card({ featured, highlighted, darkMode, extraClass, children }) {
return (
{children}
);
}
export default Card;
```
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
## Author
**Martik Avagyan**
- Website: [martikavagyan.com](https://martikavagyan.com)
- Twitter: [@martikavagyan](https://twitter.com/martikavagyan)
- GitHub: [@m-avagyan](https://github.com/m-avagyan)
## License
[MIT](https://choosealicense.com/licenses/mit/)