Skip to content

[Enhancement]: Implement the Generic header component into an 'unbranded' version of the tech docs #516

Description

@owenatgov

What should change?

Add a feature that allows tech docs to toggle using the GOV.UK header and the Generic header. Additionally tie this into automatically using a font other than Transport.

User need

In GOV.UK Frontend v6.3.0, the design system team released the Generic header component, along with accompanying tech guidance on removing GOV.UK branding from a GOV.UK service. This is for services that might be part of UK government digital and would therefore benefit from using the design system, but aren't part of GOV.UK and therefore aren't entitled to use its branding.

We know that some tech docs are part of a user facing GOV.UK service, but some aren't eg: internal docs or docs for non-GOV.UK services. A holistic 'turn off the branding' toggle would enable that latter group to more easily use the tech docs and customise them to fit their needs without infringing on the GOV.UK branding.

Proposed solution

The API could be:

  • a boolean option with an extra text/html option to specify a unique logo
  • just the unique logo option

Both these interact nicely with #435

This would swap the header block class from govuk-header to govuk-generic-header.

This could also render the specified unique logo next to the :service_name if present, as the Generic header doesn't include an option for a product name.

As well as setting the header, this could also reset the font. The best solution I've come up with for this is loading a separate stylesheet that re-specifies $govuk-font-family, which feels wasteful.

I also think that as part of this we should deprecate and remove :show_govuk_logo as the logic for this could be replaced by the above proposal.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions