Skip to content

Commit 2c1f7c6

Browse files
committed
Initial commit
0 parents  commit 2c1f7c6

21 files changed

+1089
-0
lines changed

.gitattributes

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Auto detect text files and perform LF normalization
2+
* text=auto

.gitignore

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
# Logs
2+
logs
3+
*.log
4+
npm-debug.log*
5+
yarn-debug.log*
6+
yarn-error.log*
7+
lerna-debug.log*
8+
.pnpm-debug.log*
9+
10+
# Diagnostic reports (https://nodejs.org/api/report.html)
11+
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
12+
13+
# Runtime data
14+
pids
15+
*.pid
16+
*.seed
17+
*.pid.lock
18+
19+
# Directory for instrumented libs generated by jscoverage/JSCover
20+
lib-cov
21+
22+
# Coverage directory used by tools like istanbul
23+
coverage
24+
*.lcov
25+
26+
# nyc test coverage
27+
.nyc_output
28+
29+
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
30+
.grunt
31+
32+
# Bower dependency directory (https://bower.io/)
33+
bower_components
34+
35+
# node-waf configuration
36+
.lock-wscript
37+
38+
# Compiled binary addons (https://nodejs.org/api/addons.html)
39+
build/Release
40+
41+
# Dependency directories
42+
node_modules/
43+
jspm_packages/
44+
45+
# Snowpack dependency directory (https://snowpack.dev/)
46+
web_modules/
47+
48+
# TypeScript cache
49+
*.tsbuildinfo
50+
51+
# Optional npm cache directory
52+
.npm
53+
54+
# Optional eslint cache
55+
.eslintcache
56+
57+
# Optional stylelint cache
58+
.stylelintcache
59+
60+
# Microbundle cache
61+
.rpt2_cache/
62+
.rts2_cache_cjs/
63+
.rts2_cache_es/
64+
.rts2_cache_umd/
65+
66+
# Optional REPL history
67+
.node_repl_history
68+
69+
# Output of 'npm pack'
70+
*.tgz
71+
72+
# Yarn Integrity file
73+
.yarn-integrity
74+
75+
# dotenv environment variable files
76+
.env
77+
.env.development.local
78+
.env.test.local
79+
.env.production.local
80+
.env.local
81+
82+
# parcel-bundler cache (https://parceljs.org/)
83+
.cache
84+
.parcel-cache
85+
86+
# Next.js build output
87+
.next
88+
out
89+
90+
# Nuxt.js build / generate output
91+
.nuxt
92+
dist
93+
94+
# Gatsby files
95+
.cache/
96+
# Comment in the public line in if your project uses Gatsby and not Next.js
97+
# https://nextjs.org/blog/next-9-1#public-directory-support
98+
# public
99+
100+
# vuepress build output
101+
.vuepress/dist
102+
103+
# vuepress v2.x temp and cache directory
104+
.temp
105+
.cache
106+
107+
# Docusaurus cache and generated files
108+
.docusaurus
109+
110+
# Serverless directories
111+
.serverless/
112+
113+
# FuseBox cache
114+
.fusebox/
115+
116+
# DynamoDB Local files
117+
.dynamodb/
118+
119+
# TernJS port file
120+
.tern-port
121+
122+
# Stores VSCode versions used for testing VSCode extensions
123+
.vscode-test
124+
125+
# yarn v2
126+
.yarn/cache
127+
.yarn/unplugged
128+
.yarn/build-state.yml
129+
.yarn/install-state.gz
130+
.pnp.*

docs/test-images/browser.png

625 KB
Loading

docs/test-images/out.png

111 KB
Loading

license.txt

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 Fyris
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

package.json

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{
2+
"license": "MIT",
3+
"author": "Fyris",
4+
"type": "module",
5+
"dependencies": {
6+
"@types/node": "^22.13.2",
7+
"@types/opentype.js": "^1.3.8",
8+
"opentype.js": "^1.3.4",
9+
"yoga-layout": "^3.2.1",
10+
"canvas": "^3.1.0",
11+
"lorem-ipsum": "^2.0.8",
12+
"vite": "^6.1.0"
13+
}
14+
}

readme.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# Boxes
2+
3+
An experimental canvas renderer for "web-ish" node trees
4+
5+
<img src="docs/test-images/browser.png" width="400px"/>
6+
7+
Current features:
8+
9+
- Custom style tree with inheritance inspired by CSS
10+
- Multi-line text with wrapping via [opentype.js]()
11+
- Flexbox layout via [yoga](https://www.yogalayout.dev/)
12+
- Works in browsers and with [node-canvas](https://www.npmjs.com/package/canvas)
13+
14+
**Note:** Boxes is an early work in progress and all APIs are subject to change at any time.
15+
16+
## Example
17+
18+
This image above was generated with `test/main-shared.ts`, boxes takes a node tree describing the scene and renders it to a canvas, here's the code for this scene:
19+
20+
```ts
21+
const pageStyle: Partial<StyleData> = {
22+
padding: 32, gap: 32, bg: '#001', color: '#fff'
23+
};
24+
25+
const containerStyle: Partial<StyleData> = {
26+
dir: 'row', wrap: true, gap: 8,
27+
justifyContent: 'space-between', alignItems: 'center',
28+
};
29+
30+
const numberStyle: Partial<StyleData> = {
31+
bg: '#f9ca2433', color: '#f9ca24',
32+
justifyContent: 'center', alignItems: 'center',
33+
fontSize: 32, width: 50, aspectRatio: 1, borderRadius: 25,
34+
};
35+
36+
const loremStyle: Partial<StyleData> = {
37+
bg: '#fff2', fontSize: 16, padding: 16, width: 200,
38+
};
39+
40+
const innerContent = () => {
41+
const items = repeat(10, (i) => [
42+
box(numberStyle, [text({ fontSize: 32 }, i.toString())]),
43+
text(loremStyle, lorem())
44+
]);
45+
return shuffle(items.flat());
46+
};
47+
48+
export const scene = () => {
49+
return box(pageStyle, [
50+
text({ fontSize: 32 }, 'Hi, this is boxes!'),
51+
text({ fontSize: 16 }, `An experimental canvas renderer for "web-ish" node trees. Here's a bunch of shuffled items in a wrapping flex container:`),
52+
box(containerStyle, innerContent()),
53+
]);
54+
};
55+
```
56+
57+
With `test/main-node.ts`, the same scene can be rendered to a file, without the browser:
58+
59+
<img src="docs/test-images/out.png" width="400px"/>

src/canvas.ts

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
export function traceRoundedRect(
2+
ctx: CanvasRenderingContext2D,
3+
width: number,
4+
height: number,
5+
radius: number
6+
) {
7+
if (radius == 0) {
8+
ctx.rect(0, 0, width, height);
9+
return;
10+
}
11+
12+
if (radius == width / 2) {
13+
ctx.arc(width / 2, height / 2, radius, 0, Math.PI * 2);
14+
return;
15+
}
16+
17+
ctx.moveTo(radius, 0);
18+
ctx.lineTo(width - radius, 0);
19+
ctx.quadraticCurveTo(width, 0, width, radius);
20+
ctx.lineTo(width, height - radius);
21+
ctx.quadraticCurveTo(width, height, width - radius, height);
22+
ctx.lineTo(radius, height);
23+
ctx.quadraticCurveTo(0, height, 0, height - radius);
24+
ctx.lineTo(0, radius);
25+
ctx.quadraticCurveTo(0, 0, radius, 0);
26+
}

0 commit comments

Comments
 (0)