[![banner](https://particles.js.org/images/banner3.png)](https://particles.js.org)

# tsParticles Cards Shape

[![jsDelivr](https://data.jsdelivr.com/v1/package/npm/@tsparticles/shape-cards/badge)](https://www.jsdelivr.com/package/npm/@tsparticles/shape-cards)
[![npmjs](https://badge.fury.io/js/@tsparticles/shape-cards.svg)](https://www.npmjs.com/package/@tsparticles/shape-cards)
[![npmjs](https://img.shields.io/npm/dt/@tsparticles/shape-cards)](https://www.npmjs.com/package/@tsparticles/shape-cards) [![GitHub Sponsors](https://img.shields.io/github/sponsors/matteobruni)](https://github.com/sponsors/matteobruni)

[tsParticles](https://github.com/tsparticles/tsparticles) additional cards shape.

## Quick checklist

1. Install `@tsparticles/engine` (or use the CDN bundle below)
2. Call the package loader function(s) before `tsParticles.load(...)`
3. Apply the package options in your `tsParticles.load(...)` config

## How to use it

### CDN / Vanilla JS / jQuery

The CDN/Vanilla version JS has one required file in vanilla configuration:

Including the `tsparticles.shape.cards.min.js` file will export the function to load the shape:

```text
loadCardsShape
```

### Usage

Once the scripts are loaded you can set up `tsParticles` and the shape like this:

```javascript
(async () => {
  await loadFullCardsShape(tsParticles);

  await tsParticles.load({
    id: "tsparticles",
    options: {
      /* options */
      /* here you can use particles.shape.type: ["heart", "diamond", "spade", "club"] */
      /*   or you can use particles.shape.type: ["hearts", "diamonds", "spades", "clubs"] */
    },
  });
})();
```

### ESM / CommonJS

This package is compatible also with ES or CommonJS modules, firstly this needs to be installed, like this:

```shell
$ npm install @tsparticles/shape-cards
```

or

```shell
$ yarn add @tsparticles/shape-cards
```

Then you need to import it in the app, like this:

```javascript
const { tsParticles } = require("@tsparticles/engine");
const { loadCardsShape } = require("@tsparticles/shape-cards");

(async () => {
  await loadCardsShape(tsParticles);
})();
```

or

```javascript
import { tsParticles } from "@tsparticles/engine";
import { loadCardsShape } from "@tsparticles/shape-cards";

(async () => {
  await loadCardsShape(tsParticles);
})();
```

### Granular loading

This package exposes several subpath imports to load only the shapes you need:

- **All card suits** (clubs, diamonds, hearts, spades):
  ```ts
  import { loadCardSuitsShape } from "@tsparticles/shape-cards/suits";
  ```
- **Single suit** (e.g. clubs):
  ```ts
  import { loadClubsSuitShape } from "@tsparticles/shape-cards/clubs";
  import { loadDiamondsSuitShape } from "@tsparticles/shape-cards/diamonds";
  import { loadHeartsSuitShape } from "@tsparticles/shape-cards/hearts";
  import { loadSpadesSuitShape } from "@tsparticles/shape-cards/spades";
  ```
- **Card images only** (full card face render):
  ```ts
  import { loadFullCardsShape } from "@tsparticles/shape-cards/cards";
  ```

All individual loader functions can also use the `/lazy` suffix for lazy imports (e.g. `@tsparticles/shape-cards/clubs/lazy`).

## Option mapping

- Primary options key: `particles.shape.type: "cards"`
- Shape-specific options key: `particles.shape.options.cards`

```json
{
  "particles": {
    "shape": {
      "type": "cards",
      "options": {
        "cards": {}
      }
    }
  }
}
```

## Common pitfalls

- Calling `tsParticles.load(...)` before `loadFullCardsShape(...)`
- Verify required peer packages before enabling advanced options
- Change one option group at a time to isolate regressions quickly

## Related docs

- All packages catalog: <https://github.com/tsparticles/tsparticles>
- Main docs: <https://particles.js.org/docs/>