Documentation of django-formset¶

This missing widgets and form manipulation library for Django

<django-formset> is a web component to let the browser pre-validate and manipulate one or more Django Form-s. This facilitates developers to build beautiful forms with a contemporary user experience. This library ships with a set of widgets, which integrate seamlessly with their Django’s counterparts.

Contents:

1. Introduction
- 1.1. Use Forms as Logical Entities
- 1.2. What are Web Components?
- 1.3. Annotation
- 1.4. License
- 1.5. Contributing
2. Installation
- 2.1. Customized Installation
3. Web Component <django-formset>
4. Working with a single Form
- 4.1. Using a Native Django Form
- 4.2. Using an Extended Django Form
- 4.3. Rendering a Django Form Field-by-Field
5. Styling Forms with django-formset
- 5.1. Default Styling
- 5.2. Bootstrap
- 5.3. Bulma
- 5.4. Foundation
- 5.5. Tailwind
- 5.6. UIKit
6. Dark Mode User Interface
7. Default Widgets
8. Alternative Widgets
- 8.1. Widgets for Choice Fields
- 8.2. Widgets for File- and Image Fields
- 8.3. Widget for TextField
- 8.4. Widgets for Date- and DateTime Fields
9. Submit Button Controls
- 9.1. Action Queues
- 9.2. Buttons without a Form
- 9.3. Auto-Disable Buttons
10. Activators and Button Widgets
- 10.1. Listening for Activation Events
- 10.2. Button Variants
- 10.3. Button Icons
11. Withholding Feedback
- 11.1. Withhold Validation Tick
- 11.2. Withhold Error Messages
- 11.3. Withhold Error Symbol
- 11.4. Withhold Warning Symbol
- 11.5. Server-Side Validation
12. Form Collections
- 12.1. Simple Collection
- 12.2. Nested Collection
- 12.3. Collections with Siblings
- 12.4. Sortable Collections with Siblings
13. Fields Mapping
- 13.1. Example
- 13.2. Mapping Foreign Keys
- 13.3. Implementation Details
14. Creating Forms from Models
- 14.1. Extra Meta options
- 14.2. Detail View for ModelForm
- 14.3. Complete CRUD View
15. Creating Collections from related Models
- 15.1. One-to-One Relations
- 15.2. One-to-Many Relations
16. Fieldsets
- 16.1. Example
- 16.2. Initial Data
- 16.3. Nesting Fieldsets
- 16.4. Mapping Model Fields to Fieldset Fields
17. Collection Fields
- 17.1. Examples
18. Form Renderer
- 18.1. Form Grid Example
- 18.2. Inline Form Example
- 18.3. Rendering Collections
- 18.4. Using multiple Renderers
19. Conditional Expressions
- 19.1. Questionnaire Form
- 19.2. Conditional Fieldset
- 19.3. Conditional Disable
20. Uploading Files and Images
- 20.1. Example
21. Selectize Widget
- 21.1. Usage with fixed Number of Choices
- 21.2. Usage with dynamic Number of Choices
- 21.3. Selectize Multiple Widget
- 21.4. Handling ForeignKey and ManyToManyField
- 21.5. Endpoint for Dynamic Queries
- 21.6. Adding extra Options on the Fly
- 21.7. Implementation Details
22. Dual Selector Widget
- 22.1. Features
- 22.2. Usage
- 22.3. Grouping Select Options
- 22.4. Filtering Select Options
- 22.5. Sortable Dual Selector Widget
23. Dialog Forms
- 23.1. Modal Dialogs
24. Dialog Model Forms
25. Form Stepper
26. Edit Richtext
- 26.1. Configuration
- 26.2. Richtext as a Model Field
- 26.3. Implementation Details
27. Richtext Extensions
- 27.1. Creating a custom hyperlink editor
28. Slug Input Field
- 28.1. Implementation
29. Date- and DateTime Input
- 29.1. Date Input Widget
- 29.2. Date Picker Widget
- 29.3. Date Textbox Widget
- 29.4. Date Calendar Widget
- 29.5. Date-Time Picker Widget
- 29.6. Date and Time Constraints
- 29.7. Applying Context to the Calendar
30. Date- and Date-Time Range
- 30.1. Date Range Field
- 30.2. Date-Time Range Field
- 30.3. Applying Context to the Calendar
31. Country Select Field with Flag Symbol
- 31.1. Select a single Country
- 31.2. Select multiple Countries
- 31.3. Implementation Details
32. Phone Number Field
- 32.1. Installation
- 32.2. Usage
- 32.3. Extra Settings
- 32.4. Rendering Phone Numbers
- 32.5. Implementation Details
33. Django-Admin Integration
- 33.1. Declaration over Configuration
- 33.2. Example using a ModelForm
- 33.3. Example using a FormCollection
34. Developing in django-formset
- 34.1. Setting up and running Tests
- 34.2. Building the Parsers
- 34.3. Building the Client
- 34.4. Building the Documentation
- 34.5. Running the Django Test App
35. Contributing to the Project
- 35.1. Writing Code
- 35.2. Reporting Bugs
- 35.3. Adding new Features
- 35.4. Quoting
- 35.5. Lists versus Tuples
36. Frequently Asked Questions
37. Changes
38. History of django-formset
39. A conversation with Chat-GPT

Project Home¶

The complete source for django-formset is available on GitHub at https://github.com/jrief/django-formset

License¶

django-formset is licensed according to the MIT public license.