IlyaSobolev/DocSpace-client
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

web: Components: Fixed SocialButton component readme

Browse Source
This commit is contained in:
Ilya Oleshko 2019-11-21 16:30:05 +03:00
parent 5fff53f21b
commit 83de98ef8e
1 changed files with 17 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
web/ASC.Web.Components/src/components/social-button/README.md
View File

@ -1,29 +1,25 @@
# Buttons: SocialButton
# SocialButton
## Usage
Button is used for sign up with help social networks
### Usage
```js
import { SocialButton } from 'asc-web-components';
import { SocialButton } from "asc-web-components";
```
#### Description
Button is used for sign up with help social networks.
#### Usage
```js
<SocialButton iconName={"SocialButtonGoogleIcon"} label={"Sign up with Google"}/>
```jsx
<SocialButton
iconName={"SocialButtonGoogleIcon"}
label={"Sign up with Google"}
/>
```
#### Properties
| Props | Type | Required | Values | Default | Description |
| ------------------ | -------- | :------: | --------------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| `label` | `string` | - | - | - | Button text |
| `iconName` | `string` | - | - | SocialButtonGoogleIcon | Icon of button |
| `isDisabled` | `bool` | - | - | false | Tells when the button should present a disabled state |
| `onClick` | `func` | - | - | - | What the button will trigger when clicked |
### Properties
| Props | Type | Required | Values | Default | Description |
| ------------ | :------: | :------: | :----: | :----------------------: | ----------------------------------------------------- |
| `label` | `string` | - | - | - | Button text |
| `iconName` | `string` | - | - | `SocialButtonGoogleIcon` | Icon of button |
| `isDisabled` | `bool` | - | - | `false` | Tells when the button should present a disabled state |
| `onClick` | `func` | - | - | - | What the button will trigger when clicked |