feat: better a11y

README.md

@@ -1,4 +1,4 @@
-# rc-tooltip
+# @rc-component/tooltip
 
 React Tooltip
 
@@ -9,18 +9,18 @@ React Tooltip
 [![bundle size][bundlephobia-image]][bundlephobia-url]
 [![dumi][dumi-image]][dumi-url]
 
-[npm-image]: http://img.shields.io/npm/v/rc-tooltip.svg?style=flat-square
-[npm-url]: http://npmjs.org/package/rc-tooltip
+[npm-image]: http://img.shields.io/npm/v/@rc-component/tooltip.svg?style=flat-square
+[npm-url]: http://npmjs.org/package/@rc-component/tooltip
 [travis-image]: https://img.shields.io/travis/react-component/tooltip/master?style=flat-square
 [travis-url]: https://travis-ci.com/react-component/tooltip
 [github-actions-image]: https://github.com/react-component/tooltip/actions/workflows/react-component-ci.yml/badge.svg
 [github-actions-url]: https://github.com/react-component/tooltip/actions/workflows/react-component-ci.yml
 [codecov-image]: https://img.shields.io/codecov/c/github/react-component/tooltip/master.svg?style=flat-square
 [codecov-url]: https://app.codecov.io/gh/react-component/tooltip
-[download-image]: https://img.shields.io/npm/dm/rc-tooltip.svg?style=flat-square
-[download-url]: https://npmjs.org/package/rc-tooltip
-[bundlephobia-url]: https://bundlephobia.com/package/rc-tooltip
-[bundlephobia-image]: https://badgen.net/bundlephobia/minzip/rc-tooltip
+[download-image]: https://img.shields.io/npm/dm/@rc-component/tooltip.svg?style=flat-square
+[download-url]: https://npmjs.org/package/@rc-component/tooltip
+[bundlephobia-url]: https://bundlephobia.com/package/@rc-component/tooltip
+[bundlephobia-image]: https://badgen.net/bundlephobia/minzip/@rc-component/tooltip
 [dumi-url]: https://github.com/umijs/dumi
 [dumi-image]: https://img.shields.io/badge/docs%20by-dumi-blue?style=flat-square
 
@@ -36,18 +36,18 @@ React Tooltip
 
 ## Install
 
-[![rc-tooltip](https://nodei.co/npm/rc-tooltip.png)](https://npmjs.org/package/rc-tooltip)
+[![@rc-component/tooltip](https://nodei.co/npm/@rc-component/tooltip.png)](https://npmjs.org/package/@rc-component/tooltip)
 
 ## Usage
 
 ```js
-var Tooltip = require('rc-tooltip');
+var Tooltip = require('@rc-component/tooltip');
 var React = require('react');
 var ReactDOM = require('react-dom');
 
 // By default, the tooltip has no style.
 // Consider importing the stylesheet it comes with:
-// 'rc-tooltip/assets/bootstrap_white.css'
+// '@rc-component/tooltip/assets/bootstrap_white.css'
 
 ReactDOM.render(
   <Tooltip placement="left" trigger={['click']} overlay={<span>tooltip</span>}>
@@ -135,4 +135,4 @@ npm run coverage
 
 ## License
 
-`rc-tooltip` is released under the MIT license.
+`@rc-component/tooltip` is released under the MIT license.

package.json

@@ -48,6 +48,7 @@
   "devDependencies": {
     "@rc-component/father-plugin": "^2.0.1",
     "@rc-component/np": "^1.0.3",
+    "@testing-library/jest-dom": "^6.9.1",
     "@testing-library/react": "^16.3.0",
     "@types/jest": "^29.4.0",
     "@types/node": "^22.15.18",

src/Tooltip.tsx

@@ -4,7 +4,7 @@ import type { ActionType, AlignType } from '@rc-component/trigger/lib/interface'
 import useId from '@rc-component/util/lib/hooks/useId';
 import { clsx } from 'clsx';
 import * as React from 'react';
-import { useImperativeHandle, useRef } from 'react';
+import { useImperativeHandle, useRef, useState } from 'react';
 import { placements } from './placements';
 import Popup from './Popup';
 
@@ -79,6 +79,7 @@ const Tooltip = React.forwardRef<TooltipRef, TooltipProps>((props, ref) => {
     showArrow = true,
     classNames,
     styles,
+    forceRender,
     ...restProps
   } = props;
 
@@ -89,10 +90,22 @@ const Tooltip = React.forwardRef<TooltipRef, TooltipProps>((props, ref) => {
 
   const extraProps: Partial<TooltipProps & TriggerProps> = { ...restProps };
 
-  if ('visible' in props) {
+  const isControlled = 'visible' in props;
+
+  if (isControlled) {
     extraProps.popupVisible = props.visible;
   }
 
+  const [innerVisible, setInnerVisible] = useState(() => defaultVisible || false);
+  const mergedVisible = isControlled ? props.visible : innerVisible;
+
+  const handleVisibleChange = (nextVisible: boolean) => {
+    if (!isControlled) {
+      setInnerVisible(nextVisible);
+    }
+    onVisibleChange?.(nextVisible);
+  };
+
   // ========================= Arrow ==========================
   // Process arrow configuration
   const mergedArrow = React.useMemo(() => {
@@ -118,7 +131,7 @@ const Tooltip = React.forwardRef<TooltipRef, TooltipProps>((props, ref) => {
     const originalProps = child?.props || {};
     const childProps = {
       ...originalProps,
-      'aria-describedby': overlay ? mergedId : null,
+      'aria-describedby': overlay && mergedVisible ? mergedId : null,
     };
     return React.cloneElement<any>(children, childProps) as any;
   };
@@ -145,10 +158,11 @@ const Tooltip = React.forwardRef<TooltipRef, TooltipProps>((props, ref) => {
       ref={triggerRef}
       popupAlign={align}
       getPopupContainer={getTooltipContainer}
-      onOpenChange={onVisibleChange}
+      onOpenChange={handleVisibleChange}
       afterOpenChange={afterVisibleChange}
       popupMotion={motion}
       defaultPopupVisible={defaultVisible}
+      forceRender={forceRender}
       autoDestroy={destroyOnHidden}
       mouseLeaveDelay={mouseLeaveDelay}
       popupStyle={styles?.root}

tests/index.test.tsx

@@ -502,14 +502,24 @@ describe('rc-tooltip', () => {
   });
 
   describe('children handling', () => {
-    it('should pass aria-describedby to child element when overlay exists', () => {
+    it('should toggle aria-describedby with visibility', async () => {
       const { container } = render(
-        <Tooltip id="test-id" overlay="tooltip content">
+        <Tooltip trigger={['click']} overlay="tooltip content">
           <button>Click me</button>
         </Tooltip>,
       );
 
-      expect(container.querySelector('button')).toHaveAttribute('aria-describedby', 'test-id');
+      const btn = container.querySelector('button');
+      expect(btn).not.toHaveAttribute('aria-describedby');
+
+      fireEvent.click(btn);
+      await waitFakeTimers();
+      const describedby = btn.getAttribute('aria-describedby');
+      expect(describedby).toBeTruthy();
+
+      fireEvent.click(btn);
+      await waitFakeTimers();
+      expect(btn).not.toHaveAttribute('aria-describedby');
     });
 
     it('should not pass aria-describedby when overlay is empty', () => {
@@ -522,6 +532,69 @@ describe('rc-tooltip', () => {
       expect(container.querySelector('button')).not.toHaveAttribute('aria-describedby');
     });
 
+    it('should set aria-describedby immediately when defaultVisible is true', () => {
+      const { container } = render(
+        <Tooltip defaultVisible overlay="tooltip content">
+          <button>Click me</button>
+        </Tooltip>,
+      );
+
+      expect(container.querySelector('button')).toHaveAttribute('aria-describedby');
+    });
+
+    it('should only set aria-describedby for forceRender after visible', async () => {
+      const { container } = render(
+        <Tooltip forceRender trigger={['click']} overlay="tooltip content">
+          <button>Click me</button>
+        </Tooltip>,
+      );
+
+      const btn = container.querySelector('button');
+      expect(btn).not.toHaveAttribute('aria-describedby');
+
+      fireEvent.click(btn);
+      await waitFakeTimers();
+      expect(btn).toHaveAttribute('aria-describedby');
+    });
+
+    it('should remove aria-describedby when controlled hidden without destroy', () => {
+      const overlay = 'tooltip content';
+      const { container, rerender } = render(
+        <Tooltip overlay={overlay} visible>
+          <button>Click me</button>
+        </Tooltip>,
+      );
+
+      expect(container.querySelector('button')).toHaveAttribute('aria-describedby');
+
+      rerender(
+        <Tooltip overlay={overlay} visible={false}>
+          <button>Click me</button>
+        </Tooltip>,
+      );
+
+      expect(container.querySelector('button')).not.toHaveAttribute('aria-describedby');
+    });
+
+    it('should remove aria-describedby when popup is destroyed on hide', async () => {
+      const { container } = render(
+        <Tooltip destroyOnHidden trigger={['click']} overlay="tooltip content">
+          <button>Click me</button>
+        </Tooltip>,
+      );
+
+      const btn = container.querySelector('button');
+      expect(btn).not.toHaveAttribute('aria-describedby');
+
+      fireEvent.click(btn);
+      await waitFakeTimers();
+      expect(btn).toHaveAttribute('aria-describedby');
+
+      fireEvent.click(btn);
+      await waitFakeTimers();
+      expect(btn).not.toHaveAttribute('aria-describedby');
+    });
+
     it('should preserve original props of children', () => {
       const onMouseEnter = jest.fn();
 

tsconfig.json

@@ -7,6 +7,7 @@
     "declaration": true,
     "skipLibCheck": true,
     "esModuleInterop": true,
+    "types": ["@testing-library/jest-dom"],
     "paths": {
       "@/*": [
         "src/*"