Class IgcBadgeComponent

The badge is a component indicating a status on a related item or an area where some active indication is required.

igc-badge

  • Default slot for the badge content.

base - The base wrapper of the badge.

icon - The icon container, present when an igc-icon element is slotted.

<igc-badge variant="success">New</igc-badge>
<igc-badge variant="danger" shape="square">5</igc-badge>
<igc-badge dot></igc-badge>

Hierarchy

Hierarchy

  • LitElement
    • IgcBadgeComponent

Other

dot: boolean = false

Sets whether to render a dot type badge. When enabled, the badge appears as a small dot without any content.

dot

false
outlined: boolean = false

Sets whether to draw an outlined version of the badge.

outlined

false
shape: BadgeShape = 'rounded'

The shape of the badge.

shape

'rounded'
variant: StyleVariant = 'primary'

The type (style variant) of the badge.

variant

'primary'
tagName: "igc-badge" = 'igc-badge'

styles

styles: CSSResult[] = ...

Array of styles to apply to the element. The styles should be defined using the css tag function, via constructible stylesheets, or imported from native CSS module scripts.

Note on Content Security Policy:

Element styles are implemented with <style> tags when the browser doesn't support adopted StyleSheets. To use such <style> tags with the style-src CSP directive, the style-src value must either include 'unsafe-inline' or nonce-<base64-value> with <base64-value> replaced be a server-generated nonce.

To provide a nonce to use on generated <style> elements, set window.litNonce to a server-generated nonce in your page's HTML, before loading application code:

<script>
// Generated and unique per request:
window.litNonce = 'a1b2c3d4';
</script>