Label

Maintainer:
goshander
GitHub
theme
type
size
disabled
interactive
value
copyText
children
import {Label} from '@gravity-ui/uikit';

Label (лейбл) можно использовать для выделения определенной информации. Label с кнопкой Close или Copy может быть полезен для выполнения различных простых действий.

Лейблы больше всего подходят для отображения однострочной текстовой информации с различными цветовыми кодами, показывающими ее важность.

Внешний вид

Label можно отображать в различных стилях.

Theme (тема)

Свойство theme позволяет применять различные темы в зависимости от статуса. Возможные значения: normal, info, success, warning, danger, utility, unknown и clear. Тема по умолчанию — normal.

Normal
Info
Success
Warning
Danger
Utility
Unknown
Clear

Type (тип)

Свойство type добавляет различные опции к Label:

copy — добавляет кнопку копирования, при нажатии на которую копируется значение, указанное в свойстве copyText;

close — добавляет кнопку закрытия для управления списком лейблов;

info — добавляет иконку информации к лейблу.

Closable
Copy
Info

Иконка

Иконку можно добавить с помощью свойства icon. Для этого используйте компонент Icon, который представляет собой обертку для SVG-файлов.

Icon
Icon and close
Icon and copy

Значение

Label можно применять для отображения информации в формате ключ-значение. Для этого необходимо передать ключ в свойство children, а значение — в свойство value.

Key
:
Value
Key
:
Value
Key
:
Value
Key
:
Value
Key
:
Value
Key
:
Value
Key
:
Value
Key
:
Value

Состояние

Label может иметь разные состояния:

  • disabled — взаимодействие с лейблом запрещено.
  • interactive — лейбл становится интерактивным по ховеру.
  • loading — отображает состояние загрузки.
Default
Disabled
Interactive
Loading

Размер

XXS size
XS size
S size
M size

Свойства

ИмяОписаниеТипЗначение по умолчанию
childrenСодержимое.React.ReactNode
classNameHTML-атрибут class.string
closeButtonLabelaria-label кнопки закрытия.string
copyButtonLabelaria-label кнопки копирования.string
copyTextКопируемый текст.string
disabledОтключенное состояние.boolean
iconИконка лейбла (слева).React.ReactNode
interactiveВключение эффекта ховера.boolean
loadingСостояние загрузки.booleanfalse
onClickОбработчик события click.Function
onCloseClickОбработчик события click по кнопке закрытия.Function
onCopyОбработчик события copy.Function
qaHTML-атрибут data-qa, используется для тестирования.string
sizeРазмер лейбла."xxs" "xs" "s" "m""xs"
themeТема лейбла.string"normal"
titleHTML-атрибут title.string
typeТип лейбла."default" "copy" "close" "info""default"
valueЗначение лейбла (в виде "children : value").React.ReactNode
widthЗадает ширину лейбла."auto"