Skip to content
This repository was archived by the owner on Nov 7, 2025. It is now read-only.

Commit a0ff1c4

Browse files
Bump version and update documentation
1 parent 1e0cdf3 commit a0ff1c4

File tree

2 files changed

+5
-37
lines changed

2 files changed

+5
-37
lines changed

README.md

Lines changed: 4 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -2,42 +2,10 @@
22

33
## Installation
44

5-
[Set up the GOV.UK Prototype Kit in the usual way](https://govuk-prototype-kit.herokuapp.com/docs/install) then install the task list component using:
5+
[Set up the GOV.UK Prototype Kit in the usual way](https://prototype-kit.service.gov.uk/docs/create-new-prototype) then install the task list component using:
66

7-
`npm install --save [email protected]:x-govuk/task-list-component.git#v0.0.1`
7+
`npm install --save [email protected]:x-govuk/task-list-component.git#v0.0.3`
88

9-
You can then start the kit as usual with `npm start`
9+
You can then start the kit as usual with `npm run dev`
1010

11-
## Usage example
12-
13-
Once you've installed it try adding this snippet to one of your views:
14-
15-
```
16-
{% from "task-list-component/macro.njk" import govukTaskList %}
17-
{{govukTaskList({
18-
items: [
19-
{
20-
href: "https://google.com/",
21-
hint: {text: "Google is good"},
22-
title: {text: "Google something"},
23-
statusId: "ggl",
24-
status: {
25-
classes: "govuk-task-list__status--light-blue",
26-
text: "In progress"
27-
}
28-
},
29-
{
30-
href: "https://bing.com/",
31-
hint: {text: "Bing is bad"},
32-
title: {text: "Bing something"},
33-
statusId: "bng",
34-
status: {
35-
classes: "govuk-task-list__status--error",
36-
text: "I refuse"
37-
}
38-
}
39-
]
40-
})}}
41-
```
42-
43-
Any questions, comments etc. please raise an issue.
11+
Once you’ve installed it, visit the templates section at [http://localhost:3000/manage-prototype/templates](http://localhost:3000/manage-prototype/templates). From there you can view and create task list pages.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "task-list-component",
3-
"version": "0.0.2",
3+
"version": "0.0.3",
44
"description": "",
55
"main": "index.js",
66
"scripts": {

0 commit comments

Comments
 (0)