Skip to content

Commit

Permalink
Updates dgc documentation to include tutorial for npm link
Browse files Browse the repository at this point in the history
  • Loading branch information
@dc2007git
dc2007git committed Apr 2, 2024
1 parent 6efe494 commit ec9e04f
Showing 1 changed file with 72 additions and 54 deletions.
126 changes: 72 additions & 54 deletions docs/developer/react-component.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: React Chart Component
reviewers: Dr Marcus Baw, Dr Simon Chapman, Dr Anchit Chandran
reviewers: Dr Marcus Baw, Dr Simon Chapman, Dr Anchit Chandran, Daniel Cowen
audience: developers
---

Expand All @@ -21,7 +21,7 @@ audience: developers
![height-chart-girl-component](../_assets/_images/height-chart-girl-component.png)

!!! success "Use our Growth Chart React Component"
The dGC React Component is the recommended way to display Digital Growth Charts to end users. We have built the component to be easy to integrate into existing web-based views, even if your stack does not currently use React. You can use the component as-is in a React app, or include it in plain HTML or any other JavaScript framework.
The dGC React Component is the recommended way to display Digital Growth Charts to end users. We have built the component to be easy to integrate into existing web-based views, even if your stack does not currently use React. You can use the component as-is in a React app, or include it in plain HTML or any other JavaScript framework.

Displaying growth charts is a complex task, and we have built the component to make it as easy as possible for developers to display charts correctly. The component is designed to be customisable, so you can change the look and feel to match your app.

Expand All @@ -32,84 +32,100 @@ audience: developers
React is a popular UI library for Javascript. It has endured well and remains a popular choice for developers. Importantly, unlike some other Javascript frameworks which are primarily designed for Single Page Applications, React doesn't expect to have the entire webpage to itself. It can be used as a small component in any other web page, even if the main framework being used is completely different.

!!! question "Tell us what you think"
Let us know what you think of our design decisions, on this or any other area of the dGC Project, by chatting to us on our [dGC Forum :fontawesome-brands-discourse:](https://openhealthhub.org/c/rcpch-digital-growth-charts/), or our RCPCH Community [Signal chat channel :simple-signal:](https://signal.group/#CjQKIAjLf5lS9OZIAI6lsJKWP1LmeJXkUW_fzZH1ryEw3oFEEhBH-4F7WnlyYjKerjfzD6B0)
Let us know what you think of our design decisions, on this or any other area of the dGC Project, by chatting to us on our [dGC Forum :fontawesome-brands-discourse:](https://openhealthhub.org/c/rcpch-digital-growth-charts/), or our RCPCH Community [Signal chat channel :simple-signal:](https://signal.group/#CjQKIAjLf5lS9OZIAI6lsJKWP1LmeJXkUW_fzZH1ryEw3oFEEhBH-4F7WnlyYjKerjfzD6B0)

### What about other frameworks/UI libraries?

If you need us to develop a charting component in a different language or framework, we may be able to do this with you or your company. We would need to discuss the requirements and quote for this service. You should be aware that all such RCPCH-developed artefacts will also be open source. We ensure the licensing of open source components is compatible with commercial use.

!!! note "Contact us"
To contact us for this service, email <mailto:[email protected]>.
To contact us for this service, email <mailto:[email protected]>.

## Getting started

`git clone` the repo

```console
git clone https://github.com.rcpch/{{ repository_name }}
```

Install dependencies

```console
npm install
```

Run Storybook to view the component in isolation

```console
npm run storybook
```

### Running the Charts Package locally
### Running the Charts component locally

To run the package locally alongside the React client, there are some extra steps. Since the Chart library and the React client both use React, the Charts will throw an error if you import them in the ```package.json``` of your app from a folder on your local machine.
To run the Chart component locally alongside the React client, there are some extra steps. Since the Chart **component** (aka the chart itself) and the React **client** (aka the interactive form) both use React, the Charts will throw an error if you import them in the `package.json` of your app from a folder on your local machine.

For example, in your React app:
<!-- We should stick to exclusively using these 2 terms to avoid confusion. Could also add a diagram showing which is which -->

```json
"dependencies": {
"@rcpch/digital-growth-charts-react-component-library": "file:/Users/FooBar/Development/react/component-libraries/digital-growth-charts-react-component-library",
}
We would advise having both the Component and Client open when working through this part of the documentation. If you are using Visual Studio code, you can do this by opening a 'Workspace'.

First, in the Client directory, ensure you have a version of the chart component in your `node_modules`. Look for `node_modules/@rcpch/digital-growth-charts-react-component-library`

Begin by opening a terminal in the client directory, and in the component directory. In both, execute the following command:

```console
npm ls -g --depth=0 --link=true
```

This causes a problem as it leads to 2 versions of React running. To overcome this, in your application:
The result printed out will show you any symlinks between the 2 directories, and if you have never before ran `npm link`, then this will likely be empty.

In both the client and component terminals, execute the following command:

```console
cd node_modules/react
npm link
nvm use node
```

In the root folder of your Chart library:
This will use nvm (node version manager) to move to the latest version of node.

Next, in your client terminal, execute the following command:

```console
npm link react
npm link @rcpch/digital-growth-charts-react[email protected]
```

Repeat the same for ```react-dom``` ensuring all the package versions are the same for your app and the library. The library currently uses version `17.0.2` of React and React-dom.
!!! warning
You may receive a permission denied error. If this is the case, execute the above command again but place `sudo` at the start of it.

Now, you can view your changes made live in your app:
Then, execute the following command in the component terminal:

```console
npm run build
```

Refresh your app.

If the invalid hooks error persists, an alternative method is to add the following line to ```package.json``` in the library. This removes the node_modules from the build folder:
And once you receive a message that the build has completed, go to the client terminal and enter:

```json
"scripts": {
"postinstall": "rm -rf node_modules",
...
},
```console
s/deprecated/start-react-client
```

!!! warning
You may receive a hooks error and a blank screen. This would be due to a clash between react versions between the client and component. You should navigate to the Component `node_modules` folder, and delete the `react` and `react-dom` folders.

A url will now present itself in the terminal, and you should follow that, which will take you to the client and component working together side by side.

### Making changes to the code, and visualising them

If you make changes to the component or the client, you should rerun the final 2 commands above, in the same order.


## Structure

This library has been written in Typescript. The main component is `RCPCHChart`, which takes the following `props`. Note that each component will only render a single chart type, so if you wanted to render a weight *and* a height chart, these must be done as two separate instances of the component. We find that on modern screens you can render two charts side-by-side, but on smaller screens, you may wish to render one chart at a time, perhaps in tabs for height, weight, BMI, head circumference etc, as in our [demo client](https://growth.rcpch.ac.uk/).
This library has been written in Typescript. The main component is `RCPCHChart`, which takes the following `props`. Note that each component will only render a single chart type, so if you wanted to render a weight _and_ a height chart, these must be done as two separate instances of the component. We find that on modern screens you can render two charts side-by-side, but on smaller screens, you may wish to render one chart at a time, perhaps in tabs for height, weight, BMI, head circumference etc, as in our [demo client](https://growth.rcpch.ac.uk/).

### RCPCHChart component

??? note "`RCPCHChart` component props"
```js
`js
{
title: string,
subtitle: string,
Expand All @@ -132,21 +148,21 @@ This library has been written in Typescript. The main component is `RCPCHChart`,
exportChartCallback: function(svg: any),
clinicianFocus?: boolean;
}
```
`

### Measurement interface

The `Measurement` interface is structured to reflect the JSON `Measurement` object which is returned by the API. The `RCPCHChart` component uses the `reference` prop to determine which chart to render. So far, 3 references are supported: UK-WHO (`uk-who`), Turner Syndrome (`turner`) and Down Syndrome (`trisomy-21`). The reference data for the centiles are included in the library in plottable format in the `chartdata` folder.

!!! tip
**You simply need to pass JSON from the dGC API directly in to the component asan array of `Measurement` JSON objects. The component 'knows' how to render this correctly. You don't need to parse, restructure, or even understand the JSON returned from the API: just pass it directly to the component inside an array containing one or more `Measurement` objects.**
**You simply need to pass JSON from the dGC API directly in to the component as an array of `Measurement` JSON objects. The component 'knows' how to render this correctly. You don't need to parse, restructure, or even understand the JSON returned from the API: just pass it directly to the component inside an array containing one or more `Measurement` objects.**

## Styling

The styling components allow the user to customise elements of the chart. Chart styles control the chart and the tooltips.

!!! note "Styling options available through `ChartStyle`"
```js
`js
interface ChartStyle{
backgroundColour?: string,
width?: number,
Expand All @@ -166,37 +182,37 @@ The styling components allow the user to customise elements of the chart. Chart
toggleButtonActiveColour: string
toggleButtonTextColour: string
}
```
`

Note for the tooltips and infobox text sizes, these are strokeWidths, not point sizes as the text here is SVG.

### Axis Styles

??? note "Axis styles control axes and axis labels"
```js
`js
interface AxisStyle{
axisStroke?: string,
axisLabelTextStyle?: requires {name?: string, colour?: string, size?: number, weight?: 'bold' | 'italic' | 'regular'}
tickLabelTextStyle?: requires {name?: string, colour?: string, size?: number, weight?: 'bold' | 'italic' | 'regular'}
}
```
`

### Gridline Styles

??? note "Gridline styles allow/hide gridlines and control line width, presence of dashes, colour"
```js
`js
interface GridlineStyle{
gridlines?: boolean,
stroke?: string,
strokeWidth?: number,
dashed?: boolean
}
```
`

### Centile Styles

??? note "Centile styles control the width and colour of the centile and SDS lines"
```js
`js
interface CentileStyle{
sdsStroke?: string,
sdsStrokeWidth?: string,
Expand All @@ -207,41 +223,41 @@ Note for the tooltips and infobox text sizes, these are strokeWidths, not point
midParentalCentileStrokeWidth?: number;
midParentalAreaFill?: string;
}
```
`

### SDS Styles

SDS styles control the colour and width of the SDS lines. As all measurement methods are rendered on a single chart, the user is offered the option of different colours for each measurement method (height, weight, head circumference(OFC) and body mass index (BMI)). If no SDS style is supplied, the centile line colour is used with an opacity applied to each measurement.

??? note "SDS Styles"
```js
`js
interface SDSStyle {
lineStrokeWidth?: number;
heightStroke?: string;
weightStroke?: string;
ofcStroke?: string;
bmiStroke?: string;
}
```
`

### Measurement Styles

Measurement styles control the plotted data points: colour, size and shape. Corrected ages are always rendered as crosses. Circles for chronological ages are preferred. On the SDS charts, measurement points are grey by default, with the measurement method in focus highlighted by rendering as a line. Points which are not highlighted can be emphasised on mouse hover, with the highlighted colour being set by the `highlightedMeasurementFill` prop.

??? note "Measurement Styles"
```js
`js
interface MeasurementStyle{
measurementFill?: string,
highLightedMeasurementFill?: string;
}
```
`

### Mid-Parental Height

`midParentalHeightData`: This is the return value from the RCPCH API and takes the structure:

??? note "`midParentalHeightData`"
```js
`js
export interface MidParentalHeightObject {
mid_parental_height?: number;
mid_parental_height_sds?: number;
Expand All @@ -252,15 +268,16 @@ Measurement styles control the plotted data points: colour, size and shape. Corr
mid_parental_height_lower_value?: number
mid_parental_height_upper_value?: number
}
```
`

This returns a mid-parental height, mid-parental SDS and centile, along with the centile data if the user wishes to plot a mid-parental centile. The structure of the Reference and Centile interfaces is:

??? note "`Reference` and `Centile` interface structures"
```js
export interface Reference {
[name: string]: ISexChoice
}

````js
export interface Reference {
[name: string]: ISexChoice
}

export interface ICentile {
centile: number,
Expand Down Expand Up @@ -291,26 +308,26 @@ Centile data are returned from the RCPCH API in this same structure, though no A

### `enableZoom`

```enableZoom```: a boolean optional prop which defaults to false. If true, the user can press and mouse click to zoom in or out once measurements are being displayed. A reset zoom button also appears.
`enableZoom`: a boolean optional prop which defaults to false. If true, the user can press and mouse click to zoom in or out once measurements are being displayed. A reset zoom button also appears.

### `chartType`

```chartType```: a string mandatory prop and must be one of ```'centile' | 'sds'```. It toggles between centile and SDS charts.
`chartType`: a string mandatory prop and must be one of `'centile' | 'sds'`. It toggles between centile and SDS charts.

### `enableExport`

```enableExport```: a boolean optional prop, defaults to false. If true, ```exportChartCallback``` must be implemented and a copy-paste button is rendered below the chart.
`enableExport`: a boolean optional prop, defaults to false. If true, `exportChartCallback` must be implemented and a copy-paste button is rendered below the chart.

### `exportChartCallBack`

```exportChartCallback``` callback function implemented if `enableExport` is true. It receives an SVG element. This can be saved in the client to clipboard by converting to canvas using HTML5. An example implementation of this is [here](https://github.com/rcpch/digital-growth-charts-react-client/blob/live/src/functions/canvasFromSVG.js) in our demo client.
`exportChartCallback` callback function implemented if `enableExport` is true. It receives an SVG element. This can be saved in the client to clipboard by converting to canvas using HTML5. An example implementation of this is [here](https://github.com/rcpch/digital-growth-charts-react-client/blob/live/src/functions/canvasFromSVG.js) in our demo client.

### `clinicianFocus`

```clinicianFocus```: a boolean optional prop which defaults to false. If true, the advice strings that are reported to users in tooltips are more technical and aimed at clinicians familiar with centile charts. If false, the advice strings will be less technical and more suitable for parents, guardians, carers or other laypersons.
`clinicianFocus`: a boolean optional prop which defaults to false. If true, the advice strings that are reported to users in tooltips are more technical and aimed at clinicians familiar with centile charts. If false, the advice strings will be less technical and more suitable for parents, guardians, carers or other laypersons.

!!! example "Requests for additional functionality in props"
In time, more props can be added if users request them. If you have requests, please post issues on our [GitHub](https://github.com/rcpch/digital-growth-charts-react-component-library/issues) or get involved to contribute as below.
In time, more props can be added if users request them. If you have requests, please post issues on our [GitHub](https://github.com/rcpch/digital-growth-charts-react-component-library/issues) or get involved to contribute as below.

## Troubleshooting

Expand All @@ -336,3 +353,4 @@ This chart component software is is subject to copyright and is owned by the RCP
[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)

There is important chart line rendering data bundled in the component, which subject to copyright and is owned by the RCPCH. It is specifically excluded from the MIT license mentioned above. If you wish to use this software, please [contact the RCPCH](../about/contact.md) so we can ensure you have the correct license for use. Subscribers to the Digital Growth Charts API will automatically be assigned licenses for the chart plotting data.
````

0 comments on commit ec9e04f

Please sign in to comment.