Skip to content

Fix: improve tooltips accessibility #358

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.

Sign up for GitHub

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

Open
rami-elementor wants to merge 1 commit into
base: core-beta
Choose a base branch
from
+57 −17
Open

Fix: improve tooltips accessibility #358

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 28 additions & 5 deletions src/css/common/_tooltips.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,24 @@ $bg-color: hsl(0deg 0% 20% / 90%);
}
}

.tooltip-trigger {
cursor: help;
display: inline-flex;
align-items: center;
background: transparent;
padding: 0;
margin: 0;
border: 0;
border-radius: 50%;
color: inherit;
font: inherit;

&:hover,
&:focus {
Comment thread
rami-elementor marked this conversation as resolved.
box-shadow: none;
}
}

.tooltip::before,
.tooltip-content {
position: absolute;
Expand Down Expand Up @@ -148,36 +166,41 @@ $bg-color: hsl(0deg 0% 20% / 90%);
}

.tooltip:hover,
.tooltip:focus {
.tooltip:focus,
.tooltip:focus-within {
Comment thread
rami-elementor marked this conversation as resolved.
&::before, .tooltip-content {
visibility: visible;
opacity: 1;
}
}

.tooltip-block.tooltip-start:hover,
.tooltip-block.tooltip-start:focus {
.tooltip-block.tooltip-start:focus,
.tooltip-block.tooltip-start:focus-within {
&::before, .tooltip-content {
transform: translateY(-10px);
}
}

.tooltip-block.tooltip-end:hover,
.tooltip-block.tooltip-end:focus {
.tooltip-block.tooltip-end:focus,
.tooltip-block.tooltip-end:focus-within {
&::before, .tooltip-content {
transform: translateY(10px);
}
}

.tooltip-inline.tooltip-end:hover,
.tooltip-inline.tooltip-end:focus {
.tooltip-inline.tooltip-end:focus,
.tooltip-inline.tooltip-end:focus-within {
&::before, .tooltip-content {
transform: translateX(calc(10px * var(--cs-direction-multiplier)));
}
}

.tooltip-inline.tooltip-start:hover,
.tooltip-inline.tooltip-start:focus {
.tooltip-inline.tooltip-start:focus,
.tooltip-inline.tooltip-start:focus-within {
&::before, .tooltip-content {
transform: translateX(calc(-10px * var(--cs-direction-multiplier)));
}
Expand Down
41 changes: 29 additions & 12 deletions src/js/components/common/Tooltip.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import React from 'react'
import React, { useId } from 'react'
import classnames from 'classnames'
import { __ } from '@wordpress/i18n'
import { trimTrailingChar } from '../../utils/text'
Expand All @@ -12,21 +12,38 @@ export interface TooltipProps {
icon?: ReactNode
children: ReactNode
className?: classnames.Argument
label?: string
}

export const Tooltip: React.FC<TooltipProps> = ({ block, inline, start, end, icon, className, children }) =>
<div className={classnames(
'tooltip',
{ 'tooltip-block': block, 'tooltip-inline': inline, 'tooltip-start': start, 'tooltip-end': end },
className
)}>
{icon ?? <span className="dashicons dashicons-editor-help" aria-hidden="true"></span>}
<div className="tooltip-content">
{children}
export const Tooltip: React.FC<TooltipProps> = ({ block, inline, start, end, icon, className, children, label }) => {
const tooltipId = useId()
return (
<div className={classnames(
'tooltip',
{ 'tooltip-block': block, 'tooltip-inline': inline, 'tooltip-start': start, 'tooltip-end': end },
className
)}>
<button
type="button"
className="tooltip-trigger"
aria-label={label ?? __('More information', 'code-snippets')}
aria-describedby={tooltipId}
>
{icon ?? <span className="dashicons dashicons-editor-help" aria-hidden="true"></span>}
</button>
<div role="tooltip" className="tooltip-content" id={tooltipId}>
{children}
</div>
</div>
</div>
)
}

export const ErrorTooltip: React.FC<{ message: string }> = ({ message }) =>
<Tooltip block end icon={<span className="dashicons dashicons-warning" aria-hidden="true"></span>}>
<Tooltip
block
end
label={__('Error', 'code-snippets')}
icon={<span className="dashicons dashicons-warning" aria-hidden="true"></span>}
>
{`${trimTrailingChar(message, '.!?')}. ${__('Please try again.', 'code-snippets')}`}
</Tooltip>
Loading