From b73c928b25417b4a3682ff30517d74c248a46459 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bahad=C4=B1r=20Sofuo=C4=9Flu?= Date: Wed, 1 Mar 2023 15:25:48 +0300 Subject: [PATCH] Editor d.ts updated --- components/checkbox/Checkbox.d.ts | 9 ---- components/chips/Chips.d.ts | 9 ---- components/colorpicker/ColorPicker.d.ts | 9 ---- components/editor/Editor.d.ts | 65 ++++++++++++++++++------- 4 files changed, 48 insertions(+), 44 deletions(-) diff --git a/components/checkbox/Checkbox.d.ts b/components/checkbox/Checkbox.d.ts index 442249151..464466c11 100755 --- a/components/checkbox/Checkbox.d.ts +++ b/components/checkbox/Checkbox.d.ts @@ -134,13 +134,4 @@ declare module '@vue/runtime-core' { } } -/** - * - * Checkbox is an extension to standard checkbox element with theming. - * - * Demos: - * - * - [Checkbox](https://www.primefaces.org/primevue/checkbox) - * - */ export default Checkbox; diff --git a/components/chips/Chips.d.ts b/components/chips/Chips.d.ts index db7c6c096..ed57b4ecc 100755 --- a/components/chips/Chips.d.ts +++ b/components/chips/Chips.d.ts @@ -151,13 +151,4 @@ declare module '@vue/runtime-core' { } } -/** - * - * Chips is used to enter multiple values on an input field. - * - * Demos: - * - * - [Chips](https://www.primefaces.org/primevue/chips) - * - */ export default Chips; diff --git a/components/colorpicker/ColorPicker.d.ts b/components/colorpicker/ColorPicker.d.ts index 18d4f7821..17db9128e 100755 --- a/components/colorpicker/ColorPicker.d.ts +++ b/components/colorpicker/ColorPicker.d.ts @@ -123,13 +123,4 @@ declare module '@vue/runtime-core' { } } -/** - * - * ColorPicker is an input component to select a color. - * - * Demos: - * - * - [ColorPicker](https://www.primefaces.org/primevue/colorpicker) - * - */ export default ColorPicker; diff --git a/components/editor/Editor.d.ts b/components/editor/Editor.d.ts index 5d1e70121..54ef5ff8d 100755 --- a/components/editor/Editor.d.ts +++ b/components/editor/Editor.d.ts @@ -1,6 +1,19 @@ +/** + * + * Editor groups a collection of contents in tabs. + * + * [Live Demo](https://www.primevue.org/editor/) + * + * @module editor + * + */ import { VNode } from 'vue'; import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers'; +/** + * Custom text change event. + * @see text-change + */ export interface EditorTextChangeEvent { /** * Current value as html. @@ -23,7 +36,10 @@ export interface EditorTextChangeEvent { */ instance: any; } - +/** + * Custom selection change event. + * @see selection-change + */ export interface EditorSelectionChangeEvent { /** * Current value as html. @@ -50,7 +66,10 @@ export interface EditorSelectionChangeEvent { */ instance: any; } - +/** + * Custom load event. + * @see load + */ export interface EditorLoadEvent { /** * Text editor instance. @@ -58,6 +77,9 @@ export interface EditorLoadEvent { instance: any; } +/** + * Defines valid properties in Editor component. + */ export interface EditorProps { /** * Value of the content. @@ -85,6 +107,9 @@ export interface EditorProps { modules?: any; } +/** + * Defines valid slots in Editor slots. + */ export interface EditorSlots { /** * Custom toolbar template. @@ -92,29 +117,44 @@ export interface EditorSlots { toolbar: () => VNode[]; } -export declare type EditorEmits = { +/** + * Defines valid emits in Editor component. + */ +export interface EditorEmits { /** * Emitted when the value changes. * @param {string} value - New value. */ - 'update:modelValue': (value: string) => void; + 'update:modelValue'(value: string): void; /** * Callback to invoke when text of editor changes. * @param {EditorTextChangeEvent} event - Custom text change event. */ - 'text-change': (event: EditorTextChangeEvent) => void; + 'text-change'(event: EditorTextChangeEvent): void; /** * Callback to invoke when selection of the text changes. * @param {EditorSelectionChangeEvent} event - Custom selection change event. */ - 'selection-change': (event: EditorSelectionChangeEvent) => void; + 'selection-change'(event: EditorSelectionChangeEvent): void; /** * Callback to invoke when the quill modules are loaded. * @param {EditorLoadEvent} event - Custom load event. */ - load: (event: EditorLoadEvent) => void; -}; + load(event: EditorLoadEvent): void; +} +/** + * **PrimeVue - Editor** + * + * _Editor groups a collection of contents in tabs._ + * + * [Live Demo](https://www.primevue.org/editor/) + * --- --- + * ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo.svg) + * + * @group Component + * + */ declare class Editor extends ClassComponent {} declare module '@vue/runtime-core' { @@ -123,13 +163,4 @@ declare module '@vue/runtime-core' { } } -/** - * - * Editor is rich text editor component based on Quill. - * - * Demos: - * - * - [Editor](https://www.primefaces.org/primevue/editor) - * - */ export default Editor;