Convert EmailFields to GovukEmailFields

Changes those fields (and sometimes also regular text input fields) in the following forms: - LoginForm - RegisterUserForm - ChangeEmailForm - FeedbackOrProblem - AcceptAgreementForm - ChangeNameForm (only name field here, but used in the same template field as ChangeEmailForm here: app/templates/views/user-profile/change.html) Also includes changes to templates that use this form and associated tests.
2026-07-29 04:09:07 -04:00 · 2020-08-07 15:16:04 +01:00
parent 7e771a5fa1
commit 39bc7cf721
21 changed files with 95 additions and 76 deletions
--- a/app/main/forms.py
+++ b/app/main/forms.py
@@ -147,7 +147,7 @@ def email_address(label='Email address', gov_user=True, required=True):
    if required:
        validators.append(DataRequired(message='Cannot be empty'))

-    return EmailField(label, validators, render_kw={'spellcheck': 'false'})
+    return GovukEmailField(label, validators, render_kw={'spellcheck': 'false'})


 class UKMobileNumber(TelField):
@@ -557,7 +557,7 @@ class OnOffField(RadioField):


 class LoginForm(StripWhitespaceForm):
-    email_address = EmailField('Email address', validators=[
+    email_address = GovukEmailField('Email address', validators=[
        Length(min=5, max=255),
        DataRequired(message='Cannot be empty'),
        ValidEmail()
@@ -568,8 +568,10 @@ class LoginForm(StripWhitespaceForm):


 class RegisterUserForm(StripWhitespaceForm):
-    name = StringField('Full name',
-                       validators=[DataRequired(message='Cannot be empty')])
+    name = GovukTextInputField(
+        'Full name',
+        validators=[DataRequired(message='Cannot be empty')]
+    )
    email_address = email_address()
    mobile_number = international_phone_number()
    password = password()
@@ -1299,7 +1301,7 @@ class CsvUploadForm(StripWhitespaceForm):


 class ChangeNameForm(StripWhitespaceForm):
-    new_name = StringField(u'Your name')
+    new_name = GovukTextInputField(u'Your name')


 class ChangeEmailForm(StripWhitespaceForm):
@@ -1401,7 +1403,7 @@ class SupportRedirect(StripWhitespaceForm):


 class FeedbackOrProblem(StripWhitespaceForm):
-    name = StringField('Name (optional)')
+    name = GovukTextInputField('Name (optional)')
    email_address = email_address(label='Email address', gov_user=False, required=True)
    feedback = TextAreaField('Your message', validators=[DataRequired(message="Cannot be empty")])

@@ -1850,7 +1852,7 @@ def get_placeholder_form_instance(
        else:
            field = uk_mobile_number(label=placeholder_name)
    else:
-        field = StringField(placeholder_name, validators=[
+        field = GovukTextInputField(placeholder_name, validators=[
            DataRequired(message='Cannot be empty')
        ])

@@ -2191,7 +2193,7 @@ class AcceptAgreementForm(StripWhitespaceForm):
            on_behalf_of_email=org.agreement_signed_on_behalf_of_email_address,
        )

-    version = StringField(
+    version = GovukTextInputField(
        'Which version of the agreement do you want to accept?'
    )

@@ -2209,7 +2211,7 @@ class AcceptAgreementForm(StripWhitespaceForm):
        ),
    )

-    on_behalf_of_name = StringField(
+    on_behalf_of_name = GovukTextInputField(
        'What’s their name?'
    )

--- a/app/templates/views/agreement/agreement-accept.html
+++ b/app/templates/views/agreement/agreement-accept.html
@@ -1,5 +1,4 @@
 {% extends "withnav_template.html" %}
-{% from "components/textbox.html" import textbox %}
 {% from "components/radios.html" import radio, conditional_radio_panel %}
 {% from "components/select-input.html" import select_wrapper %}
 {% from "components/form.html" import form_wrapper %}
@@ -28,10 +27,14 @@
        {% endfor %}
      {% endcall %}
      {% call conditional_radio_panel('on-behalf-of') %}
-        {{ textbox(form.on_behalf_of_name, width='1-1') }}
-        {{ textbox(form.on_behalf_of_email, width='1-1') }}
+        {{ form.on_behalf_of_name(param_extensions={"classes": "govuk-!-width-full"}) }}
+        {{ form.on_behalf_of_email(param_extensions={"classes": "govuk-!-width-full"}) }}
      {% endcall %}
-      {{ textbox(form.version, width='1-3', hint='The version number is on the front page, for example ‘3.6’') }}
+      {{ form.version(
+        param_extensions={
+          "hint": {"text": "The version number is on the front page, for example ‘3.6’"},
+          "classes": "govuk-!-width-one-third"}
+      ) }}

      {{ page_footer('Continue') }}

--- a/app/templates/views/forgot-password.html
+++ b/app/templates/views/forgot-password.html
@@ -1,5 +1,4 @@
 {% extends "withoutnav_template.html" %}
-{% from "components/textbox.html" import textbox %}
 {% from "components/page-footer.html" import page_footer %}
 {% from "components/form.html" import form_wrapper %}

@@ -16,7 +15,7 @@ Create a new password
    <p class="govuk-body">We’ll send you an email to create a new password.</p>

    {% call form_wrapper() %}
-      {{ textbox(form.email_address, safe_error_message=True) }}
+      {{ form.email_address(error_message_with_html=True) }}
      {{ page_footer("Send email") }}
    {% endcall %}

--- a/app/templates/views/invite-user.html
+++ b/app/templates/views/invite-user.html
@@ -1,5 +1,4 @@
 {% extends "withnav_template.html" %}
-{% from "components/textbox.html" import textbox %}
 {% from "components/page-header.html" import page_header %}
 {% from "components/page-footer.html" import page_footer %}
 {% from "components/form.html" import form_wrapper %}
@@ -17,7 +16,12 @@

  {% call form_wrapper() %}

-    {{ textbox(form.email_address, width='1-1', safe_error_message=True) }}
+    {{ form.email_address(
+      param_extensions={
+        "classes": "govuk-!-width-full"
+      },
+      error_message_with_html=True
+    ) }}

    {% include 'views/manage-users/permissions.html' %}

--- a/app/templates/views/manage-users/edit-user-email.html
+++ b/app/templates/views/manage-users/edit-user-email.html
@@ -1,5 +1,4 @@
 {% extends "withnav_template.html" %}
-{% from "components/textbox.html" import textbox %}
 {% from "components/page-header.html" import page_header %}
 {% from "components/page-footer.html" import page_footer %}
 {% from "components/form.html" import form_wrapper %}
@@ -17,7 +16,7 @@

  <p class="govuk-body" id="user_name">This will change the email address for {{ user.name }}.</p>
  {% call form_wrapper() %}
-    {{ textbox(form.email_address, width='1-1', safe_error_message=True) }}
+    {{ form.email_address(param_extensions={"classes": "govuk-!-width-full"}, error_message_with_html=True) }}
    {{ page_footer('Save') }}
  {% endcall %}

--- a/app/templates/views/organisations/organisation/users/invite-org-user.html
+++ b/app/templates/views/organisations/organisation/users/invite-org-user.html
@@ -1,6 +1,5 @@
 {% extends "org_template.html" %}

-{% from "components/textbox.html" import textbox %}
 {% from "components/page-footer.html" import page_footer %}
 {% from "components/page-header.html" import page_header %}
 {% from "components/form.html" import form_wrapper %}
@@ -16,7 +15,12 @@
    back_link=url_for('.manage_org_users', org_id=current_org.id)
  ) }}
  {% call form_wrapper() %}
-    {{ textbox(form.email_address, width='1-1', safe_error_message=True) }}
+    {{ form.email_address(
+      param_extensions={
+        "classes": "govuk-!-width-full"
+      },
+      error_message_with_html=True
+    ) }}

    <div class="bottom-gutter">
 		  <p class="form-label">
--- a/app/templates/views/register.html
+++ b/app/templates/views/register.html
@@ -13,8 +13,15 @@ Create an account
  <div class="govuk-grid-column-two-thirds">
    <h1 class="heading-large">Create an account</h1>
    {% call form_wrapper(autocomplete=True) %}
-      {{ textbox(form.name, width='3-4') }}
-      {{ textbox(form.email_address, hint="Must be from a public sector organisation", width='3-4', safe_error_message=True, autocomplete='email') }}
+      {{ form.name(param_extensions={"classes": "govuk-!-width-three-quarters"}) }}
+      {{ form.email_address(
+        param_extensions={
+          "hint": {"text": "Must be from a public sector organisation"},
+          "classes": "govuk-!-width-three-quarters",
+          "autocomplete": "email"
+        },
+        error_message_with_html=True
+      ) }}
      <div class="extra-tracking">
        {{ textbox(form.mobile_number, width='3-4', hint='We’ll send you a security code by text message') }}
      </div>
--- a/app/templates/views/service-settings/email-reply-to/_verify-updates.html
+++ b/app/templates/views/service-settings/email-reply-to/_verify-updates.html
@@ -1,5 +1,4 @@
 {% from "components/banner.html" import banner, banner_wrapper %}
-{% from "components/textbox.html" import textbox %}
 {% from "components/page-footer.html" import page_footer %}
 {% from "components/form.html" import form_wrapper %}
 {% from "components/button/macro.njk" import govukButton %}
@@ -47,11 +46,12 @@
    {% call form_wrapper(
      action = form_url
    ) %}
-      {{ textbox(
-        form.email_address,
-        width='1-1',
-        safe_error_message=True,
-        hint='This should be a shared inbox managed by your team, not your own email address'
+      {{ form.email_address(
+          param_extensions={
+            "hint": {"text": "This should be a shared inbox managed by your team, not your own email address"},
+            "classes": "govuk-!-width-full"
+          },
+          error_message_with_html=True
      ) }}
      {% if not first_email_address and not existing_is_default %}
        {{ form.is_default }}
--- a/app/templates/views/service-settings/email-reply-to/add.html
+++ b/app/templates/views/service-settings/email-reply-to/add.html
@@ -1,5 +1,4 @@
 {% extends "withnav_template.html" %}
-{% from "components/textbox.html" import textbox %}
 {% from "components/page-header.html" import page_header %}
 {% from "components/page-footer.html" import page_footer %}
 {% from "components/form.html" import form_wrapper %}
@@ -16,11 +15,12 @@
  ) }}

  {% call form_wrapper() %}
-    {{ textbox(
-      form.email_address,
-      width='1-1',
-      hint='This should be a shared inbox managed by your team, not your own email address',
-      safe_error_message=True
+    {{ form.email_address(
+        param_extensions={
+          "hint": {"text": "This should be a shared inbox managed by your team, not your own email address"},
+          "classes": "govuk-!-width-full"
+        },
+        error_message_with_html=True
    ) }}
    {% if not first_email_address %}
      {{ form.is_default }}
--- a/app/templates/views/service-settings/email-reply-to/edit.html
+++ b/app/templates/views/service-settings/email-reply-to/edit.html
@@ -16,11 +16,12 @@
    back_link=url_for('main.service_email_reply_to', service_id=current_service.id)
  ) }}
  {% call form_wrapper() %}
-    {{ textbox(
-      form.email_address,
-      width='1-1',
-      safe_error_message=True,
-      hint='This should be a shared inbox managed by your team, not your own email address.'
+    {{ form.email_address(
+        param_extensions={
+          "hint": {"text": "This should be a shared inbox managed by your team, not your own email address"},
+          "classes": "govuk-!-width-full"
+        },
+        error_message_with_html=True
    ) }}
    {% if form.is_default.data %}
      <p class="form-group">
--- a/app/templates/views/signin.html
+++ b/app/templates/views/signin.html
@@ -1,5 +1,4 @@
 {% extends "withoutnav_template.html" %}
-{% from "components/textbox.html" import textbox %}
 {% from "components/page-footer.html" import page_footer %}
 {% from "components/form.html" import form_wrapper %}

@@ -32,7 +31,7 @@
    {% endif %}

    {% call form_wrapper(autocomplete=True) %}
-      {{ textbox(form.email_address, autocomplete='email') }}
+      {{ form.email_address(param_extensions={"autocomplete": "email"}) }}
      {{ form.password(param_extensions={"autocomplete": "current-password"}) }}
      {{ page_footer("Continue", secondary_link=url_for('.forgot_password'), secondary_link_text="Forgotten your password?") }}
    {% endcall %}
--- a/app/templates/views/support/form.html
+++ b/app/templates/views/support/form.html
@@ -27,8 +27,8 @@
        {% call form_wrapper() %}
            {{ textbox(form.feedback, width='1-1', hint='', rows=10, autosize=True) }}
            {% if not current_user.is_authenticated %}
-              {{ textbox(form.name, width='1-1') }}
-              {{ textbox(form.email_address, width='1-1') }}
+              {{ form.name(param_extensions={"classes": "govuk-!-width-full"}) }}
+              {{ form.email_address(param_extensions={"classes": "govuk-!-width-full"}) }}
            {% else %}
              <p class="govuk-body">We’ll reply to {{ current_user.email_address }}</p>
            {% endif %}
--- a/app/templates/views/user-profile/change.html
+++ b/app/templates/views/user-profile/change.html
@@ -1,5 +1,4 @@
 {% extends "withoutnav_template.html" %}
-{% from "components/textbox.html" import textbox %}
 {% from "components/page-header.html" import page_header %}
 {% from "components/page-footer.html" import page_footer %}
 {% from "components/form.html" import form_wrapper %}
@@ -18,7 +17,7 @@
  <div class="govuk-grid-row">
    <div class="govuk-grid-column-three-quarters">
      {% call form_wrapper() %}
-        {{ textbox(form_field, safe_error_message=True) }}
+        {{ form_field(error_message_with_html=True) }}
        {{ page_footer('Save') }}
      {% endcall %}
    </div>