Package Exports

canvas-txt

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (canvas-txt) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Canvas Txt

A library to print multiline text on HTML5 canvas with better line breaks and alignments 🆎

Install

npm install canvas-txt --save

Usage

import canvasTxt from "canvas-txt";

var c = document.getElementById("myCanvas");
var ctx = c.getContext("2d");

var txt = "Lorem \n ipsum dolor sit amet";

canvasTxt.drawText(ctx,txt,100,200,200,200);
//canvasTxt.drawText(ctx,txt,x,y,width,height);

Properties

Properties	Default	Description
`debug`	`false`	Shows the border and align gravity for debugging purposes
`align`	`center`	Text align. Other possible values: `left`, `right`
`textSize`	`14`	Font size of the text in px
`font`	`Arial`	Font family of the text
`lineHeight`	`null`	Line height of the text, if set to null it tries to auto-detect the value

Methods

Method	Description
`drawText(ctx,text,x,y,width,height)`	To draw the text to the canvas
`arrayMaker(text)`	Split the text into an array based on `\n`

Example

import canvasTxt from "canvas-txt";

var c = document.getElementById("myCanvas");
var ctx = c.getContext("2d");

//You can use \n to define custom line breaks
var txt = "Lorem \nipsum dolor sit amet";

//You can also use other methods alongside this
ctx.fillStyle = "#ff0000"; //red color text

canvasTxt.font = "Verdana";
canvasTxt.textSize = 20;
canvasTxt.align = "left";
canvasTxt.lineHeight = 60;
canvasTxt.debug = true; //shows debug info
canvasTxt.drawText(ctx,txt,100,200,200,200)