React 參考

Ways

Root props

共通根屬性:

道具類型備註
apiKey字串必填。
區域設定字串當前目標語言環境。
baseLocale字串來源語言。
persistLocaleCookie布林值根運行時的默認區域設置 cookie 政策。
上下文字串 | 物件可選的根上下文。
cacheTtl數字翻譯請求的快取有效時間(TTL)。
messageFormatter'waysParser' | 'none' | fn解析器或格式化器覆蓋。
fetchertypeof fetch自訂的擷取實作。
acceptedLocales字串[]可選的明確地區列表。

Scoped props

嵌套範圍接受:

道具類型備註
上下文字串 | 物件必填。
區域設定字串可選的地區覆蓋。
baseLocale字串可選的基本區域設置覆蓋。
組件Record<string, component>可在可翻譯內容中使用的組件。

T

T 是 JSX 優先的翻譯原始碼。

道具類型備註
孩子ReactNode必填。
變數Record<string, unknown>插值輸入。
上下文字串 | 物件可選的葉子上下文覆蓋。
組件Record<string, component>豐富內容的組件映射。
固定布林值跳過固定品牌類內容的翻譯。

useT()

useT() 返回一個用於字符串、屬性和邏輯的翻譯函數。

tsx
const t = useT();
const label = t('Save changes');

運行時鉤子

useTranslatedMemo()

一個記憶化的值,當翻譯變更時會重新計算。

useTranslationLoading()

在當前上下文仍在加載時,返回 true

useCurrentLocale()

讀取根執行時區域設定。

useSetCurrentLocale()

返回根運行時區域的設置器。

LanguageSwitcher

常見道具:

道具類型備註
currentLocale字串控制的區域。
onLocaleChange(locale) => void變更處理器。
方向'上' | '下'菜單方向。
樣式 / 類別名稱物件樣式覆蓋。
未樣式化布林值禁用內建樣式。

Utility exports

@18ways/react 也重新導出:

  • fetchAcceptedLocales
  • fetchConfig
  • resolveOrigin