primeng/types/primeng-types-scrollpanel.d.ts

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,

import { TemplateRef } from '@angular/core';
import { PassThrough, PassThroughOption } from 'primeng/api';

/**
 * Defines the scroll orientation for ScrollPanel component.
 * @group Types
 */
type ScrollPanelOrientation = 'vertical' | 'horizontal';
/**
 * Custom pass-through(pt) options.
 * @template I Type of instance.
 *
 * @see {@link ScrollPanel.pt}
 * @group Interface
 */
interface ScrollPanelPassThroughOptions<I = unknown> {
    /**
     * Used to pass attributes to the root's DOM element.
     */
    root?: PassThroughOption<HTMLDivElement, I>;
    /**
     * Used to pass attributes to the content container's DOM element.
     */
    contentContainer?: PassThroughOption<HTMLDivElement, I>;
    /**
     * Used to pass attributes to the content's DOM element.
     */
    content?: PassThroughOption<HTMLDivElement, I>;
    /**
     * Used to pass attributes to the horizontal panel's DOM element.
     */
    barX?: PassThroughOption<HTMLDivElement, I>;
    /**
     * Used to pass attributes to the vertical panel's DOM element.
     */
    barY?: PassThroughOption<HTMLDivElement, I>;
}
/**
 * Defines valid pass-through options in ScrollPanel component.
 * @see {@link ScrollPanelPassThroughOptions}
 *
 * @template I Type of instance.
 */
type ScrollPanelPassThrough<I = unknown> = PassThrough<I, ScrollPanelPassThroughOptions<I>>;
/**
 * Defines valid templates in ScrollPanel.
 * @group Templates
 */
interface ScrollPanelTemplates {
    /**
     * Custom content template.
     */
    content(): TemplateRef<void>;
}

export type { ScrollPanelOrientation, ScrollPanelPassThrough, ScrollPanelPassThroughOptions, ScrollPanelTemplates };