Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix form helper types for setDefaults() method (React) and defaults() method (Vue) #1504

Merged
merged 7 commits into from
Aug 16, 2023
Merged

Fix form helper types for setDefaults() method (React) and defaults() method (Vue) #1504

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
ce77b91
Update typings
shealavington Mar 28, 2023
b921d22
Fix unexpected character
shealavington Mar 28, 2023
cf44c0a
Use user defined types
shealavington Mar 28, 2023
5560881
Use user defined types
shealavington Mar 28, 2023
e65e385
Fix types for form helper `setDefaults()` method in React adapter
reinink Aug 16, 2023
9aef348
Fix types for form helper `setDefaults()` method in Vue adapters
reinink Aug 16, 2023
0048e5e
Remove interface export from Vue 3 adapter
reinink Aug 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions packages/react/src/useForm.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { Method, Progress, router, VisitOptions } from '@inertiajs/core'
import { FormDataConvertible, Method, Progress, router, VisitOptions } from '@inertiajs/core'
import isEqual from 'lodash.isequal'
import { useCallback, useEffect, useRef, useState } from 'react'
import useRemember from './useRemember'
Expand All @@ -19,8 +19,8 @@ export interface InertiaFormProps<TForm extends Record<string, unknown>> {
setData: setDataByObject<TForm> & setDataByMethod<TForm> & setDataByKeyValuePair<TForm>
transform: (callback: (data: TForm) => TForm) => void
setDefaults(): void
setDefaults(field: keyof TForm, value: string): void
setDefaults(fields: Record<keyof TForm, string>): void
setDefaults(field: keyof TForm, value: FormDataConvertible): void
setDefaults(fields: Partial<TForm>): void
reset: (...fields: (keyof TForm)[]) => void
clearErrors: (...fields: (keyof TForm)[]) => void
setError(field: keyof TForm, value: string): void
Expand Down Expand Up @@ -186,7 +186,7 @@ export default function useForm<TForm extends Record<string, unknown>>(
transform(callback) {
transform = callback
},
setDefaults(fieldOrFields?: keyof TForm | Record<keyof TForm, string>, maybeValue?: string) {
setDefaults(fieldOrFields?: keyof TForm | Partial<TForm>, maybeValue?: FormDataConvertible) {
if (typeof fieldOrFields === 'undefined') {
setDefaults(() => data)
} else {
Expand Down
6 changes: 3 additions & 3 deletions packages/vue2/src/useForm.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { Method, Progress, router, VisitOptions } from '@inertiajs/core'
import { FormDataConvertible, Method, Progress, router, VisitOptions } from '@inertiajs/core'
import cloneDeep from 'lodash.clonedeep'
import isEqual from 'lodash.isequal'
import { reactive, watch } from 'vue'
Expand All @@ -14,8 +14,8 @@ interface InertiaFormProps<TForm> {
data(): TForm
transform(callback: (data: TForm) => object): this
defaults(): this
defaults(field: keyof TForm, value: string): this
defaults(fields: Record<keyof TForm, string>): this
defaults(field: keyof TForm, value: FormDataConvertible): this
defaults(fields: Partial<TForm>): this
reset(...fields: (keyof TForm)[]): this
clearErrors(...fields: (keyof TForm)[]): this
setError(field: keyof TForm, value: string): this
Expand Down
8 changes: 4 additions & 4 deletions packages/vue3/src/useForm.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { Method, Progress, router, VisitOptions } from '@inertiajs/core'
import { FormDataConvertible, Method, Progress, router, VisitOptions } from '@inertiajs/core'
import cloneDeep from 'lodash.clonedeep'
import isEqual from 'lodash.isequal'
import { reactive, watch } from 'vue'
Expand All @@ -14,8 +14,8 @@ interface InertiaFormProps<TForm extends Record<string, unknown>> {
data(): TForm
transform(callback: (data: TForm) => object): this
defaults(): this
defaults(field: keyof TForm, value: string): this
defaults(fields: Record<keyof TForm, string>): this
defaults(field: keyof TForm, value: FormDataConvertible): this
defaults(fields: Partial<TForm>): this
reset(...fields: (keyof TForm)[]): this
clearErrors(...fields: (keyof TForm)[]): this
setError(field: keyof TForm, value: string): this
Expand Down Expand Up @@ -70,7 +70,7 @@ export default function useForm<TForm extends Record<string, unknown>>(

return this
},
defaults(fieldOrFields?: keyof TForm | Record<keyof TForm, string>, maybeValue?: string) {
defaults(fieldOrFields?: keyof TForm | Partial<TForm>, maybeValue?: FormDataConvertible) {
if (typeof data === 'function') {
throw new Error('You cannot call `defaults()` when using a function to define your form data.')
}
Expand Down