[2.0 rc.15 / next] Types: `data-*` attributes are rejected in props objects typed with `ComponentProps` / `JSX.HTMLAttributes`
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 3/5
- 見積もり時間
- 半日
- 初心者へのやさしさ
- 45/100
- issue の種類
- バグ
- 明瞭さ
- 明確に書かれている
- 活発さ
- 活発
- 技術スタック
- typescript
- 領域
- frontend
調査の方向性
Start with the JSX type declarations in packages/web (the DOM attribute interfaces and the ElementAttributes base), and reproduce with the three errors in the gist, using tsc -p .. The fix is a template-literal index signature for data-${string} keys on the base attribute interface. Done when the three errors disappear, the @ts-expect-error checks still fail for non-data keys and non-primitive data values, and the type tests pass. Because this touches public types, confirm the approach with a maintainer first.
索引モデルが issue の本文から書いたものです。
説明
Summary
In JSX, data-* attributes are accepted on intrinsic elements. In an object typed with the same element's props (ComponentProps<"div">, JSX.HTMLAttributes<T>), they are rejected. That type is the natural one for a function that returns props to spread onto an element. This request is to declare data-* keys in the DOM attribute types with a template-literal index signature.
Reproduction
import type { ComponentProps, JSX } from "@solidjs/web";
// In JSX, data-* attributes are accepted on intrinsic elements:
export const ok = <div data-state="open" />;
// ...but not in an object typed with the same element's props:
export const a: JSX.HTMLAttributes<HTMLDivElement> = { "data-state": "open" };
export const b: ComponentProps<"div"> = { role: "button", "data-state": "open" };
// ...nor when a function returning those props is spread back onto the element:
function disclosure(): ComponentProps<"button"> {
return { "aria-expanded": "false", "data-state": "closed" };
}
export const c = <button {...disclosure()} />;
tsc -p . (TypeScript 5.9.3 and 7.0.2 give the same errors) with "jsx": "preserve", "jsxImportSource": "@solidjs/web", "strict": true:
data-attrs.tsx(7,56): error TS2353: Object literal may only specify known properties, and '"data-state"' does not exist in type 'HTMLAttributes<HTMLDivElement>'.
data-attrs.tsx(8,59): error TS2353: Object literal may only specify known properties, and '"data-state"' does not exist in type 'HTMLAttributes<HTMLDivElement> & Properties<HTMLDivElement>'.
data-attrs.tsx(12,38): error TS2353: Object literal may only specify known properties, and '"data-state"' does not exist in type 'ButtonHTMLAttributes<HTMLButtonElement> & Properties<HTMLButtonElement>'.
TypeScript exempts hyphenated names from attribute checks only in JSX syntax, so the object forms fail.
Proposal
Add a template-literal index signature to the base attribute interface in @solidjs/web's JSX types. I tested this module augmentation against rc.15:
import "@solidjs/web";
declare module "@solidjs/web" {
namespace JSX {
interface ElementAttributes<T> {
[attr: `data-${string}`]: string | number | boolean | undefined;
}
}
}
With it, the three errors above go away, and these still hold:
type P = Omit<ComponentProps<"div">, "ref">;
export const p: P = { "data-x": "1", class: "a" };
// @ts-expect-error unknown non-data keys are still rejected
export const q: P = { foo: 1 };
// @ts-expect-error data values stay primitive
export const r: P = { "data-x": {} };
export const s = <div data-n={1} data-b={true} />;
React's DOM types have the same gap, so this is not a regression. Solid 2 is already rewriting the attribute types (lowercase names, RemoveAttribute), so this seems a good point to close it.
Why it matters
Headless component libraries expose state as data-* attributes (data-state, data-disabled, data-highlighted) and compose behaviour as functions that return props objects, which are merged and spread onto parts. Without the index signature, each such function has to widen its return type or cast. Until this lands, the augmentation above is the workaround.
Versions
@solidjs/web/solid-js2.0.0-rc.15. Onnextat eb4e019,packages/webdeclares nodata-*key.- TypeScript 5.9.3 and 7.0.2
Runnable repro: https://gist.github.com/cevr/e421f9dbfe6c0da2e92818647dd408f0 (bun install && bun run repro)
Filed with Claude Code on behalf of @cevr.
- 主要言語
- TypeScript
- スター
- 36.1k
- フォーク
- 1.1k
- 平均マージ
- 10時間 41分
- マージ済み PR(30日)
- 363
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
solidjs/solid のほかの issue
-
難易度 3/5 半日 初心者へのやさしさ 55/100
メンテナーはふだん 1 日以内に返信
-
難易度 4/5 3〜5日 初心者へのやさしさ 30/100
メンテナーはふだん 1 日以内に返信
-
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
メンテナーはふだん 1 日以内に返信
-
signals: a landing reveals a held write its stale reader re-derives onto a new flight (U-5, D-9)オープン
難易度 5/5 1週間以上 初心者へのやさしさ 12/100
メンテナーはふだん 1 日以内に返信
-
難易度 4/5 3〜5日 初心者へのやさしさ 25/100
メンテナーはふだん 1 日以内に返信
似ている issue
-
fix(frontend): correct VITE_IS_DEVELPOMENT typo in shared/app.ts and align dev environment flagsオープン
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
vicharanashala/ajrasakha#1439 ·
メンテナーはふだん 1 日以内に返信
-
Add: TV5Monde Asieオープンapproved check:passed streams:add
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
backnotprop/plannotator#1932 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 半日 初心者へのやさしさ 62/100
ibm-granite/granite.build#504 ·
メンテナーはふだん 2 日以内に返信
-
reproduced
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
anomalyco/opencode#55676 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信