npm.io
0.0.155 • Published 9 years ago

ramatrix

Licence
MIT
Version
0.0.155
Deps
1
Vulns
0
Weekly
0
Stars
2

Stories in Ready

Ramatrix (React Availability Matrix)

A react component to gather a user's hourly availability.

Install

npm install ramatrix --save

Usage within a React component

import Ramatrix from 'ramatrix';

// call this function when you want to get the matrix data
getMatrixData () {
  console.log(this._myMatrix.getData()); // "{"7AMTh":true,"8AMTh":true.....
}

render () {
  return (
    <Ramatrix ref={(c) => this._myMatrix = c}/>
  );
}

Customizable options

Props can be passed for data and styling customization

militaryTime - boolean (true/false) | default - false

  • Will display hours from 0 - 23 or 12AM - 12PM

containerStyle - reactStyling object | default - display: inline-block;

  • styling that will be applied to outer container

cellWidth - reactStyling object | default - 65px

  • width that will be applied to individual cells

SSS1

Contribute/Development

Compiling for development

Simply run npm install and npm run dev from the root of the project. This will run webpack-dev-server on port 8080.

Preview in a browser!

``` localhost:8080 ```

Authors

* [jhyman2](https://github.com/jhyman2) * [kevcoxe](https://github.com/kevcoxe)

Links

* [git repo](https://github.com/jhyman2/ramatrix) * [npm](https://www.npmjs.com/package/ramatrix)

Keywords