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

web: Components: Fixed IconButton component readme

Browse Source
This commit is contained in:
Ilya Oleshko 2019-11-20 16:33:46 +03:00
parent cc9fe4d117
commit ab0ff6c264
1 changed files with 24 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
web/ASC.Web.Components/src/components/icon-button/README.md
View File

@ -1,18 +1,14 @@
# Buttons: IconButton
# IconButton
## Usage
IconButton is used for a action on a page
### Usage
```js
import { IconButton } from "asc-web-components";
```
#### Description
IconButton is used for a action on a page.
#### Usage
```js
```jsx
<IconButton
size="25"
isDisabled={false}
@ -23,14 +19,23 @@ IconButton is used for a action on a page.
/>
```
#### Properties
### Properties
| Props | Type | Required | Values | Default | Description |
| ------------- | ------------------------ | :------: | ------ | --------------- | ----------------------------------------------------- |
| `color` | `string` | - | - | `#d0d5da` | Icon color |
| `size` | `` number` or `string `` | - | - | `25` | Button height and width value |
| `isDisabled` | `bool` | - | - | `false` | Tells when the button should present a disabled state |
| `iconName` | `string` | ✅ | - | `AZSortingIcon` | Icon name |
| `isFill` | `bool` | - | - | `true` | Determines if icon fill is needed |
| `onClick` | `func` | - | - | - | What the button will trigger when clicked |
| `isClickable` | `bool` | - | - | `false` | Set cursor value |
| Props | Type | Required | Values | Default | Description |
| --------------- | :----------------: | :------: | :----: | :-------------: | ----------------------------------------------------- |
| `color` | `string` | - | - | `#d0d5da` | Icon color |
| `hoverColor` | `string` | - | - | - | Icon color on hover action |
| `clickColor` | `string` | - | - | - | Icon color on click action |
| `size` | `number`,`string` | - | - | `25` | Button height and width value |
| `isDisabled` | `bool` | - | - | `false` | Tells when the button should present a disabled state |
| `iconName` | `string` | ✅ | - | `AZSortingIcon` | Icon name |
| `iconHoverName` | `string` | - | - | - | Icon name on hover action |
| `iconClickName` | `string` | - | - | - | Icon name on click action |
| `isFill` | `bool` | - | - | `true` | Determines if icon fill is needed |
| `onClick` | `func` | - | - | - | What the button will trigger when clicked |
| `onMouseEnter` | `func` | - | - | - | What the button will trigger when cursor enter |
| `onMouseDown` | `func` | - | - | - | What the button will trigger when cursor down |
| `onMouseUp` | `func` | - | - | - | What the button will trigger when cursor up |
| `isClickable` | `bool` | - | - | `false` | Set cursor value |
| `className` | `string` | - | - | - | Set component class |
| `id` | `string`, `number` | - | - | - | Set component id |