Skip to main content

NHSUK Frontend Styles for Wagtail

Project description

Wagtail NHS.UK frontend

A wagtail implementation of the NHS frontend v10.4.2 standard components.

Installation

Install the pypi package

pip install wagtail-nhsuk-frontend

Add to your INSTALLED_APPS in wagtail settings

INSTALLED_APPS = [
  ...

  'wagtailnhsukfrontend',

  ...
]

Use blocks in your streamfields

from wagtail.admin.panels import FieldPanel
from wagtail.models import Page
from wagtail.fields import StreamField

from wagtailnhsukfrontend.blocks import ActionLinkBlock, WarningCalloutBlock

class HomePage(Page):
  body = StreamField([
      # Include any of the blocks you want to use.
      ('action_link', ActionLinkBlock()),
      ('callout', WarningCalloutBlock()),
  ], use_json_field=True)

  content_panels = Page.content_panels + [
      FieldPanel('body'),
  ]

Use templatetags

{% load nhsukfrontend_tags %}

<html>
...
<body>
  {% breadcrumb %}
</body>
</html>

Use template includes

{% include 'wagtailnhsukfrontend/header.html' with show_search=True %}

See the component documentation for a list of components you can use.

Include the CSS in your base template

  <link rel="stylesheet" type="text/css" href="{% static 'wagtailnhsukfrontend/css/nhsuk-frontend-10.4.2.min.css' %}">

Include the Javascript in your base template

  <script type="text/javascript" src="{% static 'wagtailnhsukfrontend/js/nhsuk-frontend-10.4.2.min.js' %}" defer></script>

Upgrading

If you are upgrading from v0 to v1, see the changelog.

This CSS and JS is taken directly from the nhsuk-frontend library and provided in this package for convenience.

If you have a more complicated frontend build such as compiling your own custom styles, you might want to install from npm instead.

Contributing

See the contributing documentation to run the application locally and contribute changes.

Further reading

See more documentation

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wagtail_nhsuk_frontend-2.0.1.tar.gz (91.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

wagtail_nhsuk_frontend-2.0.1-py3-none-any.whl (113.9 kB view details)

Uploaded Python 3

File details

Details for the file wagtail_nhsuk_frontend-2.0.1.tar.gz.

File metadata

  • Download URL: wagtail_nhsuk_frontend-2.0.1.tar.gz
  • Upload date:
  • Size: 91.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.4

File hashes

Hashes for wagtail_nhsuk_frontend-2.0.1.tar.gz
Algorithm Hash digest
SHA256 335f18715362091506a1274ac9bc7189b0a7e6a2287737b340b14bc58ad7224c
MD5 74b71d33394089d5ac78d2ada74ddfce
BLAKE2b-256 9b172863ae1526369eb207d822538dbf053ec394db94d8207df3c8713fd2a3db

See more details on using hashes here.

File details

Details for the file wagtail_nhsuk_frontend-2.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for wagtail_nhsuk_frontend-2.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a3aa54054234b05a4ff8c00db3beb7ff670102e0329138822d4795a09785924c
MD5 27363b2d07f87f802188c1163b10925d
BLAKE2b-256 37f21038cf1716134561a98fb7db365e5d039b42f0440edb910b53c5ec0ee0a5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page