@healthsharedigital/hs-component-library v2.1.0

HealthShare Component Library

Presentational component library for the HealthShare web application.

Setup

Create new component

Testing

Build and publish package

Importing library

Setup

After cloning the repository run npm install to install all dependencies. To run the storybook UI npm start.

Create a new component

Creating a new component is as simple as running npm run create-component and then choosing a name and a group for the new component. The components folder and files will then be automatically generated to match. Inside this folder is all the scafolding for creating a new component and associated testing. The components and styles will also be automatically added to the root exports found at src/index.ts and src/styles/index.less.

Testing

This library has 3 different types of tests:

1. Unit - With React testing library and Jest. These tests should be added as needed in the relevant component folder, eg. components/Avatar/Avatar.test.js.
2. Snapshot - Automatically generated for all component stories using the library Storyshots. npm run test to run these tests. These can be viewed in the root directory __snapshots__/storyshots.test.js.snap. Configuration for these tests are in the root directory storyshots.test.js.
3. Screenshot - Automatically generated for all component stories using the library Loki. To test screenshots storybook needs to be running with npm start, then npm run test-screenshots to run the tests. These can be viewed in the root directory .loki If there are any failing tests diff screenshots will be rendered. To approve differences, run npm run approve-screenshots. To update with new screenshots, run npm run update-screenshots. Configuration for these tests are in the root directory loki.config.js.

Build and publish package

To build the library, run npm run build. This uses rollup to bundle all exported components and styles in src/index.ts and src/index.less. This build needs to be run and included in the github repo, as it is imported directly from github.

Importing library

To import the library into the HealthShare app, run npm install git+ssh://git@github.com/HealthshareAU/hs-component-library.git. This will make components accessible at import { Button } from 'hs-component-library. Because the styles for components are css, the global css file for the library needs to be imported at the root level of the app: @import 'hs-component-library/lib/hs-component-library.css'. To access the styles used in the component library, the variables LESS file can also be imported at the root level of the app @import 'hs-component-library/lib/variables.less'. This makes variables like @color-primary-base accessible in every LESS file.