https://github.com/anooprav7/stormbreaker-cl

Stormbreaker Component Library :metal:
https://github.com/anooprav7/stormbreaker-cl

component- emotionjs react react-components stormbreaker

Last synced: about 1 year ago
JSON representation

Stormbreaker Component Library :metal:

• Host: GitHub
• URL: https://github.com/anooprav7/stormbreaker-cl
• Owner: anooprav7
• License: mit
• Created: 2020-03-28T14:38:04.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2023-01-05T18:35:13.000Z (over 3 years ago)
• Last Synced: 2025-03-14T14:48:19.722Z (over 1 year ago)
• Topics: component-, emotionjs, react, react-components, stormbreaker
• Language: JavaScript
• Homepage: https://stormbreaker-v2.netlify.com/
• Size: 1.61 MB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 24
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Stormbreaker

[![npm version](https://img.shields.io/npm/v/stormbreaker.svg?style=flat)](https://www.npmjs.com/package/stormbreaker)

[![issues](https://img.shields.io/github/issues/anooprav7/stormbreaker-cl)](https://www.github.com/anooprav7/stormbreaker-cl/issues)

[![contributors](https://img.shields.io/github/contributors/anooprav7/stormbreaker-cl)](https://www.github.com/anooprav7/stormbreaker-cl/)

![core size](https://img.shields.io/bundlephobia/min/stormbreaker.svg?label=core%20size)

![core gzip size](https://img.shields.io/bundlephobia/minzip/stormbreaker.svg?label=core%20gzip%20size)

[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/anooprav7/stormbreaker-cl/blob/master/LICENSE)

> Stormbreaker Component Library

## Install

```

yarn add stormbreaker

npm install stormbreaker --save

```

## Usage

The components need a theme to be set through the `ThemeProvider` at the root level. We provide a default theme along with the components in the package named `theme` as shown below.

We also provide some `globalStyles` styles in the package (Recommended).

```jsx padded dark

import { ThemeProvider, Global, theme, globalStyles } from "stormbreaker"

export default () => (

  

    

    // Code starts here Eg. 

  

)

```

Then, to include components from `stormbreaker`

```js dark

import React from 'react'

import { Button, Checkbox } from 'stormbreaker'

...

```

## Storybook

[Stormbreaker Storybook Docs](https://stormbreaker-v2.netlify.com/)

## [License](LICENSE)

MIT