React リファレンス
Ways
Root props
共通のルートプロパティ:
| プロップ | タイプ | ノート |
|---|---|---|
apiKey | 文字列 | 必須です。 |
ロケール | 文字列 | 現在のターゲットロケール。 |
baseLocale | 文字列 | ソースロケール。 |
persistLocaleCookie | ブール | ルートランタイムのデフォルトのロケールクッキーポリシー。 |
コンテキスト | 文字列 | オブジェクト | オプションのルートコンテキスト。 |
cacheTtl | 番号 | 翻訳リクエストのキャッシュTTL。 |
メッセージフォーマッター | 'waysParser' | 'none' | fn | パーサーまたはフォーマッターのオーバーライド。 |
suspenseTimeoutMs | 番号 | フォールバックレンダリングが継続される前に許容される最大レンダーブロック時間。 |
フェッチャー | fetchの型 | カスタムフェッチ実装。 |
acceptedLocales | 文字列[] | オプションの明示的なロケールリスト。 |
Scoped props
ネストされたスコープは受け入れます:
| プロップ | タイプ | ノート |
|---|---|---|
コンテキスト | 文字列 | オブジェクト | 必須です。 |
ロケール | 文字列 | 利用可能ですが、分離されたロケールセッションにはネストされたルートを使用してください。 |
baseLocale | 文字列 | サブツリーに対するオプションのソースロケールの上書き。 |
コンポーネント | Record<string, component> | 翻訳可能なコンテンツ内で使用されるコンポーネント。 |
T
T は JSX 優先の翻訳プリミティブです。
| プロップ | タイプ | ノート |
|---|---|---|
子供たち | ReactNode | 必須です。 |
vars | Record<string, unknown> | 補間入力。 |
コンテキスト | 文字列 | オブジェクト | オプションのリーフコンテキストのオーバーライド。 |
コンポーネント | Record<string, component> | リッチコンテンツのためのコンポーネントマッピング。 |
固定 | ブール | 固定されたブランドのようなコンテンツの翻訳をスキップします。 |
useT()
useT() は、文字列、属性、およびロジックのための翻訳関数を返します。
const t = useT();
const label = t('Save changes');ランタイムフック
useTranslatedMemo()
翻訳が変更されると再計算されるメモ化された値。
useTranslationLoading()
現在のコンテキストがまだ読み込まれている間は true を返します。
useCurrentLocale()
現在のルートランタイムの選択されたロケールを読み取ります。
useTargetLocale()
現在のスコープに対する、アクティブなターゲットロケールを読み取ります。
useBaseLocale()
現在のルートランタイムのソースロケールを読み取ります。
useSetCurrentLocale()
ルートランタイムロケールのセッターを返します。
useAcceptedLocales()
ルートランタイムから解決済みの承認ロケール一覧を読み取ります。
LanguageSwitcher
共通のプロパティ:
| プロップ | タイプ | ノート |
|---|---|---|
currentLocale | 文字列 | 制御されたロケール。 |
onLocaleChange | (ロケール) => void | 変更ハンドラー。 |
方向 | '上' | '下' | メニューの方向。 |
スタイル / クラス名 | オブジェクト | スタイリングのオーバーライド。 |
スタイルなし | ブール | 組み込みスタイルを無効にします。 |
Utility exports
@18ways/react は次のものも再エクスポートします:
fetchAcceptedLocalesfetchConfigresolveOrigin