primeng/types/primeng-types-rating.d.ts

PrimeNG is an open source UI library for Angular featuring a rich set of 80+ components, a theme designer, various theme alternatives such as Material, Bootstrap, Tailwind, premium templates and professional support. In addition, it integrates with PrimeB

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

/**
 * Custom pass-through(pt) options.
 * @template I Type of instance.
 *
 * @see {@link Rating.pt}
 * @group Interface
 */
interface RatingPassThroughOptions<I = unknown> {
    /**
     * Used to pass attributes to the host's DOM element.
     */
    host?: PassThroughOption<HTMLElement, I>;
    /**
     * Used to pass attributes to the root's DOM element.
     */
    root?: PassThroughOption<HTMLElement, I>;
    /**
     * Used to pass attributes to the option's DOM element.
     */
    option?: PassThroughOption<HTMLDivElement, I>;
    /**
     * Used to pass attributes to the on icon's DOM element.
     */
    onIcon?: PassThroughOption<HTMLElement, I>;
    /**
     * Used to pass attributes to the off icon's DOM element.
     */
    offIcon?: PassThroughOption<HTMLElement, I>;
    /**
     * Used to pass attributes to the hidden option input container's DOM element.
     */
    hiddenOptionInputContainer?: PassThroughOption<HTMLSpanElement, I>;
    /**
     * Used to pass attributes to the hidden option input's DOM element.
     */
    hiddenOptionInput?: PassThroughOption<HTMLInputElement, I>;
}
/**
 * Defines valid pass-through options in Rating component.
 * @see {@link RatingPassThroughOptions}
 *
 * @template I Type of instance.
 */
type RatingPassThrough<I = unknown> = PassThrough<I, RatingPassThroughOptions<I>>;
/**
 * Custom change event.
 * @see {@link Rating.onRate}
 * @group Events
 */
interface RatingRateEvent {
    /**
     * Browser event
     */
    originalEvent: Event;
    /**
     * Selected option value
     */
    value: number;
}
/**
 * Custom icon template context.
 * @group Interface
 */
interface RatingIconTemplateContext {
    /**
     * Star value (1-based index).
     */
    $implicit: number;
    /**
     * Style class of the icon.
     */
    class: string;
}
/**
 * Defines valid templates in Rating.
 * @group Templates
 */
interface RatingTemplates {
    /**
     * Custom on icon template.
     * @param {RatingIconTemplateContext} context - icon context.
     */
    onicon(context: RatingIconTemplateContext): TemplateRef<RatingIconTemplateContext>;
    /**
     * Custom off icon template.
     * @param {RatingIconTemplateContext} context - icon context.
     */
    officon(context: RatingIconTemplateContext): TemplateRef<RatingIconTemplateContext>;
}

export type { RatingIconTemplateContext, RatingPassThrough, RatingPassThroughOptions, RatingRateEvent, RatingTemplates };