primevue-mirror/components/lib/badgedirective/BadgeDirective.d.ts

65 lines
1.4 KiB
TypeScript
Raw Normal View History

2023-03-02 11:05:45 +00:00
/**
*
* Badge directive is a small status indicator for another element.
*
2023-03-03 14:17:03 +00:00
* [Live Demo](https://primevue.org/badge)
*
* @module badgedirective
2023-03-02 11:05:45 +00:00
*/
import { DirectiveBinding, ObjectDirective } from 'vue';
2022-09-06 12:03:37 +00:00
2023-03-02 11:05:45 +00:00
/**
* Defines modifiers of Badge directive.
*/
export interface BadgeDirectiveModifiers {
2023-03-02 11:05:45 +00:00
/**
2023-03-02 18:53:47 +00:00
* Info severity for Badge directive.
* @defaultValue true
2023-03-02 11:05:45 +00:00
*/
2023-03-02 18:53:47 +00:00
info?: boolean | undefined;
2023-03-02 11:05:45 +00:00
/**
2023-03-02 18:53:47 +00:00
* Success severity for Badge directive.
* @defaultValue false
2023-03-02 11:05:45 +00:00
*/
2023-03-02 18:53:47 +00:00
success?: boolean | undefined;
2023-03-02 11:05:45 +00:00
/**
* Warning severity for Badge directive.
2023-03-02 18:53:47 +00:00
* @defaultValue false
2023-03-02 11:05:45 +00:00
*/
2023-03-02 18:53:47 +00:00
warning?: boolean | undefined;
2023-03-02 11:05:45 +00:00
/**
* Danger severity for Badge directive.
2023-03-02 18:53:47 +00:00
* @defaultValue false
2023-03-02 11:05:45 +00:00
*/
2023-03-02 18:53:47 +00:00
danger?: boolean | undefined;
}
2023-03-02 11:05:45 +00:00
/**
* Binding of Badge directive.
*/
export interface BadgeDirectiveBinding extends Omit<DirectiveBinding, 'modifiers' | 'value'> {
/**
* Value of the Badge.
*/
value?: string | undefined;
/**
* Modifiers of the Badge.
* @type {BadgeDirectiveModifiers}
*/
modifiers?: BadgeDirectiveModifiers | undefined;
}
/**
* **PrimeVue - Badge**
*
* _Badge directive provides advisory information for a component._
*
* [Live Demo](https://www.primevue.org/badge/)
* --- ---
2023-03-03 10:55:20 +00:00
* ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png)
2023-03-02 11:05:45 +00:00
*
*/
2022-09-06 12:03:37 +00:00
declare const BadgeDirective: ObjectDirective;
export default BadgeDirective;