Guide Documentation

• Overview
  • Concepts
  • Form objects
    • Processing input data with a Form
    • Displaying a Form
  • “Isomorphic”
• React Components
  • RenderForm
    • Form options
    • Getting the Form instance
    • Other rendering scenarios
    • RenderForm props
    • RenderForm methods
  • FormRow
    • FormRow props
  • RenderFormSet
    • RenderFormSet props
    • RenderFormSet methods
  • Custom rendering with props
  • Custom rendering with a child component
  • Custom async progress rendering
• Interactive Forms with React
  • Provide a containing <form>
    • noValidate
  • Creating Forms and FormSets
  • Form state and onChange()
  • Interactive Form validation
    • Form 'auto' validation
    • 'auto' example form
  • Field validation
  • validation options
    • 'manual'
    • validation object
    • 'auto'
    • Any event name
  • Final Form validation
  • Controlled user inputs
    • controlled example Form
  • Rendering Forms
• Customising Form display
  • BoundField
  • Useful BoundField properties
  • Useful BoundField methods
  • boundFields() example
  • boundFieldsObj() example
• Forms
  • Initial input data
    • form.isInitialRender
  • Using forms to validate data
    • Server or standalone validation
    • Client validation
  • Dynamic initial values
  • Accessing the fields from the form
  • Accessing “clean” data
  • Updating a form’s input data
    • form.setData()
    • form.updateData()
  • Outputting forms as HTML
    • Styling form rows
    • Configuring form elements’ HTML id attributes and <label> tags
    • Notes on field ordering
    • How errors are displayed
    • Customising the error list format
    • More granular output
  • Extending forms
  • Prefixes for forms
  • Client: Working with files
  • Server: Binding uploaded files to a form
    • Testing for multipart forms
• Form fields
  • Core field arguments
    • required
    • label
    • initial
    • widget
    • helpText
    • errorMessages
    • validators
    • widgetAttrs
  • Providing choices
  • Dynamic choices
  • Built-in Field types
    • Built-in Field type hierarchy
    • Build-in Fields (A-Z)
    • BooleanField()
    • CharField()
    • ChoiceField()
    • TypedChoiceField()
    • DateField()
    • DateTimeField()
    • DecimalField()
    • EmailField()
    • FileField()
    • FilePathField()
    • FloatField()
    • ImageField()
    • IntegerField()
    • IPAddressField()
    • GenericIPAddressField()
    • MultipleChoiceField()
    • MultipleFileField()
    • TypedMultipleChoiceField()
    • NullBooleanField()
    • RegexField()
    • SlugField()
    • TimeField()
    • URLField()
  • Slightly complex built-in Field types
    • ComboField()
    • MultiValueField()
    • SplitDateTimeField()
    • Creating custom fields
• Form and Field validation
  • Validation steps and order
  • Throwing ValidationError
    • Throwing multiple errors
  • Using validation in practice
    • Using validators
    • Form field default cleaning
    • Cleaning a specific field
    • Cleaning and validating fields that depend on each other
      • form.clean()
      • Specifying fields used in cross-field validation
  • Asynchronous validation
    • Async field validation example
    • Cancelling async validation
    • Combining sync and async validation
• Widgets
  • Specifying widgets
  • Setting arguments for widgets
  • Customising widget attributes
  • Widgets inheriting from the Select widget
  • Customising widget instances
    • Styling widget instances
  • Base Widgets
    • Widget()
    • MultiWidget()
  • Built-in widgets
  • Widgets handling input of text
    • TextInput()
    • NumberInput()
    • EmailInput()
    • URLInput()
    • PasswordInput()
    • Textarea()
    • HiddenInput()
    • DateInput()
    • DateTimeInput()
    • TimeInput()
  • Selector and checkbox widgets
    • CheckboxInput()
    • Select()
    • NullBooleanSelect()
    • SelectMultiple()
    • RadioSelect()
    • CheckboxSelectMultiple()
  • File upload widgets
    • FileInput()
    • ClearableFileInput()
  • Composite widgets
    • MultipleHiddenInput()
    • SplitDateTimeWidget()
    • SplitHiddenDateTimeWidget()
• Formsets
  • Using initial data with a formset
  • Limiting the maximum number of forms
  • Formset validation
    • Understanding the ManagementForm
    • totalFormCount() and initialFormCount()
  • Client-side FormSets
    • Updating a formset’s data
    • Validating a formset on-demand
  • Custom formset validation
  • Using more than one formset in a <form>
• Locales
  • Adding a new locale
  • Setting the default locale