i18next-browser-languagedetector 技术文档

i18next-browser-languagedetector 技术文档

i18next-browser-languageDetector language detector used in browser environment for i18next 项目地址: https://gitcode.com/gh_mirrors/i1/i18next-browser-languageDetector

1. 安装指南

1.1 通过 npm 安装

npm install i18next-browser-languagedetector

1.2 通过 bower 安装

bower install i18next-browser-languagedetector

1.3 手动下载

你可以从 GitHub 仓库 下载源码。

2. 项目使用说明

2.1 基本使用

首先，你需要在你的项目中引入 i18next 和 i18next-browser-languagedetector。

import i18next from 'i18next';
import LanguageDetector from 'i18next-browser-languagedetector';

i18next.use(LanguageDetector).init({
  supportedLngs: ['de', 'en', 'fr'],
  ...i18nextOptions
});

2.2 配置选项

你可以通过 detection 选项来配置语言检测的行为。以下是一些常用的配置选项：

{
  order: ['querystring', 'cookie', 'localStorage', 'sessionStorage', 'navigator', 'htmlTag', 'path', 'subdomain'],
  lookupQuerystring: 'lng',
  lookupCookie: 'i18next',
  lookupLocalStorage: 'i18nextLng',
  lookupSessionStorage: 'i18nextLng',
  lookupFromPathIndex: 0,
  lookupFromSubdomainIndex: 0,
  caches: ['localStorage', 'cookie'],
  excludeCacheFor: ['cimode'],
  cookieMinutes: 10,
  cookieDomain: 'myDomain',
  htmlTag: document.documentElement,
  cookieOptions: { path: '/', sameSite: 'strict' },
  convertDetectedLanguage: (lng) => lng.replace('-', '_')
}

2.3 自定义检测功能

你可以通过实现自定义的检测功能来扩展语言检测的能力。

import LanguageDetector from 'i18next-browser-languagedetector';

const myDetector = {
  name: 'myDetectorsName',
  lookup(options) {
    return 'en';
  },
  cacheUserLanguage(lng, options) {
    // 存储语言
  }
};

const languageDetector = new LanguageDetector();
languageDetector.addDetector(myDetector);

i18next.use(languageDetector).init({
  detection: options,
});

3. 项目API使用文档

3.1 i18next.use(LanguageDetector)

将 LanguageDetector 插件注册到 i18next 实例中。

3.2 LanguageDetector.init(options)

初始化 LanguageDetector 插件，并传入选项配置。

3.3 LanguageDetector.addDetector(detector)

添加自定义的语言检测器。

4. 项目安装方式

4.1 通过 npm 安装

npm install i18next-browser-languagedetector

4.2 通过 bower 安装

bower install i18next-browser-languagedetector

4.3 手动下载

从 GitHub 仓库 下载源码。

---

通过以上文档，你应该能够顺利安装和使用 i18next-browser-languagedetector 插件，并根据需要进行自定义配置和扩展。

i18next-browser-languageDetector language detector used in browser environment for i18next 项目地址: https://gitcode.com/gh_mirrors/i1/i18next-browser-languageDetector