Number input

When to use this component

Use the number input component when you need to let a user enter either a whole number, a decimal number or either. When submitting data to CRM, this can be used where the target field is an appropriate number type.

When to not use this component

Do not use the number input component for any other purpose than allowing users to enter an whole number or decimal number.

There is specific guidance on how to ask for:

How it works

All number inputs must have labels, and in most cases the label should be visible.

Labels are aligned above the number input they refer to. They should be short, direct and written in sentence case. Do not use colons at the end of labels.

Refrain from using placeholder text instead of labels or for hints/examples. Placeholder text can disappear as soon as users start typing, potentially causing issues for users with memory conditions or when reviewing answers. Additionally, not all screen readers read placeholder text, and its default browser styles may not meet minimum contrast requirements.

HTML examples

Select the appropriate example from this page and directly integrate the HTML into your web template. You can customise these examples to align with your specific requirements, as indicated below. Refer to the layouts section for further guidance on structuring your web template.

If the component requires submission to a CRM field, ensure to replace the placeholder schema-name text in the HTML example with the actual target field schema name. Retain any prefixed or suffixed text related to the schema name. For instance, if the id attribute reads schema-name-hint in the example, ensure the replacement maintains the -hint suffix (e.g. dfe_field-hint).

This step is crucial for allowing the CRM helper framework to validate and submit data to CRM.

For single question pages

If presenting only one question on the page, designate the contents of the label as the page heading. This practice ensures users of screen readers hear the contents only once.

You will need to include an empty {% title %} block in your web template to remove the default page header and avoid duplication.

What is your age?

Update the HTML example

Replace 'schema-name' in the example by entering the schema name of your target CRM field.

      
      
<div class="govuk-form-group">
  <h1 class="govuk-label-wrapper">
    <label class="govuk-label govuk-label--l" for="schema-name">
      What is your age?
    </label>
  </h1>
  <input class="govuk-input govuk-input--width-5" id="schema-name" name="schema-name" type="text" spellcheck="false" inputmode="numeric">
</div>

Warning This is a basic web template page layout with a logged in user check and does not include additional liquid items which are common place on a CRM Portal, for example, web role, URL parameter or record checks.

      
      

{% extends 'DfE/Layouts/2ColumnWideLeft' %}

{% block title %}{% endblock %}   

{% block main %}
  {% unless user %}
    <script>
      window.location.href="{{ sitemarkers['DfE/Error/AccessDenied'].url }}"
    </script>
  {% endunless %}

  ## HTML content goes here ##

{% endblock %}

For multiple question pages

If presenting more than one question on the page, do not set the contents of the label as the page heading.

Number input component standard example

Example
HTML
Web Template

What is your age?

Update the HTML example

Replace 'schema-name' in the example by entering the schema name of your target CRM field.

      
      
<div class="govuk-form-group">
  <label class="govuk-label" for="schema-name">
    What is your age?
  </label>
  <input class="govuk-input govuk-input--width-5" id="schema-name" name="schema-name" type="text" spellcheck="false" inputmode="numeric">
</div>

      
      

{% extends 'DfE/Layouts/2ColumnWideLeft' %}

{% block title %}{% endblock %}   

{% block main %}
  {% unless user %}
    <script>
      window.location.href="{{ sitemarkers['DfE/Error/AccessDenied'].url }}"
    </script>
  {% endunless %}

  ## HTML content goes here ##

{% endblock %}

Using hint text

Use hint text to provide relevant assistance to the majority of users, such as clarifying how their information will be used or where to locate it. The hint text block is demonstrated in the example below.

Please ensure the following:

Use the hint text block appropriately
Place the hint block correctly within your HTML component
Add the aria-describedby attribute where necessary, for accessiblity. For the email component this is against the input.

Avoid lengthy paragraphs and lists in hint text, as screen readers will read out the entire content, potentially frustrating users. Additionally, refrain from including links within hint text, as screen readers do not indicate that the text is a clickable link.

Number input component hint example

Example
HTML
Web Template

What is your account number?

Must be between 6 and 8 digits long

Update the HTML example

Replace 'schema-name' in the example by entering the schema name of your target CRM field.

      
      
<div class="govuk-form-group">
  <h1 class="govuk-label-wrapper">
    <label class="govuk-label govuk-label--l" for="schema-name">
      What is your account number?
    </label>
  </h1>
  <div id="schema-name-hint" class="govuk-hint">
    Must be between 6 and 8 digits long
  </div>
  <input class="govuk-input govuk-input--width-10" id="schema-name" name="schema-name" type="text" spellcheck="false" aria-describedby="schema-name-hint" inputmode="numeric">
</div>

      
      

{% extends 'DfE/Layouts/2ColumnWideLeft' %}

{% block title %}{% endblock %}   

{% block main %}
  {% unless user %}
    <script>
      window.location.href="{{ sitemarkers['DfE/Error/AccessDenied'].url }}"
    </script>
  {% endunless %}

  ## HTML content goes here ##

{% endblock %}

Prefixes and suffixes

Use prefixes and suffixes to help users enter things like currencies and measurements.

Prefixes and suffixes are useful when there's a commonly understood symbol or abbreviation for the type of information you're asking for. Do not rely on prefixes or suffixes alone, because screen readers will not read them out.

If you need a specific type of information, say so in the input label or hint text as well. For example, put 'Cost, in pounds' in the input label and use the '£' symbol in the prefix.

Position prefixes and suffixes are positioned outside of their input to avoid interfering with some browsers that might insert an icon into the input (for example to show or generate a password).

Number input component prefix and suffix example

Example
HTML
Web Template

What is the cost per item, in pounds?

Update the HTML example

Replace 'schema-name' in the example by entering the schema name of your target CRM field.

      
      
<div class="govuk-form-group">
  <h1 class="govuk-label-wrapper">
    <label class="govuk-label govuk-label--l" for="schema-name">
      What is the cost per item, in pounds?
    </label>
  </h1>
  <div class="govuk-input__wrapper">
    <div class="govuk-input__prefix" aria-hidden="true">£</div>
    <input class="govuk-input govuk-input--width-5" id="schema-name" name="schema-name" type="text" spellcheck="false">
    <div class="govuk-input__suffix" aria-hidden="true">per item</div>
  </div>
</div>

      
      

{% extends 'DfE/Layouts/2ColumnWideLeft' %}

{% block title %}{% endblock %}   

{% block main %}
  {% unless user %}
    <script>
      window.location.href="{{ sitemarkers['DfE/Error/AccessDenied'].url }}"
    </script>
  {% endunless %}

  ## HTML content goes here ##

{% endblock %}

Use appropriately-sized inputs

Help users understand what they should enter by making number inputs the right size for the content they're intended for.

By default, the width of number inputs is fluid and will fit the full width of the container they are placed into.

If you want to make the input smaller, you can either use a fixed width input, or use the width override classes to create a smaller, fluid width input.

Asking for a whole number

If you're asking the user to enter a whole number, make sure the inputmode attribute is set to numeric to use the numeric keypad on devices with on-screen keyboards. The examples provided above on this page already have the inputmode="numeric" attribute.

Asking for a decimal number

If you're asking the user to enter a number that might include decimal places, use input type="text".

Do not set the inputmode attribute as it causes some devices to bring up a keypad without a key for the decimal separator. When copying the examples on this page, you will need to remove this attribute from the HTML.

Avoid using inputs with a type of number

Do not use <input type="number"> unless your user research shows that there's a need for it. With <input type="number"> there's a risk of users accidentally incrementing a number when they're trying to do something else - for example, scroll up or down the page. And if the user tries to enter something that's not a number, there's no explicit feedback about what they're doing wrong.

Minimum and maximum

The number component does not use input type="number" so the standard HTML min and max attributes do not apply. Do not use the minlength and maxlength attributes associated with input type="text" either. Browsers will not permit the user to enter more than the characters defined by the value of the maxlength attribute, cutting off the text as-you-type and truncating pasted text. This can lead to bad user experience.

You can use custom attributes which will work with the portal helper validation framework to set the allowed value or length range of a number input.

Minimum and maximum length and minimum and maximum value attributes can be used together, but only when the input is a whole number.

Minimum and maximum value

Use minvalue and maxvalue attributes to set a minimum or maximum value for your input. For example, input maxvalue="10" will prevent the user being able to submit a number greater than 10.

Use the minvalue attribute together with the maxvalue attribute to create a range of allowed values.

Minimum and maximum length

Use minchar and maxchar attributes to set a minimum or maximum length for your input. For example, you may wish to use input minchar="8" maxchar="8" when asking for a bank account number. Will ensure the user can only submit a number of 8 characters in length.

You can use the minchar attribute together with the maxchar attribute to create a range of allowed lengths, as described in the example above, or as individual attributes.

The length attributes can only be used as part of a number component when the input is a whole number.

Error messages

An error message is displayed next to the field and in the error summary when a validation error occurs. The CRM helper framework automatically handles error messages for specific error states, therefore you do not need to add any additional error containers to your HTML. Refer to the CRM helper framework guide to understand how to validate your front-end data.

Ensure that your component HTML and your inputs validation JavaScript object are structured correctly for your component type.

Occasionally you may wish to employ error messages outside of the validation process. You can read about the functions available within the CRM helper framework to assist you with this.

If you would like any additional advice or guidance with using these examples on Power Pages, please contact the Solutions Delivery Team.