primevue-mirror/components/tristatecheckbox/TriStateCheckbox.d.ts

64 lines
1.8 KiB
TypeScript
Executable File

import { InputHTMLAttributes } from 'vue';
import { ClassComponent, GlobalComponentConstructor, Nullable } from '../ts-helpers';
export interface TriStateCheckboxProps {
/**
* Value of the component.
*/
modelValue?: Nullable<boolean>;
/**
* When present, it specifies that the component should be disabled.
*/
disabled?: boolean | undefined;
/**
* Index of the element in tabbing order.
*/
tabindex?: string | undefined;
/**
* Identifier of the underlying input element.
*/
inputId?: string | undefined;
/**
* Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component.
*/
inputProps?: InputHTMLAttributes | undefined;
/**
* Establishes relationships between the component and label(s) where its value should be one or more element IDs.
*/
'aria-labelledby'?: string | undefined;
/**
* Establishes a string value that labels the component.
*/
'aria-label'?: string | undefined;
}
export interface TriStateCheckboxSlots {
}
export declare type TriStateCheckboxEmits = {
/**
* Emitted when the value changes.
* @param {boolean|null|undefined} value - New value.
*/
'update:modelValue': (value: Nullable<boolean>) => void;
}
declare class TriStateCheckbox extends ClassComponent<TriStateCheckboxProps, TriStateCheckboxSlots, TriStateCheckboxEmits> { }
declare module '@vue/runtime-core' {
interface GlobalComponents {
TriStateCheckbox: GlobalComponentConstructor<TriStateCheckbox>
}
}
/**
*
* TriStateCheckbox is used to select either 'true', 'false' or 'null' as the value.
*
* Demos:
*
* - [TriStateCheckbox](https://www.primefaces.org/primevue/showcase/#/tristatecheckbox)
*
*/
export default TriStateCheckbox;