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

web: Components: Fixed Badge component readme

Browse Source
This commit is contained in:
Ilya Oleshko 2019-11-19 17:25:40 +03:00
parent 4d641811a6
commit a8c08a0b7e
1 changed files with 29 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
web/ASC.Web.Components/src/components/badge/README.md
View File

@ -1,27 +1,37 @@
# Badge # Badge
## Usage Used for buttons, numbers or status markers next to icons.
### Usage
```js ```js
import { Badge } from 'asc-web-components'; import { Badge } from "asc-web-components";
<Badge />;
``` ```
#### Description ```jsx
<Badge
number={10}
backgroundColor="#ED7309"
color="#FFFFFF"
fontSize="11px"
fontWeight={800}
borderRadius="11px"
padding="0 5px"
maxWidth="50px"
onClick={() => {}}
/>
```
Notify badge ### Properties
#### Properties | Props | Type | Required | Values | Default | Description |
| ----------------- | :------: | :------: | :----: | :-------: | -------------------- |
| Props | Type | Required | Values | Default | Description | | `number` | `number` | - | - | `0` | Number value |
| ----------------- | -------- | :------: | ------ | --------- | --------------------- | | `backgroundColor` | `string` | - | - | `#ED7309` | CSS background-color |
| `number` | `number` | | | 0 | Number value | | `color` | `string` | - | - | `#FFFFFF` | CSS color |
| `backgroundColor` | `string` | | | '#ED7309' | CSS background-color | | `fontSize` | `string` | - | - | `11px` | CSS font-size |
| `color` | `string` | | | '#FFFFFF' | CSS color | | `fontWeight` | `number` | - | - | `800` | CSS font-weight |
| `fontSize` | `string` | | | '11px' | CSS font-size | | `borderRadius` | `string` | - | - | `11px` | CSS border-radius |
| `fontWeight` | `number` | | | '800' | CSS font-weight | | `padding` | `string` | - | - | `0 5px` | CSS padding |
| `borderRadius` | `string` | | | '11px' | CSS border-radius | | `maxWidth` | `string` | - | - | `50px` | CSS max-width |
| `padding` | `string` | | | '0 5px' | CSS padding | | `onClick` | `func` | - | - | - | onClick event |
| `maxWidth` | `string` | | | '50px' | CSS max-width |
| `onClick` | `func` | | | | onClick event |