Skip to content

Staff search forms

staff_search_autocomplete_field(*, form, request, field_name, search_url, remove_text=None, remove_url=None, pre_html=None, field_label=None)

Crispy forms field for an autocomplete field.

Parameters:

Name Type Description Default
form Form

The form the field belongs to.

 required
request HttpRequest

The request object.

 required
field_name str

The name of the field.

 required
search_url str

The URL to the search view.

 required
remove_text Optional[str]

The text to display on the remove button. Defaults to None.

 None
remove_url Optional[str]

The URL to the remove view. Defaults to None.

 None

Returns:

Type Description
List[Union[Field, HTML]]

List[Union[Field, HTML]]: A list of crispy form fields.
Usage

Inside the Form's init method 

self.helper = FormHelper()
self.helper.layout = Layout(
    ...
    *staff_search_autocomplete_field(
        form=self,
        request=request,
        field_name="leaver_manager",
        # The StaffSearchView URL
        search_url=reverse("leaver-manager-search"),
        # An optional URL to remove the selected staff member
        remove_url=reverse("leaver-remove-line-manager"),
    ),
    ...
)

Source code in core/staff_search/forms.py 
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
def staff_search_autocomplete_field(
    *,
    form: forms.Form,
    request: HttpRequest,
    field_name: str,
    search_url: str,
    remove_text: Optional[str] = None,
    remove_url: Optional[str] = None,
    pre_html: Optional[HTML] = None,
    field_label: Optional[str] = None,
) -> List[Union[Field, HTML]]:
    """Crispy forms field for an autocomplete field.

    Args:
        form (forms.Form):
            The form the field belongs to.
        request (HttpRequest):
            The request object.
        field_name (str):
            The name of the field.
        search_url (str):
            The URL to the search view.
        remove_text (Optional[str], optional):
            The text to display on the remove button. Defaults to None.
        remove_url (Optional[str], optional):
            The URL to the remove view. Defaults to None.

    Returns:
        List[Union[Field, HTML]]:
            A list of crispy form fields.

    Usage:
        Inside the Form's __init__ method
        ```python
        self.helper = FormHelper()
        self.helper.layout = Layout(
            ...
            *staff_search_autocomplete_field(
                form=self,
                request=request,
                field_name="leaver_manager",
                # The StaffSearchView URL
                search_url=reverse("leaver-manager-search"),
                # An optional URL to remove the selected staff member
                remove_url=reverse("leaver-remove-line-manager"),
            ),
            ...
        )
        ```
    """

    current_value = form[field_name].value()
    if not current_value:
        current_value = form.initial.get(field_name)

    output = []

    if field_label:
        output.append(
            HTML(
                "<label class='govuk-label'"
                " for='id_{field_name}_search'>"
                "<strong>{field_label}</strong></label>"
            )
        )

    if pre_html:
        output.append(pre_html)

    output.append(Field.text(field_name, field_width=Fluid.TWO_THIRDS))
    output.append(
        HTML(
            render(
                request,
                "staff_search/search_field.html",
                {
                    "search_url": search_url,
                    "search_identifier": field_name,
                    "staff_uuid": current_value,
                    "remove_text": remove_text,
                    "remove_url": remove_url,
                },
            ).content.decode()
        )
    )

    return output