From 095f600cc834fd38316a1cc4cb56f015da849ebb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tu=C4=9F=C3=A7e=20K=C3=BC=C3=A7=C3=BCko=C4=9Flu?= Date: Wed, 1 Mar 2023 16:12:09 +0300 Subject: [PATCH] Chip .d.ts updated --- components/chip/Chip.d.ts | 49 ++++++++++++++++++++++++++++----------- 1 file changed, 35 insertions(+), 14 deletions(-) diff --git a/components/chip/Chip.d.ts b/components/chip/Chip.d.ts index fd9376c5d..b717e3243 100644 --- a/components/chip/Chip.d.ts +++ b/components/chip/Chip.d.ts @@ -1,6 +1,18 @@ +/** + * + * Chip represents people using icons, labels and images. + * + * [Live Demo](https://www.primevue.org/chip) + * + * @module chip + * + */ import { VNode } from 'vue'; import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers'; +/** + * Defines valid properties in Chip component. + */ export interface ChipProps { /** * Defines the text to display. @@ -16,30 +28,48 @@ export interface ChipProps { image?: string; /** * Whether to display a remove icon. + * @defaultValue false */ removable?: boolean; /** * Icon of the remove element. - * Default value is 'pi pi-times-circle'. + * @defaultValue pi pi-times-circle */ removeIcon?: string; } +/** + * Defines valid slots in Chip component. + */ export interface ChipSlots { /** * Content can easily be customized with the default slot instead of using the built-in modes. */ - default: () => VNode[]; + default(): VNode[]; } -export declare type ChipEmits = { +/** + * Defines valid properties in Chip component. + */ +export interface ChipEmits { /** * Callback to invoke when a chip is removed. * @param {Event} event - Browser event. */ - remove: (event: Event) => void; -}; + remove(event: Event): void; +} +/** + * **PrimeVue - Chip** + * + * _Chip represents people using icons, labels and images._ + * + * [Live Demo](https://www.primevue.org/chip/) + * --- --- + * ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png) + * + * @group Component + */ declare class Chip extends ClassComponent {} declare module '@vue/runtime-core' { @@ -48,13 +78,4 @@ declare module '@vue/runtime-core' { } } -/** - * - * Chip represents entities using icons, labels and images. - * - * Demos: - * - * - [Chip](https://www.primefaces.org/primevue/chip) - * - */ export default Chip;