createFormCopy Anchor Link

createForm(options) returns a stable CreateFormReturn<Values, Checks> with core form methods and reactive status getters. Values infer from schema; configured checks infer issue levels, with error always included. Options may be an object with getters or an accessor.

import { createField, createForm } from '@oxform/solid';
import { z } from 'zod';

function EmailForm() {
  const form = createForm({ schema: z.object({ email: z.email() }), defaultValues: { email: '' } });
  const email = createField({ form, name: 'email' });
  const submit = form.submit(values => {
    console.info(values.email);
  });

  return (
    <form
      onSubmit={event => {
        event.preventDefault();
        void submit();
      }}
    >
      <input aria-label='Email' {...email.props} />
      <button type='submit' disabled={form.status.submitting}>
        Submit
      </button>
    </form>
  );
}

OptionsCopy Anchor Link

Reactive updates change configuration for later operations. Updating defaults does not overwrite current values; call reset() to apply the new baseline.

PropertiesCopy Anchor Link

Path-based operations use the same contracts as bound fields and bound arrays, with the path as their first argument. form.field.register(name) returns an element callback.

validate(fields?, options?)Copy Anchor Link

Returns Promise<[boolean, FormIssuesByLevel<Level>]>. Omit targets for whole-form validation, or supply a path or list of paths for their subtrees. Validators receive the full values object; targets limit returned issues and updated paths.

options.type selects change, blur, focus, or submit. Omitting it runs the root schema and all configured events. The boolean describes blocking issues emitted by this run; form.status.valid describes all current issues. See Validation.

const [valid, issues] = await form.validate('email', { type: 'blur' });
await form.validate();

submit(onSuccess, onError?)Copy Anchor Link

Returns a zero-argument () => Promise<void> handler. Invoke that handler to submit. It runs whole-form submit validation, then awaits onSuccess(values, form) if both the run and aggregate current validity pass, or onError(issues, form) otherwise.

The handler marks the form dirty and submitting before validation. Normal completion increments submits, clears submitting, and records successful. A rejected validator or callback rejects the handler; these completion updates are not guaranteed after rejection. It does not prevent browser submission or suppress concurrent calls.

reset(options?)Copy Anchor Link

Restores defaults, clears issues and refs, recreates fields, and resets submit status. It does not validate. values supplies a full values object for this reset without changing the default baseline; status overrides reset status.

form.reset();
form.reset({ keep: { refs: true, issues: ['error'] } });

Solid manages the internal mount and configuration-update calls. See Lifecycle for disposal and server rendering.

TypesCopy Anchor Link