text-svg
v1.0.5
Published
Convert text to SVG for node.js
Downloads
680
Readme
text-svg: Text to SVG generator for Node.js
textToSvg('Create png image\nfrom multi-line text!');
Quick start
text-svg depends on node-canvas. See node-canvas wiki on installing node-canvas.
$ npm install text-svg
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.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 object.
If you want to use any custom fonts without installing, use localFontPath
and localFontName
property.
text2Svg('with custom fonts', {
font: '50px Lobster',
localFontPath: 'fonts/Lobstar-Regular.ttf',
localFontName: 'Lobster'
});
Command line interface
$ npm install -g text-svg
$ text2Svg --help
$ text2Svg -t "Hello!" -o "output.svg"
Example
text2Svg('Example\nText', {
font: '80px Futura',
color: 'teal',
backgroundColor: 'linen',
lineSpacing: 10,
padding: 20
});
Enjoy!