@jswork/styled-box/README.md

Styled box for react.

# styled-box
> Styled box for react.

[![version][version-image]][version-url]
[![license][license-image]][license-url]
[![size][size-image]][size-url]
[![download][download-image]][download-url]

## installation
```shell
npm install -S @jswork/styled-box
```

## properties
| Name      | Type   | Required | Default | Description                           |
| --------- | ------ | -------- | ------- | ------------------------------------- |
| className | string | false    | -       | The extended className for component. |
| value     | object | false    | null    | Default value.                        |
| onChange  | func   | false    | noop    | The change handler.                   |


## usage
1. import css
  ```scss
  @import "~@jswork/boilerplate-react-component/dist/style.css";

  // or use sass
  @import "~@jswork/boilerplate-react-component/dist/style.scss";

  // customize your styles:
  $boilerplate-react-component-options: ()
  ```
2. import js
  ```js
  import React from 'react';
  import StyledBox from '../@jswork/boilerplate-react-component';
  import styled from 'styled-components';

  const Container = styled.div`
    width: 80%;
    margin: 30px auto 0;
  `;

  export default (props: any) => {
    return (
      <Container>
        <StyledBox />
      </Container>
    );
  };

  ```

## license
Code released under [the MIT license](https://github.com/afeiship/styled-box/blob/master/LICENSE.txt).

[version-image]: https://img.shields.io/npm/v/@jswork/styled-box
[version-url]: https://npmjs.org/package/@jswork/styled-box

[license-image]: https://img.shields.io/npm/l/@jswork/styled-box
[license-url]: https://github.com/afeiship/styled-box/blob/master/LICENSE.txt

[size-image]: https://img.shields.io/bundlephobia/minzip/@jswork/styled-box
[size-url]: https://github.com/afeiship/styled-box/blob/master/dist/styled-box.min.js

[download-image]: https://img.shields.io/npm/dm/@jswork/styled-box
[download-url]: https://www.npmjs.com/package/@jswork/styled-box