@nexim/card/README.md

CSS classes for Material Design 3 card.

# @nexim/card

![NPM Version](https://img.shields.io/npm/v/@nexim/card)
![Build & Lint & Test](https://github.com/the-nexim/design-system/actions/workflows/build-lint-test.yaml/badge.svg)
![NPM Downloads](https://img.shields.io/npm/dm/@nexim/card)
![NPM License](https://img.shields.io/npm/l/@nexim/card)

## Overview

a CSS utility for rendering Material Design cards with consistent styling.

## Installation

Install the package using npm or yarn:

```sh
npm install @nexim/card

# Or using yarn
yarn add @nexim/card
```

## API

import `@nexim/card/style/main.css` into your main css file

- use like that

```html
<span class="card-filled">home</span> 

<!-- make card hoverable, clickable, and activeable -->

<span class="card-filled stateful">home</span>
```