API.md

API Reference

See README.md for the consolidated API. This file contains additional detail.

form.New — Widget Resolution Detail

f, err := form.New("content", data) // data implements fmt.Fielder
// -> f.GetID() == "content." + resolveStructName(data)
// -> f.RenderHTML() renders all fields that have a Widget in data.Schema()

For each field in data.Schema():

1. field.IsPK() && field.IsAutoInc() → skip (auto-increment PKs not editable).
2. field.Widget == nil → skip (no UI binding).
3. field.Widget.Clone(formID, fieldName).(input.Input) → positioned input.
4. field.NotNull → SetRequired(true) on the input.
5. Current value bound via fmt.ReadValues() + SetValues().

(*Form).Validate() — Validation Detail

• Skips fields with SkipValidation set to true in the input.
• Uses GetSelectedValue() to get current value per input.
• Calls inp.Validate(val) (promoted from fmt.Widget).
• Returns the first error encountered.

(*Form).SyncValues(data fmt.Fielder) — Binding Detail

Synchronizes input values back to the struct pointers provided by data.Pointers(). Supports fmt.FieldText, fmt.FieldInt, fmt.FieldFloat, and fmt.FieldBool.

(*Form).ValidateData(action byte, data fmt.Fielder) — Server-side Validation

Validates the provided data using the form's input rules. Satisfies crudp.DataValidator.

fmt.Permitted — Validation Engine

type Permitted struct {
	Letters    bool     // a-z, A-Z (and ñ/Ñ)
	Tilde      bool     // á, é, í, ó, ú
	Numbers    bool     // 0-9
	Spaces     bool     // ' '
	BreakLine  bool     // '\n'
	Tab        bool     // '\t'
	Extra      []rune   // additional allowed characters
	NotAllowed []string // disallowed substrings
	Minimum    int      // minimum length
	Maximum    int      // maximum length
}

Error messages from Permitted.Validate(name, text):

• "{name} minimum {min} chars" — value shorter than Minimum
• "{name} maximum {max} chars" — value longer than Maximum
• "space not allowed" — space when Spaces=false
• "character {X} not allowed" — disallowed character

Namer Interface

Fielder types can optionally implement Namer to provide a custom form name:

type Namer interface {
    FormName() string
}

If not implemented, defaults to "form".