Code Monkey home page Code Monkey logo

django-admin-column-toggle's Introduction

Django Admin Column Toggle

Django Admin Column Toggle is a reusable Django package that adds column toggle functionality to the Django admin interface. This allows users to show or hide columns in the list view of the Django admin site.

Installation

  1. Install the package:

    With poetry

    poetry add django-admin-column-toggle
    

    With pip

    pip install django-admin-column-toggle
    
  2. Add 'column_toggle' to your `INSTALLED_APPS` setting in your Django project:

    INSTALLED_APPS = [
    ...
    'column_toggle',
    ]

Usage

  1. Import `ColumnToggleModelAdmin` from `column_toggle.admin` and inherit it in your `ModelAdmin` class. For example:

    from django.contrib import admin
    from column_toggle.admin import ColumnToggleModelAdmin
    from .models import YourModel
    
    @admin.register(YourModel)
    class YourModelAdmin(ColumnToggleModelAdmin):
        list_display = ('field1', 'field2', 'field3')
  2. To set the default selected columns, add the `default_selected_columns` attribute in your `ModelAdmin` class:

    @admin.register(YourModel)
    class YourModelAdmin(ColumnToggleModelAdmin):
        list_display = ('field1', 'field2', 'field3')
        default_selected_columns = ['field1', 'field2']

    By doing this, only the specified columns ('field1' and 'field2' in this example) will be visible by default. Users can still toggle the visibility of other columns manually.

  3. That's it! Now you should have column toggle functionality in the Django admin list view for the specified model.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

MIT

django-admin-column-toggle's People

Contributors

engwerda avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.