https://github.com/afeiship/react-demokit

Demo tookit for react.
https://github.com/afeiship/react-demokit

demo docs react

Last synced: 23 days ago
JSON representation

Demo tookit for react.

• Host: GitHub
• URL: https://github.com/afeiship/react-demokit
• Owner: afeiship
• License: mit
• Created: 2020-09-27T09:32:41.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2020-11-17T13:09:05.000Z (about 4 years ago)
• Last Synced: 2023-12-18T12:21:14.920Z (11 months ago)
• Topics: demo, docs, react
• Language: JavaScript
• Homepage:
• Size: 434 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# react-demokit

> Demo tookit 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/react-demokit

```

## properties

| Name        | Type    | Required | Default                                                             | Description                           |

| ----------- | ------- | -------- | ------------------------------------------------------------------- | ------------------------------------- |

| className   | string  | false    | -                                                                   | The extended className for component. |

| url         | string  | false    | -                                                                   | The github homepage url.              |

| title       | string  | false    | -                                                                   | The compoennt name.                   |

| description | string  | false    | -                                                                   | The component description.            |

| element     | element | false    |  | Main element.                         |

## usage

1. import css

  ```scss

  @import "~@jswork/react-github-corner/dist/style.scss";

  @import "~@jswork/react-sw-update-tips/dist/style.scss";

  @import "~@jswork/react-demokit/dist/style.scss";

  // customize your styles:

  $react-demokit-options: ()

  ```

2. import js

  ```js

  import React from 'react';

  import ReactDOM from 'react-dom';

  import pkg from '../package.json';

  import ReactDemokit from '@jswork/react-demokit';

  import './assets/style.scss';

  class App extends React.Component {

    render() {

      return (

        


          

            I'm the component 🐶

          

        

      );

    }

  }


  ReactDOM.render(, document.getElementById('app'));

  ```

## documentation

- https://afeiship.github.io/react-demokit/

## license

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

[version-image]: https://img.shields.io/npm/v/@jswork/react-demokit

[version-url]: https://npmjs.org/package/@jswork/react-demokit

[license-image]: https://img.shields.io/npm/l/@jswork/react-demokit

[license-url]: https://github.com/afeiship/react-demokit/blob/master/LICENSE.txt

[size-image]: https://img.shields.io/bundlephobia/minzip/@jswork/react-demokit

[size-url]: https://github.com/afeiship/react-demokit/blob/master/dist/react-demokit.min.js

[download-image]: https://img.shields.io/npm/dm/@jswork/react-demokit

[download-url]: https://www.npmjs.com/package/@jswork/react-demokit