Skip to content

Commit

Permalink
update examples and guidance
Browse files Browse the repository at this point in the history
  • Loading branch information
davidhunter08 committed Jul 3, 2024
1 parent d50b244 commit f2a1d2a
Show file tree
Hide file tree
Showing 5 changed files with 30 additions and 61 deletions.
10 changes: 3 additions & 7 deletions docs/components/timeline.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,20 +29,16 @@ Do not use timelines to give lots of detailed information about every stage of a

In a timeline you can use nodes (dots), lines and text to explain processes and timings.

{% example "timeline/timeline-proxy-access.njk" %}

### Nodes

Nodes can be:

- white with a grey outline (a smaller dot)
- blue (a larger dot)

Use blue nodes to show that a step is already completed.

{% example "timeline/timeline-active.njk" %}

If you’re using a timeline as a progress indicator, to show users the current status and what is coming next, use blue nodes to do this. But if your timeline is a static list outlining the points in a process in general, every node can be left white.

{% example "timeline/timeline-inactive.njk" %}
Use blue nodes to show that a step is in progress or already completed.

### Text

Expand Down
22 changes: 0 additions & 22 deletions docs/examples/timeline/timeline-active.njk

This file was deleted.

31 changes: 0 additions & 31 deletions docs/examples/timeline/timeline-inactive.njk

This file was deleted.

26 changes: 26 additions & 0 deletions docs/examples/timeline/timeline-proxy-access.njk
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
layout: layouts/example.njk
title: Timeline proxy access
figmaLink: https://www.figma.com/design/6f2CbcZ7cnpNrtKEcfQp8X/NHS-App-Design-System?m=dev&node-id=4453-2405
vueLink: [insert link to Vue component library here]
---

{% from "timeline/macro.njk" import timeline %}

{{ timeline({
items: [
{
headingText: "Await approval",
active: true,
text: "This will usually take the GP a few days, but some requests can take up to a month."
},
{
headingText: "Access services for Kevin Francis",
text: "Once your GP approves your request you will be able to access services for Kevin Francis on the NHS App."
},
{
headingText: "When access may stop",
text: "Access may stop when Kevin Francis turns 16 years old or if your GP decides it is no longer approproate."
}
]
}) }}
2 changes: 1 addition & 1 deletion docs/examples/timeline/timeline-waiting-times.njk
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: layouts/example.njk
title: Timeline waiting times
figmaLink: [insert link to Figma file here]
figmaLink: https://www.figma.com/design/6f2CbcZ7cnpNrtKEcfQp8X/NHS-App-Design-System?m=dev&node-id=4453-2405
vueLink: [insert link to Vue component library here]
---

Expand Down

0 comments on commit f2a1d2a

Please sign in to comment.