cds-snc / cds-snc/platform-forms-client

Possibility of adding a description per option for selection type questions (radio button options, checkboxes options)

Open
#4,909 2 comments 0 reactions 0 assignees View on GitHub
design-system enhancement form pattern
Dominant language
TypeScript
Stars
46
Forks
16
Avg merge
1d 8h
Merged PRs (30d)
85

Description

## Description

Form questions may require presenting different options that need more context / explanation that might be provided via hint text within the radio button option or checkbox option.

Radio option hints:
Image

Checkbox option hints:
Screenshot 2025-01-06 at 3 41 59 PM

## From CX survey

https://gcdigital.slack.com/archives/C09CM76GCS0/p1758893395659729

_

> "I would recommend it, but with warnings about it's versatility. I found it not to be as forgiving as I would like. The options to add form elements are good, but it's still fairly rigid to use. A**dding more flexibility would be great - for example I wanted check boxes with descriptions beside them to capture digital application use.** BUT I had to re-do the form b/c it didn't like the method I chose to display my information and would not publish the form. I have to now attach 2 extra pieces of information to my 'here's the survey' email to properly present the information. I would like it more it if was more flexible in allowing you to design what you needed."

_

## Context
Currently, we have hint text for question labels.
There is an opportunity to add hint text for selection options.

This would align with GCDS component anatomy.

## Screenshots or videos

Screenshot 2025-01-06 at 9.34.56 AM.png

Screenshot 2025-01-06 at 9.39.55 AM.png

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.