# shp-ui-lib

> > A simple and useful UI component library using typescript, react hooks, styled components

Latest version **0.0.4** (published 2020-09-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install shp-ui-lib
pnpm add shp-ui-lib
yarn add shp-ui-lib
bun add shp-ui-lib
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.4 |
| Published | 2020-09-29 |
| First published | 2020-09-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >=8 |
| Dependencies | 5 |
| Unpacked size | 446.5 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Sharon Haim-Pour |
| Maintainers | hpsharon |

## Links

- npm: https://www.npmjs.com/package/shp-ui-lib
- Repository: https://github.com/hpsharon/shp-ui-lib
- Homepage: https://github.com/hpsharon/shp-ui-lib#readme
- Issues: https://github.com/hpsharon/shp-ui-lib/issues
- npm.io page: https://npm.io/package/shp-ui-lib

## Dependencies (5)

- [polished](https://npm.io/package/polished.md) ^3.6.7
- [node-sass](https://npm.io/package/node-sass.md) ^4.14.1
- [classnames](https://npm.io/package/classnames.md) ^2.2.6
- [styled-props](https://npm.io/package/styled-props.md) ^1.1.2
- [styled-components](https://npm.io/package/styled-components.md) ^5.2.0

## Recent versions

- 0.0.4 (latest) — 2020-09-29
- 0.0.3 — 2020-09-29
- 0.0.2 — 2020-09-25
- 0.0.1 — 2020-09-19

## README

# shp-ui-lib

> A simple and useful UI component library using typescript, react hooks, styled components 

[![NPM](https://img.shields.io/npm/v/react-modern-library-boilerplate.svg)](https://www.npmjs.com/package/shp-ui-lib) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

## Intro

A simple and basic UI components library

## Featured Components

- Button

## Installation

Run from shell `npm install shp-ui-lib`

## Documentation
###### Button
Property    | Description               | Default |     Required
--------    | -----------               | ------- |     --------
`text`      | Text to show on button    | Empty string  | `false`
`style`     | Button style. One of the following: `primary`, `secondary`, `success`, `danger`, `warning`, `info`, `light` | `primary` | `false`
`onClick`   |   Function to execute on button click | | `true`

##Example

```javascript
import { useCallback } from 'react'
import {Button} from 'shp-ui-lib'

function App() {
  const onClickCallback = useCallback(() => {
    console.log('Clicked')
  }, [])

  return (
    <div>
      <Button type='primary' text={'Primary'} onClick={onClickCallback} /> 
      <Button type='secondary' text={'Secondary'} onClick={onClickCallback} />
      <Button type='success' text={'Success'} onClick={onClickCallback} />
      <Button type='danger' text={'Danger'} onClick={onClickCallback} />
      <Button type='warning' text={'Warning'} onClick={onClickCallback} />
      <Button type='info' text={'Info'} onClick={onClickCallback} />
      <Button type='light' text={'Light'} onClick={onClickCallback} />
    </div>
  )
}

export default App

```   

## License

MIT © [Sharon Haim-Pour](linkedin.com/in/hpsharon/)

---
_Source: https://npm.io/package/shp-ui-lib · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._