From 3e1d4369ba49f1f8e76ca59cc6f91d628696eea4 Mon Sep 17 00:00:00 2001
From: atownson <52260120+atownson@users.noreply.github.com>
Date: Mon, 3 Mar 2025 08:20:04 -0600
Subject: [PATCH] Closes #17944: Allow filtering of ObjectVar and
 MultiObjectVar script inputs (#18725)

* Add the advanced object selector to the ObjectVar and MultiObjectVar script inputs

* Fix formatting issue
---
 docs/customization/custom-scripts.md | 1 +
 netbox/extras/scripts.py             | 5 ++++-
 netbox/templates/extras/script.html  | 4 ++++
 3 files changed, 9 insertions(+), 1 deletion(-)

diff --git a/docs/customization/custom-scripts.md b/docs/customization/custom-scripts.md
index 1051b31f6..7774ef35f 100644
--- a/docs/customization/custom-scripts.md
+++ b/docs/customization/custom-scripts.md
@@ -308,6 +308,7 @@ A particular object within NetBox. Each ObjectVar must specify a particular mode
 * `query_params` - A dictionary of query parameters to use when retrieving available options (optional)
 * `context` - A custom dictionary mapping template context variables to fields, used when rendering `<option>` elements within the dropdown menu (optional; see below)
 * `null_option` - A label representing a "null" or empty choice (optional)
+* `selector` - A boolean that, when True, includes an advanced object selection widget to assist the user in identifying the desired object (optional; False by default)
 
 To limit the selections available within the list, additional query parameters can be passed as the `query_params` dictionary. For example, to show only devices with an "active" status:
 
diff --git a/netbox/extras/scripts.py b/netbox/extras/scripts.py
index 0d9c2181f..2d3f96254 100644
--- a/netbox/extras/scripts.py
+++ b/netbox/extras/scripts.py
@@ -211,10 +211,12 @@ class ObjectVar(ScriptVariable):
     :param context: A custom dictionary mapping template context variables to fields, used when rendering <option>
         elements within the dropdown menu (optional)
     :param null_option: The label to use as a "null" selection option (optional)
+    :param selector: Include an advanced object selection widget to assist the user in identifying the desired
+        object (optional)
     """
     form_field = DynamicModelChoiceField
 
-    def __init__(self, model, query_params=None, context=None, null_option=None, *args, **kwargs):
+    def __init__(self, model, query_params=None, context=None, null_option=None, selector=False, *args, **kwargs):
         super().__init__(*args, **kwargs)
 
         self.field_attrs.update({
@@ -222,6 +224,7 @@ class ObjectVar(ScriptVariable):
             'query_params': query_params,
             'context': context,
             'null_option': null_option,
+            'selector': selector,
         })
 
 
diff --git a/netbox/templates/extras/script.html b/netbox/templates/extras/script.html
index ff01cc59a..220a9d714 100644
--- a/netbox/templates/extras/script.html
+++ b/netbox/templates/extras/script.html
@@ -54,3 +54,7 @@
     </div>
   </div>
 {% endblock content %}
+
+{% block modals %}
+  {% include 'inc/htmx_modal.html' with size='lg' %}
+{% endblock %}