primeng
Version:
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
473 lines (462 loc) • 20.3 kB
JavaScript
import * as i1 from '@angular/common';
import { CommonModule } from '@angular/common';
import * as i0 from '@angular/core';
import { Injectable, forwardRef, EventEmitter, signal, inject, booleanAttribute, numberAttribute, ContentChildren, ContentChild, Output, Input, ViewEncapsulation, ChangeDetectionStrategy, Component, NgModule } from '@angular/core';
import { NG_VALUE_ACCESSOR } from '@angular/forms';
import { uuid, getFirstFocusableElement, focus } from '@primeuix/utils';
import { SharedModule, PrimeTemplate } from 'primeng/api';
import { AutoFocus } from 'primeng/autofocus';
import { BaseComponent } from 'primeng/basecomponent';
import { StarFillIcon, StarIcon } from 'primeng/icons';
import { BaseStyle } from 'primeng/base';
const theme = ({ dt }) => `
.p-rating {
position: relative;
display: flex;
align-items: center;
gap: ${dt('rating.gap')};
}
.p-rating-option {
display: inline-flex;
align-items: center;
cursor: pointer;
outline-color: transparent;
border-radius: 50%;
transition: background ${dt('rating.transition.duration')}, color ${dt('rating.transition.duration')}, border-color ${dt('rating.transition.duration')}, outline-color ${dt('rating.transition.duration')}, box-shadow ${dt('rating.transition.duration')};
}
.p-rating-option.p-focus-visible {
box-shadow: ${dt('rating.focus.ring.shadow')};
outline: ${dt('rating.focus.ring.width')} ${dt('rating.focus.ring.style')} ${dt('rating.focus.ring.color')};
outline-offset: ${dt('rating.focus.ring.offset')};
}
.p-rating-icon {
color: ${dt('rating.icon.color')};
transition: background ${dt('rating.transition.duration')}, color ${dt('rating.transition.duration')}, border-color ${dt('rating.transition.duration')}, outline-color ${dt('rating.transition.duration')}, box-shadow ${dt('rating.transition.duration')};
font-size: ${dt('rating.icon.size')};
width: ${dt('rating.icon.size')};
height: ${dt('rating.icon.size')};
}
.p-rating:not(.p-disabled):not(.p-readonly) .p-rating-option:hover .p-rating-icon {
color: ${dt('rating.icon.hover.color')};
}
.p-rating-option-active .p-rating-icon {
color: ${dt('rating.icon.active.color')};
}
/* For PrimeNG */
p-rating.ng-invalid.ng-dirty > .p-rating > .p-rating-icon {
stroke: ${dt('rating.invalid.icon.color')};
}`;
const classes = {
root: ({ props }) => [
'p-rating',
{
'p-readonly': props.readonly,
'p-disabled': props.disabled
}
],
option: ({ instance, props, value }) => [
'p-rating-option',
{
'p-rating-option-active': value <= props.modelValue,
'p-focus-visible': value === instance.focusedOptionIndex() && instance.isFocusVisibleItem
}
],
onIcon: 'p-rating-icon p-rating-on-icon',
offIcon: 'p-rating-icon p-rating-off-icon'
};
class RatingStyle extends BaseStyle {
name = 'rating';
theme = theme;
classes = classes;
static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "19.2.2", ngImport: i0, type: RatingStyle, deps: null, target: i0.ɵɵFactoryTarget.Injectable });
static ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "19.2.2", ngImport: i0, type: RatingStyle });
}
i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "19.2.2", ngImport: i0, type: RatingStyle, decorators: [{
type: Injectable
}] });
/**
*
* Rating component is a star based selection input.
*
* [Live Demo](https://www.primeng.org/rating/)
*
* @module ratingstyle
*
*/
var RatingClasses;
(function (RatingClasses) {
/**
* Class name of the root element
*/
RatingClasses["root"] = "p-rating";
/**
* Class name of the option element
*/
RatingClasses["option"] = "p-rating-option";
/**
* Class name of the on icon element
*/
RatingClasses["onIcon"] = "p-rating-on-icon";
/**
* Class name of the off icon element
*/
RatingClasses["offIcon"] = "p-rating-off-icon";
})(RatingClasses || (RatingClasses = {}));
const RATING_VALUE_ACCESSOR = {
provide: NG_VALUE_ACCESSOR,
useExisting: forwardRef(() => Rating),
multi: true
};
/**
* Rating is an extension to standard radio button element with theming.
* @group Components
*/
class Rating extends BaseComponent {
/**
* When present, it specifies that the element should be disabled.
* @group Props
*/
disabled;
/**
* When present, changing the value is not possible.
* @group Props
*/
readonly;
/**
* Number of stars.
* @group Props
*/
stars = 5;
/**
* Style class of the on icon.
* @group Props
*/
iconOnClass;
/**
* Inline style of the on icon.
* @group Props
*/
iconOnStyle;
/**
* Style class of the off icon.
* @group Props
*/
iconOffClass;
/**
* Inline style of the off icon.
* @group Props
*/
iconOffStyle;
/**
* When present, it specifies that the component should automatically get focus on load.
* @group Props
*/
autofocus;
/**
* Emitted on value change.
* @param {RatingRateEvent} value - Custom rate event.
* @group Emits
*/
onRate = new EventEmitter();
/**
* Emitted when the rating is cancelled.
* @param {Event} value - Browser event.
* @group Emits
*/
onCancel = new EventEmitter();
/**
* Emitted when the rating receives focus.
* @param {Event} value - Browser event.
* @group Emits
*/
onFocus = new EventEmitter();
/**
* Emitted when the rating loses focus.
* @param {Event} value - Browser event.
* @group Emits
*/
onBlur = new EventEmitter();
/**
* Custom on icon template.
* @group Templates
*/
onIconTemplate;
/**
* Custom off icon template.
* @group Templates
*/
offIconTemplate;
/**
* Custom cancel icon template.
* @group Templates
*/
cancelIconTemplate;
templates;
value;
onModelChange = () => { };
onModelTouched = () => { };
starsArray;
isFocusVisibleItem = true;
focusedOptionIndex = signal(-1);
nameattr;
_componentStyle = inject(RatingStyle);
_onIconTemplate;
_offIconTemplate;
_cancelIconTemplate;
ngOnInit() {
super.ngOnInit();
this.nameattr = this.nameattr || uuid('pn_id_');
this.starsArray = [];
for (let i = 0; i < this.stars; i++) {
this.starsArray[i] = i;
}
}
ngAfterContentInit() {
this.templates.forEach((item) => {
switch (item.getType()) {
case 'onicon':
this._onIconTemplate = item.template;
break;
case 'officon':
this._offIconTemplate = item.template;
break;
case 'cancelicon':
this._cancelIconTemplate = item.template;
break;
}
});
}
onOptionClick(event, value) {
if (!this.readonly && !this.disabled) {
this.onOptionSelect(event, value);
this.isFocusVisibleItem = false;
const firstFocusableEl = getFirstFocusableElement(event.currentTarget, '');
firstFocusableEl && focus(firstFocusableEl);
}
}
onOptionSelect(event, value) {
if (!this.readonly && !this.disabled) {
if (this.focusedOptionIndex() === value || value === this.value) {
this.focusedOptionIndex.set(-1);
this.updateModel(event, null);
}
else {
this.focusedOptionIndex.set(value);
this.updateModel(event, value || null);
}
}
}
onChange(event, value) {
this.onOptionSelect(event, value);
this.isFocusVisibleItem = true;
}
onInputBlur(event) {
this.focusedOptionIndex.set(-1);
this.onBlur.emit(event);
}
onInputFocus(event, value) {
if (!this.readonly && !this.disabled) {
this.focusedOptionIndex.set(value);
this.onFocus.emit(event);
}
}
updateModel(event, value) {
this.value = value;
this.onModelChange(this.value);
this.onModelTouched();
if (!value) {
this.onCancel.emit();
}
else {
this.onRate.emit({
originalEvent: event,
value
});
}
}
starAriaLabel(value) {
return value === 1 ? this.config.translation.aria.star : this.config.translation.aria.stars.replace(/{star}/g, value);
}
getIconTemplate(i) {
return !this.value || i >= this.value ? this.offIconTemplate || this._offIconTemplate : this.onIconTemplate || this.offIconTemplate;
}
writeValue(value) {
this.value = value;
this.cd.detectChanges();
}
registerOnChange(fn) {
this.onModelChange = fn;
}
registerOnTouched(fn) {
this.onModelTouched = fn;
}
setDisabledState(val) {
this.disabled = val;
this.cd.markForCheck();
}
get isCustomIcon() {
return !!(this.onIconTemplate || this._onIconTemplate || this.offIconTemplate || this._offIconTemplate || this.cancelIconTemplate || this._cancelIconTemplate);
}
static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "19.2.2", ngImport: i0, type: Rating, deps: null, target: i0.ɵɵFactoryTarget.Component });
static ɵcmp = i0.ɵɵngDeclareComponent({ minVersion: "16.1.0", version: "19.2.2", type: Rating, isStandalone: true, selector: "p-rating", inputs: { disabled: ["disabled", "disabled", booleanAttribute], readonly: ["readonly", "readonly", booleanAttribute], stars: ["stars", "stars", numberAttribute], iconOnClass: "iconOnClass", iconOnStyle: "iconOnStyle", iconOffClass: "iconOffClass", iconOffStyle: "iconOffStyle", autofocus: ["autofocus", "autofocus", booleanAttribute] }, outputs: { onRate: "onRate", onCancel: "onCancel", onFocus: "onFocus", onBlur: "onBlur" }, host: { properties: { "attr.data-pc-name": "\"rating\"", "attr.data-pc-section": "\"root\"", "class.p-readonly": "readonly", "class.p-disabled": "disabled" }, classAttribute: "p-rating" }, providers: [RATING_VALUE_ACCESSOR, RatingStyle], queries: [{ propertyName: "onIconTemplate", first: true, predicate: ["onicon"] }, { propertyName: "offIconTemplate", first: true, predicate: ["officon"] }, { propertyName: "cancelIconTemplate", first: true, predicate: ["cancelicon"] }, { propertyName: "templates", predicate: PrimeTemplate }], usesInheritance: true, ngImport: i0, template: `
<ng-container *ngIf="!isCustomIcon; else customTemplate">
<ng-template ngFor [ngForOf]="starsArray" let-star let-i="index">
<div
class="p-rating-option"
[ngClass]="{
'p-rating-option-active': star + 1 <= value,
'p-focus-visible': star + 1 === focusedOptionIndex() && isFocusVisibleItem
}"
(click)="onOptionClick($event, star + 1)"
>
<span class="p-hidden-accessible" [attr.data-p-hidden-accessible]="true">
<input
type="radio"
value="0"
[name]="nameattr"
[checked]="value === 0"
[disabled]="disabled"
[readonly]="readonly"
[attr.aria-label]="starAriaLabel(star + 1)"
(focus)="onInputFocus($event, star + 1)"
(blur)="onInputBlur($event)"
(change)="onChange($event, star + 1)"
[pAutoFocus]="autofocus"
/>
</span>
<ng-container *ngIf="!value || i >= value">
<span class="p-rating-icon" *ngIf="iconOffClass" [ngStyle]="iconOffStyle" [ngClass]="iconOffClass" [attr.data-pc-section]="'offIcon'"></span>
<StarIcon *ngIf="!iconOffClass" [ngStyle]="iconOffStyle" [styleClass]="'p-rating-icon'" [attr.data-pc-section]="'offIcon'" />
</ng-container>
<ng-container *ngIf="value && i < value">
<span class="p-rating-icon p-rating-icon-active" *ngIf="iconOnClass" [ngStyle]="iconOnStyle" [ngClass]="iconOnClass" [attr.data-pc-section]="'onIcon'"></span>
<StarFillIcon *ngIf="!iconOnClass" [ngStyle]="iconOnStyle" [styleClass]="'p-rating-icon p-rating-icon-active'" [attr.data-pc-section]="'onIcon'" />
</ng-container>
</div>
</ng-template>
</ng-container>
<ng-template #customTemplate>
<span *ngFor="let star of starsArray; let i = index" (click)="onOptionClick($event, star + 1)" [attr.data-pc-section]="'onIcon'">
<ng-container *ngTemplateOutlet="getIconTemplate(i)"></ng-container>
</span>
</ng-template>
`, isInline: true, dependencies: [{ kind: "ngmodule", type: CommonModule }, { kind: "directive", type: i1.NgClass, selector: "[ngClass]", inputs: ["class", "ngClass"] }, { kind: "directive", type: i1.NgForOf, selector: "[ngFor][ngForOf]", inputs: ["ngForOf", "ngForTrackBy", "ngForTemplate"] }, { kind: "directive", type: i1.NgIf, selector: "[ngIf]", inputs: ["ngIf", "ngIfThen", "ngIfElse"] }, { kind: "directive", type: i1.NgTemplateOutlet, selector: "[ngTemplateOutlet]", inputs: ["ngTemplateOutletContext", "ngTemplateOutlet", "ngTemplateOutletInjector"] }, { kind: "directive", type: i1.NgStyle, selector: "[ngStyle]", inputs: ["ngStyle"] }, { kind: "directive", type: AutoFocus, selector: "[pAutoFocus]", inputs: ["autofocus", "pAutoFocus"] }, { kind: "component", type: StarFillIcon, selector: "StarFillIcon" }, { kind: "component", type: StarIcon, selector: "StarIcon" }, { kind: "ngmodule", type: SharedModule }], changeDetection: i0.ChangeDetectionStrategy.OnPush, encapsulation: i0.ViewEncapsulation.None });
}
i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "19.2.2", ngImport: i0, type: Rating, decorators: [{
type: Component,
args: [{
selector: 'p-rating',
imports: [CommonModule, AutoFocus, StarFillIcon, StarIcon, SharedModule],
standalone: true,
template: `
<ng-container *ngIf="!isCustomIcon; else customTemplate">
<ng-template ngFor [ngForOf]="starsArray" let-star let-i="index">
<div
class="p-rating-option"
[ngClass]="{
'p-rating-option-active': star + 1 <= value,
'p-focus-visible': star + 1 === focusedOptionIndex() && isFocusVisibleItem
}"
(click)="onOptionClick($event, star + 1)"
>
<span class="p-hidden-accessible" [attr.data-p-hidden-accessible]="true">
<input
type="radio"
value="0"
[name]="nameattr"
[checked]="value === 0"
[disabled]="disabled"
[readonly]="readonly"
[attr.aria-label]="starAriaLabel(star + 1)"
(focus)="onInputFocus($event, star + 1)"
(blur)="onInputBlur($event)"
(change)="onChange($event, star + 1)"
[pAutoFocus]="autofocus"
/>
</span>
<ng-container *ngIf="!value || i >= value">
<span class="p-rating-icon" *ngIf="iconOffClass" [ngStyle]="iconOffStyle" [ngClass]="iconOffClass" [attr.data-pc-section]="'offIcon'"></span>
<StarIcon *ngIf="!iconOffClass" [ngStyle]="iconOffStyle" [styleClass]="'p-rating-icon'" [attr.data-pc-section]="'offIcon'" />
</ng-container>
<ng-container *ngIf="value && i < value">
<span class="p-rating-icon p-rating-icon-active" *ngIf="iconOnClass" [ngStyle]="iconOnStyle" [ngClass]="iconOnClass" [attr.data-pc-section]="'onIcon'"></span>
<StarFillIcon *ngIf="!iconOnClass" [ngStyle]="iconOnStyle" [styleClass]="'p-rating-icon p-rating-icon-active'" [attr.data-pc-section]="'onIcon'" />
</ng-container>
</div>
</ng-template>
</ng-container>
<ng-template #customTemplate>
<span *ngFor="let star of starsArray; let i = index" (click)="onOptionClick($event, star + 1)" [attr.data-pc-section]="'onIcon'">
<ng-container *ngTemplateOutlet="getIconTemplate(i)"></ng-container>
</span>
</ng-template>
`,
providers: [RATING_VALUE_ACCESSOR, RatingStyle],
changeDetection: ChangeDetectionStrategy.OnPush,
encapsulation: ViewEncapsulation.None,
host: {
class: 'p-rating',
'[attr.data-pc-name]': '"rating"',
'[attr.data-pc-section]': '"root"',
'[class.p-readonly]': 'readonly',
'[class.p-disabled]': 'disabled'
}
}]
}], propDecorators: { disabled: [{
type: Input,
args: [{ transform: booleanAttribute }]
}], readonly: [{
type: Input,
args: [{ transform: booleanAttribute }]
}], stars: [{
type: Input,
args: [{ transform: numberAttribute }]
}], iconOnClass: [{
type: Input
}], iconOnStyle: [{
type: Input
}], iconOffClass: [{
type: Input
}], iconOffStyle: [{
type: Input
}], autofocus: [{
type: Input,
args: [{ transform: booleanAttribute }]
}], onRate: [{
type: Output
}], onCancel: [{
type: Output
}], onFocus: [{
type: Output
}], onBlur: [{
type: Output
}], onIconTemplate: [{
type: ContentChild,
args: ['onicon', { descendants: false }]
}], offIconTemplate: [{
type: ContentChild,
args: ['officon', { descendants: false }]
}], cancelIconTemplate: [{
type: ContentChild,
args: ['cancelicon', { descendants: false }]
}], templates: [{
type: ContentChildren,
args: [PrimeTemplate]
}] } });
class RatingModule {
static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "19.2.2", ngImport: i0, type: RatingModule, deps: [], target: i0.ɵɵFactoryTarget.NgModule });
static ɵmod = i0.ɵɵngDeclareNgModule({ minVersion: "14.0.0", version: "19.2.2", ngImport: i0, type: RatingModule, imports: [Rating, SharedModule], exports: [Rating, SharedModule] });
static ɵinj = i0.ɵɵngDeclareInjector({ minVersion: "12.0.0", version: "19.2.2", ngImport: i0, type: RatingModule, imports: [Rating, SharedModule, SharedModule] });
}
i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "19.2.2", ngImport: i0, type: RatingModule, decorators: [{
type: NgModule,
args: [{
imports: [Rating, SharedModule],
exports: [Rating, SharedModule]
}]
}] });
/**
* Generated bundle index. Do not edit.
*/
export { RATING_VALUE_ACCESSOR, Rating, RatingClasses, RatingModule, RatingStyle };
//# sourceMappingURL=primeng-rating.mjs.map