Guaxu Docs
    Preparing search index...

    Type Alias BadgeProps

    BadgeProps:
        | {
            icon?: Omit<IconProps, "color">;
            shape: "pill";
            text: string;
            variant: BadgeVariants;
        }
        | {
            icon: Omit<IconProps, "color">;
            shape: "circle";
            variant: BadgeVariants;
        }

    Type Declaration

    • {
          icon?: Omit<IconProps, "color">;
          shape: "pill";
          text: string;
          variant: BadgeVariants;
      }
      • Optionalicon?: Omit<IconProps, "color">

        Optional icon properties (color is managed by component)

      • shape: "pill"

        Badge shape type - pill displays as a rectangular badge and circle displays as a circular badge

      • text: string

        Text content to display in the pill badge

      • variant: BadgeVariants

        Visual variant/color of the badge

    • { icon: Omit<IconProps, "color">; shape: "circle"; variant: BadgeVariants }
      • icon: Omit<IconProps, "color">

        Icon properties for the circular badge (required for circle shape)

      • shape: "circle"

        Badge shape type - pill displays as a rectangular badge and circle displays as a circular badge

      • variant: BadgeVariants

        Visual variant/color of the badge