Skip to content
Source
Sign inSign up
TanStack/form
Open History to see the last commit

quick-start.md

65 lines1.7 KB

The bare minimum to get started with TanStack Form is to create a TanstackFormController:

interface Employee {
  firstName: string
  lastName: string
  employed: boolean
  jobTitle: string
}

#form = new TanstackFormController(this, {
  defaultValues: {
    employees: [] as Employee[],
  },
})

In this example this references the instance of your LitElement in which you want to use TanStack Form.

To wire a form element in your template up with TanStack Form, use the field method of TanstackFormController:

export class TestForm extends LitElement {
  render() {
    return html`
 <p>Please enter your first name></p>
 ${this.form.field(
      {
        name: `firstName`,
        validators: {
          onChange: ({ value }) =>
            value.length < 3 ? 'Not long enough' : undefined,
        },
      },
      (field: FieldApi<Employee, 'firstName'>) => {
        return html` <div>
              <label>First Name</label>
              <input
                id="firstName"
                type="text"
                placeholder="First Name"
                @blur="${() => field.handleBlur()}"
                .value="${field.getValue()}"
                @input="${(event: InputEvent) => {
                  if (event.currentTarget) {
                    const newValue = (event.currentTarget as HTMLInputElement).value;
                    field.handleChange(newValue);
                  }
                }}"
              />
            </div>`
      },
    )}`;
  }
}

The first parameter of field is FieldOptions and the second is callback to render your element. Be aware that you need to handle updating the element and form yourself as seen in the example above.