Skip to content

Latest commit

 

History

History
100 lines (68 loc) · 4.15 KB

README.md

File metadata and controls

100 lines (68 loc) · 4.15 KB

canvas-component

Todo

  • add univeersal chromatic config with univesal federated storybook so we can have one chromatic project with multiple storybooks.

  • split Canvas component to separate package

  • enable custom easing functions

  • two.js

    • fix two.update() problem: sometimes two.update() erasing useRenderFrame shapes
    • can we avoid needing to call two.update()? no, but we can centralize to hook
    • is there a way to prevent needing to erase and rewrite two.js shapes.. maybe we don't need to render two.js shapes in a useRenderFrame? looks like only with refs, but this is kind of janky, probably better to describe two.js scene in a useRenderFrame closure, with all elements defined and modify their position each time we create them. Could try extracting two.js components to react components and don't use useRenderFrame at all. maybe that could work

  • finish adding base canvas rendering functionality

    • add text functionality (render text, modify font, direction, etc)

    • add gradient functionality (conic, linear, etc)

    • add image functionality (render images and svgs)

    • add miter limit (with examples, still don't get what that is)

    • finish rotation (make all elements rotatable around center point)

    • add custom rotation point (rotate element around custom center point)

    • add ability to bend vertices of polygons, inverted rect, etc.

    • create clipPath component for creating clips based on polygon (maybe createa clip variant as in createDrawing | creatClip for each functional drawing; allowing any shape to be a clip)

    • fork repo

    • setup chromatic/turborepo again on new repo

    • create vanilla and core packages to extract from react

  • review current code base for opportunities to improve tests

  • add Polygon support for canvas

  • add FreeDrawing support for canvas

  • add chain animations hook to canvas

Repo package structure

Adding a new package

We use plop to generate new packages. therea re 2 options

  • name: the name for the package both in package.json and directory in packages/{{name}}
  • tsconfigPreset: which tsconfig preset to use for the package. choose from one of the named files in packages/tsconfig/*

run yarn generate:package to initiate the CLI. with turborepo, the package should automatically be integrated into the various build/ci pipelines.

Adding a new app

We use plop to generate new apps. there is one option

  • name: the name for the package both in package.json and directory in packages/{{name}}

run yarn generate:app to initiate the CLI. with turborepo, the package should automatically be integrated into the various build/ci pipelines.

Testing

Global tests

  • Test that packages/apps are valid

  • no dupliate package/app names

  • no package/app with root name

  • all apps have -- jest.config.js -- tsconfig.json -- .eslintrc.js -- package.json scripts

  • all packages have: -- tsconfig.json -- .eslintrc.js -- package.json scripts -- package.json jest preset

Packages

UI

https://623670d49b1e54004a0be84c-tsfuqaennc.chromatic.com/

Chromatic

  • chromatic allows only one project per repository so we have to either, use 1 storybook for all stories, or trigger chromatic manually
  • we can use turbo repo to trigger manually
  • we can use environment variables to set branch and appId
  • there is an issue with playwrite and stale node_modules so I've disabled the npm cache until it is fixed

links:

Solution:

  • split test and storybook-test to allow normal jest runs to happen in the CI job.
  • storybook-test is a separate command that can be run manually for local testing.
  • the storybook interaction tets are run automatically during chromatic builds
  • we can trigger multiple chromatic builds with a single job using turbo repo and project specific environment variables