DevTool control prop does not match Control type output by `useForm`

オープン
#223 コメント 0 件 リアクション 2 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
55/100
issue の種類
バグ
明瞭さ
明確に書かれている
活発さ
停滞
技術スタック
react, typescript
領域
developer-experience, tooling

調査の方向性

Start by locating the TypeScript declaration for DevTool described in the issue and compare its Control generic parameters with UseFormReturn. Update the declaration so TContext and TTransformedValues are preserved, then verify that a transformed Control from useForm is accepted without a typing error.

索引モデルが issue の本文から書いたものです。

説明

"@hookform/devtools": "^4.4.0"
"react-hook-form": "^7.58.0"
"@hookform/resolvers": "^5.1.1"

Problem

Currently the typing for DevTool is

export declare const DevTool: <T extends FieldValues>(props?: ({
    id?: string | undefined;
    control?: Control<T, any, T> | undefined;
} & Pick<DevtoolUIProps, "placement" | "styles">) | undefined) => JSX.Element | null;

However, the typing for Control when output by useForm is of form

export type UseFormReturn<TFieldValues extends FieldValues = FieldValues, TContext = any, TTransformedValues = TFieldValues> = {
    ...
    control: Control<TFieldValues, TContext, TTransformedValues>;
    ...
};

The issue is that Control<T, any, T> never ingests the TTransformedValues if set, leading to a typing error.

Proposed Solution

Change the typing for DevTool to the following:

export declare const DevTool: <TFieldValues extends FieldValues = FieldValues, TContext = any, TTransformedValues = TFieldValues>(props?: ({
    id?: string | undefined;
    control?: Control<TFieldValues, TContext, TTransformedValues> | undefined;
} & Pick<DevtoolUIProps, "placement" | "styles">) | undefined) => JSX.Element | null;
主要言語
TypeScript
スター
670
フォーク
55
30日以内にマージされた PR はありません

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

react-hook-form/devtools のほかの issue

react-hook-form/devtools の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。