# @tsparticles/shape-text

> tsParticles text shape

Latest version **4.4.0** (published 2026-08-31) · MIT license · 0 weekly downloads

## Install

```sh
npm install @tsparticles/shape-text
pnpm add @tsparticles/shape-text
yarn add @tsparticles/shape-text
bun add @tsparticles/shape-text
```

## Health

**Score 70/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; has provenance; recently updated; high maintenance score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 4.4.0 |
| Published | 2026-08-31 |
| First published | 2023-01-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 190.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 8980 |
| Author | Matteo Bruni |
| Maintainers | matteobruni |
| Keywords | front-end, frontend, tsparticles, particles, particle, canvas, jsparticles, xparticles, particles-js, particles.js, particles-ts, particles.ts, typescript, javascript, animation, web, html5, web-design, webdesign, css, html, css3, animated, background, tsparticles-shape |

## Links

- npm: https://www.npmjs.com/package/@tsparticles/shape-text
- Repository: https://github.com/tsparticles/tsparticles
- Homepage: https://particles.js.org
- Issues: https://github.com/tsparticles/tsparticles/issues
- npm.io page: https://npm.io/package/@tsparticles/shape-text

## Dependencies (1)

- [@tsparticles/canvas-utils](https://npm.io/package/@tsparticles/canvas-utils.md) 4.4.0

## Alternatives

- [@tsparticles/shape-image](https://npm.io/package/@tsparticles/shape-image.md) — 303.7K weekly downloads
- [@tsparticles/shape-line](https://npm.io/package/@tsparticles/shape-line.md) — 233.7K weekly downloads
- [stringify-attributes](https://npm.io/package/stringify-attributes.md) — 58.6K weekly downloads
- [mobile-drag-drop](https://npm.io/package/mobile-drag-drop.md) — 46.3K weekly downloads
- [@comunica/actor-rdf-parse-html](https://npm.io/package/@comunica/actor-rdf-parse-html.md) — 29.2K weekly downloads

## Recent versions

- 4.4.0 (latest) — 2026-08-31
- 4.0.0-beta.17 (beta) — 2026-05-15
- 4.0.0-alpha.28 (alpha) — 2026-03-15
- 3.0.2 (next) — 2023-12-06
- 4.3.2 — 2026-07-10
- 4.3.1 — 2026-07-01
- 4.3.0 — 2026-06-27
- 4.2.1 — 2026-06-19
- 4.2.0 — 2026-06-17
- 4.1.3 — 2026-06-03
- 4.1.2 — 2026-06-01
- 4.1.1 — 2026-05-31
- 4.1.0 — 2026-05-29
- 4.0.5 — 2026-05-19
- 4.0.4 — 2026-05-19
- … 65 more at https://npm.io/package/@tsparticles/shape-text/versions

## README

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

# tsParticles Text Shape

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

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

```javascript
loadTextShape;
```

### Usage

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

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

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

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

or

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

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

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

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

or

```javascript
import { tsParticles } from "@tsparticles/engine";
import { loadTextShape } from "@tsparticles/shape-text";

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

## Option mapping

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

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

## Common pitfalls

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

---
_Source: https://npm.io/package/@tsparticles/shape-text · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._