Checkbox d.ts updated build-apidoc slot changes
parent
22a13a4f2f
commit
4a723837a1
|
@ -307,7 +307,7 @@ if (project) {
|
||||||
methods.push({
|
methods.push({
|
||||||
name: signature.name,
|
name: signature.name,
|
||||||
parameters: signature.parameters.map((param) => {
|
parameters: signature.parameters.map((param) => {
|
||||||
let type = param.type.toString();
|
/* let type = param.type.toString();
|
||||||
|
|
||||||
if (param.type.declaration) {
|
if (param.type.declaration) {
|
||||||
type = '';
|
type = '';
|
||||||
|
@ -317,12 +317,12 @@ if (project) {
|
||||||
});
|
});
|
||||||
|
|
||||||
type = `{\n ${type} }`;
|
type = `{\n ${type} }`;
|
||||||
}
|
} */
|
||||||
|
|
||||||
return {
|
return {
|
||||||
name: param.name,
|
name: param.name,
|
||||||
optional: param.flags.isOptional,
|
optional: param.flags.isOptional,
|
||||||
type: type,
|
type: param.type.toString(),
|
||||||
description: param.comment && param.comment.summary.map((s) => parseText(s.text || '')).join(' ')
|
description: param.comment && param.comment.summary.map((s) => parseText(s.text || '')).join(' ')
|
||||||
};
|
};
|
||||||
}),
|
}),
|
||||||
|
|
|
@ -1,6 +1,18 @@
|
||||||
|
/**
|
||||||
|
*
|
||||||
|
* Checkbox is an extension to standard checkbox element with theming.
|
||||||
|
*
|
||||||
|
* [Live Demo](https://www.primevue.org/checkbox/)
|
||||||
|
*
|
||||||
|
* @module checkbox
|
||||||
|
*
|
||||||
|
*/
|
||||||
import { InputHTMLAttributes } from 'vue';
|
import { InputHTMLAttributes } from 'vue';
|
||||||
import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
|
import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Defines valid properties in Checkbox component.
|
||||||
|
*/
|
||||||
export interface CheckboxProps {
|
export interface CheckboxProps {
|
||||||
/**
|
/**
|
||||||
* Value of the checkbox.
|
* Value of the checkbox.
|
||||||
|
@ -16,18 +28,22 @@ export interface CheckboxProps {
|
||||||
name?: string | undefined;
|
name?: string | undefined;
|
||||||
/**
|
/**
|
||||||
* Allows to select a boolean value instead of multiple values.
|
* Allows to select a boolean value instead of multiple values.
|
||||||
|
* @default false
|
||||||
*/
|
*/
|
||||||
binary?: boolean;
|
binary?: boolean;
|
||||||
/**
|
/**
|
||||||
* When present, it specifies that the element should be disabled.
|
* When present, it specifies that the element should be disabled.
|
||||||
|
* @default false
|
||||||
*/
|
*/
|
||||||
disabled?: boolean | undefined;
|
disabled?: boolean | undefined;
|
||||||
/**
|
/**
|
||||||
* When present, it specifies that an input field is read-only.
|
* When present, it specifies that an input field is read-only.
|
||||||
|
* @default false
|
||||||
*/
|
*/
|
||||||
readonly?: boolean | undefined;
|
readonly?: boolean | undefined;
|
||||||
/**
|
/**
|
||||||
* When present, it specifies that the element is required.
|
* When present, it specifies that the element is required.
|
||||||
|
* @default false
|
||||||
*/
|
*/
|
||||||
required?: boolean | undefined;
|
required?: boolean | undefined;
|
||||||
/**
|
/**
|
||||||
|
@ -36,10 +52,12 @@ export interface CheckboxProps {
|
||||||
tabindex?: number | undefined;
|
tabindex?: number | undefined;
|
||||||
/**
|
/**
|
||||||
* Value in checked state.
|
* Value in checked state.
|
||||||
|
* @default true
|
||||||
*/
|
*/
|
||||||
trueValue?: any;
|
trueValue?: any;
|
||||||
/**
|
/**
|
||||||
* Value in unchecked state.
|
* Value in unchecked state.
|
||||||
|
* @default false
|
||||||
*/
|
*/
|
||||||
falseValue?: any;
|
falseValue?: any;
|
||||||
/**
|
/**
|
||||||
|
@ -70,30 +88,45 @@ export interface CheckboxProps {
|
||||||
|
|
||||||
export interface CheckboxSlots {}
|
export interface CheckboxSlots {}
|
||||||
|
|
||||||
export declare type CheckboxEmits = {
|
/**
|
||||||
|
* Defines valid emits in Checkbox component.
|
||||||
|
*/
|
||||||
|
export interface CheckboxEmits {
|
||||||
/**
|
/**
|
||||||
* Emitted when the page changes.
|
* Emitted when the page changes.
|
||||||
* @param {*} value - New page value.
|
* @param {*} value - New page value.
|
||||||
*/
|
*/
|
||||||
'update:page': (value: any) => void;
|
'update:page'(value: any): void;
|
||||||
/**
|
/**
|
||||||
* Callback to invoke on value click.
|
* Callback to invoke on value click.
|
||||||
* @param {MouseEvent} event - Browser event.
|
* @param {MouseEvent} event - Browser event.
|
||||||
*/
|
*/
|
||||||
click: (event: MouseEvent) => void;
|
click(event: MouseEvent): void;
|
||||||
/**
|
/**
|
||||||
* Callback to invoke on value change.
|
* Callback to invoke on value change.
|
||||||
* @param {Event} event - Browser event.
|
* @param {Event} event - Browser event.
|
||||||
*/
|
*/
|
||||||
change: (event: Event) => void;
|
change(event: Event): void;
|
||||||
/**
|
/**
|
||||||
* Callback to invoke on value change.
|
* Callback to invoke on value change.
|
||||||
* @param {boolean} value - New value.
|
* @param {boolean} value - New value.
|
||||||
*/
|
*/
|
||||||
input: (value: boolean) => void;
|
input(value: boolean): void;
|
||||||
};
|
}
|
||||||
|
|
||||||
declare class Checkbox extends ClassComponent<CheckboxProps, CheckboxSlots, CheckboxEmits> {}
|
/**
|
||||||
|
* **PrimeVue - Checkbox**
|
||||||
|
*
|
||||||
|
* _Accordion groups a collection of contents in tabs._
|
||||||
|
*
|
||||||
|
* [Live Demo](https://www.primevue.org/checkbox/)
|
||||||
|
* --- ---
|
||||||
|
* ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo.svg)
|
||||||
|
*
|
||||||
|
* @group Component
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
export declare class Checkbox extends ClassComponent<CheckboxProps, CheckboxSlots, CheckboxEmits> {}
|
||||||
|
|
||||||
declare module '@vue/runtime-core' {
|
declare module '@vue/runtime-core' {
|
||||||
interface GlobalComponents {
|
interface GlobalComponents {
|
||||||
|
|
Loading…
Reference in New Issue