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-core): listen to array onChange events #1241

Merged
merged 12 commits into from
Mar 8, 2025
+100 −21
Merged

fix(form-core): listen to array onChange events #1241

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
feaae4e
fix(form-core): fix typing for formOptions so they don't override add…
pavle99 Mar 7, 2025
7734a8e
ci: apply automated fixes and generate docs
autofix-ci[bot] Mar 7, 2025
2a992b1
Merge branch 'fix-formOptions-types-override' of https://github.com/p…
pavle99 Mar 7, 2025
4114e86
fix(form-core): listen to array events
pavle99 Mar 7, 2025
eb8dc3b
chore(form-core): add tests
pavle99 Mar 7, 2025
66843e7
ci: apply automated fixes and generate docs
autofix-ci[bot] Mar 7, 2025
c2cc5ff
remove uncessary field validation
pavle99 Mar 7, 2025
dadf01e
Merge branch 'listen-to-array-field-changes' of https://github.com/pa…
pavle99 Mar 7, 2025
e8f1c32
ci: apply automated fixes and generate docs
autofix-ci[bot] Mar 7, 2025
59bc26f
chore: group field array listener tests
pavle99 Mar 7, 2025
ab151ec
chore: test tweaks
Mar 8, 2025
56a0918
chore: removed unused test field
Mar 8, 2025
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
30 changes: 15 additions & 15 deletions docs/reference/classes/fieldapi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ Use `field.state.value` instead.
handleBlur(): void
```

Defined in: [packages/form-core/src/FieldApi.ts:1593](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1593)
Defined in: [packages/form-core/src/FieldApi.ts:1632](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1632)

Handles the blur event.

Expand All @@ -229,7 +229,7 @@ Handles the blur event.
handleChange(updater): void
```

Defined in: [packages/form-core/src/FieldApi.ts:1586](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1586)
Defined in: [packages/form-core/src/FieldApi.ts:1625](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1625)

Handles the change event.

Expand All @@ -251,10 +251,10 @@ Handles the change event.
insertValue(
index,
value,
opts?): Promise<void>
opts?): void
```

Defined in: [packages/form-core/src/FieldApi.ts:1234](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1234)
Defined in: [packages/form-core/src/FieldApi.ts:1241](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1241)

Inserts a value at the specified index, shifting the subsequent values to the right.

Expand All @@ -274,7 +274,7 @@ Inserts a value at the specified index, shifting the subsequent values to the ri

#### Returns

`Promise`\<`void`\>
`void`

***

Expand Down Expand Up @@ -307,7 +307,7 @@ moveValue(
opts?): void
```

Defined in: [packages/form-core/src/FieldApi.ts:1264](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1264)
Defined in: [packages/form-core/src/FieldApi.ts:1297](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1297)

Moves the value at the first specified index to the second specified index.

Expand Down Expand Up @@ -360,10 +360,10 @@ Pushes a new value to the field.
### removeValue()

```ts
removeValue(index, opts?): Promise<void>
removeValue(index, opts?): void
```

Defined in: [packages/form-core/src/FieldApi.ts:1252](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1252)
Defined in: [packages/form-core/src/FieldApi.ts:1273](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1273)

Removes a value at the specified index.

Expand All @@ -379,7 +379,7 @@ Removes a value at the specified index.

#### Returns

`Promise`\<`void`\>
`void`

***

Expand All @@ -389,10 +389,10 @@ Removes a value at the specified index.
replaceValue(
index,
value,
opts?): Promise<void>
opts?): void
```

Defined in: [packages/form-core/src/FieldApi.ts:1243](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1243)
Defined in: [packages/form-core/src/FieldApi.ts:1257](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1257)

Replaces a value at the specified index.

Expand All @@ -412,7 +412,7 @@ Replaces a value at the specified index.

#### Returns

`Promise`\<`void`\>
`void`

***

Expand All @@ -422,7 +422,7 @@ Replaces a value at the specified index.
setErrorMap(errorMap): void
```

Defined in: [packages/form-core/src/FieldApi.ts:1613](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1613)
Defined in: [packages/form-core/src/FieldApi.ts:1652](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1652)

Updates the field's errorMap

Expand Down Expand Up @@ -495,7 +495,7 @@ swapValues(
opts?): void
```

Defined in: [packages/form-core/src/FieldApi.ts:1258](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1258)
Defined in: [packages/form-core/src/FieldApi.ts:1285](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1285)

Swaps the values at the specified indices.

Expand Down Expand Up @@ -547,7 +547,7 @@ Updates the field instance with new options.
validate(cause, opts?): unknown[] | Promise<unknown[]>
```

Defined in: [packages/form-core/src/FieldApi.ts:1553](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1553)
Defined in: [packages/form-core/src/FieldApi.ts:1592](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1592)

Validates the field value.

Expand Down
51 changes: 45 additions & 6 deletions packages/form-core/src/FieldApi.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1226,7 +1226,14 @@ export class FieldApi<
pushValue = (
value: TData extends any[] ? TData[number] : never,
opts?: UpdateMetaOptions,
) => this.form.pushFieldValue(this.name, value as any, opts)
) => {
this.form.pushFieldValue(this.name, value as any, opts)

this.options.listeners?.onChange?.({
value: this.state.value,
fieldApi: this,
})
}

/**
* Inserts a value at the specified index, shifting the subsequent values to the right.
Expand All @@ -1235,7 +1242,14 @@ export class FieldApi<
index: number,
value: TData extends any[] ? TData[number] : never,
opts?: UpdateMetaOptions,
) => this.form.insertFieldValue(this.name, index, value as any, opts)
) => {
this.form.insertFieldValue(this.name, index, value as any, opts)

this.options.listeners?.onChange?.({
value: this.state.value,
fieldApi: this,
})
}

/**
* Replaces a value at the specified index.
Expand All @@ -1244,26 +1258,51 @@ export class FieldApi<
index: number,
value: TData extends any[] ? TData[number] : never,
opts?: UpdateMetaOptions,
) => this.form.replaceFieldValue(this.name, index, value as any, opts)
) => {
this.form.replaceFieldValue(this.name, index, value as any, opts)

this.options.listeners?.onChange?.({
value: this.state.value,
fieldApi: this,
})
}

/**
* Removes a value at the specified index.
*/
removeValue = (index: number, opts?: UpdateMetaOptions) =>
removeValue = (index: number, opts?: UpdateMetaOptions) => {
this.form.removeFieldValue(this.name, index, opts)

this.options.listeners?.onChange?.({
value: this.state.value,
fieldApi: this,
})
}

/**
* Swaps the values at the specified indices.
*/
swapValues = (aIndex: number, bIndex: number, opts?: UpdateMetaOptions) =>
swapValues = (aIndex: number, bIndex: number, opts?: UpdateMetaOptions) => {
this.form.swapFieldValues(this.name, aIndex, bIndex, opts)

this.options.listeners?.onChange?.({
value: this.state.value,
fieldApi: this,
})
}

/**
* Moves the value at the first specified index to the second specified index.
*/
moveValue = (aIndex: number, bIndex: number, opts?: UpdateMetaOptions) =>
moveValue = (aIndex: number, bIndex: number, opts?: UpdateMetaOptions) => {
this.form.moveFieldValues(this.name, aIndex, bIndex, opts)

this.options.listeners?.onChange?.({
value: this.state.value,
fieldApi: this,
})
}

/**
* @private
*/
Expand Down
Loading