Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Stepper and Stepper Item - Ensure implicit list markup is avoided - (2036570227) #7837

Open
dqateam opened this issue Sep 19, 2023 · 6 comments
Assignees
Labels
1 - assigned Issues that are assigned to a sprint and a team member. a11y Issues related to Accessibility fixes or improvements. bug Bug reports for broken functionality. Issues should include a reproduction of the bug. c-stepper Issues that pertain to the calcite-stepper component design Issues that need design consultation prior to development. estimate - 5 A few days of work, definitely requires updates to tests. p - medium Issue is non core or affecting less that 60% of people using the library ready for dev Issues ready for development implementation. spike Issues that need quick investigations for time estimations, prioritization, or a quick assessment.

Comments

@dqateam
Copy link
Collaborator

dqateam commented Sep 19, 2023

Violation:

Ensure implicit list markup is avoided

image

WCAG Reference:

Severity:

6

Media Type:

Lists


Areas for Remediation:

  • Title: Stepper and Stepper Item - Ensure implicit list markup is avoided - (2036570227)
  • Module: Stepper and Stepper Item
    Issue
    There is content that appears as a list but does not use list markup. Examples include:
  • Complete property
  • Error property
  • Active property
  • Disabled property

User Impact
Screen reader users will have difficulty understanding that this content is a list.

Code Reference

<div class="stepper-item-header-text"><span class="stepper-item-heading">Complete property</span><span class="stepper-item-description"></span></div>
(...)
<div class="stepper-item-header-text"><span class="stepper-item-heading">Error property</span><span class="stepper-item-description"></span></div>
(...)
<div class="stepper-item-header-text"><span class="stepper-item-heading">Disabled property</span><span class="stepper-item-description"></span></div>

Suggestion
Ensure implicit list markup is avoided. Lists must use <ul>, <ol>, <li>, <dl>, <dt>, and <dd> elements as appropriate.

Compliant Code Example

<ul>
<li><div class="stepper-item-header-text"><span class="stepper-item-heading">Complete property</span><span class="stepper-item-description"></span></div></li>
(...)
<li><div class="stepper-item-header-text"><span class="stepper-item-heading">Error property</span><span class="stepper-item-description"></span></div></li>
(...)
<li><div class="stepper-item-header-text"><span class="stepper-item-heading">Disabled property</span><span class="stepper-item-description"></span></div></li>
</ul>

Additional Resources:

  • Report Source: Product accessibility evaluation conducted on the Calcite Design System in August, 2022.

monday.com sync: #6365557217

@dqateam dqateam added 0 - new New issues that need assignment. a11y Issues related to Accessibility fixes or improvements. bug Bug reports for broken functionality. Issues should include a reproduction of the bug. needs triage Planning workflow - pending design/dev review. labels Sep 19, 2023
@geospatialem
Copy link
Member

geospatialem commented Jan 3, 2024

It looks like the component's role is currently a "region", do we want to explore a different role? Perhaps a "tablist" with individual stepper-items as "tab"s similar to this tabs example?

<Host aria-label={this.messages.label} role="region">

@geospatialem geospatialem added the design Issues that need design consultation prior to development. label Jan 3, 2024
@driskull
Copy link
Member

driskull commented Jan 8, 2024

Tablist role seems appropriate here. I think this component should be refactored to implement that role.

@driskull driskull added p - medium Issue is non core or affecting less that 60% of people using the library estimate - 5 A few days of work, definitely requires updates to tests. and removed 0 - new New issues that need assignment. needs triage Planning workflow - pending design/dev review. labels Jan 8, 2024
@driskull driskull added this to the 2024-03-26 - Mar Release milestone Jan 8, 2024
@geospatialem geospatialem added the 0 - new New issues that need assignment. label Jan 8, 2024
@brittneytewks brittneytewks removed this from the 2024-03-26 - Mar Release milestone Mar 21, 2024
@geospatialem geospatialem added the ready for dev Issues ready for development implementation. label Apr 1, 2024
@github-actions github-actions bot added the needs milestone Planning workflow - pending milestone assignment, has priority and/or estimate. label Apr 1, 2024
Copy link
Contributor

github-actions bot commented Apr 1, 2024

cc @geospatialem, @brittneytewks

@geospatialem
Copy link
Member

Discussed and confirmed the role change with @SkyeSeitz - we're ready for dev. ☄️

@geospatialem geospatialem added this to the 2024-08-27 - Aug Release milestone Apr 3, 2024
@geospatialem geospatialem removed the needs milestone Planning workflow - pending milestone assignment, has priority and/or estimate. label Apr 3, 2024
@geospatialem
Copy link
Member

Related: #9147

@macandcheese macandcheese added the c-stepper Issues that pertain to the calcite-stepper component label Apr 29, 2024
@anveshmekala anveshmekala self-assigned this Sep 10, 2024
@geospatialem geospatialem added 1 - assigned Issues that are assigned to a sprint and a team member. and removed 0 - new New issues that need assignment. labels Sep 13, 2024
@geospatialem geospatialem added the spike Issues that need quick investigations for time estimations, prioritization, or a quick assessment. label Sep 23, 2024
@anveshmekala
Copy link
Contributor

Additional context: there are similar bugs reported from the audit #5604 ,#5602 and the fix is installed 071dec7.

Perhaps we can use this spike to determine if tab role fits better in improving the context instead of region.

@geospatialem

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1 - assigned Issues that are assigned to a sprint and a team member. a11y Issues related to Accessibility fixes or improvements. bug Bug reports for broken functionality. Issues should include a reproduction of the bug. c-stepper Issues that pertain to the calcite-stepper component design Issues that need design consultation prior to development. estimate - 5 A few days of work, definitely requires updates to tests. p - medium Issue is non core or affecting less that 60% of people using the library ready for dev Issues ready for development implementation. spike Issues that need quick investigations for time estimations, prioritization, or a quick assessment.
Projects
None yet
Development

No branches or pull requests

6 participants