UNPKG

2.29 kBMarkdownView Raw
1# @bund-x/core
2
3> Master Components Core Library
4
5[![NPM](https://badgen.net/npm/v/@bund-x/core)](https://www.npmjs.com/package/@bund-x/core)
6[![jsdelivr](https://badgen.net/jsdelivr/v/npm/@bund-x/core)](ttps://www.jsdelivr.com/package/npm/@bund-x/core)
7![install](https://badgen.net/packagephobia/install/@bund-x/core)
8![publish](https://badgen.net/packagephobia/publish/@bund-x/core)
9![min](https://badgen.net/bundlephobia/min/@bund-x/core)
10![min](https://badgen.net/bundlephobia/minzip/@bund-x/core)
11![dependencies](https://badgen.net/bundlephobia/dependency-count/@bund-x/core)
12![tree-shaking](https://badgen.net/bundlephobia/tree-shaking/@bund-x/core)
13![types](https://badgen.net/npm/types/@bund-x/core)
14![build](https://img.shields.io/badge/build-success-green)
15[![JavaScript Style Guide](https://badgen.net/badge/code%20style/standard/f2a)](https://standardjs.com)
16![license](https://badgen.net/badge/license/MIT/blue)
17[![follow](https://badgen.net/twitter/follow/go_beyound)](https://twitter.com/go_beyound)
18[![keybase](https://badgen.net/keybase/pgp/microbot)](https://keybase.io/microbot)
19
20[runkit](https://npm.runkit.com/@bund-x/core) -
21[jsconsole](https://jsconsole.com/) -
22[bundlephobia](https://bundlephobia.com/result?p=@bund-x/core) -
23[unpkg](https://unpkg.com/browse/@bund-x/core/) -
24[jsdeliver](https://www.jsdelivr.com/package/npm/@bund-x/core) -
25[openbase](https://openbase.io/js/@bund-x/core) -
26[network](https://npm.anvaka.com/#/view/2d/%2540bund-x%252Fcore)
27
28## Install
29
30```bash
31npm install --save @bund-x/core
32```
33
34## Usage
35
36```jsx
37import React, { Component } from 'react'
38import Button from '@bund-x/core/Button'
39
40class App extends Component {
41 render() {
42 return (
43 <Button
44 color="primary" // 'primary', 'secondary', 'success', 'danger', 'warning', 'info', 'light', 'dark'
45 shape="round" // 'round', 'square'
46 variant="solid" // 'solid', 'outline', 'text', 'contained'
47 href="/path/to/route"
48 size="md" // 'xs', 'sm', 'md', 'lg', 'xl'
49 type="submit" // 'button', 'reset', 'submit'
50 startIcon={<i className="fa fa-home" />}
51 endIcon={<i className="fa fa-home" />}>
52 children
53 </Button>
54 )
55 }
56}
57
58export default App
59```
60
61## License
62
63MIT © [bund-xyz](https://github.com/bund-xyz/core)