JGuang

悬停卡片

HoverCard · Mantine Core

交互预览
npm install @mantine/core@9.7.1 @mantine/hooks@9.7.1

悬停卡片

Mantine Core 的独立组件,请不要替换为 JGuang UI/Base UI 的同名 API。

安装

npm install @mantine/core@9.7.1 @mantine/hooks@9.7.1

入口引入 @mantine/core/styles.css,并在根组件使用 MantineProvider;通过 forceColorScheme 同步深浅色主题。

使用与验证

在左侧选择组件,在预览中操作它的状态;使用“查看代码”检查真实源码。安装后执行类型检查和构建,再验证键盘焦点、手机布局与深浅色主题。

来源

https://github.com/mantinedev/mantine/tree/f0e2bc6d28b0f0b8aaefb5b859937bf77f539df7 MIT 许可证;不包括付费内容。下方提供上游英文参考内容,中文使用指南已适配;上游详细参考暂保留英文。


版本与兼容性

固定的 Mantine Core 9.7.1 要求 React 和 React DOM 满足 ^19.2.0,并配套 @mantine/hooks@9.7.1。此条件来自实际 npm 包的 peerDependencies。React 18 或其他不兼容版本不能强行安装;先向项目负责人说明升级影响并确认方案,不使用 --force/--legacy-peer-deps 掩盖冲突。入口的原生 Provider 开启 theme.respectReducedMotion,并用 forceColorScheme 控制深浅色。

适用场景

在悬停目标附近展示上下文内容。

本地示例使用的原生参数

以下参数由本地、经过类型检查的 JSX 示例提取,按所属组件区分。不是全部属性清单;完整签名和继承关系见下方固定源码参考。

此最小示例仅传入子内容,未虚构额外属性。可选参数见源码参考。

交互与状态检查

当前场景:默认。切换支持的禁用、错误或只读场景后检查真实行为;无此原生状态的组件不会被强行添加统一属性。验证键盘焦点和退出方式,修改值后按原生回调签名连接业务状态。

业务接入边界

示例内容和状态仅保存在本地,不提供服务端持久化、授权或数据请求。静态展示组件不应被当作已完成的业务流程。

宿主配置

先安装固定版本 @mantine/core 和 @mantine/hooks,在入口引入 @mantine/core/styles.css,并使用 MantineProvider。示例的 theme 和 variant 是 JGuang 编写的宿主参数,不是所有原生组件都接受的统一 API;通过 forceColorScheme 同步应用主题。源码面板中的原生实现仅供阅读,使用 npm 导出,不要单独复制内部实现。此批只覆盖 Core,不包括日期、图表和表单扩展包。上游详细说明保留英文,不宣称全文中文化。

可运行用法

以下代码使用资源原生 API;不是把其他设计系统的同名组件替换进来。

import { useState } from 'react';
import * as M from '@mantine/core';
import '@mantine/core/styles.css';


function ComponentPreview({ variant = 'Default' }: { variant?: string }) {
const content = <M.Text>Build something beautiful / 构建美好的界面</M.Text>;
return <M.HoverCard><M.HoverCard.Target><M.Button>Hover me</M.Button></M.HoverCard.Target><M.HoverCard.Dropdown>{content}</M.HoverCard.Dropdown></M.HoverCard>;
}
export default function Example({ variant = 'Default', theme = 'light' }: { variant?: string; theme?: 'light' | 'dark' }) {
return <M.MantineProvider forceColorScheme={theme} theme={{ respectReducedMotion: true }}><ComponentPreview variant={variant} /></M.MantineProvider>;
}

可用状态与示例

默认

示例遵循 Mantine 原生 API。支持多状态的输入组件可将示例中的 variant 改为 Disabled、Invalid 或 Read only;这些只是示例标签,不是新增的组件属性。改造时保留组件要求的数据、受控值、store 和复合子组件结构。

Usage

Delays

Set open and close delays in ms with the openDelay and closeDelay props:

HoverCard delay group

Use the HoverCard.Group component to sync open and close delays of multiple HoverCard components:

Activation events

The events prop determines which interactions open the dropdown. Fields that are not specified keep their default values, for example events={{ focus: false }} disables focus activation and leaves hover activation enabled:

<DataTable head={['Field', 'Default', 'Description']} data={[ [<code>hover</code>, <code>true</code>, 'Dropdown is opened when the target is hovered with a mouse'], [<code>focus</code>, <code>true</code>, 'Dropdown is opened when the target is focused with the keyboard'], [ <code>touch</code>, <code>false</code>, <> Dropdown is opened when the target is tapped on a touch device, requires <code>hover</code>{' '} to be enabled </>, ], ]} />

Focus activation uses :focus-visible semantics: the dropdown is opened when the target is focused with the keyboard, but not when it is focused by a mouse click.

touch is disabled by default because there is no hover on touch devices – the first tap would open the dropdown instead of activating the target. Enable it only if the target does not have its own tap action. touch extends hover activation, it has no effect if hover is disabled.

Keyboard interactions

<DataTable head={['Key', 'Description']} data={[ ['Tab', <>Moves focus to the target, opens the dropdown if <code>events.focus</code> is enabled</>], ['Escape', <>Closes the dropdown, can be disabled with <code>{'closeOnEscape={false}'}</code></>], ]} />

The dropdown is also closed when the user presses outside of the target and the dropdown (pointerdown event), set closeOnClickOutside={false} to disable this behavior. Note that the clickOutsideEvents prop is not supported by HoverCard: outside press is always detected with the pointerdown event.

Interactive dropdown

By default, the dropdown is closed as soon as the pointer leaves the target: if there is a gap between the target and the dropdown, or if the pointer travels diagonally over unrelated elements, the dropdown closes before the pointer reaches it.

Set the interactive prop to keep the dropdown open while the pointer travels toward it. It is required by WCAG 1.4.13 if the dropdown contains interactive content. Note that an interactive dropdown intercepts pointer events of the content it overlaps:

With interactive elements

HoverCard is displayed only when the mouse is over the target element or dropdown. You can use anchors and buttons within dropdowns, using inputs is not recommended:

The role prop controls the accessible relation between the target and the dropdown:

<DataTable head={['Value', 'Target attributes', 'Dropdown attributes']} data={[ [ <> <code>dialog</code> (default) </>, <> <code>aria-haspopup="dialog"</code>, <code>aria-expanded</code>, <code>aria-controls</code> </>, <> <code>role="dialog"</code>, <code>aria-labelledby</code> </>, ], [<code>tooltip</code>, <code>aria-describedby</code>, <code>role="tooltip"</code>], ]} />

Use role="tooltip" if the dropdown contains only descriptive content – its content is then announced by screen readers as the description of the target.

Keep the default role="dialog" if the dropdown contains headings, links, buttons or any other content that is not a plain description of the target.

Accessibility

HoverCard can be opened with a mouse and with the keyboard, and is announced by screen readers:

  • The target is focusable if it is an interactive element (a button or a link). If the target is not interactive, add tabIndex={0} to it to make it reachable with the keyboard.
  • Focusing the target with the keyboard opens the dropdown, Escape and a press outside of the target and the dropdown close it.
  • onDismiss is called when the dropdown is closed with Escape key or with a press outside of the target and the dropdown.
  • aria-haspopup, aria-expanded, aria-controls and aria-describedby attributes are managed by the component, see the Dropdown role section.
  • The returnFocus prop is ignored while focus activation is enabled (events.focus, the default): focus is already on the target when the dropdown is opened with the keyboard, and returning it after the target was blurred would trap keyboard users on the target. Escape pressed inside the dropdown always returns focus to the target.

Limitations

The dropdown is rendered in a portal at the end of document.body, it is not a part of the tab order of the page. Keyboard users can open, read and dismiss the dropdown, but cannot move focus into it – links and buttons inside the dropdown are not reachable with the keyboard.

If the dropdown contains interactive content, that content must also be available elsewhere on the page. Do not use the trapFocus prop to work around this limitation: focus cannot be moved into the dropdown in the first place, and trapping focus in a hover-triggered element strands keyboard users.

With withinPortal={false} the dropdown is rendered next to the target and focus can be moved into it with Tab, but moving focus out of the dropdown with Tab does not close it – the dropdown is closed with Escape, with a press outside or when the pointer leaves the target.

Hover and focus activations do not coordinate: if the pointer leaves the target while the target is focused with the keyboard, the dropdown is closed after closeDelay and is not reopened until the target is blurred and focused again.

源码参数参考

以下实现签名和类型从本地固定版本源码生成。保留可选属性、原生继承类型、联合分支和 never 限制;不会将其他设计系统的 API 混入。forwardRef 实现中的 ref 属于 React 引用,不是新增业务属性。此区域是原始类型参考,不是上游说明的全文翻译。

HoverCard(props: HoverCardProps)
export interface HoverCardEvents {
  /** Determines whether the dropdown should be opened when the target is hovered @default true */
  hover?: boolean;

  /** Determines whether the dropdown should be opened when the target is focused with the keyboard @default true */
  focus?: boolean;

  /** Determines whether the dropdown should be opened when the target is tapped on touch devices. Requires `hover` to be enabled @default false */
  touch?: boolean;
}

export interface HoverCardProps extends Omit<PopoverProps, 'opened' | 'onChange'> {
  /** Initial opened state */
  initiallyOpened?: boolean;

  /** Called when the dropdown is opened */
  onOpen?: () => void;

  /** Called when the dropdown is closed */
  onClose?: () => void;

  /**
   * Delay in ms before the dropdown opens after mouse enters the target.
   * Overridden by HoverCard.Group delay if used within a group.
   * @default 0
   */
  openDelay?: number;

  /**
   * Delay in ms before the dropdown closes after mouse leaves the target or dropdown.
   * Overridden by HoverCard.Group delay if used within a group.
   * @default 150
   */
  closeDelay?: number;

  /**
   * Determines which events open the dropdown. Fields that are not specified keep their default values.
   * @default { hover: true, focus: true, touch: false }
   */
  events?: HoverCardEvents;

  /**
   * If set, the dropdown stays open while the pointer travels from the target to the dropdown
   * and remains over it. Set it if the dropdown contains interactive content.
   * @default false
   */
  interactive?: boolean;

  /**
   * Accessible relation between the target and the dropdown. `dialog` sets `aria-haspopup`,
   * `aria-expanded` and `aria-controls` on the target, `tooltip` sets `aria-describedby` instead
   * and should be used if the dropdown contains only descriptive content.
   * @default 'dialog'
   */
  role?: 'dialog' | 'tooltip';

  /** Determines whether the dropdown should be closed when the user presses outside of the target and the dropdown @default true */
  closeOnClickOutside?: boolean;

  /** Not supported by `HoverCard`: outside press is always detected with the `pointerdown` event. Use `closeOnClickOutside` to disable it. */
  clickOutsideEvents?: string[];

  /**
   * Determines whether focus should be returned to the target when the dropdown closes.
   * Ignored when focus activation is enabled (`events.focus`, the default), otherwise moving
   * focus away from the target would return it and reopen the dropdown.
   * `Escape` pressed inside the dropdown always returns focus to the target.
   * @default false
   */
  returnFocus?: boolean;

  /** Called when the dropdown is closed with `Escape` key or with a press outside of the target and the dropdown */
  onDismiss?: () => void;
}

原生与外部类型

以下外部类型仍由 React 或资源自身依赖定义,没有手工展开为虚构属性。实际可用类型以安装版本的 TypeScript 检查为准。

Omit<PopoverProps, 'opened' | 'onChange'>
PopoverProps