Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

Documentationbreadcrumb arrow Grafana documentationbreadcrumb arrow API Referencebreadcrumb arrow @grafana/uibreadcrumb arrow CardProps
Enterprise Open source

CardProps interface

Signature

typescript 
export interface Props extends Omit<CardContainerProps, 'disableEvents' | 'disableHover'>

Import

typescript 
import { CardProps } from '@grafana/ui';

Properties

PropertyTypeDescription
descriptionstringCard description text
disabledbooleanIndicates if the card and all its actions can be interacted with
headingReactNodeMain heading for the Card *
hrefstringLink to redirect to on card click. If provided, the Card inner content will be rendered inside a
onClick() => voidOn click handler for the Card

description property

Card description text

Signature

typescript 
description?: string;

disabled property

Indicates if the card and all its actions can be interacted with

Signature

typescript 
disabled?: boolean;

heading property

Main heading for the Card *

Signature

typescript 
heading: ReactNode;

href property

Link to redirect to on card click. If provided, the Card inner content will be rendered inside a

Signature

typescript 
href?: string;

onClick property

On click handler for the Card

Signature

typescript 
onClick?: () => void;