Skip to content
forked from LingDong-/q5xjs

A small and fast alternative (experimental) implementation of p5.js in Typescript

License

Notifications You must be signed in to change notification settings

dchicchon/q5xts

 
 

Repository files navigation

q5.ts

This project is an TypeScript implementation of the q5xjs project.

Installation

npm i q5xts

Usage

import { Q5 } from 'q5xts';

export class Drawing extends Q5 {
  constructor(
    scope: 'global' | 'offscreen' | '',
    elm: HTMLElement,

  ) {
    super(scope, elm);
    this.setup = () => {
        console.log('setup function here')
        this.frameRate(60);
    };

    this.draw = () => {
        console.log('draw function here')
        this.rect(0,0,100,100)
    };
  }
}

Limitations

Currently this package does not provide the full usage of the original q5xjs package. Here we focus on utilizing it in a specified element scope and not the global scope.

This package is a work in progress and should include the capabilities of the original project later on

Docs

[TODO: explain Q5 constructor function]

Refer to the original website or the original github repo

Sandbox

You can view the sandbox environment here: https://dchicchon.github.io/q5xts/

Example Projects

Links

About

A small and fast alternative (experimental) implementation of p5.js in Typescript

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 98.3%
  • CSS 1.1%
  • Other 0.6%