diff --git a/src/components/UserLabel/README.md b/src/components/UserLabel/README.md index 186cef17f1..1f592f0f3f 100644 --- a/src/components/UserLabel/README.md +++ b/src/components/UserLabel/README.md @@ -9,23 +9,23 @@ Used to manage avatar appearance. Use "person" for a personalized entity and "em ```tsx - - - +Charles Darwin (person) +email@example.com (email) +Alan Turing (other) ``` @@ -39,12 +39,12 @@ This component can be used with a custom avatar. It works only with `type: 'pers code={` import {GraduationCap} from '@gravity-ui/icons'; - - +Charles Darwin +Charles Darwin `} > - - '}} text="Charles Darwin" /> + Charles Darwin + '}}>Charles Darwin LANDING_BLOCK--> @@ -53,8 +53,8 @@ LANDING_BLOCK--> ```tsx import {GraduationCap} from '@gravity-ui/icons'; - - +Charles Darwin +Charles Darwin ``` @@ -66,20 +66,20 @@ This component is also interactive. It can be clickable or closable. ```tsx - alert('onClick triggered')} /> - alert('onCloseClick triggered')} /> + alert('onClick triggered')}>Charles Darwin + alert('onCloseClick triggered')}>Charles Darwin ``` @@ -90,7 +90,7 @@ LANDING_BLOCK--> | :----------- | :------------------------------------------ | :-------------------------------------------------------------------------: | :----------: | | type | Avatar appearance | `'person'` `'email'` `'empty'` | `'person'` | | avatar | User avatar | [AvatarProps](../Avatar/README.md#properties) `string` `React.ReactElement` | | -| text | Visible text | `string` | | +| children | Visible text | `React.ReactNode` | | | view | UserLabel view | `'outlined'` `'clear'` | `'outlined'` | | onClick | `click` event handler for component itself | `Function` | | | onCloseClick | `click` event handler for button with cross | `Function` | |