useLocale - sunpeak

sunpeak API

Overview

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

Wraps onhostcontextchanged

MCP Apps SDK reference

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>;
}

The locale value comes from McpUiHostContext.locale.

useOpenLinkOpen external links.

​Overview

Wraps onhostcontextchanged

​Import

​Signature

​Returns

​Usage

Overview

Import

Signature

Returns

Usage