https://github.com/kodie/spontaneous-text

A node module that draws the provided text string onto the provided image in a random font, color, size, and position.
https://github.com/kodie/spontaneous-text

canvas draw font image javascript nodejs picture random text

Last synced: about 2 months ago
JSON representation

A node module that draws the provided text string onto the provided image in a random font, color, size, and position.

• Host: GitHub
• URL: https://github.com/kodie/spontaneous-text
• Owner: kodie
• License: mit
• Created: 2017-01-10T14:42:34.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2017-01-27T16:33:08.000Z (almost 8 years ago)
• Last Synced: 2024-11-06T17:24:06.654Z (2 months ago)
• Topics: canvas, draw, font, image, javascript, nodejs, picture, random, text
• Language: JavaScript
• Size: 8.79 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# spontaneous-text [![npm version](https://badge.fury.io/js/spontaneous-text.svg)](https://badge.fury.io/js/spontaneous-text)

A node module that draws the provided text string onto the provided image in a random font, color, size, and position.

## Installation

`npm install spontaneous-text --save`

## Usage

```javascript

var imgText = require('spontaneous-text');

var image = 'img/original_image.jpg';

var text = 'My Awesome Text!';

var options = {

	file: 'img/new_image.png',

    padding: 5

};

imgText(image, text, options, function(err, res) {

  if (!err) {

    console.log(res);

  } else { console.log(new Error(err)); }

});

```

## Parameters

`image` - The image to draw the text onto. Can be a file path or an image buffer.

`text` - The text string to draw onto the image.

`options` - The options object to set the options explained below. (Optional)

## Options

`padding` - The number of pixels that is off-limits to text around the edge of the image.

`file` - If specified, the image will be saved to this file.

`mute` - Set to `true` to mute console output.

## Default Options

```json

{

  "padding": 10,

  "file": "",

  "mute": false

}

```

## Return

Here's an example of what the response will look like:

```

{

	image: ,

	font: 'Alike',

	color: '#59e060',

	width: 1197,

	height: 916,

	box: {

		width: 743,

        height: 268,

        x: 286,

        y: 81

	}

}

```

`image` - The image buffer.

`font` - The font name used.

`color` - The font color used.

`width` - The image width.

`height` - The image height.

`box` - The bounding box decided for the text.

## License

MIT. See the License file for more info.