INSTUI-4241: fix(ui-toggle-details): do not put aria-expanded and aria-controls on the toggle if there is nothing to toggle #1747
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
… the toggle if there is nothing to toggle Also do not render an empty div for the details in this case. Note that this might break tests since they might find these DOM parts via these ARIA tags. Also the empty div took up a small space when expanded (0.375rem), this might cause layout changes TEST PLAN: Make a ToggleDetails without any children, it should have no aria tags. Should still listen to mouse events
matyasf
commented
Oct 24, 2024
Comment on lines
-47
to
-48
| onToggle: function () {}, | ||
| children: null |
There was a problem hiding this comment.
this is just removing some old old code, ancient InstUI loved default values even when it was not needed.
matyasf
commented
Oct 24, 2024
| return { | ||
| ...props, |
There was a problem hiding this comment.
this is better, users cannot override our props this way
matyasf
commented
Oct 24, 2024
Comment on lines
+104
to
+113
| // Do not put aria-controls and aria-expanded into the toggle if there | ||
| // is nothing to open | ||
| const tProps = this.props.children | ||
| ? toggleProps | ||
| : { onClick: toggleProps.onClick } | ||
| const props = { | ||
| ...omitProps(this.props, ToggleDetails.allowedProps), | ||
| ...toggleProps, | ||
| ...tProps, | ||
| children: this.renderSummary(expanded) | ||
| // spread operator makes toggleProps loose Record<string, any>> | ||
| } as Record<string, any> | ||
| } as Record<string, unknown> |
matyasf
commented
Oct 24, 2024
| @@ -152,11 +155,11 @@ class ToggleDetails extends Component<ToggleDetailsProps> { | |||
| } | |||
|
|
|||
| renderDetails(expanded: boolean, detailsProps: { id: string }) { | |||
| const { children } = this.props | |||
| if (!this.props.children) return null | |||
| const expandedStyles = expanded ? { display: 'block' } : { display: 'none' } | |||
| return ( | |||
| <div {...detailsProps} css={[this.props.styles?.details, expandedStyles]}> | |||
There was a problem hiding this comment.
This div is rendering a line with 0.375rem when open even when it has no children. I've removed this, hopefully nothing will break
|
joyenjoyer
approved these changes
Oct 25, 2024
git-nandor
approved these changes
Oct 28, 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.
Also do not render an empty div for the details in this case. Note that this might break tests since
they might find these DOM parts via these ARIA tags. Also the empty div took up a small space when expanded (0.375rem), this might cause layout changes
TEST PLAN:
Make a ToggleDetails without any children, it should have no aria tags. Should still listen to mouse events