@react-md/badge | react-md

Index

Interfaces

Type aliases

Variables

Type aliases

BadgeContainerProps

BadgeContainerProps: HTMLAttributes<HTMLSpanElement>

BadgeTheme

BadgeTheme: "primary" | "secondary" | "default" | "clear"

Variables

Const Badge

Badge: ForwardRefExoticComponent<BadgeProps & RefAttributes<HTMLSpanElement>> = ...

This component is generally used for displaying notifications with a count relative to another element with the BadgeContainer component. However, it can be used by itself to display any subpplementary content if needed.

Const BadgeContainer

BadgeContainer: ForwardRefExoticComponent<BadgeContainerProps & RefAttributes<HTMLSpanElement>> = ...

This is a really simple component that will just allow you to position a badge relative to another component.

Const BadgedButton

BadgedButton: ForwardRefExoticComponent<BadgedButtonProps & RefAttributes<HTMLButtonElement>> = ...

This is a small wrapper for the Button component that will automatically apply the aria-describedby attribute when it has been "badged". It also adds some reasonable defaults for the most common use-case for badges: notifications.