Numeric Rating Scale Picker

NumericRatingScalePicker is a headless 0 to 10 rating, such as a numeric pain rating scale: a <fieldset> whose <legend> names the question, one native radio per whole number, and the consumer's words for each end. Lily ships no anchor words and is not a validated instrument; the wording and its validation are the consumer's.

Status: experimental — new, implemented and unit-tested in every headless library; not yet exercised in a composed flow.

Example

How bad is your pain now?No painWorst pain imaginable
Show demo markup
<fieldset class="numeric-rating-scale-picker"><legend class="numeric-rating-scale-picker-legend">How bad is your pain now?</legend><span class="numeric-rating-scale-picker-min-label" id="nrs-demo-min">No pain</span><span class="numeric-rating-scale-picker-options"><label class="numeric-rating-scale-picker-option"><input type="radio" name="pain" value="0" aria-describedby="nrs-demo-min"> 0</label><label class="numeric-rating-scale-picker-option"><input type="radio" name="pain" value="1"> 1</label><label class="numeric-rating-scale-picker-option"><input type="radio" name="pain" value="2"> 2</label><label class="numeric-rating-scale-picker-option"><input type="radio" name="pain" value="3"> 3</label><label class="numeric-rating-scale-picker-option"><input type="radio" name="pain" value="4"> 4</label><label class="numeric-rating-scale-picker-option"><input type="radio" name="pain" value="5"> 5</label><label class="numeric-rating-scale-picker-option"><input type="radio" name="pain" value="6"> 6</label><label class="numeric-rating-scale-picker-option"><input type="radio" name="pain" value="7"> 7</label><label class="numeric-rating-scale-picker-option"><input type="radio" name="pain" value="8"> 8</label><label class="numeric-rating-scale-picker-option"><input type="radio" name="pain" value="9"> 9</label><label class="numeric-rating-scale-picker-option"><input type="radio" name="pain" value="10" aria-describedby="nrs-demo-max"> 10</label></span><span class="numeric-rating-scale-picker-max-label" id="nrs-demo-max">Worst pain imaginable</span></fieldset>
Usage example
<NumericRatingScalePicker
  label="How bad is your pain now?"
  minLabel="No pain"
  maxLabel="Worst pain imaginable"
  name="pain"
/>
Show Svelte source
// In your Svelte component:
import NumericRatingScalePicker from "lily-design-system-svelte-headless/components/NumericRatingScalePicker/NumericRatingScalePicker.svelte";

<NumericRatingScalePicker>
  <!-- content -->
</NumericRatingScalePicker>

Usage

<NumericRatingScalePicker
  label="How bad is your pain now?"
  minLabel="No pain"
  maxLabel="Worst pain imaginable"
  name="pain"
/>

Props

  • label: string (required) — the question, rendered as the <legend>
  • min: number (optional) — the lowest value, default 0
  • max: number (optional) — the highest value, default 10
  • minLabel: string (optional) — the words for the lowest value
  • maxLabel: string (optional) — the words for the highest value
  • value: string (optional) — the chosen value (bindable or controlled)
  • name: string (optional) — the radios' form name, default rating
  • required: boolean (optional) — the form needs an answer
  • ...restProps: any — additional HTML attributes spread onto the root

Keyboard Interactions

Key Action
Tab Moves into the group, to the chosen radio or the first
Arrow keys Move to the next or previous number and choose it

ARIA

  • A native <fieldset> named by its <legend>; each radio is named by its number; the end radios are described by the anchor words

When to Use

  • Use for a 0 to 10 numeric rating, such as pain intensity, with anchor words at each end.
  • Use where each number must be its own choice, reachable by keyboard.

When Not to Use

  • Do not use for a Net Promoter Score — use net-promoter-score-radio-group.
  • Do not use for a face scale — faces need a licensed instrument; five-face-rating-radio-group is a satisfaction scale, not a pain scale.
  • Do not use for a free number — use number-input.

Headless

This headless component ships zero CSS and decides nothing visual. The consumer provides all styling targeting the .numeric-rating-scale-picker class hook, and every word.

Styles

.numeric-rating-scale-picker and its parts.

Testing

  • The legend names the group, and there is one radio per number
  • The end radios are described by the anchor words
  • The arrow keys move and choose

Advice

  • Use the exact wording of the instrument your service has validated, translated by the people who validated it.
  • Do not colour the numbers from green to red; meaning must not be colour alone.

Implementation Notes

  • Renders <fieldset class="numeric-rating-scale-picker"> with a <legend>, and one radio per number from min (default 0) to max (default 10)
  • minLabel and maxLabel are shown and linked to the end radios with aria-describedby
  • required makes the group need an answer (on the first radio, as native radio groups do)
  • Form reset restores the first value

Related components

  • net-promoter-score-radio-group — a picker for selecting a 0-10 Net Promoter Score
  • radio-group — a group of radio inputs

References

  • Spec: spec/healthcare-ui/index.md

Lily™ and Lily Design System™ are trademarks.

Canonical contract

Generated from this component's canonical metadata — the machine-checked source the implementations are held to.

Metadata

  • Component: numeric-rating-scale-picker
  • PascalCase: NumericRatingScalePicker
  • Description: a picker for a 0 to 10 rating, such as pain, with the consumer's words at each end
  • Status: experimental — new, implemented and unit-tested in every headless library; not yet exercised in a composed flow
  • HTML tag: <fieldset>
  • CSS class: .numeric-rating-scale-picker
  • Interactive: yes

ARIA

  • A native <fieldset> named by its <legend>; each radio is named by its number; the end radios are described by the anchor words

Keyboard

  • Tab moves into the group, to the chosen radio or the first; the arrow keys move and choose (native radios)

Props

  • label: string (required) — the question, rendered as the <legend>
  • min: number (optional) — the lowest value, default 0
  • max: number (optional) — the highest value, default 10
  • minLabel: string (optional) — the words for the lowest value
  • maxLabel: string (optional) — the words for the highest value
  • value: string (optional) — the chosen value (bindable or controlled)
  • name: string (optional) — the radios' form name, default rating
  • required: boolean (optional) — the form needs an answer
  • ...restProps: any — additional HTML attributes spread onto the root

Markdown

This page as Markdown, for people and AI tools: numeric-rating-scale-picker.md