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,
253 lines (246 loc) • 10.4 kB
TypeScript
import { AccordionPanelPassThrough, AccordionValue, AccordionHeaderPassThrough, AccordionToggleIconTemplateContext, AccordionContentPassThrough, AccordionPassThrough, AccordionTabCloseEvent, AccordionTabOpenEvent } from 'primeng/types/accordion';
export * from 'primeng/types/accordion';
import * as _angular_core from '@angular/core';
import { TemplateRef } from '@angular/core';
import { MotionOptions } 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 { BaseStyle } from 'primeng/base';
import * as i1$1 from 'primeng/ripple';
/**
*
* Accordion groups a collection of contents in tabs.
*
* [Live Demo](https://www.primeng.org/accordion/)
*
* @module accordionstyle
*
*/
declare enum AccordionClasses {
/**
* Class name of the root element
*/
root = "p-accordion",
/**
* Class name of the content wrapper
*/
contentwrapper = "p-accordioncontent",
/**
* Class name of the content
*/
content = "p-accordioncontent-content",
/**
* Class name of the header
*/
header = "p-accordionheader",
/**
* Class name of the toggle icon
*/
toggleicon = "p-accordionheader-toggle-icon",
/**
* Class name of the panel
*/
panel = "p-accordionpanel"
}
declare class AccordionStyle extends BaseStyle {
name: string;
style: string;
classes: {
root: string;
panel: ({ instance }: {
instance: any;
}) => (string | {
'p-accordionpanel-active': any;
'p-disabled': any;
})[];
header: string;
toggleicon: string;
contentContainer: string;
contentWrapper: string;
content: string;
};
static ɵfac: _angular_core.ɵɵFactoryDeclaration<AccordionStyle, never>;
static ɵprov: _angular_core.ɵɵInjectableDeclaration<AccordionStyle>;
}
interface AccordionStyle extends BaseStyle {
}
/**
* AccordionPanel is a helper component for Accordion component.
* @group Components
*/
declare class AccordionPanel extends BaseComponent<AccordionPanelPassThrough> {
$pcAccordionPanel: AccordionPanel | undefined;
bindDirectiveInstance: Bind;
componentName: string;
onAfterViewChecked(): void;
pcAccordion: Accordion;
/**
* Value of the active tab.
* @defaultValue undefined
* @group Props
*/
value: _angular_core.ModelSignal<AccordionValue>;
/**
* Disables the tab when enabled.
* @defaultValue false
* @group Props
*/
disabled: _angular_core.InputSignalWithTransform<boolean, unknown>;
active: _angular_core.Signal<boolean>;
valueEquals(currentValue: AccordionValue, value: AccordionValue): boolean;
_componentStyle: AccordionStyle;
static ɵfac: _angular_core.ɵɵFactoryDeclaration<AccordionPanel, never>;
static ɵcmp: _angular_core.ɵɵComponentDeclaration<AccordionPanel, "p-accordion-panel, p-accordionpanel", never, { "value": { "alias": "value"; "required": false; "isSignal": true; }; "disabled": { "alias": "disabled"; "required": false; "isSignal": true; }; }, { "value": "valueChange"; }, never, ["*"], true, [{ directive: typeof i1.Bind; inputs: {}; outputs: {}; }]>;
}
/**
* AccordionHeader is a helper component for Accordion component.
* @group Components
*/
declare class AccordionHeader extends BaseComponent<AccordionHeaderPassThrough> {
$pcAccordionHeader: AccordionHeader | undefined;
bindDirectiveInstance: Bind;
componentName: string;
onAfterViewChecked(): void;
pcAccordion: Accordion;
pcAccordionPanel: AccordionPanel;
id: _angular_core.Signal<string>;
active: _angular_core.Signal<boolean>;
disabled: _angular_core.Signal<boolean>;
ariaControls: _angular_core.Signal<string>;
hostTabindex: _angular_core.Signal<"-1" | "0">;
/**
* Toggle icon template.
* @type {TemplateRef<AccordionToggleIconTemplateContext>} context - Context of the template
* @example
* ```html
* <ng-template #toggleicon let-active="active"> </ng-template>
* ```
* @see {@link AccordionToggleIconTemplateContext}
* @group Templates
*/
toggleicon: _angular_core.Signal<TemplateRef<AccordionToggleIconTemplateContext> | undefined>;
toggleIconContext: _angular_core.Signal<AccordionToggleIconTemplateContext>;
onClick(event?: MouseEvent | KeyboardEvent): void;
onFocus(): void;
onKeydown(event: KeyboardEvent): void;
_componentStyle: AccordionStyle;
changeActiveValue(): void;
private findPanel;
private findHeader;
private findNextPanel;
private findPrevPanel;
private findFirstPanel;
private findLastPanel;
private changeFocusedPanel;
private arrowDownKey;
private arrowUpKey;
private onHomeKey;
private onEndKey;
private onEnterKey;
dataP: _angular_core.Signal<string>;
static ɵfac: _angular_core.ɵɵFactoryDeclaration<AccordionHeader, never>;
static ɵcmp: _angular_core.ɵɵComponentDeclaration<AccordionHeader, "p-accordion-header, p-accordionheader", never, {}, {}, ["toggleicon"], ["*"], true, [{ directive: typeof i1$1.Ripple; inputs: {}; outputs: {}; }, { directive: typeof i1.Bind; inputs: {}; outputs: {}; }]>;
}
/**
* AccordionContent is a helper component for Accordion component.
* @group Components
*/
declare class AccordionContent extends BaseComponent<AccordionContentPassThrough> {
$pcAccordionContent: AccordionContent | undefined;
bindDirectiveInstance: Bind;
componentName: string;
onAfterViewChecked(): void;
pcAccordion: Accordion;
pcAccordionPanel: AccordionPanel;
active: _angular_core.Signal<boolean>;
ariaLabelledby: _angular_core.Signal<string>;
id: _angular_core.Signal<string>;
_componentStyle: AccordionStyle;
ptParams: _angular_core.Signal<{
context: boolean;
}>;
computedMotionOptions: _angular_core.Signal<MotionOptions>;
static ɵfac: _angular_core.ɵɵFactoryDeclaration<AccordionContent, never>;
static ɵcmp: _angular_core.ɵɵComponentDeclaration<AccordionContent, "p-accordion-content, p-accordioncontent", never, {}, {}, never, ["*"], true, [{ directive: typeof i1.Bind; inputs: {}; outputs: {}; }]>;
}
/**
* Accordion groups a collection of contents in tabs.
* @group Components
*/
declare class Accordion extends BaseComponent<AccordionPassThrough> implements BlockableUI {
componentName: string;
$pcAccordion: Accordion | undefined;
bindDirectiveInstance: Bind;
onAfterViewChecked(): void;
/**
* Value of the active tab.
* @defaultValue undefined
* @group Props
*/
value: _angular_core.ModelSignal<AccordionValue>;
/**
* When enabled, multiple tabs can be activated at the same time.
* @defaultValue false
* @group Props
*/
multiple: _angular_core.InputSignalWithTransform<boolean, unknown>;
/**
* Icon of a collapsed tab.
* @group Props
*/
expandIcon: _angular_core.InputSignal<string | undefined>;
/**
* Icon of an expanded tab.
* @group Props
*/
collapseIcon: _angular_core.InputSignal<string | undefined>;
/**
* When enabled, the focused tab is activated.
* @defaultValue false
* @group Props
*/
selectOnFocus: _angular_core.InputSignalWithTransform<boolean, unknown>;
/**
* The motion options.
* @group Props
*/
motionOptions: _angular_core.InputSignal<MotionOptions | undefined>;
computedMotionOptions: _angular_core.Signal<MotionOptions>;
/**
* Callback to invoke when an active tab is collapsed by clicking on the header.
* @param {AccordionTabCloseEvent} event - Custom tab close event.
* @group Emits
*/
onClose: _angular_core.OutputEmitterRef<AccordionTabCloseEvent>;
/**
* Callback to invoke when a tab gets expanded.
* @param {AccordionTabOpenEvent} event - Custom tab open event.
* @group Emits
*/
onOpen: _angular_core.OutputEmitterRef<AccordionTabOpenEvent>;
id: _angular_core.WritableSignal<string>;
_componentStyle: AccordionStyle;
onKeydown(event: KeyboardEvent): void;
onTabArrowDownKey(event: KeyboardEvent): void;
onTabArrowUpKey(event: KeyboardEvent): void;
onTabHomeKey(event: KeyboardEvent): void;
changeFocusedTab(element: HTMLElement | null): void;
findNextHeaderAction(tabElement: HTMLElement | null, selfCheck?: boolean): any;
findPrevHeaderAction(tabElement: HTMLElement | null, selfCheck?: boolean): any;
findFirstHeaderAction(): any;
findLastHeaderAction(): any;
onTabEndKey(event: KeyboardEvent): void;
getBlockableElement(): HTMLElement;
updateValue(value: string | number): void;
static ɵfac: _angular_core.ɵɵFactoryDeclaration<Accordion, never>;
static ɵcmp: _angular_core.ɵɵComponentDeclaration<Accordion, "p-accordion", never, { "value": { "alias": "value"; "required": false; "isSignal": true; }; "multiple": { "alias": "multiple"; "required": false; "isSignal": true; }; "expandIcon": { "alias": "expandIcon"; "required": false; "isSignal": true; }; "collapseIcon": { "alias": "collapseIcon"; "required": false; "isSignal": true; }; "selectOnFocus": { "alias": "selectOnFocus"; "required": false; "isSignal": true; }; "motionOptions": { "alias": "motionOptions"; "required": false; "isSignal": true; }; }, { "value": "valueChange"; "onClose": "onClose"; "onOpen": "onOpen"; }, never, ["*"], true, [{ directive: typeof i1.Bind; inputs: {}; outputs: {}; }]>;
}
declare class AccordionModule {
static ɵfac: _angular_core.ɵɵFactoryDeclaration<AccordionModule, never>;
static ɵmod: _angular_core.ɵɵNgModuleDeclaration<AccordionModule, never, [typeof Accordion, typeof i2.SharedModule, typeof AccordionPanel, typeof AccordionHeader, typeof AccordionContent, typeof i1.BindModule], [typeof Accordion, typeof i2.SharedModule, typeof AccordionPanel, typeof AccordionHeader, typeof AccordionContent, typeof i1.BindModule]>;
static ɵinj: _angular_core.ɵɵInjectorDeclaration<AccordionModule>;
}
export { Accordion, AccordionClasses, AccordionContent, AccordionHeader, AccordionModule, AccordionPanel, AccordionStyle };