Documented ObjectListView quick search feature for plugins #20500
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jeremystretch
requested review from
a team and
jnovinger
and removed request for
a team
jnovinger
requested changes
Oct 7, 2025
There was a problem hiding this comment.
Thanks for the doc additions, @991jo . It's much appreciated!
I made some notes here and below:
- Let's clarify that the "Quick Search" field is the UI field, not the field in the filter or the method name.
- Your sentences appear to all be on a separate line, is there some reason to not have them on the same line and let MkDocs figure out the wrapping?
| filterset_class = filtersets.MyModelFilterSet | ||
| ``` | ||
|
|
||
| ### Search function for use by the ObjectListView quick search |
There was a problem hiding this comment.
Suggested change
| ### Search function for use by the ObjectListView quick search | |
| ### Implementing Quick Search |
| Q(description__icontains=value) | ||
| ) | ||
| ``` | ||
|
|
There was a problem hiding this comment.
Some things that I think are worth mentioning:
NetBoxModelFilterSet.search()is already implemented and just returns the queryset unmodified, which is why it needs to be over-ridden here.- For context, the
search()method is called as a result of theqfilter, which is already wire up inNetBoxModelFilterSetand does not need to be over-ridden here unless different behavior is required.
| ### Search function for use by the ObjectListView quick search | ||
|
|
||
| The `ObjectListView` has a field called Quick Search. | ||
| For this field to work the corresponding FilterSet has to implement the `search` function. |
There was a problem hiding this comment.
Suggested change
| For this field to work the corresponding FilterSet has to implement the `search` function. | |
| For Quick Search to work the corresponding FilterSet has to implement the `search` method. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes: #20499