函数获取

    Intlayer 允许您在内容模块中声明内容函数,这些函数可以是同步的或异步的。当应用程序构建时,Intlayer 执行这些函数以获取函数的结果。返回值必须是一个 JSON 对象或一个简单值,如字符串或数字。

    警告:函数获取目前不支持在 JSON 内容声明和远程内容声明文件中。

    函数声明

    下面是一个简单同步函数获取内容的示例:

    **/*.content.ts
    import type { DeclarationContent } from "intlayer";const functionContent = {  key: "function_content",  content: {    text: () => "这是由函数渲染的内容",  },} satisfies DeclarationContent;export default functionContent;

    在这个示例中,text 键包含一个返回字符串的函数。这个内容可以通过使用 Intlayer 的解释器包(如 react-intlayer)在您的 React 组件中渲染。

    异步函数获取

    除了同步函数,Intlayer 还支持异步函数,允许您从外部来源获取数据或用模拟数据模拟数据检索。

    下面是一个模拟服务器获取的异步函数的示例:

    **/*.content.ts
    import { setTimeout } from "node:timers/promises";import type { DeclarationContent } from "intlayer";const fakeFetch = async (): Promise<string> => {  // 等待 200 毫秒以模拟从服务器获取数据  return await setTimeout(200).then(() => "这是从服务器获取的内容");};const asyncFunctionContent = {  key: "async_function",  content: { text: fakeFetch },} satisfies DeclarationContent;export default asyncFunctionContent;

    在这种情况下,fakeFetch 函数模拟延迟以模拟服务器响应时间。Intlayer 执行异步函数并使用结果作为 text 键的内容。

    在 React 组件中使用基于函数的内容

    要在 React 组件中使用基于函数的内容,您需要从 react-intlayer 导入 useIntlayer 并使用内容 ID 调用它以检索内容。下面是一个示例:

    **/*.jsx
    import type { FC } from "react";import { useIntlayer } from "react-intlayer";const MyComponent: FC = () => {  const functionContent = useIntlayer("function_content");  const asyncFunctionContent = useIntlayer("async_function_content");  return (    <div>      <p>{functionContent.text}</p>      {/* 输出:这是由函数渲染的内容 */}      <p>{asyncFunctionContent.text}</p>      {/* 输出:这是从服务器获取的内容 */}    </div>  );};export default MyComponent;

    如果您有改善此文档的想法,请随时通过在GitHub上提交拉取请求来贡献。

    文档的 GitHub 链接