npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

canvas-text-block

v1.1.3

Published

Easily render a wrapping block of text in an HTML Canvas Element.

Downloads

30

Readme

canvas-text-block

Example image generated with canvas-text-block

Easily render a wrapping block of text in an HTML Canvas Element or Node Canvas

Motivation

  • There are ways to render individual lines of text in canvas, but not a wrapping text block. This package solves this problem.
  • There are some packages out there that do this in a way, but this implementation adds the ability to specify the lineHeight and other styling configurations.

Usage

Installation

Install the package:

npm install canvas-text-block

Importing

You can import the package as a module:

import CanvasTextBlock from "canvas-text-block";

Or as CommonJS:

const CanvasTextBlock = require("canvas-text-block");

Additionally, there is a UMD build (/dist/CanvasTextBlock.js) for use in the browser:

<script src="node_modules/canvas-text-block/dist/CanvasTextBlock.js"></script>

It is recommended to use something like Gulp or Browserify if you intend on using Canvas Text Block in the browser.

Usage

import CanvasTextBlock from 'canvas-text-block'

...

// Create your canvas
const canvas = document.createElement("canvas");
canvas.width = 1000;
canvas.height = 1000;

const options = {
  fontSize: 50,
}

// Init the package.
const textBlock = new CanvasTextBlock(
  canvas, // An HTML Canvas Element
  100, // The x position of the canvas where the text block should start
  100, // The y position of the canvas where the text block should start
  800, // The width of the text block
  800, // The height of the text block
  options // An optional options config object
);

// Set the text
textBlock.setText(
  "This text block will be rendered in the region specified in the constructor above"
);

Options

const defaultOptions = {
  color: "#fff", // Set the color of the text block
  fontFamily: "arial", // Set the font family of the text block
  fontSize: 16, // Set the font size in pixels
  lineHeight: 24, // Set the text line height in pixels
  padding: 0, // The padding around the text box in pixels
  backgroundColor: "transparent", // Set a background color for the text block
  weight: "normal", // Set the font weight
  overflow: false, // Should the package overflow lines that do not fit in the text block
  ellipsis: true, // If overflow is off, should the last word of the text block have an ellipsis?
};

Examples

For examples, please take a look in the examples directory.

License

This project is licensed under the MIT license.