Skip to main content

Add action buttons to individual rows in the Django Admin

Project description

Django Admin Row Actions

Allows you to easily define a drop-down 'actions' menu that is appended as the final column in your model's changelist and perform actions on that row.

Menu items can call urls or methods, can be disabled, have tooltips, etc.

I've extracted this from code written for http://hireablehq.com/. The admin there has Bootstrap available but I've modified this version to use a standalone jQuery dropdown.

Installation

  1. Install from PyPI:

    pip install django-admin-row-actions
    

    or install using pip and git:

    pip install git+https://github.com/DjangoAdminHackers/django-admin-row-actions.git
    
  2. Add to INSTALLED_APPS:

    INSTALLED_APPS = [
        ...
        'django_admin_row_actions',
        ...
    ]
    
  3. Add the mixin to your ModelAdmin:

    from django_admin_row_actions import AdminRowActionsMixin
    ...
    
    class ExampleAdmin(AdminRowActionsMixin, admin.ModelAdmin):
        ...
    
  4. Define a get_row_actions method on your ModelAdmin

    def get_row_actions(self, obj):
        row_actions = [
            {
                'label': 'Edit',
                'url': obj.get_edit_url(),
                'enabled': obj.status is not 'cancelled',
            }, {
                'label': 'Download PDF',
                'url': obj.get_pdf_url(),
            }, {
                'label': 'Convert',
                'url': reverse('convert_stuff', args=[obj.id]),
                'tooltip': 'Convert stuff',
            }, {
                'divided': True,
                'label': 'Cancel',
                'action': 'mark_cancelled',
            },
        ]
        row_actions += super(ExampleAdmin, self).get_row_actions(obj)
        return row_actions
    

The first three menu items are simple links to a url you provide by whatever means you choose.

The final one defines 'action' instead of 'url'. This should be the name of a callable on your ModelAdmin or Model class (similar to ModelAdmin.list_display).

You can add mouseover tooltips to each individual actions with the 'tooltip' dictionary key, and enable/disable individual actions for each individual object with the 'enabled'.

Special option 'divided' can be passed to any item to display horizontal rule above it.

Credits

Inspired (and code based on): django-object-actions

Includes parts of jquery-dropdown; credits go to Cory LaViska.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django_admin_row_actions-0.10.0.tar.gz (10.5 kB view details)

Uploaded Source

Built Distribution

django_admin_row_actions-0.10.0-py2.py3-none-any.whl (13.6 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file django_admin_row_actions-0.10.0.tar.gz.

File metadata

  • Download URL: django_admin_row_actions-0.10.0.tar.gz
  • Upload date:
  • Size: 10.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.11.3 Darwin/21.6.0

File hashes

Hashes for django_admin_row_actions-0.10.0.tar.gz
Algorithm Hash digest
SHA256 b75e2b40d14f3caa230806432b6e0877c27776f3b13c67a5bacf7db5211e4b2e
MD5 425200ef6e07af415b3784e6fff8e430
BLAKE2b-256 c4c47dcee6f800722559be540f62604544cdb6d8d56f0ad8281246b0b9f20089

See more details on using hashes here.

Provenance

File details

Details for the file django_admin_row_actions-0.10.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for django_admin_row_actions-0.10.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 7ac3a9747727b1186b8c1a7d8067c6a0946d3df2bc3b8618a430b7f03c4630e1
MD5 603cfe2d41e7810a9e4f75b7f5c8151a
BLAKE2b-256 89a7ab92b79c93da700657c5d1c3be594b6d474df307d00fc6f94df10ab4ed85

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page