/** * * Label can be used standalone or in conjunction with form components to provide accessible labeling. * * [Live Demo](https://www.primevue.dev/label/) * * @module label * */ import type { DefineComponent, DesignToken, EmitFn, PassThrough } from '@primevue/core'; import type { ComponentHooks } from '@primevue/core/basecomponent'; import type { PassThroughOptions } from 'primevue/passthrough'; import type { Component, TransitionProps, VNode } from 'vue'; export declare type LabelPassThroughOptionType = LabelPassThroughAttributes | ((options: LabelPassThroughMethodOptions) => LabelPassThroughAttributes | string) | string | null | undefined; export declare type LabelPassThroughTransitionType = TransitionProps | ((options: LabelPassThroughMethodOptions) => TransitionProps) | undefined; /** * Custom passthrough(pt) option method. */ export interface LabelPassThroughMethodOptions { /** * Defines instance. */ instance: any; /** * Defines valid properties. */ props: LabelProps; /** * Defines valid attributes. */ attrs: any; /** * Defines parent options. */ parent: any; /** * Defines passthrough(pt) options in global config. */ global: object | undefined; } /** * Custom passthrough(pt) options. * @see {@link LabelProps.pt} */ export interface LabelPassThroughOptions { /** * Used to pass attributes to the root's DOM element. */ root?: LabelPassThroughOptionType; /** * Used to manage all lifecycle hooks. * @see {@link BaseComponent.ComponentHooks} */ hooks?: ComponentHooks; } /** * Custom passthrough attributes for each DOM elements */ export interface LabelPassThroughAttributes { [key: string]: any; } /** * Defines valid properties in Label component. */ export interface LabelProps { /** * Use to change the HTML tag of root element. * @defaultValue LABEL */ as?: string | Component | undefined; /** * When enabled, it changes the default rendered element for the one passed as a child element. * @defaultValue false */ asChild?: boolean | undefined; /** * It generates scoped CSS variables using design tokens for the component. */ dt?: DesignToken; /** * Used to pass attributes to DOM elements inside the component. * @type {LabelPassThroughOptions} */ pt?: PassThrough; /** * Used to configure passthrough(pt) options of the component. * @type {PassThroughOptions} */ ptOptions?: PassThroughOptions; /** * When enabled, it removes component related styles in the core. * @defaultValue false */ unstyled?: boolean; } /** * Defines valid slots in Label component. */ export interface LabelSlots { /** * Default content slot. * @param {Object} scope - Default slot's params. */ default(scope?: { /** * Class name of the root element. */ class: string; }): VNode[]; } /** * Defines valid emits in Label component. */ export interface LabelEmitsOptions {} export declare type LabelEmits = EmitFn; /** * **PrimeVue - Label** * * _Label can be used standalone or in conjunction with form components to provide accessible labeling._ * * [Live Demo](https://www.primevue.dev/label/) * --- --- * ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png) * * @group Component * */ declare const Label: DefineComponent; declare module 'vue' { export interface GlobalComponents { Label: DefineComponent; } } export default Label;