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

feat(a11y): add screen reader support for Tooltip #490

Merged
merged 17 commits into from
Jan 7, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 3 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,8 @@
"dependencies": {
"@babel/runtime": "^7.11.2",
"@rc-component/trigger": "^2.0.0",
"classnames": "^2.3.1"
"classnames": "^2.3.1",
"rc-util": "^5.44.3"
},
"devDependencies": {
"@rc-component/father-plugin": "^1.0.0",
Expand All @@ -69,4 +70,4 @@
"react": ">=16.9.0",
"react-dom": ">=16.9.0"
}
}
}
23 changes: 19 additions & 4 deletions src/Tooltip.tsx
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
import type { ArrowType, TriggerProps, TriggerRef } from '@rc-component/trigger';
import Trigger from '@rc-component/trigger';
import type { ActionType, AlignType, AnimationType } from '@rc-component/trigger/lib/interface';
import classNames from 'classnames';
import * as React from 'react';
import { forwardRef, useImperativeHandle, useRef } from 'react';
import { placements } from './placements';
import Popup from './Popup';
import classNames from 'classnames';
import useId from 'rc-util/lib/hooks/useId';

export interface TooltipProps
extends Pick<
Expand Down Expand Up @@ -60,7 +61,7 @@ export interface TooltipClassNames {
body?: string;
}

export interface TooltipRef extends TriggerRef {}
export interface TooltipRef extends TriggerRef { }

const Tooltip = (props: TooltipProps, ref: React.Ref<TooltipRef>) => {
const {
Expand Down Expand Up @@ -91,7 +92,9 @@ const Tooltip = (props: TooltipProps, ref: React.Ref<TooltipRef>) => {
...restProps
} = props;

const mergedId = useId(id);
const triggerRef = useRef<TriggerRef>(null);

useImperativeHandle(ref, () => triggerRef.current);

const extraProps: Partial<TooltipProps & TriggerProps> = { ...restProps };
Expand All @@ -103,14 +106,26 @@ const Tooltip = (props: TooltipProps, ref: React.Ref<TooltipRef>) => {
<Popup
key="content"
prefixCls={prefixCls}
id={id}
id={mergedId}
bodyClassName={tooltipClassNames?.body}
overlayInnerStyle={{ ...overlayInnerStyle, ...tooltipStyles?.body }}
>
{overlay}
</Popup>
);

const getChildren = () => {
aojunhao123 marked this conversation as resolved.
Show resolved Hide resolved
const child = React.Children.only(children);
const originalProps = child?.props || {};

const childProps = {
...originalProps,
'aria-describedby': overlay ? mergedId : null,
};

return React.cloneElement(children, childProps);
};

return (
<Trigger
popupClassName={classNames(overlayClassName, tooltipClassNames?.root)}
Expand All @@ -135,7 +150,7 @@ const Tooltip = (props: TooltipProps, ref: React.Ref<TooltipRef>) => {
arrow={showArrow}
{...extraProps}
>
{children}
{getChildren()}
</Trigger>
);
};
Expand Down
58 changes: 58 additions & 0 deletions tests/index.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -279,4 +279,62 @@ describe('rc-tooltip', () => {
expect(tooltipElement.style.backgroundColor).toBe('blue');
expect(tooltipBodyElement.style.color).toBe('red');
});

describe('children handling', () => {
it('should pass aria-describedby to child element when overlay exists', () => {
const { container } = render(
<Tooltip id="test-id" overlay="tooltip content">
<button>Click me</button>
</Tooltip>,
);

expect(container.querySelector('button')).toHaveAttribute('aria-describedby', 'test-id');
});

it('should not pass aria-describedby when overlay is empty', () => {
const { container } = render(
<Tooltip id="test-id" overlay={null}>
<button>Click me</button>
</Tooltip>,
);

expect(container.querySelector('button')).not.toHaveAttribute('aria-describedby');
});

it('should preserve original props of children', () => {
const onMouseEnter = jest.fn();

const { container } = render(
<Tooltip overlay="tip">
<button className="custom-btn" onMouseEnter={onMouseEnter}>
Click me
</button>
</Tooltip>,
);

const btn = container.querySelector('button');
expect(btn).toHaveClass('custom-btn');

// 触发原始事件处理器
fireEvent.mouseEnter(btn);
expect(onMouseEnter).toHaveBeenCalled();
});

it('should throw error when multiple children provided', () => {
const errorSpy = jest.spyOn(console, 'error').mockImplementation(() => { });

expect(() => {
render(
// @ts-expect-error
<Tooltip overlay="tip" >
<button>First</button>
<button>Second</button>
</Tooltip>,
);
}).toThrow();

errorSpy.mockRestore();
});
});
});

aojunhao123 marked this conversation as resolved.
Show resolved Hide resolved
Loading