expo-localization/build/Localization.types.d.ts

Provides an interface for native user localization information.

export type Locale = {
    /**
     * An [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) with a region code.
     * @example
     * `'en-US'`, `'es-419'`, `'pl-PL'`.
     */
    languageTag: string;
    /**
     * An [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) without the region code.
     * @example
     * `'en'`, `'es'`, `'pl'`.
     */
    languageCode: string | null;
    /**
     * An [ISO 15924](https://en.wikipedia.org/wiki/ISO_15924) 4-letter script code. On Android and Web, it may be `null` if none is defined.
     * @example
     * `'Latn'`, `'Hans'`, `'Hebr'`.
     */
    languageScriptCode: string | null;
    /**
     * The region code for your device that comes from the Region setting under Language & Region on iOS, Region settings on Android and is parsed from locale on Web (can be `null` on Web).
     * @example
     * `'US'`.
     */
    regionCode: string | null;
    /**
     * The region code for the preferred language. When the language is not region-specific, it returns the same value as `regionCode`. When the language is region-specific, it returns the region code for the language (`en-CA` -> `CA`).
     * Prefer using `regionCode` for any internalization purposes.
     * @example
     * `'US'`.
     */
    languageRegionCode: string | null;
    /**
     * Currency code for the locale.
     * On iOS, it's the currency code from the `Region` setting under Language & Region, not for the current locale.
     * On Android, it's the currency specifc to the locale in the list, as there are no separate settings for selecting a region.
     * Is `null` on Web, use a table lookup based on region instead.
     * @example
     * `'USD'`, `'EUR'`, `'PLN'`.
     */
    currencyCode: string | null;
    /**
     * Currency symbol for the currency specified by `currencyCode`.
     * @example
     * `'$'`, `'€'`, `'zł'`.
     */
    currencySymbol: string | null;
    /**
     * Currency code for the locale.
     * On iOS, it's the currency code for the current locale in the list, not the device region.
     * On Android, it's equal to `currencyCode`.
     * Is `null` on Web.
     * Prefer using `currencyCode` for any internalization purposes.
     * @example
     * `'USD'`, `'EUR'`, `'PLN'`.
     */
    languageCurrencyCode: string | null;
    /**
     * Currency symbol for the currency specified by `languageCurrencyCode`.
     * Prefer using `currencySymbol` for any internalization purposes.
     * @example
     * `'$'`, `'€'`, `'zł'`.
     */
    languageCurrencySymbol: string | null;
    /**
     * Decimal separator used for formatting numbers with fractional parts.
     * @example
     * `'.'`, `','`.
     */
    decimalSeparator: string | null;
    /**
     * Digit grouping separator used for formatting large numbers.
     * @example
     * `'.'`, `','`.
     */
    digitGroupingSeparator: string | null;
    /**
     * Text direction for the locale. One of: `'ltr'`, `'rtl'`.
     */
    textDirection: 'ltr' | 'rtl';
    /**
     * The measurement system used in the locale.
     * Is `null` on Web, as user chosen measurement system is not exposed on the web and using locale to determine measurement systems is unreliable.
     * Ask for user preferences if possible.
     */
    measurementSystem: `metric` | `us` | `uk` | null;
    /**
     * The temperature unit used in the locale.
     * Returns `null` if the region code is unknown.
     */
    temperatureUnit: 'celsius' | 'fahrenheit' | null;
};
/**
 * An enum mapping days of the week in Gregorian calendar to their index as returned by the `firstWeekday` property.
 */
export declare enum Weekday {
    SUNDAY = 1,
    MONDAY = 2,
    TUESDAY = 3,
    WEDNESDAY = 4,
    THURSDAY = 5,
    FRIDAY = 6,
    SATURDAY = 7
}
/**
 * The calendar identifier, one of [Unicode calendar types](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Locale/calendar).
 * Gregorian calendar is aliased and can be referred to as both `CalendarIdentifier.GREGORIAN` and `CalendarIdentifier.GREGORY`.
 */
export declare enum CalendarIdentifier {
    /** Thai Buddhist calendar */
    BUDDHIST = "buddhist",
    /** Traditional Chinese calendar */
    CHINESE = "chinese",
    /** Coptic calendar */
    COPTIC = "coptic",
    /** Traditional Korean calendar */
    DANGI = "dangi",
    /** Ethiopic calendar, Amete Alem (epoch approx. 5493 B.C.E) */
    ETHIOAA = "ethioaa",
    /** Ethiopic calendar, Amete Mihret (epoch approx, 8 C.E.) */
    ETHIOPIC = "ethiopic",
    /** Gregorian calendar */
    GREGORY = "gregory",
    /** Gregorian calendar (alias) */
    GREGORIAN = "gregory",
    /** Traditional Hebrew calendar */
    HEBREW = "hebrew",
    /** Indian calendar */
    INDIAN = "indian",
    /** Islamic calendar */
    ISLAMIC = "islamic",
    /** Islamic calendar, tabular (intercalary years [2,5,7,10,13,16,18,21,24,26,29] - civil epoch) */
    ISLAMIC_CIVIL = "islamic-civil",
    /** Islamic calendar, Saudi Arabia sighting */
    ISLAMIC_RGSA = "islamic-rgsa",
    /**Islamic calendar, tabular (intercalary years [2,5,7,10,13,16,18,21,24,26,29] - astronomical epoch) */
    ISLAMIC_TBLA = "islamic-tbla",
    /** Islamic calendar, Umm al-Qura */
    ISLAMIC_UMALQURA = "islamic-umalqura",
    /** ISO calendar (Gregorian calendar using the ISO 8601 calendar week rules) */
    ISO8601 = "iso8601",
    /** Japanese imperial calendar */
    JAPANESE = "japanese",
    /** Persian calendar */
    PERSIAN = "persian",
    /** Civil (algorithmic) Arabic calendar */
    ROC = "roc"
}
export type Calendar = {
    /**
     * The calendar identifier, one of [Unicode calendar types](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Locale/calendar).
     *
     * On Android is limited to one of device's [available calendar types](https://developer.android.com/reference/java/util/Calendar#getAvailableCalendarTypes()).
     *
     * On iOS uses [calendar identifiers](https://developer.apple.com/documentation/foundation/calendar/identifier), but maps them to the corresponding Unicode types, will also never contain `'dangi'` or `'islamic-rgsa'` due to it not being implemented on iOS.
     */
    calendar: CalendarIdentifier | null;
    /**
     * True when current device settings use 24-hour time format.
     * Can be null on some browsers that don't support the [hourCycle](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Locale/hourCycle) property in [Intl](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl) API.
     */
    uses24hourClock: boolean | null;
    /**
     * The first day of the week. For most calendars Sunday is numbered `1`, with Saturday being number `7`.
     * Can be null on some browsers that don't support the [weekInfo](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Locale/weekInfo) property in [Intl](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl) API.
     * @example
     * `1`, `7`.
     */
    firstWeekday: Weekday | null;
    /**
     * Time zone for the calendar. Can be `null` on Web.
     * @example
     * `'America/Los_Angeles'`, `'Europe/Warsaw'`, `'GMT+1'`.
     */
    timeZone: string | null;
};
//# sourceMappingURL=Localization.types.d.ts.map