跳到内容
新问题

对这个项目有疑问吗？注册一个免费的GitHub帐户以打开一个问题，并联系其维护者和社区。

注册GitHub

单击“注册GitHub”，表示您同意我们的服务条款和隐私声明。我们偶尔会向您发送与帐户相关的电子邮件。

已经在GitHub上了？登录到您的帐户
跳到底部

WIP：向register_block_pattern添加描述。 #23070个

已合并
将19个提交合并到从 2020年7月6日
已合并

WIP：向register_block_pattern添加描述。 #23070

将19个提交合并到从 2020年7月6日

对话

卡罗来纳州人
复制链接
贡献者

@卡罗来纳州人 卡罗来纳州人 评论2020年6月10日 •
已编辑

描述

我尝试向块模式添加描述。
修复 #23042

我也不确定我的ID是否正确。

常量描述Id=块编辑器插入模式项描述-${instanceId}；

输出：
<div class=“components-visually-hidden”id=“block-editor-inserter__patterns-item-description-4”>具有渐变背景和超大字体段落的封面块</div（分频）>

这是如何测试的？

我为四个现有模式以及主题中的一个模式添加了描述。
我通过检查插入器上的标记进行了测试，并使用NVDA屏幕阅读器测试了由和可视化隐藏元素描述的aria。

变更类型

新功能。

检查清单：

  • 我的代码已经过测试。
  • 我的代码遵循WordPress代码风格。
  • [x]我的代码遵循可访问性标准。
  • 我的代码有适当的内联文档。
  • 如果合适的话，我已经包括了开发人员文档。
  • 我已经更新了所有受此PR中任何重构/重命名影响的React Native文件。

你知道riad
你知道riad 检验过的 2020年6月11日
查看已审阅的更改
packages/block-editor/src/components/inserter/block-patterns.js 过时的
>
<BlockPreview块={blocks}viewportWidth={viewportWith}/>
<div className=“block-editor-inserter__patterns-item-title”>
{图案标题}
</div>
<VisuallyHidden id={descriptionId}>
复制链接
贡献者

选择隐藏此评论的原因

将显示原因，以便向其他人描述此评论。了解更多信息.

您可以添加

{！！pattern.description&&(//你的可视隐藏元素} )

根据描述的存在情况有条件地呈现。

你知道riad
你知道riad 检验过的 2020年6月11日
查看已审阅的更改
复制链接
贡献者

@你知道riad 你知道riad 留下了评论

选择隐藏此评论的原因

将显示原因，以便向其他人描述此评论。了解更多信息.

我觉得这很好。我很感激@恩里克桑切斯的评论

@卡罗来纳州人
复制链接
贡献者 作者

您对将“title”重命名为label，匹配register_block_style有何感想？它需要成为一个单独的问题吗？

@你知道riad
复制链接
贡献者

我们也有块的“标题”，所以似乎不一致已经存在。

@卡罗来纳州人
添加“做错事”消息
851113c个 
为所需属性添加doing_it_errors消息。向块图案添加描述。使用描述和viewportWidth更新文档。
你知道riad
你知道riad 检验过的 2020年6月11日
查看已审阅的更改
docs/designers-developers/developers/block-api/block-patterns.md 过时的
@@-15,16+15,19@@`register_block_pattern`函数接收模式名称作为fi
图案的属性包括：
-`title`（必填）：模式的可读标题。
-`content`（必填）：模式的原始HTML内容。
-`description`（必填）：模式的描述。用于描述插入器中的图案。
复制链接
贡献者

选择隐藏此评论的原因

将显示原因，以便向其他人描述此评论。了解更多信息.

我个人对是否需要这样做犹豫不决。我认为这不应该是因为许多现有模式都没有它，我们应该回到标题上来。有时标题足够描述性。

复制链接
贡献者

选择隐藏此评论的原因

将显示原因，以便向其他人描述此评论。了解更多信息.

有没有一种方法不需要它，但真正得到鼓励？

复制链接
贡献者

选择隐藏此评论的原因

将显示原因，以便向其他人描述此评论。了解更多信息.

嗯，我不知道，如果我们可能找不到消息，我们可以通过控制台记录消息，但我们以前从未这样做过，它可能非常冗长。但我想不出办法。

复制链接
贡献者 作者

选择隐藏此评论的原因

将显示原因，以便向其他人描述此评论。了解更多信息.

唯一关心的是与现有模式的兼容性吗？因为函数刚刚重命名，那么，开发人员必须做出更改，为什么添加描述是一个更大的问题？

复制链接
贡献者

选择隐藏此评论的原因

将显示原因，以便向其他人描述此评论。了解更多信息.

我已经考虑了很多，我仍然认为它不应该是强制性的。有些模式具有足够的描述性，API应该尽可能简单易用。

然而，对潜在的Patterns目录/存储库进行强制是一个单独的问题，我认为这在那里是不同的。

复制链接
贡献者 作者

选择隐藏此评论的原因

将显示原因，以便向其他人描述此评论。了解更多信息.

但我认为这就是问题所在，如果你看不到这些模式，它们就不是描述性的。
目前，标题或内容都不是必需的，尽管文档中说它们是必需的。
如果没有标题，屏幕阅读器只能宣布“按钮”。

添加描述比添加类别更直接（尤其是在注册类别时）。

@恩里克桑切斯
复制链接
贡献者

这是一个很棒的公关，@卡罗来纳州人! 已使用VoiceOver+Safari进行测试，工作正常。你添加的描述非常详细，很容易描绘出图案。

@你知道riad
复制链接
贡献者

我们如何将此PR推进到5.5中

@恩里克桑切斯
复制链接
贡献者

如果能将其包含在5.5中并进行更新以反映#23608.

在合并之前还有什么要做的吗？

@你知道riad
复制链接
贡献者

我个人希望删除强制性方面，以包括此处所述的内容#23070（评论）特别是因为我们在5.5过程中较晚，到目前为止人们可能已经创建了很多模式。

@卡罗来纳州人
复制链接
贡献者 作者

因此，为了总结周五无障碍团队会议期间的讨论：
需要标题。
强烈建议进行说明。

#23608需要首先合并，以便模式列表是最新的。

@卡罗来纳州人
合并拉取请求 #8 来自WordPress/master
02d507页 
与主机同步
@卡罗来纳州人
尝试解决合并冲突
第1页，共2603页 
试图解决与插入器更新的合并冲突
@卡罗来纳州人
合并拉取请求 #9 来自卡罗来纳州/马斯特
a336d2e型 
与主服务器同步
@卡罗来纳州人
不再需要描述
第52页第8页第64页 
删除对模式注册表中描述属性的检查。更新文档，以显示鼓励而非必需的描述。
@卡罗来纳州人
将描述添加到块图案列表
a4bef7a之前 
将描述添加到块图案列表中。如果描述存在，则在标题后输出可视隐藏的描述。
@卡罗来纳州人
更新block-patterns.md
功能8c4310 
更新了viewportWidth描述中的措辞。
@你知道riad
复制链接
贡献者

@卡罗来纳州人听起来不错👍

#23608年合并后，您有时间刷新PR以包括在今天的RC中吗？

你知道riad
你知道riad 检验过的 2020年7月6日
查看已审阅的更改
lib/class-wp块模式注册.php
$message=__（'模式内容必须是字符串。'，'gutenberg'）；
_doing_it_error（__METHOD_，$message，'8.5.0'）；
返回false；
}
复制链接
贡献者

选择隐藏此评论的原因

将显示原因，以便向其他人描述此评论。了解更多信息.

此处的更改需要专用的Core补丁。

复制链接
贡献者 作者

选择隐藏此评论的原因

将显示原因，以便向其他人描述此评论。了解更多信息.

我不知道在哪里上传：）https://core.trac.wordpress.org/attachment/ticket/50550/50550-doing-it-wrong.patch

你知道riad
你知道riad 批准了这些更改 2020年7月6日
查看已审阅的更改
复制链接
贡献者

@你知道riad 你知道riad 留下了评论

选择隐藏此评论的原因

将显示原因，以便向其他人描述此评论。了解更多信息.

看起来很棒。谢谢@卡罗来纳州人

@你知道riad 你知道riad合并提交咖啡铁进入之内 WordPress（文字出版社）:主人 2020年7月6日
@github-操作 github-操作 机器人程序补充这个首次贡献者 Gutenberg存储库的首次贡献者打开的Pull请求标签2020年7月6日
@github-操作 github-操作 机器人程序将此添加到古腾堡8.5里程碑2020年7月6日
@你知道riad
复制链接
贡献者

我合并得太快，没有重新编写提交消息。我想这次没问题：）。

免费注册 在GitHub上加入此对话.已经有账户了吗？登录以发表评论
审阅者

@恩里克桑切斯 恩里克桑切斯 enriquesanchez留下评论

@你知道riad 你知道riad 你知道riad批准了这些更改

@埃拉特里克斯 埃拉特里克斯 等待ellatrix的审查请求

@spacedmonkey（空格键） spacedmonkey（空格键） 等待spacedmonkey要求的审查

@蒂莫西·巴科布斯 蒂莫西·巴科布斯 等待Timothy Bjacobs的审查请求

@阿吉博拉 阿吉博拉 等待ajitbohra要求的审查

@克里斯万帕顿 克里斯万帕顿 等待chrisvanpatten的审查请求

@姆卡兹 姆卡兹 等待mkaz要求的审查

受让人
未分配人员
标签
首次贡献者 Gutenberg存储库的首次贡献者打开的Pull请求
项目
还没有
里程碑
古腾堡8.5
开发

成功合并此拉取请求可能会解决这些问题。

将“description”属性添加到块模式
3名参与者
@卡罗来纳州人 @你知道riad @恩里克桑切斯