primeng/types/primeng-types-scrollarea.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 scrollbar visibility variant for ScrollArea component.
 * @group Types
 */
type ScrollAreaVariant = 'auto' | 'hover' | 'scroll' | 'always' | 'hidden';
/**
 * Custom pass-through(pt) options.
 * @template I Type of instance.
 *
 * @see {@link ScrollArea.pt}
 * @group Interface
 */
interface ScrollAreaPassThroughOptions<I = unknown> {
    /**
     * Used to pass attributes to the root's DOM element.
     */
    root?: PassThroughOption<HTMLDivElement, I>;
    /**
     * Used to pass attributes to the viewport's DOM element.
     */
    viewport?: PassThroughOption<HTMLDivElement, I>;
    /**
     * Used to pass attributes to the content's DOM element.
     */
    content?: PassThroughOption<HTMLDivElement, I>;
    /**
     * Used to pass attributes to the scrollbar's DOM element.
     */
    scrollbar?: PassThroughOption<HTMLDivElement, I>;
    /**
     * Used to pass attributes to the handle's DOM element.
     */
    handle?: PassThroughOption<HTMLDivElement, I>;
    /**
     * Used to pass attributes to the corner's DOM element.
     */
    corner?: PassThroughOption<HTMLDivElement, I>;
}
/**
 * Defines valid pass-through options in ScrollArea component.
 * @see {@link ScrollAreaPassThroughOptions}
 *
 * @template I Type of instance.
 */
type ScrollAreaPassThrough<I = unknown> = PassThrough<I, ScrollAreaPassThroughOptions<I>>;
/**
 * Defines valid templates in ScrollArea.
 * @group Templates
 */
interface ScrollAreaTemplates {
    /**
     * Custom content template.
     */
    content(): TemplateRef<void>;
}

export type { ScrollAreaPassThrough, ScrollAreaPassThroughOptions, ScrollAreaTemplates, ScrollAreaVariant };