New to Kendo UI for Vue? Start a free 30-day trial

Represents the Kendo UI for Vue BadgeContainer component. Accepts properties of type BadgeContainerProps.

Definition

Package:@progress/kendo-vue-indicators

Properties Interface:BadgeContainerProps

Syntax:

vue
<BadgeContainer
    :content="'badgeContent'"
    :theme-color="'error'"
    :position="'edge'"
>
    <img :src="avatarUrl" :alt="'User avatar'" />
    <template #badgeContent>12</template>
</BadgeContainer>

Properties

align?

{ horizontal: "start" | "end"; vertical: "top" | "bottom" }

Sets the alignment of the Badge. The BadgeContainer uses { vertical: 'top', horizontal: 'end' } when you do not set it.

The possible keys are:

  • horizontal— Sets the horizontal alignment of the Badge.
    • start—Uses the start point of the parent element.
    • end—Uses the end point of the parent element.
  • vertical— Sets the vertical alignment of the Badge.
    • top—Uses the top point of the parent element.
    • bottom—Uses the bottom point of the parent element.
Default:

undefined

Sets a custom template for the Badge content. Accepts a slot name, a render function, or a Vue component.

Renders an additional cutout border around the Badge when you set it to true.

The possible values are:

  • true
  • false (Default)

dir?

string

Sets the dir HTML attribute of the Badge. Use it to switch between LTR and RTL.

fillMode?

"solid" | "tint" | "outline"

Sets the fill style of the Badge.

The possible values are:

  • solid
  • tint
  • outline
Default:

undefined

position?

"edge" | "outside" | "inside" | "inline"

Sets the position of the Badge relative to the edge of the container element. The BadgeContainer uses edge when you do not set it.

The possible values are:

  • edge—Places the center of the Badge on the edge of the container element.
  • outside—Places the whole Badge outside the edge of the container element.
  • inside—Places the whole Badge inside the edge of the container element.
  • inline—Places the Badge inline without position or alignment classes.
Default:

undefined

rounded?

"small" | "medium" | "large" | "none" | "full"

Sets the roundness of the Badge.

The possible values are:

  • none
  • small
  • medium
  • large
  • full
Default:

undefined

size?

"small" | "medium" | "large"

Sets the size of the Badge.

The possible values are:

  • small
  • medium
  • large
Default:

undefined

themeColor?

"primary" | "secondary" | "tertiary" | "info" | "success" | "warning" | "error" | "inverse" | "inherit"

Sets the theme color of the Badge. The BadgeContainer uses base when you do not set it.

The possible values are:

  • primary—Applies the primary theme color.
  • secondary—Applies the secondary theme color.
  • tertiary— Applies the tertiary theme color.
  • inherit— Applies the inherited color.
  • info—Applies the info theme color.
  • success— Applies the success theme color.
  • warning— Applies the warning theme color.
  • error— Applies the error theme color.
  • inverse— Applies the inverse theme color.
Default:

undefined