chrome:shell.skip

generated:catalog.entry.rate-picker.title

generated:catalog.entry.rate-picker.description

@xngui/components/rate-picker
@xngui/components/rate-picker

chrome:demo.section

chrome:demo.preview

demo-preview:rate-picker.your-ratingdemo-preview:rate-picker.description
demo-preview:hints.category.navigation:
Tab← →
demo-preview:hints.category.focus:
Focus
demo-preview:hints.category.pointer:
Click
import { Component } from '@angular/core';
import { XForm } from '@xngui/components/form';
import { XRatePicker } from '@xngui/components/rate-picker';
import { XIcon } from '@xngui/icons';
 
@Component({
selector: 'app-example',
imports: [XForm, XRatePicker, XIcon],
templateUrl: './rate-picker.component.html',
})
export class ExampleComponent {}

chrome:demo.events.title

chrome:demo.events.empty

chrome:demo.api.title

x-rate-picker

chrome:demo.api.col.property
chrome:demo.api.col.type
chrome:demo.api.col.default
chrome:demo.api.col.description
max
number
—
Maximum star count — defaults to `5` when unset.
precision
XRatePickerPrecision
1
Minimum selectable increment — `1` for whole stars or `0.5` for half stars.
allowClear
boolean
true
Re-clicking or double-tapping the active rating clears the value when true.
variant
XVariant
—
Highlight color role for filled icons — falls back to XConfigService when unset.
size
XSize
—
Visual size tier — falls back to XConfigService when unset.
density
XDensity
—
Spacing offsets — orthogonal to `size`; falls back to XConfigService when unset.
label
string
''
Visible label text above the stars.
description
string
''
Optional helper text under the label.
ariaLabel
string
—
Accessible name when no visible `label` is provided.
name
string
''
Native form control `name` attribute.
controlId
string
—
Native `id` on the focusable control; falls back to `name`, then a generated id.
disabled
boolean
false
Prevents interaction and sets `aria-disabled` on the control surface.
readonly
boolean
false
Value-only input — user cannot change when true.
invalid
boolean
false
Marks the control invalid for styling and ARIA.
required
boolean
false
Marks the control as required for validation and ARIA.