@front10/landing-page-book
Version:
A react library for landing page
18 lines (16 loc) • 1.15 kB
Markdown
# GithubButton
[](https://github.com/RichardLitt/standard-readme)
## Properties
| </br>Name | </br>Type | </br>Summary | </br>Default |
| ---- | ---- | ---- | ---- |
| className | `string` | CSS class name selector to customs styles | `''` |
| color | `string` | Color of button. | `'light'` |
| disabled | `bool` | Shows github button disabled. | `false` |
| loadingClass | `string` | Class to loading indicator. | `'fa fa-circle-o-notch fa-spin'` |
| repository | `string` | Github repository. | `'landing-page-book'` |
| showBtnText | `bool` | Shows the text inside the button. | `true` |
| showCounter | `bool` | Shows the total next to the button. | `true` |
| showGithubIcon | `bool` | Shows github icon on the button. | `false` |
| text | `string` | text to show inside the button | `'Fork'` |
| type | `string` | What button show. Can be: <code>fork</code>,<code>follow</code>,<code>star</code>,<code>download</code>,<code>watch</code>,<code>issue</code>` | `'fork'` |
| username | `string` | Github username. | `'front10'` |