Tag .d.ts updated

pull/3689/head
Tuğçe Küçükoğlu 2023-03-01 17:13:12 +03:00
parent 7418526f69
commit c06284941d
1 changed files with 33 additions and 15 deletions

View File

@ -1,8 +1,18 @@
/**
*
* Tag component is used to categorize content.
*
* [Live Demo](https://www.primevue.org/tag)
*
* @module tag
*
*/
import { VNode } from 'vue'; import { VNode } from 'vue';
import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers'; import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
type TagSeverityType = 'success' | 'info' | 'warning' | 'danger' | undefined; /**
* Defines valid properties in Tag component.
*/
export interface TagProps { export interface TagProps {
/** /**
* Value to display inside the tag. * Value to display inside the tag.
@ -10,11 +20,11 @@ export interface TagProps {
value?: any; value?: any;
/** /**
* Severity type of the tag. * Severity type of the tag.
* @see TagSeverityType
*/ */
severity?: TagSeverityType; severity?: 'success' | 'info' | 'warning' | 'danger' | undefined;
/** /**
* Whether the corners of the tag are rounded. * Whether the corners of the tag are rounded.
* @defaultValue false
*/ */
rounded?: boolean | undefined; rounded?: boolean | undefined;
/** /**
@ -23,15 +33,32 @@ export interface TagProps {
icon?: string | undefined; icon?: string | undefined;
} }
/**
* Defines valid slots in Tag component.
*/
export interface TagSlots { export interface TagSlots {
/** /**
* Custom content template * Custom content template
*/ */
default: () => VNode[]; default(): VNode[];
} }
export declare type TagEmits = {}; /**
* Defines valid emits in Tag component.
*/
export interface TagEmits {}
/**
* **PrimeVue - Tag**
*
* _Tag component is used to categorize content._
*
* [Live Demo](https://www.primevue.org/tag/)
* --- ---
* ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png)
*
* @group Component
*/
declare class Tag extends ClassComponent<TagProps, TagSlots, TagEmits> {} declare class Tag extends ClassComponent<TagProps, TagSlots, TagEmits> {}
declare module '@vue/runtime-core' { declare module '@vue/runtime-core' {
@ -40,13 +67,4 @@ declare module '@vue/runtime-core' {
} }
} }
/**
*
* Tag component is used to categorize content.
*
* Demos:
*
* - [Tag](https://www.primefaces.org/primevue/tag)
*
*/
export default Tag; export default Tag;