Boltdocs Logo
GuíasIntegracionesAPIPluginsComponentes
  1. Home
  2. ChevronRightHooks
  3. ChevronRightuseI18n

useI18n

Administrar y cambiar entre diferentes idiomas/regiones.

El hook useI18n retorna detalles sobre la región activa de la documentación, lista los idiomas disponibles definidos en boltdocs.config.ts, y proporciona una función auxiliar para cambiar la región activa.

ImportaciónLink

import { useI18n } from 'boltdocs/client'

Esquema de RespuestaLink

El hook retorna los siguientes parámetros del objeto:

interface UseI18nReturn {
  currentLocale: string | undefined      // The active language locale string (e.g. 'en', 'es')
  currentLocaleLabel: string | undefined // The human-readable label of the active language
  availableLocales: LocaleOption[]       // List of all locales configured in the workspace
  handleLocaleChange: (locale: string) => void // Navigates and re-routes to the targeted locale
}

interface LocaleOption {
  key: string                            // Locale key matching directory naming (e.g. 'en')
  label: string                          // Human-readable language descriptor (e.g. 'English')
  value: string                          // Matching routing path prefix
  isCurrent: boolean                     // True if this option is the active locale
}

Ejemplo de UsoLink

A continuación se muestra un componente de selección de idioma de referencia construido con botones personalizados y el hook useI18n:

import React, { useState } from 'react'
import { useI18n } from 'boltdocs/client'

export default function LanguageSelector() {
  const { currentLocaleLabel, availableLocales, handleLocaleChange } = useI18n()
  const [isOpen, setIsOpen] = useState(false)

  if (availableLocales.length <= 1) return null

  return (
    <div className="relative inline-block text-left">
      <button
        onClick={() => setIsOpen(!isOpen)}
        className="px-3 py-1.5 border rounded-lg text-sm bg-surface hover:bg-zinc-50 dark:hover:bg-zinc-900 transition-colors"
      >
        Language: <span className="font-semibold">{currentLocaleLabel}</span>
      </button>

      {isOpen && (
        <div className="absolute right-0 mt-2 w-48 border rounded-lg bg-surface shadow-lg z-50 p-1 flex flex-col gap-1">
          {availableLocales.map((loc) => (
            <button
              key={loc.key}
              onClick={() => {
                handleLocaleChange(loc.key)
                setIsOpen(false)
              }}
              className={`w-full text-left px-3 py-2 text-xs rounded-md transition-colors ${
                loc.isCurrent
                  ? 'bg-primary-500/10 text-primary-600 font-semibold'
                  : 'hover:bg-zinc-100 dark:hover:bg-zinc-800'
              }`}
            >
              {loc.label}
            </button>
          ))}
        </div>
      )}
    </div>
  )
}
Last updated on July 27, 2026

Was this page helpful?