https://github.com/zachmccormick/django-related-select

designed to make AJAX-powered select fields easy using Django forms
https://github.com/zachmccormick/django-related-select

Last synced: 5 months ago
JSON representation

designed to make AJAX-powered select fields easy using Django forms

• Host: GitHub
• URL: https://github.com/zachmccormick/django-related-select
• Owner: zachmccormick
• License: apache-2.0
• Created: 2016-06-02T14:36:15.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2018-04-11T13:07:09.000Z (about 8 years ago)
• Last Synced: 2025-12-02T11:39:30.310Z (6 months ago)
• Language: Python
• Homepage:
• Size: 18.6 KB
• Stars: 6
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
# django-related-select

The django-related-select module is designed to make ajax-powered select fields easy using Django forms.

## Installation

Install using pip:

    pip install django-related-select

Add to INSTALLED_APPS

     INSTALLED_APPS = [

         ...

         'related_select',

         ...

     ]

## Usage

### Form

    class MyForm(forms.Form):

        foo = forms.ChoiceField(choices=[('foo', 'foo')])

        bar = RelatedChoiceField(related_dependent='foo', related_url=reverse_lazy('my-related-select-view'))

        

        # optional if you're using bound forms, for error handling or pre-filling of fields

        # otherwise any RelatedChoiceFields will lose their contents

        def __init__(self, **kwargs):

            super(MyForm, self).__init__(**kwargs)

            if self.is_bound:

                self.fields['bar'].init_bound_field(self.data.get('foo'))

### View

    class MyRelatedSelectView(RelatedSelectView):

        @staticmethod

        def filter(value, **kwargs):

            return SomeModel.objects.filter(related_model_id=value)

        

        @staticmethod

        def to_value(obj):

            # uses obj.id by default, but can return any valid value

            return obj.uuid

        

        @staticmethod

        def to_text(obj):

            # uses str(obj) by default, but can return any string

            return '({}) {}'.format(obj.id, obj.name)

### Template

    

    ...

    {{ form.bar }}

    ...

    

    ...