diff --git a/src/components/badge/Badge.d.ts b/src/components/badge/Badge.d.ts index 31ea3918d..b040c69a3 100644 --- a/src/components/badge/Badge.d.ts +++ b/src/components/badge/Badge.d.ts @@ -1,11 +1,52 @@ -interface BadgeProps { +import { VNode } from 'vue'; +import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers'; + +type BadgeSeverityType = 'info' | 'success' | 'warning' | 'danger'; + +type BadgeSizeType = 'large' | 'xlarge' | undefined; + +export interface BadgeProps { + /** + * Value to display inside the badge. + */ value?: any; - severity?: string; - size?: string; + /** + * Severity type of the badge. + * @see BadgeSeverityType + */ + severity?: BadgeSeverityType; + /** + * Size of the badge, valid options are "large" and "xlarge". + * @see BadgeSizeType + */ + size?: BadgeSizeType; } -declare class Badge { - $props: BadgeProps; +export interface BadgeSlots { + /** + * Content can easily be customized with the default slot instead of using the built-in display. + */ + default: () => VNode[]; } +export declare type BadgeEmits = { +} + +declare class Badge extends ClassComponent { } + +declare module '@vue/runtime-core' { + interface GlobalComponents { + Badge: GlobalComponentConstructor + } +} + +/** + * + * Badge is a small status indicator for another element. + * + * Demos: + * + * - [Badge](https://www.primefaces.org/primevue/showcase/#/badge) + * + */ export default Badge;