view-ui-plus/types/badge.d.ts

A high quality UI components Library with Vue.js 3

import type { DefineComponent } from 'vue';

export declare const Badge: DefineComponent<{
    /**
     * 显示的数字，大于`overflowCount`时，显示`${overflowCount}+`，为 0 时隐藏
     */
    count?: number;

    /**
     * 展示封顶的数字值
     */
    'overflow-count'?: number | string;

    /**
     * 不展示数字，只有一个小红点，如需隐藏 dot ，需要设置`count`为 0
     */
    dot?: boolean;

    /**
     * 自定义的class名称，dot 模式下无效
     */
    'class-name'?: string;

    /**
     * 使用预设的颜色，可选值为 success、primary、normal、error、warning、info
     */
    type?: 'success' | 'primary' | 'normal' | 'error' | 'warning' | 'info';

    /**
     * 当数值为 0 时，是否展示 Badge
     */
    'show-zero'?: boolean;

    /**
     * 设置 Badge 为状态点，可选值为 success、processing、default、error、warning
     */
    status?: 'success' | 'processing' | 'default' | 'error' | 'warning';

    /**
     * 自定义内容，如果设置了 status，则为状态点的文本
     */
    text?: string;

    /**
     * 设置状态点的位置偏移，格式为 [x, y]
     */
    offset?: any[];

    /**
     * 设置更多状态点的颜色或自定义颜色
     */
    color?: string;

    'v-slots'?: {
        /**
         * 自定义角标显示内容（去角标背景），数值 count 将无效。
         */
        count?: () => any;

        /**
         * 自定义角标显示内容（带角标背景），数值 count 将无效。亦可自定义状态点模式下的 text 内容。
         */
        text?: () => any;

    };
}>