Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .npmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
engine-strict = true
use-node-version = 22.22.3

1 change: 1 addition & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,5 @@
"[typescript]": {
"editor.defaultFormatter": "rvest.vs-code-prettier-eslint"
},
"js/ts.tsdk.path": "node_modules/typescript/lib",
}
5 changes: 1 addition & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,10 +100,7 @@ at start up so they are ready when your application is rendered.
```ts
import { RendererMain } from '@solidtv/renderer';

import {
WebGlCoreRenderer,
SdfTextRenderer,
} from '@solidtv/renderer/webgl';
import { WebGlCoreRenderer, SdfTextRenderer } from '@solidtv/renderer/webgl';
import { CanvasTextRenderer } from '@solidtv/renderer/canvas';

const renderer = new RendererMain(
Expand Down
8 changes: 8 additions & 0 deletions eslint.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,14 @@ export default [
'@typescript-eslint/no-unused-vars': 'warn',
'@typescript-eslint/no-empty-object-type': 'warn',
'@typescript-eslint/no-unused-expressions': 'warn',
'@typescript-eslint/no-unused-vars': [
'warn',
{
caughtErrorsIgnorePattern: '^(e|er|err|error)$',
argsIgnorePattern: '^_',
varsIgnorePattern: '^_',
},
],
},
},
{
Expand Down
141 changes: 141 additions & 0 deletions examples/tests/text-jump.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,141 @@
import type { ExampleSettings } from '../common/ExampleSettings.js';
import { waitForLoadedDimensions, waitUntilIdle } from '../common/utils.js';

export async function automation(settings: ExampleSettings) {
await test(settings);
await settings.snapshot();
}

/**
* Diagnostic test for initial text jump risk.
*
* This test focuses on parent-driven jumps: the text node is inside a parent
* container that uses mount/autosize. If parent dimensions change from initial
* frame to loaded frame, its mount translation can cause a visible jump.
*/
export default async function test({ renderer, testRoot }: ExampleSettings) {
testRoot.w = 900;
testRoot.h = 360;
testRoot.color = 0xffffffff;

renderer.createTextNode({
x: 20,
y: 14,
fontFamily: 'Ubuntu',
fontSize: 28,
color: 0x000000ff,
text: 'Text jump diagnostic (parent mount/autosize case)',
parent: testRoot,
});

await runCase({
renderer,
testRoot,
y: 120,
rendererType: 'sdf',
label: 'SDF',
});

await runCase({
renderer,
testRoot,
y: 250,
rendererType: 'canvas',
label: 'Canvas',
});
}

async function runCase({
renderer,
testRoot,
y,
rendererType,
label,
}: {
renderer: ExampleSettings['renderer'];
testRoot: ExampleSettings['testRoot'];
y: number;
rendererType: 'sdf' | 'canvas';
label: string;
}) {
const anchorX = 650;

renderer.createNode({
x: anchorX,
y: y - 40,
w: 1,
h: 80,
color: 0x00000066,
parent: testRoot,
});

const parentContainer = renderer.createNode({
x: anchorX,
y,
mountX: 0.5,
mountY: 0.5,
pivotX: 0.5,
pivotY: 0.5,
autosize: false,
color: 0x00000000,
parent: testRoot,
});

const textNode = renderer.createTextNode({
x: 0,
y: 0,
contain: 'width',
maxWidth: 280,
textAlign: 'center',
forceLoad: true,
fontFamily: 'Ubuntu',
fontSize: 42,
color: 0x003366ff,
textRendererOverride: rendererType,
text: 'JUMP CHECK',
parent: parentContainer,
});

const initialParentW = Math.round(parentContainer.w);
const initialParentH = Math.round(parentContainer.h);

await waitForLoadedDimensions(textNode);
await waitUntilIdle(renderer);

const loadedParentW = Math.round(parentContainer.w);
const loadedParentH = Math.round(parentContainer.h);

const pass =
initialParentW === loadedParentW && initialParentH === loadedParentH;

// Red box = initial parent dimensions, green box = loaded parent dimensions.
renderer.createNode({
x: anchorX - initialParentW / 2,
y: y - initialParentH / 2,
w: initialParentW,
h: initialParentH,
color: 0xff000044,
parent: testRoot,
});

renderer.createNode({
x: anchorX - loadedParentW / 2,
y: y - loadedParentH / 2,
w: loadedParentW,
h: loadedParentH,
color: 0x00ff0044,
parent: testRoot,
});

renderer.createTextNode({
x: 20,
y: y - 32,
fontFamily: 'Ubuntu',
fontSize: 24,
color: pass ? 0x007700ff : 0xaa0000ff,
text:
`${label}: parent initial ${initialParentW}x${initialParentH}, loaded ${loadedParentW}x${loadedParentH} -> ` +
`${pass ? 'PASS' : 'JUMP RISK'}`,
parent: testRoot,
});
}
12 changes: 6 additions & 6 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@
"lint:fix": "pnpm run lint:fix:prettier && pnpm run lint:fix:eslint",
"lint:prettier": "prettier --check \"**/*.{ts,js,cjs,md}\"",
"lint:fix:prettier": "prettier --write \"**/*.{ts,js,cjs,md}\"",
"lint:eslint": "eslint .",
"lint:fix:eslint": "eslint --fix .",
"lint:eslint": "eslint . --ignore-pattern examples",
"lint:fix:eslint": "eslint --fix . --ignore-pattern examples",
"typedoc": "typedoc",
"prepare": "husky install",
"prepack": "pnpm run build",
Expand All @@ -55,7 +55,7 @@
},
"homepage": "https://github.com/solid-tv/renderer#readme",
"devDependencies": {
"@types/node": "^20.19.17",
"@types/node": "^22.19.19",
"@typescript-eslint/eslint-plugin": "^8.44.0",
"@typescript-eslint/parser": "^8.44.0",
"@vitest/coverage-v8": "^2.1.9",
Expand All @@ -65,9 +65,9 @@
"husky": "^8.0.3",
"lint-staged": "^13.3.0",
"prettier": "^2.8.8",
"release-it": "^17.10.0",
"release-it": "^20.0.1",
"typedoc": "^0.28.13",
"typescript": "~5.9.2",
"typescript": "~5.9.3",
"vitest": "^2.1.9",
"vitest-mock-extended": "^2.0.2"
},
Expand All @@ -87,7 +87,7 @@
"README.md",
"scripts"
],
"packageManager": "pnpm@10.17.0",
"packageManager": "pnpm@10.33.4",
"engines": {
"npm": ">= 10.0.0",
"pnpm": ">= 10.17.0",
Expand Down
Loading
Loading