@graphcms/html-to-slate-ast (英语)
HTML 到Hygraph 的 RichTextAST 格式的 Slate AST 转换器.
QQ 此转换器输出Hygraph 中使用的 Slate AST 的自定义风味, 并且很可能不会输出一个与您自己的 Slate 执行相容的输出 。 但可以随意把它叉出并适应你的需要.
使用量
说明: 如果使用这个带Node.js的软件包,则需要使用18版或更高版本.
1. 安装
这个软件包需要有软件包 slate 财务报告和审定财务报表 slate-hyperscript 已安装,以及 jsdom 也可以在节点中运行转换器.
npm install [email protected] [email protected] @graphcms/html-to-slate-ast
# for Node.js or isomorphic usage, jsdom is required
npm install jsdom
2. 转换数据
如果你正在使用节点J, 你需要使用 htmlToSlateAST 函数,返回 a 答应如果您正在浏览器中使用此软件包,您可以使用 htmlToSlateASTSync 函数,它是同步的,不需要 jsdom。 。 。 .
import { htmlToSlateAST } from '@graphcms/html-to-slate-ast';
// Or if you are using this package in the browser
import { htmlToSlateASTSync } from '@graphcms/html-to-slate-ast';
async function main() {
const htmlString = '<div><p>test</p></div>'; // or import from a file or database
const ast = await htmlToSlateAST(htmlString);
console.log(JSON.stringify(ast, null, 2));
}
main()
.then(() => process.exit(0))
.catch(e => console.error(e));
3. 在内容 API 变异中使用它
这种对话的输出与我们 RichTextAST GraphQL 类型并可用于导入您丰富的文本字段的内容。 以下是一个变异的例子:
mutation newArticle($title: String!, $content: RichTextAST) {
createArticle(data: { title: $title, content: $content }) {
id
title
content {
html
raw
}
}
}
生成的产出 htmlToSlateAST 将代表 children 数组 会 议 日 程 和 议 程 列表编辑器对象然而,在创建或更新 Rich 文本字段的值时,您正在设定编辑器节点本身的值。 这意味着输出应该被转化为富文本兼容对象,例如:
const data = await client.request(newArticleQuery, {
title: 'Example title for an article',
content: { children: ast },
});
这里,在Slate方面, $content 是编辑器节点,所以 $ast 数组必须指定为 children 键。 如果你不把它交给 children 键,该变异将因以下错误而失败.
ClientError: could not transform richText: Values should be an array of objects containing raw rich text values.
您可以使用 图克- 请求 将数据转换为 Hygraph 这里。 。 。 .
见关于 丰富的文本字段类型 财务报告和审定财务报表 内容 Api 变异。 。 。 .
许可证
根据麻省理工学院的许可.
由Hygraph制作 加入我们的社区来啊!