Skip to content

docs: autocomplete field term filter #1709

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lukasvinclav merged 3 commits into from
Nov 29, 2025
Merged

docs: autocomplete field term filter #1709

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
08be473
docs: autocomplete field term filter
lukasvinclav Nov 29, 2025
43c84ab
docs: autocomplete term filter example
lukasvinclav Nov 29, 2025
848769f
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Nov 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions docs/fields/autocomplete.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,22 @@ class MyAutocompleteView(BaseAutocompleteView):
model = MyModel

def dispatch(self, request, *args, **kwargs):
# DO THE PERMISSIONS CHECKS HERE
# Permissions checks here
return super().dispatch(request, *args, **kwargs)

def get_queryset(self):
# ADDITIONAL FILTERS AND PERMISSIONS CHECKS HERE
return super().get_queryset()
# Search query is available in the request.GET object under the key "term"
term = self.request.GET.get("term")

# Additional filters and permissions checks here
qs = super().get_queryset()

# No search provided, return all results
if term == "":
return qs

# Search query provided, filter results
return qs.filter(my_field__icontains=term)


@admin.register(MyModel)
Expand Down