视觉隐藏 · VisuallyHidden
视觉隐藏用于辅助功能场景。下面的官方示例展示原生用法与状态,属性名保持上游 API。
安装与前置条件
npm install @astryxdesign/core@0.7.1 @astryxdesign/theme-neutral@0.7.1 @stylexjs/stylex@0.19.0
需要 React 19+,按顺序导入基础 CSS 和主题,并设置 Theme Provider。参见开始使用。
示例与使用方式
- 视觉隐藏 · 综合展示 1:首先体验这个示例,再查看代码理解组件的组合方式。
- 视觉隐藏 · 交互示例 2:可交互查看这一用法的行为,复制代码时保留它实际使用的属性与导入。
- 视觉隐藏 · 交互示例 3:可交互查看这一用法的行为,复制代码时保留它实际使用的属性与导入。
- 视觉隐藏 · 交互示例 4:可交互查看这一用法的行为,复制代码时保留它实际使用的属性与导入。
API 与上游详细参考
优先使用 0.7.1 官方中文说明;上游尚未提供中文的条目保留英文。属性名、类型及默认值保持原生 API,不把示例状态名称当成组件属性。
VisuallyHidden
Renders content in the accessibility tree while hiding it visually. Use for accessible names on icon-only controls, aria-live announcement regions, and supplementary screen-reader context.
| 属性 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| children | ReactNode | 对辅助技术公开但对视觉隐藏的内容。 | |
| as | ElementType | 'span' | 要渲染的 HTML 标签。实时区域请使用块级元素。 |
使用建议
- Use to give icon-only buttons and controls an accessible name that screen readers announce.
- Render as a block element (as="div") with aria-live to announce dynamic updates like drag-and-drop or result counts.
- 避免:Use it to hide content from everyone; it stays in the accessibility tree; use conditional rendering or
hiddento remove content entirely. - 避免:Put interactive controls inside it; the content is not visible and cannot receive pointer input.
完整示例的额外依赖
部分示例使用独立图标包。示例清单中的每条安装命令包含该示例实际需要的依赖;若要运行本页全部示例,还需安装:
npm install @heroicons/react@2.2.0