Skip to content

Commit e67e32b

Browse files
Create new_component-baseline.md
1 parent 7f391d9 commit e67e32b

File tree

1 file changed

+66
-0
lines changed

1 file changed

+66
-0
lines changed
Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# Pull request template #1
2+
## For adding a new component with status `Baseline completed`
3+
4+
A component's status should be updated to `Baseline completed` when the core functionality for the component has been completed and it is ready for use in prototyping.
5+
6+
`Baseline completed` components have not necessarily passed review for responsive design, accessibility, progressive enhancement and real-use testing.
7+
8+
Therefore, developers should be prepared that these components may be modified in the future. Where modifications occur, a new version of the component library will be published and a description of the updates will be included in the change log.
9+
10+
---
11+
12+
### New component details:
13+
14+
| Key | Value |
15+
| :--- | :--- |
16+
| Name | Line |
17+
| Folder | data-vis |
18+
| Sub-folder | line-chart |
19+
20+
---
21+
22+
### New component information:
23+
24+
| Key | Value |
25+
| :--- | :--- |
26+
| Description | The `Line` component receives an array of data and a lineFunction and combines them to render an SVG path element. <br><br>This path element can have hover and click events. It can also have markers, which can have their own optional hover and click events. |
27+
| Context | Since the `Line` component renders an SVG path element it must be called within an `<svg>` element. <br><br>The Line component has been designed as a child component of `Lines`, which takes a full dataset and renders a line for each row, allowing developers to customise the styling and behaviour of lines in groups or individually.<br><br>The Lines component has, in turn, been designed as a child component of `LineChart`, which incorporates other components include `Axis` and labelling to form a complete data visualisation. |
28+
29+
---
30+
31+
### Connected components:
32+
33+
| Component | Description of connectivity | Status |
34+
| :--- | :--- | :--- |
35+
| `Lines` | Calls `Line` component to render individual lines. | `In progress` |
36+
| `LineChart` | Calls `Lines` to render all lines. | Not yet developed |
37+
38+
---
39+
40+
### Dependencies:
41+
42+
| Dependency | Description | New dependency? |
43+
| :--- | :--- | :--- |
44+
| None | - | - |
45+
46+
---
47+
48+
### Core features:
49+
50+
| Feature | Description |
51+
| :--- | :--- |
52+
| Description | The Line component |
53+
54+
---
55+
56+
### Requested checks:
57+
58+
| Check | Description |
59+
| :--- | :--- |
60+
| - | - |
61+
62+
---
63+
64+
### Additional notes:
65+
66+

0 commit comments

Comments
 (0)