[Bug] Focus ownership: Escape does not clear keyboard focus, a pointer pass loses it, and controlled focus survives pointer leave

Ouverte
#189 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

Personne n'a encore pris cette issue.

Évaluation

Difficulté
3/5
Temps estimé
Une demi-journée
Accessibilité débutants
55/100
Type d'issue
Bug
Clarté
Clairement spécifiée
Activité
Active
Stack technique
d3, typescript

Piste de recherche

Start by running packages/charts-core/test-repro/04-keyboard-focus-min.test.ts from the repo root; both cases A and B fail on the current commit. For A, look at the Escape branch in handleKeyDown in packages/charts-core/src/renderer.ts and at dismissTooltip, then at the Escape handling in interaction.ts. For B, follow focusOwner through the pointer-move and mouseleave handlers and setControlledFocus in renderer.ts, and the ChartFocusSource type in dom-types.ts and types.ts. Done when both tests pass without breaking the existing focus tests.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

Version: @tanstack/charts 1.1.0 (57774e1).

The renderer tracks who owns focus (focusOwner: pointer, keyboard, controlled), but three transitions are wrong. With keyboard focus on the chart SVG (Tab), Escape does nothing (A), and a pointer passing over the chart drops the keyboard position, so the next arrow restarts at index 0 (B). Focus set through the controller from a pointer resolution is never cleared when the pointer leaves (C). All three are in the same ownership logic in renderer.ts.

A. Escape does not dismiss keyboard focus

Expected: Escape clears focus (tooltip, guides, onFocusChange(null)), DOM focus stays on the SVG, and the next arrow resumes navigation. Escape is also missing from the key list in tooltips-and-focus.md:654.

B. A pointer pass loses keyboard focus

Expected: keyboard focus survives a pointer pass and the next arrow continues from it.

C. Controlled focus from a pointer resolution survives pointer leave (from this comment)
  • mouseleave and pointercancel run clearPointerFocus, which acts only when focusOwner === 'pointer' (renderer.ts:764-781, bound at renderer.ts:964-965).
  • ChartControlledFocusOptions.source only labels the focus for marks and tooltips (dom-types.ts:72-77, renderer.ts:688-690); it does not hand ownership to the pointer.
  • Example: after a drill-down zoom no pointer event fires, so the app re-resolves focus for the still pointer with interaction.setControlledFocus(interaction.resolvePointer(x, y)). When the pointer then leaves, focus, tooltip and dimming stay. Read from source, not run.

Expected: focus set from a pointer resolution is cleared on pointer leave, like pointer focus.

Repro (A and B)

Save as packages/charts-core/src/repro.test.ts, run pnpm vitest run packages/charts-core/src/repro.test.ts. The tests assert the expected behaviour.

import { expect, it, vi } from 'vitest'
import { scaleLinear } from 'd3-scale'
import { dot } from './dot'
import { mountChartRenderer } from './renderer'
import { defineChart } from './scene'

const data = [0, 1, 2].map((x) => ({ x }))
const definition = defineChart({
  marks: [dot(data, { x: 'x', y: 'x', key: (d) => String(d.x) })],
  scales: { x: { scale: scaleLinear().domain([0, 2]) }, y: { scale: scaleLinear().domain([0, 2]) } },
  guides: false,
})
function setup() {
  const el = document.createElement('div')
  const surface: any = { element: el, render: () => { el.tabIndex = 0 }, paintFocus() {}, destroy() {},
    clientToScene: (s: any) => ({ x: s.points[0].x, y: s.points[0].y }) }
  const renderer: any = { id: 't', prerender: () => '', mount: (c: HTMLElement) => (c.append(el), surface) }
  const onFocusChange = vi.fn()
  const root = document.body.appendChild(document.createElement('div'))
  mountChartRenderer(root, { definition, renderer, width: 400, height: 300, ariaLabel: 'g', onFocusChange })
  const fire = (e: Event) => el.dispatchEvent(e)
  fire(new FocusEvent('focusin', { bubbles: true })) // Tab into the SVG
  return {
    fire, root,
    key: (key: string) => fire(new KeyboardEvent('keydown', { bubbles: true, key })),
    last: () => onFocusChange.mock.calls.at(-1)?.[0]?.datum ?? null,
  }
}
it('A: Escape clears keyboard focus', () => {
  const t = setup(); expect(t.last()).toEqual({ x: 0 })
  t.key('Escape'); expect(t.last()).toBeNull()
})
it('B: keyboard focus survives a pointer pass', () => {
  const t = setup(); t.key('ArrowRight') // x=1
  t.fire(new MouseEvent('pointermove', { bubbles: true, clientX: 5, clientY: 5 }))
  t.root.dispatchEvent(new MouseEvent('mouseleave'))
  t.key('ArrowRight'); expect(t.last()).toEqual({ x: 2 }) // continues, not restart
})

Output on 57774e1 (vitest 4.1.10): both fail.

A: AssertionError: expected { x: +0 } to be null
B: AssertionError: expected { x: +0 } to deeply equal { x: 2 }
Proposed fix
  • A: handle Escape for plain keyboard focus through the existing dismissTooltip path.
  • B and C: let setControlledFocus take ownership from its source: accept source: 'keyboard' (already in ChartFocusSource, types.ts:1736-1737) and set focusOwner = 'keyboard' for it, and set focusOwner = 'pointer' for source: 'pointer' or a pointer resolution, so the usual leave handling clears it. Alternative for C: document a "re-resolve at the last pointer position" call that keeps pointer ownership.

Impact (bklit migration, Chrome): B is worked around by re-applying the last point with setControlledFocus on pointer leave, passing source: 'keyboard' through a type cast; C needs our own mouseleave listener. There is no workaround for A.

Related: PR #164 "feat(focus): two-dimensional grid focus for heatmaps" (open), #203 (early pointer input hits the same ownership rule).

Langage dominant
TypeScript
Étoiles
870
Forks
57
Merge moyen
11 h 58 min
PR mergées (30 j)
18

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de TanStack/charts

Toutes les issues de TanStack/charts

Issues similaires

Plus d'issues TypeScript

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.