npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@healthsharedigital/hs-component-library

v2.0.2

Published

Presentational component library for the HealthShare web application.

Downloads

78

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

healthshare-devshealthshare-devs

Keywords

Readme

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://[email protected]/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.