canvas-size
DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/canvas-size package

2.0.0 • Public • Published

canvas-size

NPM GitHub Workflow Status (master) Codacy code quality Codacy branch coverage License: MIT jsDelivr Sponsor this project

Determine the maximum area, height, width, and custom dimensions of an HTML <canvas> element.

Why?

The HTML canvas element is widely supported by modern and legacy browsers, but each browser and platform combination imposes unique size limitations (see Test Results) that will render a canvas unusable when exceeded. Unfortunately, browsers do not provide a way to determine what their limitations are, nor do they provide any kind of feedback after an unusable canvas has been created. This makes working with large canvas elements a challenge, especially for applications that support a variety of browsers and platforms.

This micro-library provides the maximum area, height, and width of an HTML canvas element supported by the browser as well as the ability to test custom canvas dimensions. By collecting this information before a new canvas element is created, applications are able to reliably set canvas dimensions within the size limitations of each browser/platform.

Features

  • Determine the maximum <canvas> area, height, and width
  • Test custom <canvas> dimensions
  • Web worker + OffscreenCanvas support
  • UMD and ES6 module available
  • Lightweight (< 1k min+gzip) and dependency-free

Browser Support

Chrome logo Chrome 4+
Edge logo Edge 12+
Firefox logo Firefox 3.6+
Safari logo Safari 4+
Internet Explorer logo Internet Explorer 10+

Installation

NPM

npm install canvas-size
import canvasSize from 'canvas-size';

CDN

Available on jsdelivr (below), unpkg, and other CDN services that auto-publish npm packages.

<!-- ES Module (latest v2.x.x) -->
<script
  type="module"
  src="https://cdn.jsdelivr.net/npm/canvas-size@2/dist/canvas-size.esm.min.js"
></script>
<!-- Global "canvasSize" (latest v2.x.x) -->
<script src="https://cdn.jsdelivr.net/npm/canvas-size@2"></script>

💡 Note the @ version lock in the URLs above. This prevents breaking changes in future releases from affecting your project and is therefore the safest method of loading dependencies from a CDN. When a new major version is released, you will need to manually update your CDN URLs by changing the version after the @ symbol.

Usage & Options

See the documentation site for details.

Sponsorship

A sponsorship is more than just a way to show appreciation for the open-source authors and projects we rely on; it can be the spark that ignites the next big idea, the inspiration to create something new, and the motivation to share so that others may benefit.

If you benefit from this project, please consider lending your support and encouraging future efforts by becoming a sponsor.

Thank you! 🙏🏻

Contact & Support

  • Follow 👨🏻‍💻 @jhildenbiddle on Twitter and GitHub for announcements
  • Create a 💬 GitHub issue for bug reports, feature requests, or questions
  • Add a ⭐️ star on GitHub and 🐦 tweet to promote the project
  • Become a 💖 sponsor to support the project and future efforts

License

This project is licensed under the MIT License. See the LICENSE for details.

Copyright (c) John Hildenbiddle (@jhildenbiddle)

Package Sidebar

Install

npm i canvas-size

Weekly Downloads

34,075

Version

2.0.0

License

MIT

Unpacked Size

127 kB

Total Files

11

Last publish

Collaborators

  • jhildenbiddle