Add inline editble fields to your templates
Project description
django-inlineedit
Inline editing for Django models
Installation
-
Use pip to install the latest stable release
pip install django-inlineeditOR
Run the following command inside the top-level cloned repository:
'easy_install .'
-
Add
inlineedittoINSTALLED_APPSin the project settings (see dependencies below) -
Add
path(<url for form submission>, include('inlineedit.urls'))to the base URLsdjango-inlineedit will use any URL you specify, make sure it does not conflict with existing URLs in your app!
Quickstart
In your templates add the django-inlineedit JS in a suitable location (for example at the bottom of the template <body>):
{% load inlineedit %}
{% inlineedit_default_script %}
Then load the template tags with:
{% load inlineedit %}
to add inline editing to a field, you use the inlineedit template tag. For example:
{% inlineedit "my_object.my_field" %}
This will add the HTML and JS necessary to edit my_field in object my_object. without any further configuration, the tag will display the field and show the editing link when the mouse hover over the field. A single click will open up an editing element and accept/reject buttons. Click the former to accept any changes and the latter to cancel those.
Custom Adaptors
The adaptors mediate how django-inlineedit interprets various kinds of fields and template forms or widgets. Users can define their own adaptors to support new types of fields and widgets.
To create a new adaptor create a class that derives from inlineedit.adaptors.basic.BasicAdaptor and re-implement its methods as required. most often you will want to rewrite form_field and/or display_value. These functions respectively return the form field and HTML reprentation of the editable field. the specialist adaptors provided for markdown inputs and to support the CKEditor WYSIWYG editor are good examples to start with.
Once your custome adaptor has been created, register it in the project settings file by defining the INLINEEDIT_ADAPTORS dictionary. for example:
INLINEEDIT_ADAPTORS = {
"custom": "main.adaptors.ExampleCustomAdaptor",
}
Finally, you refer to the new adaptor by its INLINEEDIT_ADAPTORS key. for example:
{% inlineedit "my_object.my_custom_field" "custom" %}
Dependencies:
Required jquery 3.3.1 or higher installed.
Support for integration with other libraries (optional)
-
django-reversions
No configuration is needed, django-inlineedit will simply use django-reversion as long as your models are decorated with @reversion.register()
-
Django-CKEditor
Version 5.9.0 or higher is required for the CKEditor adaptor to work. for example:
{% inlineedit "my_object.my_field" "ckeditor" %}Or
{% inlineedit "my_object.my_field" "ckeditor" "toolbar" %} -
Markdown
The Python library Markdown is required for the adaptor to work
{% inlineedit "my_object.my_field" "markdown" %}
Running examples
- cd into the root directory of the example you want to run (under the examples folder)
- run
python3 manage.py migrateto setup a local sqlite3 database. - run
python3 manage.py runserverto start a local development server for the example.
Open source licenses
This product depends on the following software and media packages
Bootstrap version 4.0 is licensed under the MIT License
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for django_inlineedit-1.1-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | f5a91e8c54672872db0b6c0ac3d85c376fe30d55d5190c6b8ba2d21510a68709 |
|
| MD5 | 54bf65bafba5c9dae75b0fcdac1a080a |
|
| BLAKE2b-256 | c972455b0b0eefbae083f2e84003d060a3687fe11deaf91b101c2179492732e2 |
