Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface HoverAlert

Hierarchy

  • HoverAlert

Index

Properties

Properties

Optional iconKind

iconKind: "info" | "error" | "warning"

Predefined icons to display next ot the summary.

summary

summary: MarkupContent

Text content to be shown on hovers. Since the alert is displayed inline, multiparagraph content will be rendered on one line. It's recommended to provide a brief message here, and place futher details in the badge or provide a link.

Optional type

type: undefined | string

When an alert has a dismissal type, dismissing it will prevent all alerts of that type from being shown. If no type is provided, the alert is not dismissible.

Generated using TypeDoc