canonical / canonical/vanilla-framework

[Component amendment]: Empty state on error

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

Description

## Adding button to Error management empty state

All empty state use cases should have an action for recovery. The error management variant should include a CTA in every scenario. The rationale is that having the possibility to recover from the error should be provided for the user in an error state.
The suggestion is to add a primary button that exists for the empty state pattern, as it is not yet specified for the error management section of the vanilla documentation.

## Visual

![Image](https://github.com/user-attachments/assets/ac2bf957-3314-4b4c-82a9-468b56cd4ece)

## Context

This came up in the Support portal. The user tried to access a ticket that they didn't have access to and encountered an error with no further action to help them navigate back.
There are two scenarios on what happens for recovery action:
- when the url history is available the option would be to go back to the previous page in the support portal
- otherwise the button would navigate the user back to the homepage.

Contributor guide

Open the contributing guide

Research direction

Start with the vanilla documentation's error management empty-state section and compare it with the existing empty-state primary-button pattern. Check how recovery is described for each error scenario, then confirm the documented CTA covers returning to available history or to the homepage.

Written by the indexing model from the issue text.

Assessment

Domain
design, documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.