django-search-input-field 0.1.12

A Django app providing a search input field.

Django Search Input Field

The Django Search Input Field package simplifies the process of integrating Ajax searchable input fields into Django forms. This package provides flexibility for searching model fields or any custom data, enhancing the user experience and improving search functionality within your Django applications.

Installation

You can install the package via pip:

pip install django-search-input-field

Once installed, add the app to your INSTALLED_APPS in your Django settings:

INSTALLED_APPS = [
    ...
    "django_search_input_field"
]

Finally, include the package's URLs in your project's URL configuration:

urlpatterns = [
    path('django_search_input_field/', include('django_search_input_field.urls')),
]

Usage

Field Types

SelectSearchCharField

The SelectSearchCharField is used to perform a search on a specified field and return the field value.

Example Usage:

from django import forms
from django_search_input_field.field import SelectSearchCharField
from Main.models import Customers

class CustomerSearchFieldForm(forms.Form):
    name = SelectSearchCharField(field="name", model=Customers)

SearchModelField

The SearchModelField is used to search based on a specified field but returns the entire model object, using the field for searching.

Example Usage:

from django import forms
from django_search_input_field.field import SearchModelField
from Main.models import Customers

class CustomerSearchFieldForm(forms.Form):
    name = SearchModelField(model=Customers, search_field="name")

CharRelatedField

The CharRelatedField is used to fill related fields automatically when a SearchModelField is selected.

Example Usage:

from django import forms
from django_search_input_field.field import CharRelatedField, SearchModelField
from Main.models import Customers

class CustomerSearchFieldWithRelatedForm(forms.Form):
    name = SearchModelField(model=Customers, search_field="name")
    email = CharRelatedField(related_field="name", related_search_input="email")

Advanced Usage

fields

Argument	Description
field	Specifies the field to perform the search on.
model	Specifies the model to perform the search on. Only used with SelectSearchCharField.
search_field	Specifies the field to search on. Only used with SearchModelField.
related_field	Specifies the related field to populate automatically. Only used with CharRelatedField.
related_search_input	Specifies the related search input. Only used with CharRelatedField.
permissions	Specifies the permissions required for the search operation.
query_function_name	Specifies the name of the query function to be used.
min_search_length	Specifies the minimum length of characters required for the search to execute.

Custom Providers

You can create custom providers to tailor the search behavior according to your specific requirements.

Here's an example of creating a custom provider:

from django_search_input_field.providers import SearchModelProvider

class CustomModelProvider(SearchModelProvider):
    model = YourModel
    query_function_name = 'custom_search_function'
    auto_register = True

    def get_queryset(self):
        # Implement your custom queryset logic here
        return YourModel.objects.all()

    def get_filtered_queryset(self, function_filters, search_key):
        # Implement your custom filtered queryset logic here
        return YourModel.objects.filter(**function_filters)

    def get_filtered_options(self, function_filters, search_key):
        options = self.get_filtered_queryset(function_filters, search_key)
        return [ModelOption(option, serializer=None, object_str=lambda obj: str(obj)) for option in options]

Using Custom Providers

After creating a custom provider, you can use it in your form or field:

from django import forms
from django_search_input_field.field import SearchModelField
from .providers import CustomModelProvider

class YourForm(forms.Form):
    custom_field = SearchModelField(
        model=None,
        search_field="your_field",
        permissions=[YourCustomPermission],
        query_function_name=CustomModelProvider.query_function_name,
        min_search_length=1,
    )