grafana/docs/sources/packages_api/ui/badgeprops.md

62 lines
1.1 KiB
Markdown
Raw Normal View History

+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "BadgeProps"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
+++
## BadgeProps interface
<b>Signature</b>
```typescript
export interface BadgeProps
```
<b>Import</b>
```typescript
import { BadgeProps } from '@grafana/ui';
```
<b>Properties</b>
| Property | Type | Description |
| --- | --- | --- |
| [color](#color-property) | <code>BadgeColor</code> | |
| [icon](#icon-property) | <code>IconName</code> | |
| [text](#text-property) | <code>string</code> | |
| [tooltip](#tooltip-property) | <code>string</code> | |
### color property
<b>Signature</b>
```typescript
color: BadgeColor;
```
### icon property
<b>Signature</b>
```typescript
icon?: IconName;
```
### text property
<b>Signature</b>
```typescript
text: string;
```
### tooltip property
<b>Signature</b>
```typescript
tooltip?: string;
```