Fixed #1836 - For ColorPicker

src/components/colorpicker/ColorPicker.d.ts

@@ -1,23 +1,112 @@
-interface ColorPickerProps {
+import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
+
+type ColorPickerFormatType = 'hex' | 'rgb' | 'hsb';
+
+type ColorPickerAppendToType = 'body' | 'self' | string | undefined;
+
+export interface ColorPickerChangeEvent {
+    /**
+     * Browser event
+     */
+    originalEvent: Event;
+    /**
+     * Selected color value.
+     */
+    value: any;
+}
+
+export interface ColorPickerProps {
+    /**
+     * Value of the component.
+     */
     modelValue?: any;
+    /**
+     * Initial color to display when value is not defined.
+     * Default value is ff0000.
+     */
     defaultColor?: any;
-    inline?: boolean;
+    /**
-    format?: string;
+     * Whether to display as an overlay or not.
-    disabled?: boolean;
+     */
-    tabindex?: string;
+    inline?: boolean | undefined;
-    autoZIndex?: boolean;
+    /**
-    baseZIndex?: number;
+     * Format to use in value binding, supported formats are "hex", "rgb" and "hsb".
-    ariaLabelledBy?: string;
+     * @see ColorPickerFormatType
-    panelClass?: string;
+     * Default value is 'hex'.
-    appendTo?: string;
+     */
+    format?: ColorPickerFormatType;
+    /**
+     * When present, it specifies that the component should be disabled.
+     */
+    disabled?: boolean | undefined;
+    /**
+     * Index of the element in tabbing order.
+     */
+    tabindex?: string | undefined;
+    /**
+     * Whether to automatically manage layering.
+     * Default value is true.
+     */
+    autoZIndex?: boolean | undefined;
+    /**
+     * Base zIndex value to use in layering.
+     * Default value is 0.
+     */
+    baseZIndex?: number | undefined;
+    /**
+     * Establishes relationships between the component and label(s) where its value should be one or more element IDs.
+     */
+    ariaLabelledBy?: string | undefined;
+    /**
+     * Style class of the overlay panel.
+     */
+    panelClass?: string | undefined;
+    /**
+     * A valid query selector or an HTMLElement to specify where the overlay gets attached. Special keywords are "body" for document body and "self" for the element itself.
+     * Default value is 'body'.
+     */
+    appendTo?: ColorPickerAppendToType;
 }
 
-declare class ColorPicker {
+export interface ColorPickerSlots {
-    $props: ColorPickerProps;
-    $emit(eventName: 'update:modelValue', value: any): this;
-    $emit(eventName: 'change', event: {originalEvent: Event, value: any}): this;
-    $emit(eventName: 'show'): this;
-    $emit(eventName: 'hide'): this;
 }
 
+export declare type ColorPickerEmits = {
+    /**
+     * Emitted when the value changes.
+     * @param {*} value - New value.
+     */
+    'update:modelValue': (value: any) => void;
+     /**
+      * Callback to invoke when a chip is added.
+      * @param {ColorPickerChangeEvent} event - Custom add event.
+      */
+    'change': (event: ColorPickerChangeEvent) => void;
+    /**
+     * Callback to invoke when input is cleared by the user.
+     */
+    'show': () => void;
+     /**
+     * Callback to invoke when input is cleared by the user.
+     */
+    'hide': () => void;
+}
+
+declare class ColorPicker extends ClassComponent<ColorPickerProps, ColorPickerSlots, ColorPickerEmits> { }
+
+declare module '@vue/runtime-core' {
+    interface GlobalComponents {
+        ColorPicker: GlobalComponentConstructor<ColorPicker>
+    }
+}
+
+/**
+ *
+ * ColorPicker is an input component to select a color.
+ *
+ * Demos:
+ *
+ * - [ColorPicker](https://www.primefaces.org/primevue/showcase/#/colorpicker)
+ *
+ */
 export default ColorPicker;