For AI agents: the complete documentation index is available at https://rickyshin93.github.io/tao-ui/llms.txt, the full documentation bundle is available at https://rickyshin93.github.io/tao-ui/llms-full.txt, and this page is available as Markdown at https://rickyshin93.github.io/tao-ui/components/rate.md.
v0.0.57
  • English
  • Rate

    Data Entry@rockshin/tao-ui

    Lets people choose a rating with full or half steps.

    When to use

    Use for a short ordered scale. Add a visible label and explain what the highest and lowest ratings mean.

    Examples

    Controlled half-star rating

    Arrow keys move the rating. allowHalf enables half steps and tooltips explain each whole-star score.

    390 × 640
    TSX

    Allow or prevent clearing

    With allowClear enabled, clicking the selected score again resets it to zero.

    Click the selected star to clear

    A value is always retained

    TSX

    Read-only and disabled

    readOnly presents an existing score; disabled communicates that the control is unavailable.

    Average: 4.5

    Rating unavailable

    TSX

    Custom characters and count

    character can be a node or a function of the item index.

    • ♥
      ♥
    • ♥
      ♥
    • ♥
      ♥
    • 1
      1
    • 2
      2
    • 3
      3
    • 4
      4
    • 5
      5
    TSX

    Sizes and provider defaults

    small, middle and large are accepted. The native medium spelling is also supported.

    TSX

    Focus and semantic customization

    Use the ref when another action needs to move focus into the rating control.

    TSX

    API

    Rate

    PropertyDescriptionTypeDefault Value