/** * * Fieldset is an input component that provides real-time suggestions when being typed. * * [Live Demo](https://www.primereact.org/fieldset/) * * @module fieldset * */ import * as React from 'react'; import { CSSTransitionProps } from '../csstransition'; import { IconType, PassThroughType } from '../utils/utils'; export declare type FieldsetPassThroughType = PassThroughType; /** * Custom passthrough(pt) option method. */ export interface FieldsetPassThroughMethodOptions { props: FieldsetProps; state: FieldsetState; } /** * Custom toggle event. * @see {@link FieldsetEmits.toggle} */ export interface FieldsetToggleEvent { /** * Browser event. */ originalEvent: React.MouseEvent; /** * Collapsed state as a boolean */ value: boolean; } /** * Custom passthrough(pt) options. * @see {@link FieldsetProps.pt} */ export interface FieldsetPassThroughOptions { /** * Uses to pass attributes to the root's DOM element. */ root?: FieldsetPassThroughType>; /** * Uses to pass attributes to the legend's DOM element. */ legend?: FieldsetPassThroughType>; /** * Uses to pass attributes to the toggler's DOM element. */ toggler?: FieldsetPassThroughType>; /** * Uses to pass attributes to the toggler icon's DOM element. */ togglerIcon?: FieldsetPassThroughType>; /** * Uses to pass attributes to the legend title's DOM element. */ legendTitle?: FieldsetPassThroughType>; /** * Uses to pass attributes to the toggleable content's DOM element. */ toggleableContent?: FieldsetPassThroughType>; /** * Uses to pass attributes to the content's DOM element. */ content?: FieldsetPassThroughType>; } /** * Defines current inline state in Fieldset component. */ export interface FieldsetState { /** * Current collapsed state as a boolean. * @defaultValue false */ collapse: boolean; } /** * Custom toggle event. * @see {@link FieldsetProps.onToggle} * @event */ interface FieldsetToggleEvent { /** * Browser mouse event. */ originalEvent: React.MouseEvent; /** * Collapsed state as a boolean. */ value: boolean; } /** * Defines valid properties in Fieldset component. In addition to these, all properties of HTMLFieldSetElement can be used in this component. * @group Properties */ export interface FieldsetProps extends Omit, HTMLFieldSetElement>, 'ref'> { /** * Header text of the fieldset. */ legend?: React.ReactNode | undefined; /** * When specified, content can toggled by clicking the legend. * @defaultValue false */ toggleable?: boolean | undefined; /** * Defines the default visibility state of the content. * @defaultValue false */ collapsed?: boolean | undefined; /** * Icon of an expanded tab. */ collapseIcon?: IconType | undefined; /** * The properties of CSSTransition can be customized, except for "nodeRef" and "in" properties. * @type {CSSTransitionProps} */ transitionOptions?: CSSTransitionProps | undefined; /** * Icon of an collapsed tab. */ expandIcon?: IconType | undefined; /** * Callback to invoke when a tab gets expanded. * @param {React.MouseEvent} event - Browser event. */ onExpand?(event: React.MouseEvent): void; /** * Callback to invoke when an active tab is collapsed by clicking on the header. * @param {React.MouseEvent} event - Browser event. */ onCollapse?(event: React.MouseEvent): void; /** * Callback to invoke when a tab gets expanded. * @param {FieldsetToggleEvent} event - Custom toggle event. */ onToggle?(event: FieldsetToggleEvent): void; /** * Callback to invoke when fieldset is clicked. * @param {React.MouseEvent} event - Browser event. */ onClick?(event: React.MouseEvent): void; /** * Used to get the child elements of the component. * @readonly */ children?: React.ReactNode | undefined; /** * Uses to pass attributes to DOM elements inside the component. * @type {FieldsetPassThroughOptions} */ pt?: FieldsetPassThroughOptions; } /** * **PrimeReact - Fieldset** * * _Fieldset is an input component that provides real-time suggestions when being typed._ * * [Live Demo](https://www.primereact.org/fieldset/) * --- --- * ![PrimeReact](https://primefaces.org/cdn/primereact/images/logo-100.png) * * @group Component */ export declare class Fieldset extends React.Component { /** * Used to get container element. * @return {HTMLFieldSetElement} Container element */ public getElement(): HTMLFieldSetElement; /** * Used to get the content element of the fieldset. * @return {HTMLDivElement} Content element */ public getContent(): HTMLDivElement; }