⬅️ Back to Table of Contents

📄 usePreferredLanguages

📊 Analysis Summary

Metric	Count
🔧 Functions	1
📦 Imports	5

📚 Table of Contents

• Imports
• Functions

🛠️ File Location:

📂 packages/core/usePreferredLanguages/index.ts

📦 Imports

Name	Source
ShallowRef	vue
ConfigurableWindow	../_configurable
shallowRef	vue
defaultWindow	../_configurable
useEventListener	../useEventListener

---

Functions

usePreferredLanguages(options: ConfigurableWindow): ShallowRef<readonly string[]>

Reactive Navigator Languages.

Parameters:

• options any: No description

See: https://vueuse.org/usePreferredLanguages

Tags: @__NO_SIDE_EFFECTS__

Raw JSDoc

/**
 * Reactive Navigator Languages.
 *
 * @see https://vueuse.org/usePreferredLanguages
 * @param options
 *
 * @__NO_SIDE_EFFECTS__
 */

Calls:

• shallowRef (from vue)
• useEventListener (from ../useEventListener)

Code

export function usePreferredLanguages(options: ConfigurableWindow = {}): ShallowRef<readonly string[]> {
  const { window = defaultWindow } = options
  if (!window)
    return shallowRef(['en'])

  const navigator = window.navigator
  const value = shallowRef<readonly string[]>(navigator.languages)

  useEventListener(window, 'languagechange', () => {
    value.value = navigator.languages
  }, { passive: true })

  return value
}

---

Generated by Syntax Scribe