fn

usePreferredLanguages

v0.0.14testeddemo

Reactive navigator.languages. Tracks the user's preferred languages and updates automatically whenever the browser emits a languagechange event. Falls back to ['en'] during SSR or when no window is available, so the returned value is always a non-empty array.

Examples

ts
const languages = usePreferredLanguages();
// -> ['en-US', 'en', 'fr']
ts
// Pass a custom window (e.g. an iframe)
const languages = usePreferredLanguages({ window: iframe.contentWindow });

Demo

Loading demo…

Signature

ts
export function usePreferredLanguages(options: ConfigurableWindow ={ ... }

Parameters

ParameterTypeDescription
options?ConfigurableWindowOptions

Returns

ShallowRef<readonly string[]>Reactive list of the user's preferred languages