API Reference

Complete API documentation for every public class, method, and attribute in textual-wtf.

Sections

Page	Contents
Forms	BaseForm, Form — form declaration, validation, data access
Fields	Field, StringField, IntegerField, BooleanField, ChoiceField, TextField
Validators	Validator, Required, MinLength, MaxLength, MinValue, MaxValue, EmailValidator, FunctionValidator
Layouts	FormLayout, ControllerAwareLayout, DefaultFormLayout
Runtime objects	BoundField, FieldController, FieldWidget, FieldErrors
TabbedForm	TabbedForm
Exceptions	ValidationError, FieldError, FormError, AmbiguousFieldError

Quick import reference

Everything public is available from the top-level textual_wtf package:

from textual_wtf import (
    # Forms
    Form,
    BaseForm,
    TabbedForm,

    # Fields
    StringField,
    IntegerField,
    BooleanField,
    ChoiceField,
    TextField,

    # Validators
    Validator,
    Required,
    MinLength,
    MaxLength,
    MinValue,
    MaxValue,
    EmailValidator,
    FunctionValidator,

    # Layouts
    FormLayout,
    ControllerAwareLayout,
    DefaultFormLayout,

    # Runtime types
    BoundField,
    FieldController,
    FieldErrors,
    FieldWidget,

    # Exceptions
    ValidationError,
    FieldError,
    FormError,
    AmbiguousFieldError,
)