https://github.com/itsdouges/react-library-boilerplate

🚂🍽 for js libraries I make. nyc, codecov, travis.
https://github.com/itsdouges/react-library-boilerplate

Last synced: 11 months ago
JSON representation

🚂🍽 for js libraries I make. nyc, codecov, travis.

• Host: GitHub
• URL: https://github.com/itsdouges/react-library-boilerplate
• Owner: itsdouges
• License: mit
• Created: 2017-04-11T22:43:59.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2017-10-03T09:17:32.000Z (over 8 years ago)
• Last Synced: 2025-01-23T14:38:30.473Z (12 months ago)
• Language: JavaScript
• Homepage:
• Size: 135 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# [react-library-boilerplate](https://github.com/madou/react-library-boilerplate)

[![NPM version](http://img.shields.io/npm/v/react-library-boilerplate.svg?style=flat-square)](https://www.npmjs.com/package/react-library-boilerplate)

[![NPM downloads](http://img.shields.io/npm/dm/react-library-boilerplate.svg?style=flat-square)](https://www.npmjs.com/package/react-library-boilerplate)

[![Build Status](http://img.shields.io/travis/madou/react-library-boilerplate/master.svg?style=flat-square)](https://travis-ci.org/madou/react-library-boilerplate)

[![codecov](https://codecov.io/gh/madou/react-library-boilerplate/branch/master/graph/badge.svg)](https://codecov.io/gh/madou/react-library-boilerplate)

[![Dependency Status](http://img.shields.io/david/madou/react-library-boilerplate.svg?style=flat-square)](https://david-dm.org/madou/react-library-boilerplate)

Quick description of what it does!



  



## Installation

```sh

npm install react-library-boilerplate

```

## Usage

```javascript

import 'react-library-boilerplate/styles.css';

import ReactStickyHeader from 'react-library-boilerplate';

import ReactDOM from 'react-dom';

ReactDOM.render(

  

        
ReactStickyHeader


        


          
When

          
Why

          
About

        

      

    }

  >

    

      // More header stuff here, this won't be sticky.

    

  ,

  document.getElementById('container')

);

```


| prop | type | required |

|-|-|-|

| children | Children  | no |

| header | Children | yes |

| backgroundImage | string | no |

| backgroundColor | string | no |

| headerOnly | boolean | no |

| onSticky | (boolean) => void | no |

| className | string | no |

### React Story Book

To run the component in various modes, run the following command then go to `http://localhost:6006/`.

```bash

npm start

```

### Testing

```bash

npm test

```