# text-svg

> Convert text to SVG for node.js

Latest version **3.0.3** (published 2026-07-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install text-svg
pnpm add text-svg
yarn add text-svg
bun add text-svg
```

## Health

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

Positive: has types; esm support; no vulnerabilities; has provenance; high quality score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 3.0.3 |
| Published | 2026-07-28 |
| First published | 2020-02-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 22.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 11 |
| Author | Aditya Patadia |
| Maintainers | adityapatadia |
| Keywords | text, svg, typescript |

## Links

- npm: https://www.npmjs.com/package/text-svg
- Repository: https://github.com/gumlet/text-svg
- Homepage: https://github.com/gumlet/text-svg#readme
- Issues: https://github.com/gumlet/text-svg/issues
- npm.io page: https://npm.io/package/text-svg

## Dependencies (1)

- [canvas](https://npm.io/package/canvas.md) ^3.1.0

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 3.0.3 (latest) — 2026-07-28
- 3.0.2 — 2026-07-28
- 3.0.1 — 2025-10-25
- 3.0.0 — 2025-08-01
- 2.0.1 — 2025-04-10
- 2.0.0 — 2025-04-08
- 1.0.7 — 2025-04-08
- 1.0.6 — 2025-04-08
- 1.0.5 — 2024-06-16
- 1.0.4 — 2021-09-08
- 1.0.3 — 2021-03-02
- 1.0.2 — 2020-02-11
- 1.0.1 — 2020-02-08
- 1.0.0 — 2020-02-07

## README

[![NPM Version](https://img.shields.io/npm/v/text-svg)](https://www.npmjs.com/package/text-svg)

# text-svg: Text to SVG generator for Node.js

```js
textToSvg('Create svg image\nfrom multi-line text!');
```

![text2svg](./img/text2svg.svg)

## Quick start

text-svg depends on [node-canvas](https://github.com/Automattic/node-canvas).
See [node-canvas wiki](https://github.com/Automattic/node-canvas/wiki) on installing node-canvas.

```
$ npm install text-svg
```

```js
var fs = require('fs');
var text2Svg = require('text-svg');
fs.writeFileSync('out.svg', text2Svg('Hello!', {color: 'blue'}));
```

## Option

``text2svg(text, option)``

|param|default|
|---|---|
|text|(required)|
|option.font|'30px sans-serif'|
|option.textAlign|'left'|
|option.color (or option.textColor)|'black'|
|option.backgroundColor (or option.bgColor)|'transparent'|
|option.lineSpacing|0|
|option.strokeWidth|0|
|option.strokeColor|'white'|
|option.padding|0|
|option.padding(Left\|Top\|Right\|Bottom)|0|
|option.borderWidth|0|
|option.border(Left\|Top\|Right\|Bottom)Width|0|
|option.borderColor|'black'|
|option.localFontPath||
|option.localFontName||
|option.output|'buffer'|
|option.width||
|option.height||

``option.color = '#000' | 'rgb(0, 0, 0)' | 'black' | ...``

``option.output = 'buffer' | 'stream' | 'dataURL' | 'canvas'``

``option.strokeWidth = 1 | 2 | ... `` A padding may have to be set to avoid cutoff of stroke

``'canvas'`` returns [node-canvas](https://github.com/Automattic/node-canvas) object.

If you want to use any custom fonts without installing, use `localFontPath` and `localFontName` property.

```js
text2Svg('with custom fonts', {
  font: '50px Lobster',
  localFontPath: 'fonts/Lobstar-Regular.ttf',
  localFontName: 'Lobster'
});
```

## Example

```js
text2Svg('Example\nText', {
  font: '80px Futura',
  color: 'teal',
  backgroundColor: 'linen',
  lineSpacing: 10,
  padding: 20
});
```

![ExampleText](./img/exampleText.png)

Enjoy!

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