引用块 · Blockquote
引用块用于内容展示场景。下面的官方示例展示原生用法与状态,属性名保持上游 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:可交互查看这一用法的行为,复制代码时保留它实际使用的属性与导入。
API 与上游详细参考
优先使用 0.7.1 官方中文说明;上游尚未提供中文的条目保留英文。属性名、类型及默认值保持原生 API,不把示例状态名称当成组件属性。
Blockquote
带有行首边框和次要文本颜色的引用块。用于突出显示引用内容、推荐语或摘录。边框和内边距使用逻辑属性,因此在从右到左的语言环境中会移到右侧。
| 属性 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| children * | ReactNode | 引用块的内容。 | |
| cite | ReactNode | 引用的可选出处。在引用内容之后以 <cite> 元素渲染。 | |
| xstyle | StyleXStyles | 用于布局自定义的 StyleX 样式(边距、定位、尺寸)。必须是 stylex.create() 的值,不能是 style={{}} 这样的内联样式对象。 |
使用建议
- 用于引用文本、推荐语或来自外部来源的高亮摘录。
- 当引用来源已知时,提供 cite 属性。
- 通过 cite 传入来源,而不是写在 children 里,这样它会渲染为语义化的 <cite> 元素,辅助技术可以将其与引用内容区分开。
- 避免:用于提示框或信息说明,应使用 Banner。
- 避免:自行用 <footer> 包裹出处。<blockquote> 内的 <footer> 会成为 contentinfo 文档地标,页面上有多个引用时就会报告多个页脚。
主题 API
{
"targets": [
{
"className": "astryx-blockquote",
"visualProps": []
}
]
}
组件结构
- 边框: 行首边缘的边框,使用 --color-border-emphasized 绘制。
- 引用内容: 通过 children 传入的引用内容,渲染在 <blockquote> 元素内。
- 出处: 通过 cite 传入的来源,在引用内容下方以 <cite> 元素渲染。