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

web: Components: Fixed DropDownItem component readme

Browse Source
This commit is contained in:
Ilya Oleshko 2019-11-20 14:21:42 +03:00
parent 2ab437dad5
commit 4998711ac3
1 changed files with 18 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
web/ASC.Web.Components/src/components/drop-down-item/README.md
View File

@ -1,22 +1,14 @@
# DropDownItem
## Usage
Is a item of DropDown component
### Usage
```js
import { DropDownItem } from "asc-web-components";
```
#### Description
Is a item of DropDown component.
An item can act as separator, header, or container.
When used as container, it will retain all styling features and positioning. To disable hover effects in container mode, you can use *noHover* property.
#### Usage
```js
```jsx
<DropDownItem
isSeparator={false}
isHeader={false}
@ -26,14 +18,18 @@ When used as container, it will retain all styling features and positioning. To
/>
```
#### Properties
An item can act as separator, header, or container.
| Props | Type | Required | Values | Default | Description |
| ------------- | -------- | :------: | ------ | --------------- | ---------------------------------------------------------- |
| `isSeparator` | `bool` | - | - | `false` | Tells when the dropdown item should display like separator |
| `isHeader` | `bool` | - | - | `false` | Tells when the dropdown item should display like header |
| `label` | `string` | - | - | `Dropdown item` | Dropdown item text |
| `icon` | `string` | - | - | - | Dropdown item icon |
| `onClick` | `func` | - | - | - | What the dropdown item will trigger when clicked |
| `disabled` | `bool` | - | - | `false` | Tells when the dropdown item should display like disabled |
| `noHover` | `bool` | - | - | `false` | Disable default style hover effect |
When used as container, it will retain all styling features and positioning. To disable hover effects in container mode, you can use _noHover_ property.
### Properties
| Props | Type | Required | Values | Default | Description |
| ------------- | :------: | :------: | :----: | :-------------: | ---------------------------------------------------------- |
| `isSeparator` | `bool` | - | - | `false` | Tells when the dropdown item should display like separator |
| `isHeader` | `bool` | - | - | `false` | Tells when the dropdown item should display like header |
| `label` | `string` | - | - | `Dropdown item` | Dropdown item text |
| `icon` | `string` | - | - | - | Dropdown item icon |
| `onClick` | `func` | - | - | - | What the dropdown item will trigger when clicked |
| `disabled` | `bool` | - | - | `false` | Tells when the dropdown item should display like disabled |
| `noHover` | `bool` | - | - | `false` | Disable default style hover effect |