# peak-design

> Peak design React component library.

Latest version **0.1.3** (published 2018-09-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install peak-design
pnpm add peak-design
yarn add peak-design
bun add peak-design
```

## 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.1.3 |
| Published | 2018-09-02 |
| First published | 2018-07-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 5 |
| Unpacked size | 353.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Kyle Lawson |
| Maintainers | kylelawson |
| Keywords | peak, design, react, component, library |

## Links

- npm: https://www.npmjs.com/package/peak-design
- Repository: https://github.com/KyleLawson16/peak-design
- Homepage: https://github.com/KyleLawson16/peak-design.git#readme
- Issues: https://github.com/KyleLawson16/peak-design.git/issues
- npm.io page: https://npm.io/package/peak-design

## Dependencies (5)

- [clone](https://npm.io/package/clone.md) ^2.1.1
- [react](https://npm.io/package/react.md) ^16.2.0
- [react-dom](https://npm.io/package/react-dom.md) ^16.2.0
- [prop-types](https://npm.io/package/prop-types.md) ^15.6.0
- [react-social-icons](https://npm.io/package/react-social-icons.md) ^3.0.0

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 0.1.3 (latest) — 2018-09-02
- 0.1.2 — 2018-09-02
- 0.1.1 — 2018-09-02
- 0.1.0 — 2018-09-02
- 0.0.2 — 2018-07-29
- 0.0.1 — 2018-07-29

## README

# Peak Design

## Components

- [SocialIcon](#SocialIcon)
- [WhiteSpace](#WhiteSpace)

## <a name="SocialIcon">SocialIcon:</a>

### Example

```
import React from 'react'
import { SocialIcon } from 'peak-design'

export default class Footer extends React.Component {
  renderSocialIcons() {
    const icons = [
      { name: 'twitter', url: 'https://twitter.com/LOUassistant?lang=en' },
      { name: 'linkedin', url: 'https://www.linkedin.com/company/lou-assistant' },
      { name: 'youtube', url: 'https://www.youtube.com/channel/UCCiCE0DwqFplf6SV2MhT4SA' }
    ]
    return icons.map(icon => {
      return (
        <SocialIcons
          key={icon.name}
          url={icon.url}
          color="#888"
          hovColor="rgb(59,200,200)"
          width={35}
          height={35}
          marginRight={5}
          marginLeft={5}
        />
      )
    })
  }

  render() {
    return <div>{this.renderSocialIcons()}</div>
  }
}
```

### Properties

| Property    |  Type  |
| ----------- | :----: |
| url         | string |
| color       | color  |
| hoverColor  | color  |
| width       |  int   |
| height      |  int   |
| marginLeft  |  int   |
| marginRight |  int   |

## <a name="WhiteSpace">WhiteSpace</a>

### Example

```
import React from 'react'
import { WhiteSpace } from 'peak-design'

export default class Heading extends React.Component {
  render() {
    return (
      <div>
        <h1>Title</h1>
        <WhiteSpace height={20} />
        <p>Description</p>
      </div>
    )
  }
}
```

### Properties

| Property        |  Type  | Default     |
| --------------- | :----: | ----------- |
| orientation     | string | 'vertical'  |
| height          |  int   | null        |
| width           |  int   | null        |
| backgroundColor | color  | transparent |

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