@guardian/react-crossword

中文文档
20.1.0发布于 2026/10/08Apache-2.0TypeScriptESM + CJS构建来源已验证近 30 天下载 1.6万

用于渲染填字符的独立反应组件 .

中文使用文档
文档目录9 节
  1. 特征
  2. API 密码
  3. 道具
  4. 交叉字数据格式
  5. 进度格式
  6. 他们
  7. 建筑
  8. 版式
  9. 安装

@guardian/react-crossword

用于渲染填字符的独立反应组件 .

Example crossword grid

特征

  • 横字网和线索
  • 在网格中显示连字符和多字词答案的分隔符
  • 版式是响应的(可以定制)
  • 尝试的线索在线索列表中被灰色化
  • 点击线索突出显示关联行或列
  • 跨多行或多行的组合线索
  • 进度保存到本地存储
  • 答案可以检查和披露
  • 在检查通过错误信件击中的答案时智能清除
  • 图表助手
  • 可访问性:填字符中的元素被明确标注为交流上下文和状态以辅助技术
  • 键盘可导航: 您可以在网格、 线索和控件之间标签, 这些可以使用箭头键导航
  • 包括打印样式
  • 包括对主题和自定义颜色方案的支持

API 密码

道具

Prop细节
data(单位:千美元)需求提供填字的数据,包括线索、答案和元数据(见 交叉字数据格式(中文(简体) )
progress(单位:千美元)可选)电网现状(见 进度格式(中文(简体) )
onProgressChange(单位:千美元)可选每次读者改变网格时都会打电话 { progress, filledCells, totalCells, isComplete }。 。 。 . isComplete 实值 true 当每个细胞都持有它的解决方案,并且总是 false 当找不到解决方案时。 在装入时恢复保存进度时不调用 .
Layout(单位:千美元)可选)允许自定义默认布局(见 版式(中文(简体) )

默认主题的任何密钥也可以作为道具被传递来自定义填字的外观. 详细情况见 他们 节.

交叉字数据格式

这是用于创建以上所显示的填字符的一组示例数据:

{
    id: 'crosswords/example/1',
    number: 1,
    name: 'Example crossword No 1',
    creator: {
        name: 'James',
        webUrl: 'https://www.theguardian.com/profile/maskarade',
    },
    date: 1740149419743,
    webPublicationDate: 1740149419743,
  entries: [
    {
      id: '1-across',
      number: 1,
      humanNumber: '1',
      clue: 'Toy on a string (2-2)',
      direction: 'across',
      length: 4,
      group: ['1-across'],
      position: { x: 0, y: 0 },
      separatorLocations: {
        '-': [2],
      },
      solution: 'YOYO',
    },
    {
      id: '2-across',
      number: 2,
      humanNumber: '2',
      clue: 'Have a rest (3,4)',
      direction: 'across',
      length: 7,
      group: ['2-across'],
      position: { x: 0, y: 2 },
      separatorLocations: {
        ',': [3],
      },
      solution: 'LIEDOWN',
    },
    {
      id: '1-down',
      number: 1,
      humanNumber: '1',
      clue: 'Colour (6)',
      direction: 'down',
      length: 6,
      group: ['1-down'],
      position: { x: 0, y: 0 },
      separatorLocations: {},
      solution: 'YELLOW',
    },
    {
      id: '3-down',
      number: 3,
      humanNumber: '3',
      clue: 'Bits and bobs (4,3,4)',
      direction: 'down',
      length: 7,
      group: ['3-down', '4-down'],
      position: { x: 3, y: 0 },
      separatorLocations: {
        ',': [4],
      },
      solution: 'ODDSAND',
    },
    {
      id: '4-down',
      number: 4,
      humanNumber: '4',
      clue: 'See 3 down',
      direction: 'down',
      length: 4,
      group: ['3-down', '4-down'],
      position: {
        x: 6,
        y: 1,
      },
      separatorLocations: {},
      solution: 'ENDS',
    },
  ],
  solutionAvailable: true,
  dateSolutionAvailable: 1542326400000,
  dimensions: {
    cols: 13,
    rows: 13,
  },
  crosswordType: 'quick',
    pdf: 'https://crosswords-static.guim.co.uk/gdn.quick.20250221.pdf',
}

进度格式

网格进取被作为简单的二维阵列存储,并被坚持于本地存储. 阵列中的每个元素都包含相应的网格单元格的值. 空或非部分答案的单元格以空字符串表示.

上面的字面例子有:

[
    ['Y', 'E', 'L', 'L', 'O', 'W', ''],
    ['O', '', 'I', '', '', '', ''],
    ['Y', '', 'E', '', '', '', ''],
    ['O', 'D', 'D', 'S', 'A', 'N', 'D'],
    ['', '', 'O', '', '', '', ''],
    ['', '', 'W', '', '', '', ''],
    ['', 'E', 'N', 'D', 'S', '', ''],
];

数据按栏(x)和行(y)进行索引,因此与网格的视觉布局相比较,打印时将数组中的数据被移植.

例如,最后一个字母: 2个纵队 位于网格的第7行和第3行,因此可按 progress[6][2] 给我们"N".

他们

填字题中的以下密钥可以传递到 Crossword 用于自定义其外观的组件 :

密钥说明
gridBackgroundColor网格上“ 黑色” 平方/ 潜水器等的背景颜色
gridForegroundColor网格上“ 白色” 平方的背景颜色
gridTextColor网格中文字的颜色(符号和输入字母)
gridPrintBackgroundColor打印时“ 黑色” 方格的背景颜色
gridGutterSize网格单元格间差距的大小
gridCellSize网格上单元格的一面长度
gridCellStrikeThrough错误单元格中的击出颜色
textColor主文本颜色(网格文本,线索等)
focusColor当前选中单元格边框的颜色
selectedTextColor当前选中线索的颜色
selectedBackgroundColor目前选中的单元格/ 线索的颜色
connectedBackgroundColor连接到当前选中线索的单元格/ 线索的颜色
buttonBackgroundColor线索帮助按钮的背景颜色
buttonBackgroundHoverColor线索帮助按钮的徘徊颜色
borderColor用于视窗分隔UI部分的边框颜色
clueListBorderColor线索列表上方应用的边框颜色
clueMinWidth线索最小宽度
clueMaxWidth线索的最大宽度
anagramHelperBackgroundColor动画助手的背景颜色
anagramHelperCandidateTextColor尚未在网格上被洗发的信件的文本颜色
focusedClueBackgroundColor焦点线索的背景颜色

建筑

版式

自定义布局组件可以传递到 Crossword 组件通过 Layout 道具 (英语). 由填字所构成的单个组件被传递到布局上作为道具,以便可以根据需要应用额外的元素或样式. (这在DCR中用于自定义版式并允许插入广告槽

这是布局的简化例子 :

const Layout: CrosswordProps['Layout'] = ({
    Grid,
    Clues,
    Controls,
    SavedMessage,
    AnagramHelper,
    FocusedClue,
}) => {
    return (
        <div>
            <AnagramHelper />
            <div>
                <FocusedClue />
                <Grid />
                <FocusedClue />
                <Controls />
                <SavedMessage />
            </div>

            <div>
                <Clues direction="across" />
                <Clues direction="down" />
            </div>
        </div>
    );
};

安装

$ pnpm add @guardian/react-crossword

或者说

$ npm i @guardian/react-crossword

版本与发布记录

@guardian/react-crossword 共发布 189 个版本,首次发布于 2019/09/03;过去 12 个月发布了 41 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
20.1.0latest2026/10/081 个月前
20.0.02026/10/081 个月前
0.0.0-canary-20261007091825canary2026/10/071 个月前
19.0.12026/06/234 个月前
19.0.02026/06/105 个月前
0.0.0-canary-202605181317572026/05/185 个月前

关于 @guardian/react-crossword 的常见问题

@guardian/react-crossword 是什么?

用于渲染填字符的独立反应组件 .

如何安装 @guardian/react-crossword?

在项目目录运行 npm install @guardian/react-crossword,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(^18.2.0)、@emotion/react(^11.11.4)、@guardian/libs(^33.0.0)、@guardian/source(^14.0.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@guardian/react-crossword 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@guardian/react-crossword 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@guardian/react-crossword 可以商用吗?

@guardian/react-crossword 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@guardian/react-crossword 的下载量有多少?

根据 npm 官方下载统计,@guardian/react-crossword 在 2026/10/17 – 2026/11/15 这 30 天内被下载 15,723 次,日均约 524 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@guardian/react-crossword 还在维护吗?

最新版本 20.1.0 发布于 2026/10/08(1 个月前);至今共发布 189 个版本,其中过去 12 个月发布了 41 个;首次发布于 2019/09/03。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。