- Docs
- Stop auto-submit with disableAutoSubmit()
Stop auto-submit with disableAutoSubmit()
Turns auto-submit off and cancels any pending debounce timer. Use it to pause automatic submission during a multi-step flow.
Turns auto-submit off and cancels any pending debounce timer.
Signature
disableAutoSubmit(): FormController
Returns
The same FormController — chainable.
Behaviour
- Sets
state.autoSubmitEnabledtofalse. - Cancels
state.autoSubmitTimerif one is pending. - Notifies subscribers (because the state’s
autoSubmitfield changes).
Equivalent to calling autoSubmit(false).
Examples
Pause autosave while typing resumes
import { form } from '@samline/forms'
const draft = form('draft-form', { autoSubmit: { debounce: 800 } })
document.querySelector('#pause')?.addEventListener('click', () => {
draft.disableAutoSubmit()
})
document.querySelector('#resume')?.addEventListener('click', () => {
draft.autoSubmit({ debounce: 800 })
})
Disable on blur
import { form } from '@samline/forms'
const search = form('search-form', { autoSubmit: { debounce: 250 } })
search.element?.addEventListener('focusin', () => {
search.autoSubmit({ debounce: 250 })
})
search.element?.addEventListener('focusout', () => {
search.disableAutoSubmit()
})
Edge cases
- Re-enabling later requires calling
autoSubmit()again. The previous debounce configuration is not preserved. - A pending debounce timer is removed, but the timer was already scheduled; nothing fires for it.
Related
autoSubmit— enable / configure.destroy— also cancels any pending debounce.