canonical / canonical/vanilla-framework

[Proposal] Deprecate or clarify usage of <legend class="is-required"> for fieldset in forms

Open
#5,596 3 comments 0 reactions 0 assignees View on GitHub
Priority: Low Tier: Global WG: Validated
Dominant language
HTML
Stars
983
Forks
216
Avg merge
3d 13h
Merged PRs (30d)
3

Description

**Description:**
While reviewing the Forms / Fieldset required example on the Vanilla Framework website, I noticed the use of for indicating required fields in a radio group. However, I haven't found this pattern in our Figma library, and I haven’t seen it and used in practice, either internally at Canonical or externally.

**Questions:**
- Is this component actively maintained and intended for use?
- If not, should we consider deprecating it from both documentation and code to reduce confusion?

**References:**
Example on the Vanilla site
Image

**Suggestion:**
I propose we review this and decide whether to:
1. Deprecate it officially
2. Update its design and add it to Figma if it's still considered useful

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the Forms / Fieldset required example on the Vanilla Framework website and the referenced Figma library. Determine whether the pattern is maintained and intended for use, then document the decision about deprecation or continued use. Done means the decision and any resulting documentation, code, and design-library updates are aligned.

Written by the indexing model from the issue text.

Assessment

Tech stack
css, figma, html
Domain
design, documentation, frontend
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.