primeng
Version:
PrimeNG is a premium UI library for Angular featuring a rich set of 90+ components, a theme designer, various theme alternatives such as Material, Bootstrap, Tailwind, premium templates and professional support. In addition, it integrates with PrimeBlock,
182 lines (178 loc) • 6.91 kB
TypeScript
import { FieldsetPassThrough, FieldsetBeforeToggleEvent, FieldsetAfterToggleEvent, FieldsetToggleIconTemplateContext } from 'primeng/types/fieldset';
export * from 'primeng/types/fieldset';
import * as _angular_core from '@angular/core';
import { TemplateRef, ElementRef } from '@angular/core';
import { MotionOptions, MotionEvent } from '@primeuix/motion';
import * as i2 from 'primeng/api';
import { BlockableUI } from 'primeng/api';
import { BaseComponent } from 'primeng/basecomponent';
import * as i1 from 'primeng/bind';
import { Bind } from 'primeng/bind';
import { CSSProperties } from 'primeng/types/shared';
import { BaseStyle } from 'primeng/base';
/**
*
* Fieldset is a grouping component with the optional content toggle feature.
*
* [Live Demo](https://www.primeng.org/fieldset/)
*
* @module fieldsetstyle
*
*/
declare enum FieldsetClasses {
/**
* Class name of the root element
*/
root = "p-fieldset",
/**
* Class name of the legend element
*/
legend = "p-fieldset-legend",
/**
* Class name of the legend label element
*/
legendLabel = "p-fieldset-legend-label",
/**
* Class name of the toggle icon element
*/
toggleIcon = "p-fieldset-toggle-icon",
/**
* Class name of the content container element
*/
contentContainer = "p-fieldset-content-container",
/**
* Class name of the content wrapper element
*/
contentWrapper = "p-fieldset-content-wrapper",
/**
* Class name of the content element
*/
content = "p-fieldset-content"
}
declare class FieldsetStyle extends BaseStyle {
name: string;
style: string;
classes: {
root: ({ instance }: {
instance: any;
}) => (string | {
'p-fieldset-toggleable': any;
})[];
legend: string;
legendLabel: string;
toggleButton: string;
toggleIcon: string;
contentContainer: string;
contentWrapper: string;
content: string;
};
static ɵfac: _angular_core.ɵɵFactoryDeclaration<FieldsetStyle, never>;
static ɵprov: _angular_core.ɵɵInjectableDeclaration<FieldsetStyle>;
}
interface FieldsetStyle extends BaseStyle {
}
/**
* Fieldset is a grouping component with the optional content toggle feature.
* @group Components
*/
declare class Fieldset extends BaseComponent<FieldsetPassThrough> implements BlockableUI {
componentName: string;
$pcFieldset: Fieldset | undefined;
_componentStyle: FieldsetStyle;
bindDirectiveInstance: Bind;
/**
* Header text of the fieldset.
* @group Props
*/
legend: _angular_core.InputSignal<string | undefined>;
/**
* When specified, content can toggled by clicking the legend.
* @group Props
* @defaultValue false
*/
toggleable: _angular_core.InputSignalWithTransform<boolean, unknown>;
/**
* Defines the initial state of content, supports one or two-way binding as well.
* @group Props
*/
collapsed: _angular_core.ModelSignal<boolean>;
/**
* Inline style of the component.
* @group Props
*/
style: _angular_core.InputSignal<CSSProperties>;
/**
* Style class of the component.
* @group Props
*/
styleClass: _angular_core.InputSignal<string | undefined>;
/**
* The motion options.
* @group Props
*/
motionOptions: _angular_core.InputSignal<MotionOptions | undefined>;
/**
* Callback to invoke before panel toggle.
* @param {FieldsetBeforeToggleEvent} event - Custom toggle event
* @group Emits
*/
onBeforeToggle: _angular_core.OutputEmitterRef<FieldsetBeforeToggleEvent>;
/**
* Callback to invoke after panel toggle.
* @param {FieldsetAfterToggleEvent} event - Custom toggle event
* @group Emits
*/
onAfterToggle: _angular_core.OutputEmitterRef<FieldsetAfterToggleEvent>;
/**
* Custom header template.
* @group Templates
*/
headerTemplate: _angular_core.Signal<TemplateRef<void> | undefined>;
/**
* Custom toggler icon template.
* @group Templates
*/
toggleIconTemplate: _angular_core.Signal<TemplateRef<FieldsetToggleIconTemplateContext> | undefined>;
/**
* Custom expand icon template.
* @group Templates
*/
expandIconTemplate: _angular_core.Signal<TemplateRef<void> | undefined>;
/**
* Custom collapse icon template.
* @group Templates
*/
collapseIconTemplate: _angular_core.Signal<TemplateRef<void> | undefined>;
/**
* Custom content template.
* @group Templates
*/
contentTemplate: _angular_core.Signal<TemplateRef<void> | undefined>;
contentWrapperViewChild: _angular_core.Signal<ElementRef<any> | undefined>;
private _id;
get id(): string;
get headerId(): string;
get contentId(): string;
buttonAriaLabel: _angular_core.Signal<string | undefined>;
toggleIconContext: _angular_core.Signal<FieldsetToggleIconTemplateContext>;
dataP: _angular_core.Signal<string>;
contentTabindex: _angular_core.Signal<"-1" | undefined>;
isContentVisible: _angular_core.Signal<boolean>;
computedMotionOptions: _angular_core.Signal<MotionOptions>;
onAfterViewChecked(): void;
toggle(event: MouseEvent): void;
onKeyDown(event: KeyboardEvent): void;
expand(): void;
collapse(): void;
getBlockableElement(): HTMLElement;
updateTabIndex(): void;
onToggleDone(event: MotionEvent): void;
static ɵfac: _angular_core.ɵɵFactoryDeclaration<Fieldset, never>;
static ɵcmp: _angular_core.ɵɵComponentDeclaration<Fieldset, "p-fieldset", never, { "legend": { "alias": "legend"; "required": false; "isSignal": true; }; "toggleable": { "alias": "toggleable"; "required": false; "isSignal": true; }; "collapsed": { "alias": "collapsed"; "required": false; "isSignal": true; }; "style": { "alias": "style"; "required": false; "isSignal": true; }; "styleClass": { "alias": "styleClass"; "required": false; "isSignal": true; }; "motionOptions": { "alias": "motionOptions"; "required": false; "isSignal": true; }; }, { "collapsed": "collapsedChange"; "onBeforeToggle": "onBeforeToggle"; "onAfterToggle": "onAfterToggle"; }, ["headerTemplate", "toggleIconTemplate", "expandIconTemplate", "collapseIconTemplate", "contentTemplate"], ["p-header", "*"], true, [{ directive: typeof i1.Bind; inputs: {}; outputs: {}; }]>;
}
declare class FieldsetModule {
static ɵfac: _angular_core.ɵɵFactoryDeclaration<FieldsetModule, never>;
static ɵmod: _angular_core.ɵɵNgModuleDeclaration<FieldsetModule, never, [typeof Fieldset, typeof i2.SharedModule, typeof i1.BindModule], [typeof Fieldset, typeof i2.SharedModule, typeof i1.BindModule]>;
static ɵinj: _angular_core.ɵɵInjectorDeclaration<FieldsetModule>;
}
export { Fieldset, FieldsetClasses, FieldsetModule, FieldsetStyle };