Signage
The signage component is used within lists of signage, acting as navigational links, on home and subcategory pages.
Card with description
<ul class="asp-grid">
<li class="asp-grid__item asp-signage">
<h2 class="asp-signage__title">
<a class="asp-signage__link" href="#">Signage title</a>
</h2>
<p class="asp-signage__content">Signage content (html).</p>
<p class="asp-signage__content">With additional line. </p>
</li>
</ul>Nunjucks macro options
Use options to customise the appearance, content and behaviour of a component when using a macro, for example, changing the text.
Some options are required for the macro to work; these are marked as "Required" in the option description.
If you're using Nunjucks macros in production with "html" options, or ones ending with "html", you must sanitise the HTML to protect against cross-site scripting exploits.
| Name | Type | Description |
|---|---|---|
| modifier | array or false (boolean) | Array of sizes for the signage components within the grid. Default values are null or false (boolean). WIP |
| rows | object | Required. Object of each signage component. See rows. |
Options for rows
| Name | Type | Description |
|---|---|---|
| href | string | Required. The URL that the signage component will link to. Note; If this is set, element will be automatically set to "a" if it has not already been defined. |
| title | string | Required. The signage component title that displays in the signage component. |
| content | array or false (boolean) | The signage component content. If false (boolean), the following parameters will be ignored. See content. |
Options for content
| Name | Type | Description |
|---|---|---|
| html | string | Required. HTML for the signage component content. If 'html' is provided, the 'text' parameter will be ignored. |
| text | string | Required. Text for the signage component content. If 'html' is provided, the 'text' parameter will be ignored. |
{% from "signage/macro.njk" import aspSignage %}
{{ aspSignage({
rows: [
{
href: "#",
title: "Signage title",
content: {
html: '<p class="asp-signage__content">Signage content (html).</p>
<p class="asp-signage__content">With additional line. </p>'
}
}
]
}) }}
Card without description
<ul class="asp-grid">
<li class="asp-grid__item asp-grid__item--medium-one-third asp-signage">
<h2 class="asp-signage__title">
<a class="asp-signage__link" href="#">Signage title 1</a>
</h2>
</li>
<li class="asp-grid__item asp-grid__item--medium-one-third asp-signage">
<h2 class="asp-signage__title">
<a class="asp-signage__link" href="#">Signage title 2</a>
</h2>
</li>
<li class="asp-grid__item asp-grid__item--medium-one-third asp-signage">
<h2 class="asp-signage__title">
<a class="asp-signage__link" href="#">Signage title 3</a>
</h2>
</li>
</ul>Nunjucks macro options
Use options to customise the appearance, content and behaviour of a component when using a macro, for example, changing the text.
Some options are required for the macro to work; these are marked as "Required" in the option description.
If you're using Nunjucks macros in production with "html" options, or ones ending with "html", you must sanitise the HTML to protect against cross-site scripting exploits.
| Name | Type | Description |
|---|---|---|
| modifier | array or false (boolean) | Array of sizes for the signage components within the grid. Default values are null or false (boolean). WIP |
| rows | object | Required. Object of each signage component. See rows. |
Options for rows
| Name | Type | Description |
|---|---|---|
| href | string | Required. The URL that the signage component will link to. Note; If this is set, element will be automatically set to "a" if it has not already been defined. |
| title | string | Required. The signage component title that displays in the signage component. |
| content | array or false (boolean) | The signage component content. If false (boolean), the following parameters will be ignored. See content. |
Options for content
| Name | Type | Description |
|---|---|---|
| html | string | Required. HTML for the signage component content. If 'html' is provided, the 'text' parameter will be ignored. |
| text | string | Required. Text for the signage component content. If 'html' is provided, the 'text' parameter will be ignored. |
{% from "signage/macro.njk" import aspSignage %}
{{ aspSignage({
modifier: ["medium-one-third"],
rows: [
{
href: "#",
title: "Signage title 1"
},
{
href: "#",
title: "Signage title 2"
},
{
href: "#",
title: "Signage title 3"
}
]
}) }}
When to use this component
This component should be positioned, at the top of pages or after a clear subheading, as group of the same signage components. Cards can used within a service, website or application.
On the ‘citizen site’, this component can be used on subcategory pages. For example lists of, Police Stations, Neighbour Policing team pages, and, Speed camera information.
Within the subcategory pages on the ‘citizen site’, this component can be used on subcategory menus. For example, within Neighbour Policing teams, Priorities, Events and Local information. As Priorities and Events are dynamically populated from the CMS, only one link may show.
When not to use this component
Do not use the signage component within text or without an associated heading.
How it works
This component acts a link with a large display area, heading and optional description. The heading will be read by assistive technology. A description can be utilised to provide additional information to aid the visitor with navigation around the site.
Will be be placed within a grid pattern.
Alias
Previously known as a card component on the ‘citizen site’.
Status of development
The below criteria all need to be met for a component to be considered as fully developed for use within the ASP Digital Design System.
| Development criteria | Status |
|---|---|
| WCAG 2.2 compliant | Not started |
| WCAG 2.1 compliant | Completed |
| HTML / Nunjucks version | Completed |
| Figma version | Not started |
| M365 versions | Not started |
| Documentation | In progress |
Published 3 May 2024
Last updated 17 September 2024