Skip to content
master
Go to file
Code

Latest commit

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
Jun 7, 2019

README.md

SmartHR UI

React components for creating SmartHR applications.

npm version CircleCI e2e

Components

master branch's storybook: https://smarthr-ui.netlify.com/

Installation

SmartHR-UI is available as an npm package.

// with npm
npm install smarthr-ui

// with yarn
yarn add smarthr-ui

Install peerDependencies.

// with npm
npm install react react-dom styled-components

// with yarn
yarn add react react-dom styled-components

Usage

The simplest and easiest example to get you started.

import React from 'react'
import ReactDOM from 'react-dom'
import { createTheme, ThemeProvider, PrimaryButton } from 'smarthr-ui'

const theme = createTheme({})

const App: React.FC<Record<string: unknown>> = () => (
  <ThemeProvider theme={theme}>
    <PrimaryButton>Hello World</PrimaryButton>
  </ThemeProvider>
)

ReactDOM.render(<App />, document.getElementById('app'))

Contributing

We'd greatly appreciate any contribution you make.

Changelog

Please read the changelog.

Design

We released design in InVision. If you use our service logo, please read the SmartHR Brand Asset Guide

License

This project is licensed under the terms of the MIT license.