Skip to content

feat: rating question type - #3637

Open
global-prog wants to merge 2 commits into
nextcloud:mainfrom
global-prog:contrib/rating-question
Open

feat: rating question type#3637
global-prog wants to merge 2 commits into
nextcloud:mainfrom
global-prog:contrib/rating-question

Conversation

@global-prog

@global-prog global-prog commented Sep 9, 2026

Copy link
Copy Markdown

Closes #2608.

Summary

A compact rating question, with stars, hearts or thumbs up, configurable from 2 to 10 icons (default 5).

A linear scale already covers 1..N, but renders as a row of radio buttons. A rating is the control people expect for "how would you rate this", takes far less width, and reads at a glance in the results.

Accessibility

Built from real radio inputs rather than clickable icons, so:

  • it stays keyboard navigable, and each option is announced with the value it selects (3 of 5) rather than as an unnamed radio
  • the hit area is a full --default-clickable-area square while the icon itself stays small — an icon-sized target is awkward to hit on a phone
  • the hover animation is dropped under prefers-reduced-motion
  • the icons wrap, since ten of them plus the clear button do not fit one line on a narrow screen

Storage and validation

The answer is stored as the plain number, so results and CSV export need no special handling.

It is validated server-side as a whole number within the configured maximum rather than trusting the client. A rating carries no options, so it is checked on its own rather than as a predefined-option type.

Scope

  • no schema change; maxRating and ratingIcon live in the existing extraSettings
  • FormsQuestionType is deliberately left alone, matching how linearscale, ranking and color are already handled, so openapi.json is unaffected

Testing

  • npm run lint, npm run stylelint and php -l clean
  • built against current main with no errors
  • checked: default 5 stars, switching to hearts and thumbs, changing the count, clearing an answer, a required rating left empty, and a submitted value appearing correctly in the results and CSV export

Happy to adjust the default icon count, the icon set, or drop the hearts/thumbs options if you would rather keep it to stars.

🤖 AI (if applicable)

  • The content of this PR was partly or fully generated using AI

Implements nextcloud#356: a compact star rating, with hearts and thumbs as alternatives.

A linear scale already covers 1..N, but as a row of radio buttons. A rating is the
control people expect for "how would you rate this", takes far less width, and reads
at a glance in the results.

Built from real radio inputs rather than clickable icons, so it stays keyboard
navigable and every option is announced with the value it selects. The hit area is a
full clickable-area square while the icon itself stays small, since an icon-sized
target is awkward to hit on a phone. The hover animation is dropped under
prefers-reduced-motion.

Configurable from 2 to 10 icons, defaulting to 5. The answer is stored as the plain
number, so results and CSV export need no special handling.

Validated server-side as a whole number within the configured maximum rather than
trusting the client. Rating carries no options, so it is checked on its own rather
than as a predefined-option type.

No schema change. FormsQuestionType is left alone, matching how linearscale, ranking
and color are already handled, so openapi.json is unaffected.

Signed-off-by: global-prog <raqeeb@uosamarra.edu.iq>
@codecov

codecov Bot commented Sep 9, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@Chartman123

Copy link
Copy Markdown
Collaborator

@global-prog thanks for the PR :) please add the AI section to the description if you used AI to generate this PR 👍🏻

some comments on the code itself: as this uses mostly the same logic as linear scale questions, we should re-use the existing extraSettings (especially maxOption instead of maxRating) and also the validation logic as far as possible. Rest is looking good from a first glance at it.

Perhaps you could also add a screenshot/recording of how it works to the description so that the @nextcloud/designers could have a look at it without having to build it 👍🏻

A rating is a linear scale that always starts at 1 and is drawn as icons, so it should
not carry settings and checks of its own:

  * its top end is stored as optionsHighest rather than a separate maxRating key, and
    optionsLowest is refused, since a rating's lowest end is always 1;
  * the linear scale's bounds on optionsHighest (2 to 10) now apply to it as well. The
    editor already offered exactly that range, but the server never enforced it;
  * the range check that validated linear scale answers is moved into one helper that
    both types call, keeping its message and defaults, so linear scale behaviour is
    unchanged.

Adds tests for the rating's accepted settings and for its answer validation, which the
first commit did not have.

Signed-off-by: global-prog <raqeeb@uosamarra.edu.iq>
@global-prog

Copy link
Copy Markdown
Author

Thanks! Done in the latest commit:

  • the rating now stores its top end as optionsHighest instead of maxRating, and gets the linear scale's bounds on it (2 to 10). optionsLowest is refused, since a rating always starts at 1.
  • the linear scale's range check is moved into one helper that both types call, with the same message and defaults, so linear scale behaviour is unchanged.
  • added tests for the rating's settings and its answer validation.

I've added the AI declaration to the description, and I'll add a screenshot of the editor and the filled-in form there as well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

2. developing Work in progress enhancement New feature or request feature: ❓ question types

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[QuestionType] Rating

2 participants