Skip to main content

​
Overview

The useLocale hook returns the user’s current locale (language and region).

​
Import

import { useLocale } from 'sunpeak';

​
Signature

function useLocale(): string | null

​
Returns

A locale string (e.g., 'en-US', 'fr-FR', 'ja-JP'), or null if not available.

​
Usage

import { useLocale } from 'sunpeak';

function MyWidget() {
  const locale = useLocale();

  return (
    <div>
      Current locale: {locale || 'Unknown'}
    </div>
  );
}