Skip to main content

​
Overview

The useLocale hook returns the user’s locale string from the host. It is a convenience wrapper around useHostContext.

​
Import

import { useLocale } from 'sunpeak';

​
Signature

function useLocale(): string

​
Returns

​
return
string
BCP 47 locale string (e.g., 'en-US'). Defaults to 'en-US' when unavailable.

​
Usage

import { useLocale } from 'sunpeak';

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

  const formatted = new Intl.NumberFormat(locale).format(1234.56);
  return <p>{formatted}</p>;
}