# @mystroken/canvas

> Object oriented canvas 2D rendering in JavaScript.

Latest version **0.0.6** (published 2020-01-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install @mystroken/canvas
pnpm add @mystroken/canvas
yarn add @mystroken/canvas
bun add @mystroken/canvas
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.6 |
| Published | 2020-01-19 |
| First published | 2019-09-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 5.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Mystro Ken |
| Maintainers | mystroken |
| Keywords | javascript, canvas, 2d, library, creativecoding |

## Links

- npm: https://www.npmjs.com/package/@mystroken/canvas
- Repository: https://github.com/mystroken/canvas
- Homepage: https://github.com/mystroken/canvas#readme
- Issues: https://github.com/mystroken/canvas/issues
- npm.io page: https://npm.io/package/@mystroken/canvas

## Alternatives

- [exif-parser](https://npm.io/package/exif-parser.md) — 3.8M weekly downloads
- [vite-plugin-compression](https://npm.io/package/vite-plugin-compression.md) — 569.5K weekly downloads
- [pica](https://npm.io/package/pica.md) — 442.4K weekly downloads
- [@reportportal/client-javascript](https://npm.io/package/@reportportal/client-javascript.md) — 408.8K weekly downloads
- [@tldraw/state](https://npm.io/package/@tldraw/state.md) — 316.0K weekly downloads

## Recent versions

- 0.0.6 (latest) — 2020-01-19
- 0.0.5 — 2019-12-21
- 0.0.4 — 2019-10-07
- 0.0.3 — 2019-09-07
- 0.0.2 — 2019-09-06
- 0.0.1 — 2019-09-06

## README

# Canvas

[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/mystroken/canvas/issues)

> :kiwi_fruit: Object oriented canvas 2D rendering in JavaScript.

<br>

## Installation

```bash
npm install @mystroken/canvas
```

<br>

## Usage

Look at the sources files for more information.

###### Import

```javascript

import Canvas from '@mystroken/canvas';
import Renderable from '@mystroken/canvas/Renderable'; 
```

###### Create a renderable.

```javascript
class Circle extends Renderable {

    render(ctx) {
        ctx.beginPath();
        ctx.arc(110, 110, 25, Math.PI * 2, false);
        ctx.closePath();

        ctx.stroke();
    }
}
```

###### Add renderables on the canvas.

```javascript
const canvas = new Canvas(document.querySelector('#canvas'));

// Get some renderables.
const circle = new Circle();
const rect = new Rectangle();

// Adds renderables to canvas.
canvas.add(circle);
canvas.add(rect);

// Render the canvas.
canvas.render();
```

---
_Source: https://npm.io/package/@mystroken/canvas · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
