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,
234 lines (230 loc) • 8.75 kB
TypeScript
import { PanelPassThrough, PanelIconPos, PanelToggler, PanelBeforeToggleEvent, PanelAfterToggleEvent, PanelHeaderIconsTemplateContext } from 'primeng/types/panel';
export * from 'primeng/types/panel';
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, Footer } from 'primeng/api';
import { BaseComponent } from 'primeng/basecomponent';
import * as i1 from 'primeng/bind';
import { Bind } from 'primeng/bind';
import { ButtonDirectiveOptions } from 'primeng/types/button';
import { BaseStyle } from 'primeng/base';
declare class PanelStyle extends BaseStyle {
name: string;
style: string;
classes: {
root: ({ instance }: {
instance: any;
}) => (string | {
'p-panel-toggleable': any;
})[];
header: string;
title: string;
headerActions: ({ instance }: {
instance: any;
}) => (string | {
'p-panel-icons-start': boolean;
'p-panel-icons-end': boolean;
'p-panel-icons-center': boolean;
})[];
pcToggleButton: string;
contentContainer: string;
contentWrapper: string;
content: string;
footer: string;
};
static ɵfac: _angular_core.ɵɵFactoryDeclaration<PanelStyle, never>;
static ɵprov: _angular_core.ɵɵInjectableDeclaration<PanelStyle>;
}
/**
*
* Panel is a container with the optional content toggle feature.
*
* [Live Demo](https://www.primeng.org/panel/)
*
* @module panelstyle
*
*/
declare enum PanelClasses {
/**
* Class name of the root element
*/
root = "p-panel",
/**
* Class name of the header element
*/
header = "p-panel-header",
/**
* Class name of the title element
*/
title = "p-panel-title",
/**
* Class name of the header actions element
*/
headerActions = "p-panel-header-actions",
/**
* Class name of the toggle button element
*/
pcToggleButton = "p-panel-toggle-button",
/**
* Class name of the content container element
*/
contentContainer = "p-panel-content-container",
/**
* Class name of the content wrapper element
*/
contentWrapper = "p-panel-content-wrapper",
/**
* Class name of the content element
*/
content = "p-panel-content",
/**
* Class name of the footer element
*/
footer = "p-panel-footer"
}
/**
* Panel is a container with the optional content toggle feature.
* @group Components
*/
declare class Panel extends BaseComponent<PanelPassThrough> implements BlockableUI {
componentName: string;
$pcPanel: Panel | undefined;
_componentStyle: PanelStyle;
bindDirectiveInstance: Bind;
/**
* Id of the component.
*/
id: _angular_core.InputSignal<string>;
/**
* Defines if content of panel can be expanded and collapsed.
* @group Props
*/
toggleable: _angular_core.InputSignalWithTransform<boolean, unknown>;
/**
* Header text of the panel.
* @group Props
*/
header: _angular_core.InputSignal<string | undefined>;
/**
* Defines the initial state of panel content, supports one or two-way binding as well.
* @group Props
*/
collapsed: _angular_core.ModelSignal<boolean>;
/**
* Position of the icons.
* @group Props
*/
iconPos: _angular_core.InputSignal<PanelIconPos>;
/**
* Specifies if header of panel cannot be displayed.
* @group Props
*/
showHeader: _angular_core.InputSignalWithTransform<boolean, unknown>;
/**
* Specifies the toggler element to toggle the panel content.
* @group Props
*/
toggler: _angular_core.InputSignal<PanelToggler>;
/**
* Configuration object forwarded to the toggle button.
* @group Props
*/
toggleButtonProps: _angular_core.InputSignal<ButtonDirectiveOptions | undefined>;
/**
* The motion options.
* @group Props
*/
motionOptions: _angular_core.InputSignal<MotionOptions | undefined>;
/**
* Callback to invoke before panel toggle.
* @param {PanelBeforeToggleEvent} event - Custom panel toggle event
* @group Emits
*/
onBeforeToggle: _angular_core.OutputEmitterRef<PanelBeforeToggleEvent>;
/**
* Callback to invoke after panel toggle.
* @param {PanelAfterToggleEvent} event - Custom panel toggle event
* @group Emits
*/
onAfterToggle: _angular_core.OutputEmitterRef<PanelAfterToggleEvent>;
footerFacet: _angular_core.Signal<Footer | undefined>;
/**
* Defines template option for header.
* @example
* ```html
* <ng-template #header> </ng-template>
* ```
* @group Templates
*/
headerTemplate: _angular_core.Signal<TemplateRef<void> | undefined>;
/**
* Defines template option for icon.
* @example
* ```html
* <ng-template #icons> </ng-template>
* ```
* @group Templates
*/
iconTemplate: _angular_core.Signal<TemplateRef<void> | undefined>;
/**
* Defines template option for content.
* @example
* ```html
* <ng-template #content> </ng-template>
* ```
* @group Templates
*/
contentTemplate: _angular_core.Signal<TemplateRef<void> | undefined>;
/**
* Defines template option for footer.
* @example
* ```html
* <ng-template #footer> </ng-template>
* ```
* @group Templates
*/
footerTemplate: _angular_core.Signal<TemplateRef<void> | undefined>;
/**
* Defines template option for headerIcon.
* @param {PanelHeaderIconsTemplateContext} context - context of the template.
* @example
* ```html
* <ng-template #headericons let-collapsed> </ng-template>
* ```
* @see {@link PanelHeaderIconsTemplateContext}
* @group Templates
*/
headerIconsTemplate: _angular_core.Signal<TemplateRef<PanelHeaderIconsTemplateContext> | undefined>;
contentWrapperViewChild: _angular_core.Signal<ElementRef<any> | undefined>;
titlebarId: _angular_core.Signal<string>;
headerId: _angular_core.Signal<string>;
contentId: _angular_core.Signal<string>;
buttonAriaLabel: _angular_core.Signal<string | undefined>;
dataP: _angular_core.Signal<string>;
hasFooter: _angular_core.Signal<boolean>;
showDefaultIcon: _angular_core.Signal<boolean>;
contentTabindex: _angular_core.Signal<"-1" | undefined>;
headerIconsContext: _angular_core.Signal<PanelHeaderIconsTemplateContext>;
isContentVisible: _angular_core.Signal<boolean>;
computedMotionOptions: _angular_core.Signal<MotionOptions>;
onAfterViewChecked(): void;
onHeaderClick(event: MouseEvent): void;
onIconClick(event: MouseEvent): void;
toggle(event: MouseEvent): void;
expand(): void;
collapse(): void;
getBlockableElement(): HTMLElement;
updateTabIndex(): void;
onKeyDown(event: KeyboardEvent): void;
onToggleDone(event: MotionEvent): void;
static ɵfac: _angular_core.ɵɵFactoryDeclaration<Panel, never>;
static ɵcmp: _angular_core.ɵɵComponentDeclaration<Panel, "p-panel", never, { "id": { "alias": "id"; "required": false; "isSignal": true; }; "toggleable": { "alias": "toggleable"; "required": false; "isSignal": true; }; "header": { "alias": "header"; "required": false; "isSignal": true; }; "collapsed": { "alias": "collapsed"; "required": false; "isSignal": true; }; "iconPos": { "alias": "iconPos"; "required": false; "isSignal": true; }; "showHeader": { "alias": "showHeader"; "required": false; "isSignal": true; }; "toggler": { "alias": "toggler"; "required": false; "isSignal": true; }; "toggleButtonProps": { "alias": "toggleButtonProps"; "required": false; "isSignal": true; }; "motionOptions": { "alias": "motionOptions"; "required": false; "isSignal": true; }; }, { "collapsed": "collapsedChange"; "onBeforeToggle": "onBeforeToggle"; "onAfterToggle": "onAfterToggle"; }, ["footerFacet", "headerTemplate", "iconTemplate", "contentTemplate", "footerTemplate", "headerIconsTemplate"], ["p-header", "*", "p-footer"], true, [{ directive: typeof i1.Bind; inputs: {}; outputs: {}; }]>;
}
declare class PanelModule {
static ɵfac: _angular_core.ɵɵFactoryDeclaration<PanelModule, never>;
static ɵmod: _angular_core.ɵɵNgModuleDeclaration<PanelModule, never, [typeof Panel, typeof i2.SharedModule, typeof i1.BindModule], [typeof Panel, typeof i2.SharedModule, typeof i1.BindModule]>;
static ɵinj: _angular_core.ɵɵInjectorDeclaration<PanelModule>;
}
export { Panel, PanelClasses, PanelModule, PanelStyle };