Skip to main content

@rtorcato/browser-common / forms

forms

Functions​

serializeForm()​

serializeForm(form): Record<string, string>

Defined in: forms/index.ts:11

Serializes a form element into an object of key-value pairs.

Example​

import { serializeForm } from '@rtorcato/browser-common/forms'
const data = serializeForm(myForm)

Parameters​

form​

HTMLFormElement

The HTMLFormElement to serialize.

Returns​

Record<string, string>

An object with form field names and values.

resetForm()​

resetForm(form): void

Defined in: forms/index.ts:31

Resets a form to its initial values.

Example​

import { resetForm } from '@rtorcato/browser-common/forms'
resetForm(myForm)

Parameters​

form​

HTMLFormElement

The HTMLFormElement to reset.

Returns​

void

setFormValues()​

setFormValues(form, values): void

Defined in: forms/index.ts:45

Sets values on a form from an object.

Example​

import { setFormValues } from '@rtorcato/browser-common/forms'
setFormValues(myForm, { name: 'Ada', email: 'a@b.co' })

Parameters​

form​

HTMLFormElement

The HTMLFormElement to update.

values​

Record<string, string>

An object of field names and values.

Returns​

void

isFormValid()​

isFormValid(form): boolean

Defined in: forms/index.ts:66

Validates a form using the browser's built-in validation.

Example​

import { isFormValid } from '@rtorcato/browser-common/forms'
if (isFormValid(myForm)) submit()

Parameters​

form​

HTMLFormElement

The HTMLFormElement to validate.

Returns​

boolean

True if the form is valid, false otherwise.

onFormSubmit()​

onFormSubmit(form, callback): () => void

Defined in: forms/index.ts:82

Adds a submit event listener to a form with preventDefault and callback.

Example​

import { onFormSubmit } from '@rtorcato/browser-common/forms'
const off = onFormSubmit(myForm, (e) => console.log('submitted'))
off()

Parameters​

form​

HTMLFormElement

The HTMLFormElement to listen on.

callback​

(event) => void

The callback to run on submit.

Returns​

A function to remove the event listener.

() => void