Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface BadgeAttachmentRenderOptions

An attachment adds content to a hover tooltip or result in a locations panel.

Hierarchy

Index

Properties

Optional backgroundColor

backgroundColor: undefined | string

The CSS background-color property value for the attachment.

deprecated

Use {@link BadgeAttachmentRenderOptions#kind} to pick a predefined icon

Optional color

color: undefined | string

The CSS color property value for the attachment.

deprecated

Use {@link BadgeAttachmentRenderOptions#kind} to pick a predefined icon

Optional dark

Overwrite style for dark themes.

deprecated

Use {@link BadgeAttachmentRenderOptions#kind} to pick a predefined icon

Optional hoverMessage

hoverMessage: undefined | string

Tooltip text to display when hovering over the attachment.

Optional icon

icon: undefined | string

The icon (a base64-encoded image icon) to display next to the wrapped value.

deprecated

Use {@link BadgeAttachmentRenderOptions#kind} to pick a predefined icon

kind

kind: "info" | "error" | "warning"

Predefined icons for badge attachments

Optional light

Overwrite style for light themes.

deprecated

Use {@link BadgeAttachmentRenderOptions#kind} to pick a predefined icon

Optional linkURL

linkURL: undefined | string

If set, the attachment becomes a link with this destination URL.

Generated using TypeDoc