New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More
Socket
Sign inDemoInstall
Socket

@georgedoescode/cx

Package Overview
Dependencies
Maintainers
1
Versions
7
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@georgedoescode/cx

CX 🎨

  • 1.0.4
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
2
Maintainers
1
Weekly downloads
 
Created
Source

CX 🎨

A 💀 simple library created to provide a better canvas development experience.

Why?

There are a couple of things I wish canvas did:

  • Scale to the DPR of the screen
  • Allow definition of custom drawing methods

CX aims to provide both of these whilst staying out of the way and not disrupting your workflow.

Installation

1. Package Manager

# npm
npm i @georgedoescode/cx

2. CDN

<script src="https://unpkg.com/@georgedoescode/cx">

Usage

The (probably) easiest and quickest way of getting started with cx is to grab the library from unpkg, pop it in a script tag and start having a poke.

Here is an example:

<!DOCTYPE html>
<html lang="en">
    <head>
        <meta charset="UTF-8" />
        <meta name="viewport" content="width=device-width, initial-scale=1.0" />
        <title>CX Example</title>
    </head>
    <body>
        <div class="wrapper"></div>
        <script src="https://unpkg.com/@georgedoescode/cx"></script>
        <script>
            // Create a new canvas, append to the DOM
            const { ctx } = cx.createCanvas();

            // Draw as you usually would!
            ctx.moveTo(0, 0);
            ctx.lineTo(200, 200);
        </script>
    </body>
</html>

Usage with module bundlers

CX exports the function createCanvas, this can be used to build a new cx instance.

import { createCanvas } from '@georgedoescode/cx';

// Create a new canvas, append to the DOM
const { ctx } = createCanvas();

// Draw as you usually would!
ctx.moveTo(0, 0);
ctx.lineTo(200, 200);

Note: CX provides an es module (cx.es.js) build which should be used by Webpack 2+ / rollup etc, for everything else there is a UMD build (cx.min.js).

Documentation

createCanvas

Creates a new cx instance.

Options:
NameTypeDefaultDescription
widthInteger400The width of the canvas
heightInteger400The height of the canvas
mountDOM Elementdocument.bodyWhere the canvas element is appended
dprIntegerwindow.devicePixelRatioMutliplier for canvas dimensions
Returns:
{
    ctx: {
        base, //  CanvasRenderingContext2D
        registerCustomMethod // (fn) - register custom drawing method
    },
    element: {
        el, // <canvas> DOM element
        setPXDensity // (fn) - scale <canvas> element and context
    }
}

registerCustomMethod

FAQs

Package last updated on 01 Apr 2020

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc