Components

Header

The GOV.UK header shows users that they are on GOV.UK and which service they are using.

This implementation also supports websites not hosted on GOV.UK by replacing the crown logo. It also provides explicit support for individual government departments by through the use of the appropriate departmental colours.

Props
NameTypeDefaultDescription
idother'id' attribute to place on the base HTML element
classBlockotherBlock name override in BEM style classes applied to all elements
classModifiersotherBEM style modifiers to apply to the base HTML element
classNameotherExtra classes to apply to the base HTML element
defaultCheckedother
defaultValueother
suppressContentEditableWarningother
suppressHydrationWarningother
accessKeyother
autoCapitalizeother
autoFocusother
contentEditableother
contextMenuother
dirother
draggableother
enterKeyHintother
hiddenother
langother
nonceother
slotother
spellCheckother
styleother
tabIndexother
titleother
translateother
radioGroupother
roleother
aboutother
contentother
datatypeother
inlistother
prefixother
propertyother
relother
resourceother
revother
typeofother
vocabother
autoCorrectother
autoSaveother
colorother
itemPropother
itemScopeother
itemTypeother
itemIDother
itemRefother
resultsother
securityother
unselectableother
inputModeotherHints at the type of data that might be entered by the user while editing the element or its contents
isotherSpecify that a standard HTML element should behave like a defined custom built-in element
exportpartsother
partother
aria-activedescendantotherIdentifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
aria-atomicotherIndicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.
aria-autocompleteotherIndicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.
aria-braillelabelotherDefines a string value that labels the current element, which is intended to be converted into Braille.
aria-brailleroledescriptionotherDefines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.
aria-busyother
aria-checkedotherIndicates the current "checked" state of checkboxes, radio buttons, and other widgets.
aria-colcountotherDefines the total number of columns in a table, grid, or treegrid.
aria-colindexotherDefines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.
aria-colindextextotherDefines a human readable text alternative of aria-colindex.
aria-colspanotherDefines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.
aria-controlsotherIdentifies the element (or elements) whose contents or presence are controlled by the current element.
aria-currentotherIndicates the element that represents the current item within a container or set of related elements.
aria-describedbyotherIdentifies the element (or elements) that describes the object.
aria-descriptionotherDefines a string value that describes or annotates the current element.
aria-detailsotherIdentifies the element that provides a detailed, extended description for the object.
aria-disabledotherIndicates that the element is perceivable but disabled, so it is not editable or otherwise operable.
aria-dropeffectotherIndicates what functions can be performed when a dragged object is released on the drop target.
aria-errormessageotherIdentifies the element that provides an error message for the object.
aria-expandedotherIndicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
aria-flowtootherIdentifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.
aria-grabbedotherIndicates an element's "grabbed" state in a drag-and-drop operation.
aria-haspopupotherIndicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
aria-hiddenotherIndicates whether the element is exposed to an accessibility API.
aria-invalidotherIndicates the entered value does not conform to the format expected by the application.
aria-keyshortcutsotherIndicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
aria-labelotherDefines a string value that labels the current element.
aria-labelledbyotherIdentifies the element (or elements) that labels the current element.
aria-levelotherDefines the hierarchical level of an element within a structure.
aria-liveotherIndicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.
aria-modalotherIndicates whether an element is modal when displayed.
aria-multilineotherIndicates whether a text box accepts multiple lines of input or only a single line.
aria-multiselectableotherIndicates that the user may select more than one item from the current selectable descendants.
aria-orientationotherIndicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
aria-ownsotherIdentifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.
aria-placeholderotherDefines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.
aria-posinsetotherDefines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
aria-pressedotherIndicates the current "pressed" state of toggle buttons.
aria-readonlyotherIndicates that the element is not editable, but is otherwise operable.
aria-relevantotherIndicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.
aria-requiredotherIndicates that user input is required on the element before a form may be submitted.
aria-roledescriptionotherDefines a human-readable, author-localized description for the role of an element.
aria-rowcountotherDefines the total number of rows in a table, grid, or treegrid.
aria-rowindexotherDefines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.
aria-rowindextextotherDefines a human readable text alternative of aria-rowindex.
aria-rowspanotherDefines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.
aria-selectedotherIndicates the current "selected" state of various widgets.
aria-setsizeotherDefines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
aria-sortotherIndicates if items in a table or grid are sorted in ascending or descending order.
aria-valuemaxotherDefines the maximum allowed value for a range widget.
aria-valueminotherDefines the minimum allowed value for a range widget.
aria-valuenowotherDefines the current value for a range widget.
aria-valuetextotherDefines the human readable text alternative of aria-valuenow for a range widget.
dangerouslySetInnerHTMLother
onCopyother
onCopyCaptureother
onCutother
onCutCaptureother
onPasteother
onPasteCaptureother
onCompositionEndother
onCompositionEndCaptureother
onCompositionStartother
onCompositionStartCaptureother
onCompositionUpdateother
onCompositionUpdateCaptureother
onFocusother
onFocusCaptureother
onBlurother
onBlurCaptureother
onChangeother
onChangeCaptureother
onBeforeInputother
onBeforeInputCaptureother
onInputother
onInputCaptureother
onResetother
onResetCaptureother
onSubmitother
onSubmitCaptureother
onInvalidother
onInvalidCaptureother
onLoadother
onLoadCaptureother
onErrorother
onErrorCaptureother
onKeyDownother
onKeyDownCaptureother
onKeyPressother
onKeyPressCaptureother
onKeyUpother
onKeyUpCaptureother
onAbortother
onAbortCaptureother
onCanPlayother
onCanPlayCaptureother
onCanPlayThroughother
onCanPlayThroughCaptureother
onDurationChangeother
onDurationChangeCaptureother
onEmptiedother
onEmptiedCaptureother
onEncryptedother
onEncryptedCaptureother
onEndedother
onEndedCaptureother
onLoadedDataother
onLoadedDataCaptureother
onLoadedMetadataother
onLoadedMetadataCaptureother
onLoadStartother
onLoadStartCaptureother
onPauseother
onPauseCaptureother
onPlayother
onPlayCaptureother
onPlayingother
onPlayingCaptureother
onProgressother
onProgressCaptureother
onRateChangeother
onRateChangeCaptureother
onSeekedother
onSeekedCaptureother
onSeekingother
onSeekingCaptureother
onStalledother
onStalledCaptureother
onSuspendother
onSuspendCaptureother
onTimeUpdateother
onTimeUpdateCaptureother
onVolumeChangeother
onVolumeChangeCaptureother
onWaitingother
onWaitingCaptureother
onAuxClickother
onAuxClickCaptureother
onClickother
onClickCaptureother
onContextMenuother
onContextMenuCaptureother
onDoubleClickother
onDoubleClickCaptureother
onDragother
onDragCaptureother
onDragEndother
onDragEndCaptureother
onDragEnterother
onDragEnterCaptureother
onDragExitother
onDragExitCaptureother
onDragLeaveother
onDragLeaveCaptureother
onDragOverother
onDragOverCaptureother
onDragStartother
onDragStartCaptureother
onDropother
onDropCaptureother
onMouseDownother
onMouseDownCaptureother
onMouseEnterother
onMouseLeaveother
onMouseMoveother
onMouseMoveCaptureother
onMouseOutother
onMouseOutCaptureother
onMouseOverother
onMouseOverCaptureother
onMouseUpother
onMouseUpCaptureother
onSelectother
onSelectCaptureother
onTouchCancelother
onTouchCancelCaptureother
onTouchEndother
onTouchEndCaptureother
onTouchMoveother
onTouchMoveCaptureother
onTouchStartother
onTouchStartCaptureother
onPointerDownother
onPointerDownCaptureother
onPointerMoveother
onPointerMoveCaptureother
onPointerUpother
onPointerUpCaptureother
onPointerCancelother
onPointerCancelCaptureother
onPointerEnterother
onPointerLeaveother
onPointerOverother
onPointerOverCaptureother
onPointerOutother
onPointerOutCaptureother
onGotPointerCaptureother
onGotPointerCaptureCaptureother
onLostPointerCaptureother
onLostPointerCaptureCaptureother
onScrollother
onScrollCaptureother
onWheelother
onWheelCaptureother
onAnimationStartother
onAnimationStartCaptureother
onAnimationEndother
onAnimationEndCaptureother
onAnimationIterationother
onAnimationIterationCaptureother
onTransitionEndother
onTransitionEndCaptureother
departmentotherDepartment branding to use (e.g. home-office)
govUKotherWhether to add the standard Gov.UK content
maxContentsWidthotherMaximum width of the contents in px units (-1 for full width)
navigationotherNavigation links
organisationHrefotherOrganisation link URL
organisationTextotherOrganisation link text
rebrandotherIf true, use the redesigned header and new GOV.UK logotype
serviceHrefotherService link URL
serviceNameotherService link text
signOutHrefotherSign out link URL
signOutTextotherSign out link text
logootherCustom logo, use null to remove

When to use this component

You must use the GOV.UK header at the top of every page if your service is being hosted on one of these domains:

  • gov.uk/myservice
  • myservice.service.gov.uk
  • myblog.blog.gov.uk

It can be used elsewhere as long as govUK mode is NOT enabled.

When not to use this component

You must not use the GOV.UK header if your service is not being hosted on one of the above domains. However, you can still use this component if you disable govUK mode which will remove GDS' crown logo.

Stories

Standard

A standard Header. This does not include GDS' crown logo and is suitable for use outside of GOV.UK including internal application and websites of local councils.

Default GOV.UK header

Use the default GOV.UK header if your service is hosted on GOV.UK and has 5 pages or fewer.

Re-branded GOV.UK header

The default header for public facing websites on GOV.UK, after 25th June 2025.

Add the rebrand prop, and ensure that a parent element, such as <html>, has the govuk-template--rebranded class.

Header with service name

Header with service name and navigation

Deprecated

Use the header with navigation if you need to include basic navigation, contact or account management links.

You should now use the Service navigation component instead.

Header with service name and sign-out link

Deprecated

A sign-out link can be provided and added to the end of the list of navigation links.

You should now use the Service navigation component instead.

Full width

A header that does NOT restrict the width on wide screens.

Custom logo

A custom logo can be provided, via the logo prop.

No logo

The logo can be removed entirely by passing null to the logo prop.

Department colours

If you are building an internal application you can supply the name of your department in order to use their colours.

DBT

DCMS

DEFRA

DWP

FCO

Home Office

HMRC

HM Treasury

MHCLG

MoJ

Office of the leader of the House of lords

Scotland office

Wales office