Simple-Dom-Control Documentation

Simple-Dom-Control, usually shortened to SDC, is a Django-centered framework for building server-rendered applications with a structured client runtime. It combines:

• Django views and templates for server-side HTML generation

• JavaScript controllers for client-side behavior and DOM orchestration

• model synchronization over WebSockets

• CLI tooling that generates controllers, models, and project scaffolding

This documentation now covers both parts of the system:

• the Python/Django package simpledomcontrol

• the JavaScript runtime SimpleDomControlClient

Guides

• What is SDC
  • What SDC provides
  • Architecture overview
  • Why SDC exists
  • Relationship to MVC and MVT
• Installation
  • Requirements
  • Install the Python package
  • What gets installed
  • Next step
• Getting Started
  • Quick setup
  • Manual setup flow
  • What sdc_init changes
  • Project layout after initialization
  • Create your first app
  • Your first controller
  • Your first model
  • Where the client docs fit in
• Core of SDC
  • Management command
  • SDC extensions
• First App
  • The one idea to hold onto
  • Project setup
  • New Controller
  • Basic Navigation
  • DB Model
  • Client-Side Data Models
  • Wiring up the Catalog
  • Server methods on a controller view
  • Registering the model on the client
  • Live updates over WebSocket
  • The “My List” page
  • Book details and modal navigation
  • Editing books as staff
  • Named forms
  • Feedback and auto-submitting forms
  • Login, logout and groups
  • URL parameters and sdc_update_url
  • Lifecycle recap
  • Safe DOM updates
  • Testing the app
  • General styling and HTML header
  • Running the app
  • Cheat sheet
  • Common gotchas
  • What to explore next
• How to navigate?
  • Basic Navigation
  • Parametrized Navigation
  • Navigate from code
  • Nested detail views
  • Subview in Modal

Runtime and API

• The Client Runtime
  • Overview
  • Primary exports
  • Bootstrap flow
  • Tag registration
  • DOM parameter binding
  • contentUrl and HTML loading
  • Dynamic DOM fragments
  • Safe DOM operations
  • Client asset structure
  • Where to read next
• SDC Controllers
  • Creating a controller
  • Server side of a controller
  • Client files
  • The JavaScript controller
  • Lifecycle
  • Example controller
  • DOM events
  • Refresh and reconciliation
  • Mixins
  • Server calls
  • Forms and models
  • Built-in controllers in sdc_tools
• SDC Models
  • Creating a model
  • Server model metadata
  • Authorization
  • Client-side model architecture
  • Querysets in controllers
  • SdcQuerySet behavior
  • Loading and re-synchronizing data
  • Other queryset methods
  • Server-rendered views
  • Forms and SdcModel synchronization
  • How rendered forms are attached
  • Validation errors
  • Relationships
  • Uploads and connection lifecycle

Indices and tables

• Index

• Module Index

• Search Page