Skip to content

Latest commit

 

History

History
89 lines (54 loc) · 3.64 KB

README.md

File metadata and controls

89 lines (54 loc) · 3.64 KB
Raw

django-angular

Let Django play well with AngularJS

Build Status PyPI version Python versions Software license Twitter Follow

Deprecation Warning: AngularJS is dead

Since AngularJS is deprecated now, this library shall not be used for new projects anymore. Instead please proceed with my follow-up project django-formset. All the useful features for Django Form validation have been reimplemented in django-formset, this time in vanilla TypeScript and without depending on any third party package.

What does it offer?

Add AngularJS directives to Django Forms. This allows to handle client side form validation using the constraints provided by the server side Form declaration.

For more information, please visit the demo site.

How to run

git clone https://github.com/jrief/django-angular.git django-angular.git
cd django-angular.git
docker build -t django-angular.git .
docker run -d -it -p 9002:9002 django-angular.git

Open the application at http://{docker-host's-ip}:9002/

Backward Incompatibility

To be compliant with other libraries such as djangorestframework, server-side responses on rejected forms use error code 422, rather than 200. If you use your own form controllers, adopt them accordingly. The JSON format used to communicate errors downstream has changed slightly.

New Features

For a smoother transition path, django-angular added two directives in version 2.0:

<form djng-endpoint="/path/to/endpoint">...</form>, which can be used to upload form data to the server. It also populates the error fields, in case the server rejected some data.

<djng-forms-set endpoint="/path/to/endpoint"><form ...>...</form>...</djng-forms-set> Similar to the above directive, but rather than validating one single form, it validates a set of forms using one shared endpoint.

A promise chain has been introduced. Buttons used to submit form data and then proceed with something else, now can be written as:

<button ng-click="do(update()).then(redirectTo('/path/to/other/page'))">Label</button>

Documentation

Detailed documentation on ReadTheDocs.

Demo on how to combine Django with Angular's form validation.

Please drop me a line, if and where you use this project.

Features

  • Seamless integration of Django forms with AngularJS controllers.
  • Client side form validation for Django forms using AngularJS.
  • Let an AngularJS controller call methods in a Django view - kind of Javascript RPCs.
  • Manage Django URLs for static controller files.
  • Three way data binding to connect AngularJS models with a server side message queue.
  • Perform basic CRUD operations.

Examples

License

Copyright © 2019

MIT licensed