Skip to content

getValues

폼 값 가져오기

</> getValues: (payload?: string | string[]) => Object

폼 값을 읽기 위한 최적화된 헬퍼 함수입니다. watchgetValues의 차이점은 getValues리렌더링을 발생시키지 않으며 입력 변경을 구독하지 않는다는 점입니다.

Props


타입설명
undefined폼의 전체 값을 반환합니다.
string폼 값의 특정 경로에 있는 값을 가져옵니다.
array폼 값의 특정 경로에 있는 값을 배열로 반환합니다.

예제:


아래 예제는 getValues 메서드를 호출할 때 어떤 결과를 얻을 수 있는지 보여줍니다.

<input {...register("root.test1")} />
<input {...register("root.test2")} />
이름출력
getValues(){ root: { test1: '', test2: ''} }
getValues("root"){ test1: '', test2: ''}
getValues("root.firstName")''
getValues(["yourDetails.lastName"])['']
규칙
  • 비활성화된 입력 필드는 undefined로 반환됩니다. 사용자가 입력을 업데이트하지 못하게 하면서도 필드 값을 유지하려면 readOnly를 사용하거나 전체 <fieldset />을 비활성화할 수 있습니다. 예제를 참고하세요.
  • 초기 렌더링 전에는 useFormdefaultValues를 반환합니다.

예제:


import React from "react"
import { useForm } from "react-hook-form"
type FormInputs = {
test: string
test1: string
}
export default function App() {
const { register, getValues } = useForm<FormInputs>()
return (
<form>
<input {...register("test")} />
<input {...register("test1")} />
<button
type="button"
onClick={() => {
const values = getValues() // { test: "test-input", test1: "test1-input" }
const singleValue = getValues("test") // "test-input"
const multipleValues = getValues(["test", "test1"]) // ["test-input", "test1-input"]
}}
>
Get Values
</button>
</form>
)
}
import { useForm } from "react-hook-form"
export default function App() {
const { register, getValues } = useForm()
return (
<form>
<input {...register("test")} />
<input {...register("test1")} />
<button
type="button"
onClick={() => {
const values = getValues() // { test: "test-input", test1: "test1-input" }
const singleValue = getValues("test") // "test-input"
const multipleValues = getValues(["test", "test1"])
// ["test-input", "test1-input"]
}}
>
Get Values
</button>
</form>
)
}
import React from "react"
import { useForm } from "react-hook-form"
// 평면적인 입력 값
type Inputs = {
key1: string
key2: number
key3: boolean
key4: Date
}
export default function App() {
const { register, getValues } = useForm<Inputs>()
getValues()
return <form />
}
// 중첩된 입력 값
type Inputs1 = {
key1: string
key2: number
key3: {
key1: number
key2: boolean
}
key4: string[]
}
export default function Form() {
const { register, getValues } = useForm<Inputs1>()
getValues()
// function getValues(): Record<string, unknown>
getValues("key1")
// function getValues<"key1", unknown>(payload: "key1"): string
getValues("key2")
// function getValues<"key2", unknown>(payload: "key2"): number
getValues("key3.key1")
// function getValues<"key3.key1", unknown>(payload: "key3.key1"): unknown
getValues<string, number>("key3.key1")
// function getValues<string, number>(payload: string): number
getValues<string, boolean>("key3.key2")
// function getValues<string, boolean>(payload: string): boolean
getValues("key4")
// function getValues<"key4", unknown>(payload: "key4"): string[]
return <form />
}

여러분의 지원에 감사드립니다

React Hook Form이 프로젝트에서 유용하다면, GitHub에서 스타를 눌러 지원해 주세요.