インストール
モジュールをインストールします:
npm install @wordpress/react-i18n
このパッケージは、あなたのコードがES2015+環境で実行されることを前提としています。そのような言語機能やAPIのサポートが限られているか、まったくない環境を使用している場合は、コードに@wordpress/babel-preset-default
で提供されるポリフィルを含める必要があります。
API
I18nProvider
*使用法*
``````bash
import { createI18n } from '@wordpress/i18n';
import { I18nProvider } from '@wordpress/react-i18n';
const i18n = createI18n();
ReactDom.render(
<I18nProvider i18n={ i18n }>
<App />
</I18nProvider>,
el
);
`
デフォルトの`````I18n`````インスタンスが`````@wordpress/i18n`````からエクスポートされます。
*パラメータ*
- props `````I18nProviderProps`````: i18nプロバイダーのプロパティ。
*戻り値*
- `````JSX.Element`````: I18nProviderでラップされた子要素。
<a name="usei18n"></a>
### useI18n
i18n関数へのアクセスを提供するReactフックです。[`````@wordpress/i18n`````](https://developer.wordpress.org/block-editor/reference-guides/packages/i18n)から``````````、`````_x`````、`````_n`````、`````_nx`````、`````isRTL`````、および`````hasTranslation`````関数を公開します。そちらのドキュメントを参照してください。
*使用法*
``````bash
import { useI18n } from '@wordpress/react-i18n';
function MyComponent() {
const { __ } = useI18n();
return __( 'Hello, world!' );
}
`
withI18n
i18n翻訳関数(useI18n
フックによって公開されるのと同じセット)をラップされたコンポーネントにプロパティとして渡すReact高階コンポーネントです。
使用法
import { withI18n } from '@wordpress/react-i18n';
function MyComponent( { __ } ) {
return __( 'Hello, world!' );
}
export default withI18n( MyComponent );
パラメータ
- InnerComponent
ComponentType< P >
: ラップされ、``````````のようなi18n関数を受け取るReactコンポーネント
戻り値
このパッケージへの貢献
これはGutenbergプロジェクトの一部である個別のパッケージです。このプロジェクトはモノレポとして整理されています。特定の目的を持つ複数の自己完結型ソフトウェアパッケージで構成されています。このモノレポ内のパッケージは、https://www.npmjs.com/に公開され、https://make.wordpress.org/core/や他のソフトウェアプロジェクトで使用されています。
このパッケージやGutenberg全体への貢献について詳しく知りたい場合は、プロジェクトの主要なhttps://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.mdをお読みください。