What is the purpose of isSubmitting in form state?

[paschaldev]

The purpose of isSubmitting is not clear. How do you control this value, how do you update the state of isSubmitting, is this automated? When does it trigger?

I would like to set isSubmitting to true when I'm running an async request to store something on the server from the form values but I don't see how to use the isSubmitting in the docs to do this even though it's present everywhere in examples.

The DOC should be clear on the purpose of isSubmitting and how to use this value. I want to show a spinner when the form isSubmitting after wrapping the button with form.subscribe

[Balastrong]

It is indeed automatic and is true during the submit process, goes false when form is no longer submitting as the name suggests and is exactly for your use case.

Extra explanation: it is set to true when form.handleSubmit and is set to false when either:
A) Validation is performed and form is invalid
or
B) Form is valid, onSubmit is awaited and it fulfills

Here for more context (look where done() is called)

form/packages/form-core/src/FormApi.ts

Lines 913 to 968 in ade193c

	handleSubmit = async () => {
	this.store.setState((old) => ({
	...old,
	// Submission attempts mark the form as not submitted
	isSubmitted: false,
	// Count submission attempts
	submissionAttempts: old.submissionAttempts + 1,
	}))
	// Don't let invalid forms submit
	if (!this.state.canSubmit) return
	this.store.setState((d) => ({ ...d, isSubmitting: true }))
	const done = () => {
	this.store.setState((prev) => ({ ...prev, isSubmitting: false }))
	}
	// Validate all fields
	await this.validateAllFields('submit')
	// Fields are invalid, do not submit
	if (!this.state.isFieldsValid) {
	done()
	this.options.onSubmitInvalid?.({
	value: this.state.values,
	formApi: this,
	})
	return
	}
	// Run validation for the form
	await this.validate('submit')
	if (!this.state.isValid) {
	done()
	this.options.onSubmitInvalid?.({
	value: this.state.values,
	formApi: this,
	})
	return
	}
	try {
	// Run the submit code
	await this.options.onSubmit?.({ value: this.state.values, formApi: this })
	this.store.batch(() => {
	this.store.setState((prev) => ({ ...prev, isSubmitted: true }))
	done()
	})
	} catch (err) {
	done()
	throw err
	}
	}

I'll try to make a guess, are you awaiting for your async call inside your onSubmit?