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-inlineedit`
OR
Run the following command inside the top-level cloned repository:
'easy_install .'
Finally, make sure jquery is loaded on any templates that use inline editing. For example, add the following to the HEAD of your page:
<script src="https://code.jquery.com/jquery.js"></script>
Quickstart
Add inlineedit to INSTALLED_APPS in the project settings (see dependencies below)
Add path(<url for form submission>, include('inlineedit.urls')) to the base URLs. Django-inlineedit will use any URL you specify, but make sure it does not conflict with existing URLs in your app!
In your templates load the template tags with:
{% load inlineedit %}
Then add the django-inlineedit JS is a suitable location (for example at the bottom of the template <body>). jQuery must be loaded before this:
{% inlineedit_default_script %}
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.
ForeignKeys can be transversed as expected:
{% inlineedit "my_object.my_child_object.my_field" %}
Access Control
The default behaviour is to users that have change permissions to edit a particular model field.
To change this behaviour set INLINEEDIT_EDIT_ACCESS in settings to a callable that takes the user, model instance and field class as arguments and returns True if editing is allowed.
Two additional options are in the app. access.is_staff and access.is_superuser allow editing only by staff members or superusers respectively. The former also requires that the user has change permission. Finally, access.has_perm implements the default behaviour. Example:
INLINEEDIT_EDIT_ACCESS = inlineedit.access.is_staff
Access control can also be implemented at adaptor level as described below
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.
Three custom adaptors are provided with Django-inlineedit: markdown, ckeditor and ckeditor-implicit. These clearly support markdown inputs and the CKEditor WYSIWYG editor. The latter version of the CKEditor adaptor supports the case where the CKEditor RichTextField model field is used. The former overwrite the widget with the CKEditor version and allows custom toolbars to be selected in the template tag
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.
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-adaptor": "main.adaptors.ExampleCustomAdaptor",
}
Finally, you refer to the new adaptor by its INLINEEDIT_ADAPTORS key. for example:
{% inlineedit "my_object.my_custom_field" "custom-adaptor" %}
Extra Arguments
the inlineedit template tag can handle certain extra parameters
| Parameter | Options | Description |
|---|---|---|
| template | 'inlineedit/default.html' (the default), 'inlineedit/fixed.html' or any other template of your choice | Chose template used to render inlineedit links and forms |
Any other positional or named arguments are passed on to the adaptor constructor.
Access Control in Custom Adaptors
You can control access to editing at adaptor level as well by overwriting has_edit_perm(user). For example, the following will allow anyone to edit a particular field that is using ExampleCustomAdaptor:
class ExampleCustomAdaptor:
def has_edit_perm(user):
return True
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.2-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c98c057c77ec0156e8c4df63b7dfa4574bffe7e9748414f1bf6b3a1da9e41028 |
|
| MD5 | 88bbaa10a2bb61722473fe6df99aef2a |
|
| BLAKE2b-256 | b7069d490b75b41c8c76fc21a235f62efd48f94aa91f22860719f4fd3e0045e6 |
