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.1.0.tar.gz (92.0 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.1.0-py3-none-any.whl (113.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: wagtail_nhsuk_frontend-2.1.0.tar.gz
  • Upload date:
  • Size: 92.0 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.1.0.tar.gz
Algorithm Hash digest
SHA256 4fea8d69174b68eacc4cb03e996ce8d2f66045617c57f5e6fb853d576010c0c9
MD5 0902f275df6eaf6ff4e9bfa540842a3a
BLAKE2b-256 a1b44fbc985c1420f9522861d683575e03e9fa752bccec2c4c308fe36ae023e3

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for wagtail_nhsuk_frontend-2.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ec091cdbb660cccde08f9d7bdaba95c2685debdd13caa468a6dcc5f05ff0af1a
MD5 f6253bb5791b3d70b79d21d70b3896b2
BLAKE2b-256 cf6ae9915aae9e8febab6cd6c24939a2bb0ad46bef9fbb5564fa617f3b7c109c

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