feat(step-flow): add aria props to component - FE-7013 #7121
+152
−4
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
DipperTheDan
commented
Dec 10, 2024
| @@ -180,7 +195,14 @@ export const StepFlow = forwardRef<StepFlowHandle, StepFlowProps>( | |||
| ); | |||
|
|
|||
| return ( | |||
| <StyledStepFlow {...rest} {...tagComponent("step-flow", rest)}> | |||
| <StyledStepFlow | |||
| role="group" | |||
There was a problem hiding this comment.
This role has been added because I saw an Axe warning of attribute is not well supported on a div with no valid role attribute when using the aria props. The role of group was what I thought fit this component. However, I am open to suggestions on which is best. A role of presentation or none triggers the Axe warning.
nuria1110
reviewed
Dec 10, 2024
|
|
||
| const stepFlowComponent = screen.getByTestId("step-flow"); | ||
|
|
||
| expect(stepFlowComponent).toHaveAttribute("aria-label", "foo"); |
There was a problem hiding this comment.
suggestion (non-blocking): We could use the toHaveAccessbleName matcher here to ensure the accessible name has been correctly set.
Suggested change
| expect(stepFlowComponent).toHaveAttribute("aria-label", "foo"); | |
| expect(stepFlowComponent).toHaveAccessibleName( "foo"); |
|
|
||
| const stepFlowComponent = screen.getByTestId("step-flow"); | ||
|
|
||
| expect(stepFlowComponent).toHaveAttribute("aria-labelledby", "foo"); |
There was a problem hiding this comment.
suggestion (non-blocking): Same here
|
|
||
| const stepFlowComponent = screen.getByTestId("step-flow"); | ||
|
|
||
| expect(stepFlowComponent).toHaveAttribute("aria-describedby", "foo"); |
There was a problem hiding this comment.
Suggestion (non-blocking): Same here, we could use toHaveAccessibleDescription
nuria1110
approved these changes
Dec 10, 2024
mihai-albu-sage
approved these changes
Dec 11, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed behaviour
Aria props are destructured and present in the documentation for
Step FlowCurrent behaviour
Aria props are not destructured. They are present due to
...restbeing spread on the component. Due to this, they do not appear in the Storybook documentation for the component under thePropssection.Checklist
d.tsfile added or updated if requiredQA
Additional context
N/A
Testing instructions
New test stories have been created to demonstrate the newly added aria props. These stories are:
You should be able to see these attributes in the DOM, on the element for Step Flow.
There should also be no other functional or styling regressions due to this change.