Help Scout Design System (HSDS) — React Component Library
Clone or download
Latest commit 7dbd0c7 Jan 22, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.git-hooks Update pre-commit hook Jul 27, 2017
.remake/component/remake-name ChatScroller: Enable external selector (#434) Dec 17, 2018
.storybook DropdownV2 Performance Boost + ComboBox (#408) Dec 3, 2018
.vscode Add Remake (#433) Dec 17, 2018
config React 16! (#403) Nov 27, 2018
docs Update contributing docs [skip ci] Nov 8, 2018
images HSDS: Rebrand Nov 8, 2018
scripts Add prestart into workflow Dec 4, 2018
src AvatarStack: Adjust UI + Update Storybook (#451) Jan 22, 2019
stories AvatarStack: Adjust UI + Update Storybook (#451) Jan 22, 2019
.babelrc Improve build size (#414) Dec 3, 2018
.bookignore Adjust .bookignore [skip ci] Aug 15, 2018
.eslintignore Add Remake (#433) Dec 17, 2018
.eslintrc ArticleCard: UI Updates (#413) Nov 30, 2018
.flowconfig AttachmentList: Improve UX on new items Jul 13, 2018
.gitbook.yaml Rename gitbook.yml -> gitbook.yaml [skip ci] Aug 15, 2018
.gitignore Dropdown V2! (#400) Nov 19, 2018
.huskrc Remove Karma (and other dependencies) (#377) Oct 15, 2018
.npmignore Typescript (#381) Nov 8, 2018
.nvmrc Typescript (#381) Nov 8, 2018
.prettierignore Add Remake (#433) Dec 17, 2018
.prettierrc.yml Add prettier May 24, 2018
.travis.yml Remove surge + travis deploy. Switched to Netlify Nov 8, 2018
.watchmanconfig Add .watchmanconfig [skip ci] Sep 28, 2018
CONTRIBUTING.md Update link in contributing README [skip ci] Nov 8, 2018
LICENSE Add license [skip-ci] Sep 28, 2017
README.md Update npm package badge [skip ci] Jan 17, 2019
jest.config.js DropdownV2 Performance Boost + ComboBox (#408) Dec 3, 2018
package-lock.json 2.5.17 Jan 22, 2019
package.json 2.5.17 Jan 22, 2019
tsconfig.json ChatScroller: Enable external selector (#434) Dec 17, 2018

README.md

HSDS: React

Build Status Coverage Status npm version node npm

React components for Help Scout's Design System

Live Demo

Check out HSDS's Storybook:

https://hsds-react.netlify.com/

Install

npm install @helpscout/hsds-react --save

Getting Started

After cloning this repo down, run:

npm install

Once everything is installed, run:

npm start

Check out HSDS's Storybook at http://localhost:8900/ in your browser!

Testing

To run Jest in watch mode, run:

npm run dev

To execute all the tests (with Coverage reporting), run:

npm run test

Publishing

To publish and release a new version of HSDS, run the following command:

npm run release

You'll be presented with a CLI prompt with options. Pick the one you want, and that's it! The script will take care of the rest (from testing to publishing).

Deploying Storybook

To deploy the Storybook, run the following command:

npm run deploy

Blue?

On Nov 8, 2018, we rebranded Blue to HSDS: React 🎉.

The original Blue library will still exist on npm, and is still installable via:

npm install @helpscout/blue --save

However, continued development of this component library will continue under HSDS: React, which is installable via:

npm install @helpscout/hsds-react --save

A big thanks to all the folks involved in Blue! Blue will always be your boy 💙 .