UNPKG

1.19 kBTypeScriptView Raw
1import * as React from 'react';
2import { ButtonProps } from '../Button';
3export declare enum NotificationBadgeVariant {
4 read = "read",
5 unread = "unread",
6 attention = "attention"
7}
8export interface NotificationBadgeProps extends Omit<ButtonProps, 'variant'> {
9 /** @deprecated Use the variant prop instead - Adds styling to the notification badge to indicate it has been read */
10 isRead?: boolean;
11 /** Determines the variant of the notification badge */
12 variant?: NotificationBadgeVariant | 'read' | 'unread' | 'attention';
13 /** A number displayed in the badge alongside the icon */
14 count?: number;
15 /** content rendered inside the notification badge */
16 children?: React.ReactNode;
17 /** additional classes added to the notification badge */
18 className?: string;
19 /** Adds accessible text to the notification badge. */
20 'aria-label'?: string;
21 /** Icon to display for attention variant */
22 attentionIcon?: React.ReactNode;
23 /** Icon do display in notification badge */
24 icon?: React.ReactNode;
25}
26export declare const NotificationBadge: React.FunctionComponent<NotificationBadgeProps>;
27//# sourceMappingURL=NotificationBadge.d.ts.map
\No newline at end of file