diff --git a/components/chart/Chart.d.ts b/components/chart/Chart.d.ts index 29c419633..58be8ac8c 100755 --- a/components/chart/Chart.d.ts +++ b/components/chart/Chart.d.ts @@ -51,12 +51,12 @@ export interface ChartProps { plugins?: any; /** * Width of the chart in non-responsive mode. - * Default value is 300. + * @defaultValue 300 */ width?: number | undefined; /** * Height of the chart in non-responsive mode. - * Default value is 150. + * @defaultValue 150 */ height?: number | undefined; /** diff --git a/components/inlinemessage/InlineMessage.d.ts b/components/inlinemessage/InlineMessage.d.ts index 1b99222eb..775aeb16f 100755 --- a/components/inlinemessage/InlineMessage.d.ts +++ b/components/inlinemessage/InlineMessage.d.ts @@ -1,26 +1,49 @@ +/** + * + * InlineMessage component is useful in cases where a single message needs to be displayed related to an element such as forms. It has one property, severity of the message. + * + * [Live Demo](https://www.primevue.org/inlinemessage/) + * + * @module inlinemessage + * + */ import { VNode } from 'vue'; import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers'; -type InlineMessageSeverityType = 'success' | 'info' | 'warn' | 'error' | undefined; - +/** + * Defines valid properties in InlineMessage component. + */ export interface InlineMessageProps { /** * Severity level of the message. - * @see InlineMessageSeverityType - * Default value is 'info'. + * @defaultValue 'info' */ - severity?: InlineMessageSeverityType; + severity?: 'success' | 'info' | 'warn' | 'error' | undefined; } - +/** + * Defines valid slots in InlineMessage slots. + */ export interface InlineMessageSlots { /** * Default custom slot. */ - default: () => VNode[]; + default(): VNode[]; } -export declare type InlineMessageEmits = {}; +export interface InlineMessageEmits {} +/** + * **PrimeVue - InlineMessage** + * + * _InlineMessage component is useful in cases where a single message needs to be displayed related to an element such as forms. It has one property, severity of the message._ + * + * [Live Demo](https://www.primevue.org/inlinemessage/) + * --- --- + * ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo.svg) + * + * @group Component + * + */ declare class InlineMessage extends ClassComponent {} declare module '@vue/runtime-core' { @@ -29,13 +52,4 @@ declare module '@vue/runtime-core' { } } -/** - * - * InlineMessage component is useful in cases where a single message needs to be displayed related to an element such as forms. It has one property, severity of the message. - * - * Demos: - * - * - [InlineMessage](https://www.primefaces.org/primevue/message) - * - */ export default InlineMessage; diff --git a/components/inputmask/InputMask.d.ts b/components/inputmask/InputMask.d.ts index 8d2a3fb49..cec986ff4 100755 --- a/components/inputmask/InputMask.d.ts +++ b/components/inputmask/InputMask.d.ts @@ -1,6 +1,6 @@ /** * - * InputMask groups a collection of contents in tabs. + * InputMask component is used to enter input in a certain format such as numeric, date, currency, email and phone. * * [Live Demo](https://www.primevue.org/inputmask/) * @@ -83,7 +83,7 @@ export interface InputMaskEmits { /** * **PrimeVue - InputMask** * - * _InputMask groups a collection of contents in tabs._ + * _InputMask component is used to enter input in a certain format such as numeric, date, currency, email and phone._ * * [Live Demo](https://www.primevue.org/inputmask/) * --- --- diff --git a/components/inputswitch/InputSwitch.d.ts b/components/inputswitch/InputSwitch.d.ts index 4083a1c47..ff5c163fc 100755 --- a/components/inputswitch/InputSwitch.d.ts +++ b/components/inputswitch/InputSwitch.d.ts @@ -1,6 +1,6 @@ /** * - * InputSwitch groups a collection of contents in tabs. + * InputSwitch is used to select a boolean value. * * [Live Demo](https://www.primevue.org/inputswitch/) * @@ -85,7 +85,7 @@ export interface InputSwitchEmits { /** * **PrimeVue - InputSwitch** * - * _InputSwitch groups a collection of contents in tabs._ + * _InputSwitch is used to select a boolean value._ * * [Live Demo](https://www.primevue.org/inputswitch/) * --- --- diff --git a/components/message/Message.d.ts b/components/message/Message.d.ts index 8a1828f66..3590f7209 100755 --- a/components/message/Message.d.ts +++ b/components/message/Message.d.ts @@ -1,27 +1,37 @@ +/** + * + * Message groups a collection of contents in tabs. + * + * [Live Demo](https://www.primevue.org/message/) + * + * @module message + * + */ import { ButtonHTMLAttributes, VNode } from 'vue'; import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers'; -type MessageSeverityType = 'success' | 'info' | 'warn' | 'error' | undefined; - +/** + * Defines valid properties in Message component. + */ export interface MessageProps { /** * Severity level of the message. - * @see MessageSeverityType - * Default value is 'info'. + * @defaultValue 'info' */ - severity?: MessageSeverityType; + severity?: 'success' | 'info' | 'warn' | 'error' | undefined; /** * Whether the message can be closed manually using the close icon. - * Default value is true. + * @defaultValue true */ closable?: boolean | undefined; /** * When enabled, message is not removed automatically. + * @defaultValue true */ sticky?: boolean | undefined; /** * Delay in milliseconds to close the message automatically. - * Default value is 3000. + * @defaultValue 3000 */ life?: number | undefined; /** @@ -30,7 +40,7 @@ export interface MessageProps { icon?: string | undefined; /** * Icon to display in the message close button. - * Default value is 'pi pi-times'. + * @defaultValue 'pi pi-times' */ closeIcon?: string | undefined; /** @@ -39,21 +49,39 @@ export interface MessageProps { closeButtonProps?: ButtonHTMLAttributes | undefined; } +/** + * Defines valid slots in Message slots. + */ export interface MessageSlots { /** * Default custom slot. */ - default: () => VNode[]; + default(): VNode[]; } -export declare type MessageEmits = { +/** + * Defines valid emits in Message component. + */ +export interface MessageEmits { /** * Callback to invoke when a message is closed. * @param {Event} event - Browser event. */ - close: (event: Event) => void; -}; + close(event: Event): void; +} +/** + * **PrimeVue - Message** + * + * _Messages is used to display inline messages with various severities._ + * + * [Live Demo](https://www.primevue.org/message/) + * --- --- + * ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo.svg) + * + * @group Component + * + */ declare class Message extends ClassComponent {} declare module '@vue/runtime-core' { @@ -62,13 +90,4 @@ declare module '@vue/runtime-core' { } } -/** - * - * Messages is used to display inline messages with various severities. - * - * Demos: - * - * - [Message](https://www.primefaces.org/primevue/message) - * - */ export default Message; diff --git a/components/radiobutton/RadioButton.d.ts b/components/radiobutton/RadioButton.d.ts index 8a03f9849..a7318ce48 100755 --- a/components/radiobutton/RadioButton.d.ts +++ b/components/radiobutton/RadioButton.d.ts @@ -1,6 +1,6 @@ /** * - * RadioButton groups a collection of contents in tabs. + * RadioButton is an extension to standard radio button element with theming. * * [Live Demo](https://www.primevue.org/radiobutton/) * @@ -82,7 +82,7 @@ export interface RadioButtonEmits { /** * **PrimeVue - RadioButton** * - * _RadioButton groups a collection of contents in tabs._ + * _RadioButton is an extension to standard radio button element with theming._ * * [Live Demo](https://www.primevue.org/radiobutton/) * --- ---