`onFocusChange` fires again after each render, also when the focused point does not change
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 新手友好度
- 68/100
- Issue 类型
- 缺陷
- 描述清晰度
- 描述清楚
- 活跃度
- 活跃
- 技术栈
- react, typescript
调研方向
Start with the focus restoration and callback logic in dist/renderer.js around lines 157–172, then follow how a definition update reaches the renderer. Check whether tests cover repeated renders with an unchanged focused-point key and focus groups. Done means callbacks fire when focus identity changes, but not when a render restores the same focus.
由索引模型根据 Issue 内容生成。
描述
Version: @tanstack/charts 1.0.0, React adapter (@tanstack/charts/react)
Problem
After each render that had a focused point, the renderer calls onFocusChange and onFocusGroupChange again. It does this also when the focused point has the same key as before. The point is a new object each time, because restoreChartFocusPoint returns the point from the new scene.
In dist/renderer.js (about lines 157 to 172):
const nextFocusedPoints = trackedPointer
? resolvePointerFocus(...)
: previousFocusedPoint
? (() => {
const restored = restoreChartFocusPoint(presentedPoints, previousFocusedPoint);
return restored ? focusPointsForPoint(restored, presentedPoints) : [];
})()
: [];
const nextFocusedPoint = nextFocusedPoints[0] ?? null;
...
if (previousFocusedPoint || nextFocusedPoint || previousCursorPresentation) {
...
options.onFocusChange?.(nextFocusedPoint);
options.onFocusGroupChange?.(nextFocusedPoints);
}
A render occurs when the definition identity changes (definitionChanged in renderer.js, about line 686). In React, a definition that is not memoized, or a memo dependency that changes with the focus, causes a new render.
The usual React pattern is to put the focused point in state. With that pattern, the result is a render loop:
- The pointer focuses a point.
onFocusChange(point)callssetFocused(point). - React renders again. Something in the definition depends on the focus (for example a highlighted series), so the definition is a new object.
- The adapter calls
update. The renderer restores the same point as a new object and callsonFocusChange(newObject). setFocused(newObject)does not bail out, because the object is new. Go to step 2.
Minimal repro
import { useMemo, useState } from 'react';
import { defineChart, lineY, type ChartPoint } from '@tanstack/charts';
import { Chart } from '@tanstack/charts/react';
import { scaleLinear } from '@tanstack/charts/scales/linear';
import { tooltip } from '@tanstack/charts/tooltip';
const rows = [
{ x: 0, y: 1 },
{ x: 1, y: 3 },
{ x: 2, y: 2 },
];
let renders = 0;
export function Repro() {
const [focused, setFocused] = useState<ChartPoint | null>(null);
// The definition depends on the focus, which is a normal thing to do.
const definition = useMemo(
() =>
defineChart({
marks: [
lineY(rows, {
x: 'x',
y: 'y',
strokeWidth: focused ? 3 : 1,
}),
],
scales: { x: { scale: scaleLinear }, y: { scale: scaleLinear } },
tooltip,
}),
[focused],
);
console.log('render', ++renders);
return (
<Chart
definition={definition}
ariaLabel="Repro"
width={400}
height={200}
onFocusChange={setFocused}
/>
);
}
Move the pointer over a point and keep it there.
Expected
onFocusChange fires once when the focused point changes. It does not fire again when a render restores the same point.
Actual
onFocusChange fires after every render with a new point object for the same key. The component renders again and again while the pointer stays on the point.
Our workaround
We store a primitive, so React bails out of the state update:
const handleFocusChange = useCallback((point: ChartPoint | null) => {
setActiveIndex(point ? point.datumIndex : null);
}, []);
This works, but each consumer must know about it. Nothing in the docs tells you about the risk.
Suggested fix
Call onFocusChange and onFocusGroupChange only when the focus identity changes, for example with sameChartPointIdentity(previousFocusedPoint, nextFocusedPoint) and the same check on each point of the group. If a re-emit on each render is intentional, please document it in the React reference for onFocusChange, next to the memoization guidance from https://github.com/TanStack/charts/pull/111.
Related
- https://github.com/TanStack/charts/pull/111 (docs: React definition ownership and memoization)
Written by an agent (Claude Code, claude-opus-5-5).
- 主要语言
- TypeScript
- 星标
- 769
- 派生
- 47
- 平均合并
- 6 小时 9 分钟
- 30 天内合并 PR
- 20
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
TanStack/charts 的其他 Issue
-
难度 1/5 1 小时以内 新手友好度 85/100
维护者通常 1 天内回复
-
brushX with `values` can shorten the selection range when it’s dragged to the plot edge可能已有人在做 @andersk 于 2 天前认领。 未关闭
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 1 天内回复
-
难度 5/5 一周以上 新手友好度 35/100
维护者通常 1 天内回复
-
难度 4/5 3-5 天 新手友好度 54/100
维护者通常 1 天内回复
-
难度 4/5 3-5 天 新手友好度 52/100
维护者通常 1 天内回复
相似的 Issue
-
community first-timers-only good first issue hacktoberfest help wanted low hanging fruit up-for-grabs
难度 1/5 1 小时以内 新手友好度 75/100
lingdojo/kana-dojo#32018 · 1 条评论 · 5 个 reaction ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 72/100
paperclipai/paperclip#15751 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 72/100
BuilderIO/agent-native#7275 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 74/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 65/100
维护者通常 1 天内回复