This repository has been archived by the owner on Sep 11, 2024. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 831
Add descriptions to ambiguous links for screen readers #7310
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
/* | ||
Copyright 2021 The Matrix.org Foundation C.I.C. | ||
|
||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
|
||
http://www.apache.org/licenses/LICENSE-2.0 | ||
|
||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
*/ | ||
|
||
.mx_ExternalLink { | ||
color: $links; | ||
} | ||
|
||
.mx_ExternalLink_icon { | ||
display: inline-block; | ||
mask-image: url('$(res)/img/external-link.svg'); | ||
background-color: currentColor; | ||
mask-repeat: no-repeat; | ||
mask-size: contain; | ||
width: $font-11px; | ||
height: $font-11px; | ||
margin-left: $font-3px; | ||
vertical-align: middle; | ||
} |
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
/* | ||
Copyright 2021 The Matrix.org Foundation C.I.C. | ||
|
||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
|
||
http://www.apache.org/licenses/LICENSE-2.0 | ||
|
||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
*/ | ||
|
||
import React, { DetailedHTMLProps, AnchorHTMLAttributes } from 'react'; | ||
import classNames from 'classnames'; | ||
|
||
interface Props extends DetailedHTMLProps<AnchorHTMLAttributes<HTMLAnchorElement>, HTMLAnchorElement> {} | ||
|
||
/** | ||
* Simple link component that adds external link icon after link children | ||
*/ | ||
const ExternalLink: React.FC<Props> = ({ children, className, ...rest }) => | ||
<a | ||
target="_blank" | ||
rel="noreferrer noopener" | ||
{...rest} | ||
className={classNames('mx_ExternalLink', className)} | ||
> | ||
{ children } | ||
<i className='mx_ExternalLink_icon' /> | ||
</a>; | ||
|
||
export default ExternalLink; |
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
/* | ||
Copyright 2021 The Matrix.org Foundation C.I.C. | ||
|
||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
http://www.apache.org/licenses/LICENSE-2.0 | ||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
*/ | ||
|
||
import React from 'react'; | ||
import { renderIntoDocument } from 'react-dom/test-utils'; | ||
|
||
import ExternalLink from '../../../../src/components/views/elements/ExternalLink'; | ||
|
||
describe('<ExternalLink />', () => { | ||
const defaultProps = { | ||
"href": 'test.com', | ||
"onClick": jest.fn(), | ||
"className": 'myCustomClass', | ||
'data-test-id': 'test', | ||
}; | ||
const getComponent = (props = {}) => { | ||
const wrapper = renderIntoDocument<HTMLDivElement>( | ||
<div><ExternalLink {...defaultProps} {...props} /></div>, | ||
) as HTMLDivElement; | ||
return wrapper.children[0]; | ||
}; | ||
|
||
it('renders link correctly', () => { | ||
const children = <span>react element <b>children</b></span>; | ||
expect(getComponent({ children, target: '_self', rel: 'noopener' })).toMatchSnapshot(); | ||
}); | ||
|
||
it('defaults target and rel', () => { | ||
const children = 'test'; | ||
const component = getComponent({ children }); | ||
expect(component.getAttribute('rel')).toEqual('noreferrer noopener'); | ||
expect(component.getAttribute('target')).toEqual('_blank'); | ||
}); | ||
|
||
it('renders plain text link correctly', () => { | ||
const children = 'test'; | ||
expect(getComponent({ children })).toMatchSnapshot(); | ||
}); | ||
}); |
36 changes: 36 additions & 0 deletions
36
test/components/views/elements/__snapshots__/ExternalLink-test.tsx.snap
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
// Jest Snapshot v1, https://goo.gl/fbAQLP | ||
|
||
exports[`<ExternalLink /> renders link correctly 1`] = ` | ||
<a | ||
class="mx_ExternalLink myCustomClass" | ||
data-test-id="test" | ||
href="test.com" | ||
rel="noopener" | ||
target="_self" | ||
> | ||
<span> | ||
react element | ||
<b> | ||
children | ||
</b> | ||
</span> | ||
<i | ||
class="mx_ExternalLink_icon" | ||
/> | ||
</a> | ||
`; | ||
|
||
exports[`<ExternalLink /> renders plain text link correctly 1`] = ` | ||
<a | ||
class="mx_ExternalLink myCustomClass" | ||
data-test-id="test" | ||
href="test.com" | ||
rel="noreferrer noopener" | ||
target="_blank" | ||
> | ||
test | ||
<i | ||
class="mx_ExternalLink_icon" | ||
/> | ||
</a> | ||
`; |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this looks unrelated to the PR title
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This was styling the external link icon that was inline as an img, removed it when replacing with the
ExternalLink
component.