インストール

モジュールをインストールします:

  1. npm install @wordpress/react-i18n

このパッケージは、あなたのコードがES2015+環境で実行されることを前提としています。そのような言語機能やAPIのサポートが限られているか、まったくない環境を使用している場合は、コードに@wordpress/babel-preset-defaultで提供されるポリフィルを含める必要があります。

API

I18nProvider

  1. *使用法*
  2. ``````bash
  3. import { createI18n } from '@wordpress/i18n';
  4. import { I18nProvider } from '@wordpress/react-i18n';
  5. const i18n = createI18n();
  6. ReactDom.render(
  7. <I18nProvider i18n={ i18n }>
  8. <App />
  9. </I18nProvider>,
  10. el
  11. );
  12. `
  1. デフォルトの`````I18n`````インスタンスが`````@wordpress/i18n`````からエクスポートされます。
  2. *パラメータ*
  3. - props `````I18nProviderProps`````: i18nプロバイダーのプロパティ。
  4. *戻り値*
  5. - `````JSX.Element`````: I18nProviderでラップされた子要素。
  6. <a name="usei18n"></a>
  7. ### useI18n
  8. i18n関数へのアクセスを提供するReactフックです。[`````@wordpress/i18n`````](https://developer.wordpress.org/block-editor/reference-guides/packages/i18n)から``````````、`````_x`````、`````_n`````、`````_nx`````、`````isRTL`````、および`````hasTranslation`````関数を公開します。そちらのドキュメントを参照してください。
  9. *使用法*
  10. ``````bash
  11. import { useI18n } from '@wordpress/react-i18n';
  12. function MyComponent() {
  13. const { __ } = useI18n();
  14. return __( 'Hello, world!' );
  15. }
  16. `

withI18n

i18n翻訳関数(useI18nフックによって公開されるのと同じセット)をラップされたコンポーネントにプロパティとして渡すReact高階コンポーネントです。

使用法

  1. import { withI18n } from '@wordpress/react-i18n';
  2. function MyComponent( { __ } ) {
  3. return __( 'Hello, world!' );
  4. }
  5. export default withI18n( MyComponent );

パラメータ

  • InnerComponent ComponentType< P >: ラップされ、``````````のようなi18n関数を受け取るReactコンポーネント

戻り値

  • FunctionComponent< PropsAndI18n< P > >: ラップされたコンポーネント

このパッケージへの貢献

これはGutenbergプロジェクトの一部である個別のパッケージです。このプロジェクトはモノレポとして整理されています。特定の目的を持つ複数の自己完結型ソフトウェアパッケージで構成されています。このモノレポ内のパッケージは、https://www.npmjs.com/に公開され、https://make.wordpress.org/core/や他のソフトウェアプロジェクトで使用されています。

このパッケージやGutenberg全体への貢献について詳しく知りたい場合は、プロジェクトの主要なhttps://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.mdをお読みください。