我们使用MDXJS包在 Markdown 中编写内容,并在其中使用 React 组件。
有没有办法在 MDX / Markdown 文件中使用i18next / react-i18next包?
我们使用MDXJS包在 Markdown 中编写内容,并在其中使用 React 组件。
有没有办法在 MDX / Markdown 文件中使用i18next / react-i18next包?
i18next
在里面使用MDX
:导入MDX
文件时,只需将其用作任何其他 React 组件:
import { default as SomeContent } from './some-content.mdx';
...
<SomeContent />
因此,您还可以传递一些道具,在这种情况下是t
函数,并在内部以一些特定的方式使用它:
import { default as SomeContent } from './some-content.mdx';
export const SomeComponent: React.FC = React.memo((props) => {
const { t } = useTranslation();
return (
<SomeContent t={ t } someProp="Some value" />
);
});
如果您想检查这是否有效或查看MDX
文件中可以访问哪些道具,请在其中添加:
<pre>{ JSON.stringify(props, null, ' ') }</pre>
<pre>{ typeof props.t }</pre>
对于上面的示例,它将显示:
{"someProp":"Some value"}
function
请注意,您不能在“原始”MD
元素中使用这些道具,即使您在它们周围添加了包装器:
### Doesn't work: { props.t('some.translation') }
Doesn't work: { props.t('some.translation') }.
Doesn't work: <>{ props.t('some.translation') }</>.
Doesn't work: <Fragment>{ props.t('some.translation') }</Fragment>.
Doesn't work: <span>{ props.t('some.translation') }</span>.
所以你必须写HTML
标签:
<h3>Works: { props.t('some.translation') }</h3>
<p>Works: { props.t('some.translation') }.</p>
<p>Works: <>{ props.t('some.translation') }</>.</p>
<p>Works: <Fragment>{ props.t('some.translation') }</Fragment>.</p>
<p>Works: <span>{ props.t('some.translation') }</span>.</p>
MDX
在中使用i18next
:如果您在配置中设置returnObjects: true
,i18next
您还可以MDX
在翻译文件中添加组件:
import { default as ContentEN } from './content.en.mdx';
import { default as ContentES } from './content.es.mdx';
i18next.use(initReactI18next).init({
resources: {
en: {
translation: {
content: ContentEN,
},
},
es: {
translation: {
content: ContentES,
},
},
},
returnObjects: true,
}));
然后你会在你的任何组件中像这样使用它(是的,你也可以t
像以前一样传递 down 或任何其他道具:
export const SomeComponent: React.FC = React.memo((props) => {
const { t } = useTranslation();
const Content = t('content');
return (
<Content t={ t } someProp="Some value" />
);
});
i18next
在里面使用@mdx-js/runtime
:如果您正在使用@mdx-js/runtime
,那么您将传递您的道具scope
:
import { default as SomeContent } from './some-content.mdx';
export const SomeComponent: React.FC = React.memo((props) => {
const { t } = useTranslation();
return (
<MDX components={ ... } scope={ { t, someProp: 'Some value' } }>{ props.mdx }</MDX>
);
});