@tsparticles/shape-square/README.md

tsParticles square shape

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

# tsParticles Square Shape

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

[tsParticles](https://github.com/tsparticles/tsparticles) additional square 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.square.min.js` file will export the function to load the shape:

```javascript
loadSquareShape;
```

### Usage

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

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

  await tsParticles.load({
    id: "tsparticles",
    options: {
      /* options */
      /* here you can use particles.shape.type: "square" */
    },
  });
})();
```

### 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-square
```

or

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

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

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

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

or

```javascript
import { tsParticles } from "@tsparticles/engine";
import { loadSquareShape } from "@tsparticles/shape-square";

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

## Option mapping

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

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

## Common pitfalls

- Calling `tsParticles.load(...)` before `loadSquareShape(...)`
- 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/>