maz-ui
Version:
A standalone components library for Vue.Js 3 & Nuxt.Js 3
102 lines (101 loc) • 12 kB
TypeScript
import { MaybeRefOrGetter } from 'vue';
declare const bcp47Codes: readonly ["af-ZA", "sq-AL", "ar-DZ", "ar-BH", "ar-EG", "ar-IQ", "ar-JO", "ar-KW", "ar-LB", "ar-LY", "ar-MA", "ar-OM", "ar-QA", "ar-SA", "ar-SY", "ar-TN", "ar-AE", "ar-YE", "hy-AM", "Cy-az-AZ", "Lt-az-AZ", "eu-ES", "be-BY", "bg-BG", "ca-ES", "zh-CN", "zh-HK", "zh-MO", "zh-SG", "zh-TW", "zh-CHS", "zh-CHT", "hr-HR", "cs-CZ", "da-DK", "div-MV", "nl-BE", "nl-NL", "en-AU", "en-BZ", "en-CA", "en-CB", "en-IE", "en-JM", "en-NZ", "en-PH", "en-ZA", "en-TT", "en-GB", "en-US", "en-ZW", "et-EE", "fo-FO", "fa-IR", "fi-FI", "fr-BE", "fr-CA", "fr-FR", "fr-LU", "fr-MC", "fr-CH", "gl-ES", "ka-GE", "de-AT", "de-DE", "de-LI", "de-LU", "de-CH", "el-GR", "gu-IN", "he-IL", "hi-IN", "hu-HU", "is-IS", "id-ID", "it-IT", "it-CH", "ja-JP", "kn-IN", "kk-KZ", "kok-IN", "ko-KR", "ky-KZ", "lv-LV", "lt-LT", "mk-MK", "ms-BN", "ms-MY", "mr-IN", "mn-MN", "nb-NO", "nn-NO", "pl-PL", "pt-BR", "pt-PT", "pa-IN", "ro-RO", "ru-RU", "sa-IN", "Cy-sr-SP", "Lt-sr-SP", "sk-SK", "sl-SI", "es-AR", "es-BO", "es-CL", "es-CO", "es-CR", "es-DO", "es-EC", "es-SV", "es-GT", "es-HN", "es-MX", "es-NI", "es-PA", "es-PY", "es-PE", "es-PR", "es-ES", "es-UY", "es-VE", "sw-KE", "sv-FI", "sv-SE", "syr-SY", "ta-IN", "tt-RU", "te-IN", "th-TH", "tr-TR", "uk-UA", "ur-PK", "Cy-uz-UZ", "Lt-uz-UZ", "vi-VN"];
declare const countryCodes: readonly ["AA", "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GT", "GU", "GW", "GY", "HK", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TA", "TC", "TD", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "XK", "YE", "YT", "ZA", "ZM", "ZW"];
declare const iso6391Codes: readonly ["aa", "ab", "ae", "af", "ak", "am", "an", "ar", "as", "av", "ay", "az", "ba", "be", "bg", "bh", "bi", "bm", "bn", "bo", "br", "bs", "ca", "ce", "ch", "co", "cr", "cs", "cu", "cv", "cy", "da", "de", "dv", "dz", "ee", "el", "en", "eo", "es", "et", "eu", "fa", "ff", "fi", "fj", "fo", "fr", "fy", "ga", "gd", "gl", "gn", "gu", "gv", "ha", "he", "hi", "ho", "hr", "ht", "hu", "hy", "hz", "ia", "id", "ie", "ig", "ii", "ik", "io", "is", "it", "iu", "ja", "jv", "ka", "kg", "ki", "kj", "kk", "kl", "km", "kn", "ko", "kr", "ks", "ku", "kv", "kw", "ky", "la", "lb", "lg", "li", "ln", "lo", "lt", "lu", "lv", "mg", "mh", "mi", "mk", "ml", "mn", "mr", "ms", "mt", "my", "na", "nb", "nd", "ne", "ng", "nl", "nn", "no", "nr", "nv", "ny", "oc", "oj", "om", "or", "os", "pa", "pi", "pl", "ps", "pt", "qu", "rm", "rn", "ro", "ru", "rw", "sa", "sc", "sd", "se", "sg", "si", "sk", "sl", "sm", "sn", "so", "sq", "sr", "ss", "st", "su", "sv", "sw", "ta", "te", "tg", "th", "ti", "tk", "tl", "tn", "to", "tr", "ts", "tt", "tw", "ty", "ug", "uk", "ur", "uz", "ve", "vi", "vo", "wa", "wo", "xh", "yi", "yo", "za", "zh", "zu"];
declare const displayNamesCodes: ("sm" | "lg" | "br" | "hr" | "li" | "th" | "tr" | "to" | "mi" | "mn" | "ms" | "tt" | "id" | "cy" | "fy" | "el" | "is" | "af-ZA" | "sq-AL" | "ar-DZ" | "ar-BH" | "ar-EG" | "ar-IQ" | "ar-JO" | "ar-KW" | "ar-LB" | "ar-LY" | "ar-MA" | "ar-OM" | "ar-QA" | "ar-SA" | "ar-SY" | "ar-TN" | "ar-AE" | "ar-YE" | "hy-AM" | "Cy-az-AZ" | "Lt-az-AZ" | "eu-ES" | "be-BY" | "bg-BG" | "ca-ES" | "zh-CN" | "zh-HK" | "zh-MO" | "zh-SG" | "zh-TW" | "zh-CHS" | "zh-CHT" | "hr-HR" | "cs-CZ" | "da-DK" | "div-MV" | "nl-BE" | "nl-NL" | "en-AU" | "en-BZ" | "en-CA" | "en-CB" | "en-IE" | "en-JM" | "en-NZ" | "en-PH" | "en-ZA" | "en-TT" | "en-GB" | "en-US" | "en-ZW" | "et-EE" | "fo-FO" | "fa-IR" | "fi-FI" | "fr-BE" | "fr-CA" | "fr-FR" | "fr-LU" | "fr-MC" | "fr-CH" | "gl-ES" | "ka-GE" | "de-AT" | "de-DE" | "de-LI" | "de-LU" | "de-CH" | "el-GR" | "gu-IN" | "he-IL" | "hi-IN" | "hu-HU" | "is-IS" | "id-ID" | "it-IT" | "it-CH" | "ja-JP" | "kn-IN" | "kk-KZ" | "kok-IN" | "ko-KR" | "ky-KZ" | "lv-LV" | "lt-LT" | "mk-MK" | "ms-BN" | "ms-MY" | "mr-IN" | "mn-MN" | "nb-NO" | "nn-NO" | "pl-PL" | "pt-BR" | "pt-PT" | "pa-IN" | "ro-RO" | "ru-RU" | "sa-IN" | "Cy-sr-SP" | "Lt-sr-SP" | "sk-SK" | "sl-SI" | "es-AR" | "es-BO" | "es-CL" | "es-CO" | "es-CR" | "es-DO" | "es-EC" | "es-SV" | "es-GT" | "es-HN" | "es-MX" | "es-NI" | "es-PA" | "es-PY" | "es-PE" | "es-PR" | "es-ES" | "es-UY" | "es-VE" | "sw-KE" | "sv-FI" | "sv-SE" | "syr-SY" | "ta-IN" | "tt-RU" | "te-IN" | "th-TH" | "tr-TR" | "uk-UA" | "ur-PK" | "Cy-uz-UZ" | "Lt-uz-UZ" | "vi-VN" | "AA" | "AC" | "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BF" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BW" | "BY" | "BZ" | "CA" | "CC" | "CD" | "CF" | "CG" | "CH" | "CI" | "CK" | "CL" | "CM" | "CN" | "CO" | "CR" | "CU" | "CV" | "CW" | "CX" | "CY" | "CZ" | "DE" | "DJ" | "DK" | "DM" | "DO" | "DZ" | "EC" | "EE" | "EG" | "EH" | "ER" | "ES" | "ET" | "FI" | "FJ" | "FK" | "FM" | "FO" | "FR" | "GA" | "GB" | "GD" | "GE" | "GF" | "GG" | "GH" | "GI" | "GL" | "GM" | "GN" | "GP" | "GQ" | "GR" | "GT" | "GU" | "GW" | "GY" | "HK" | "HN" | "HR" | "HT" | "HU" | "ID" | "IE" | "IL" | "IM" | "IN" | "IO" | "IQ" | "IR" | "IS" | "IT" | "JE" | "JM" | "JO" | "JP" | "KE" | "KG" | "KH" | "KI" | "KM" | "KN" | "KP" | "KR" | "KW" | "KY" | "KZ" | "LA" | "LB" | "LC" | "LI" | "LK" | "LR" | "LS" | "LT" | "LU" | "LV" | "LY" | "MA" | "MC" | "MD" | "ME" | "MF" | "MG" | "MH" | "MK" | "ML" | "MM" | "MN" | "MO" | "MP" | "MQ" | "MR" | "MS" | "MT" | "MU" | "MV" | "MW" | "MX" | "MY" | "MZ" | "NA" | "NC" | "NE" | "NF" | "NG" | "NI" | "NL" | "NO" | "NP" | "NR" | "NU" | "NZ" | "OM" | "PA" | "PE" | "PF" | "PG" | "PH" | "PK" | "PL" | "PM" | "PR" | "PS" | "PT" | "PW" | "PY" | "QA" | "RE" | "RO" | "RS" | "RU" | "RW" | "SA" | "SB" | "SC" | "SD" | "SE" | "SG" | "SH" | "SI" | "SJ" | "SK" | "SL" | "SM" | "SN" | "SO" | "SR" | "SS" | "ST" | "SV" | "SX" | "SY" | "SZ" | "TA" | "TC" | "TD" | "TG" | "TH" | "TJ" | "TK" | "TL" | "TM" | "TN" | "TO" | "TR" | "TT" | "TV" | "TW" | "TZ" | "UA" | "UG" | "US" | "UY" | "UZ" | "VA" | "VC" | "VE" | "VG" | "VI" | "VN" | "VU" | "WF" | "WS" | "XK" | "YE" | "YT" | "ZA" | "ZM" | "ZW" | "aa" | "ab" | "ae" | "af" | "ak" | "am" | "an" | "ar" | "as" | "av" | "ay" | "az" | "ba" | "be" | "bg" | "bh" | "bi" | "bm" | "bn" | "bo" | "bs" | "ca" | "ce" | "ch" | "co" | "cr" | "cs" | "cu" | "cv" | "da" | "de" | "dv" | "dz" | "ee" | "en" | "eo" | "es" | "et" | "eu" | "fa" | "ff" | "fi" | "fj" | "fo" | "fr" | "ga" | "gd" | "gl" | "gn" | "gu" | "gv" | "ha" | "he" | "hi" | "ho" | "ht" | "hu" | "hy" | "hz" | "ia" | "ie" | "ig" | "ii" | "ik" | "io" | "it" | "iu" | "ja" | "jv" | "ka" | "kg" | "ki" | "kj" | "kk" | "kl" | "km" | "kn" | "ko" | "kr" | "ks" | "ku" | "kv" | "kw" | "ky" | "la" | "lb" | "ln" | "lo" | "lt" | "lu" | "lv" | "mg" | "mh" | "mk" | "ml" | "mr" | "mt" | "my" | "na" | "nb" | "nd" | "ne" | "ng" | "nl" | "nn" | "no" | "nr" | "nv" | "ny" | "oc" | "oj" | "om" | "or" | "os" | "pa" | "pi" | "pl" | "ps" | "pt" | "qu" | "rm" | "rn" | "ro" | "ru" | "rw" | "sa" | "sc" | "sd" | "se" | "sg" | "si" | "sk" | "sl" | "sn" | "so" | "sq" | "sr" | "ss" | "st" | "su" | "sv" | "sw" | "ta" | "te" | "tg" | "ti" | "tk" | "tl" | "tn" | "ts" | "tw" | "ty" | "ug" | "uk" | "ur" | "uz" | "ve" | "vi" | "vo" | "wa" | "wo" | "xh" | "yi" | "yo" | "za" | "zh" | "zu")[];
export type Bcp47Code = (typeof bcp47Codes)[number];
export type Iso6391Code = (typeof iso6391Codes)[number];
export type CountryCode = (typeof countryCodes)[number];
export type DisplayNameCode = (typeof displayNamesCodes)[number];
export type DisplayNamesOptions = Omit<Intl.DisplayNamesOptions, 'type'> & {
type?: 'region' | 'language';
};
interface DynamicDisplayNamesOptions {
/**
* The type of display names to use.
* @property 'region' | 'language'
* @default 'region'
*/
type?: MaybeRefOrGetter<DisplayNamesOptions['type']>;
/**
* The language display to use.
* @property 'standard' | 'narrow' | 'short'
* @default 'standard'
*/
languageDisplay?: MaybeRefOrGetter<DisplayNamesOptions['languageDisplay']>;
/**
* The fallback to use.
* @property 'code' | 'none'
* @default 'code'
*/
fallback?: MaybeRefOrGetter<DisplayNamesOptions['fallback']>;
/**
* The style to use.
* @property 'long' | 'short' | 'narrow'
* @default 'long'
*/
style?: MaybeRefOrGetter<DisplayNamesOptions['style']>;
/**
* The locale matcher to use.
* @property 'lookup' | 'best fit'
* @default 'lookup'
*/
localeMatcher?: MaybeRefOrGetter<DisplayNamesOptions['localeMatcher']>;
}
type GetDisplayNameOptions = MaybeRefOrGetter<{
locale?: MaybeRefOrGetter<DisplayNameCode | string>;
} & DynamicDisplayNamesOptions>;
export type CodesType = 'iso' | 'bcp' | 'country' | 'all';
declare function getDisplayName(code: MaybeRefOrGetter<DisplayNameCode | string>, options?: GetDisplayNameOptions): import('vue').ComputedRef<string | undefined>;
type GetAllDisplayNamesOptions<T extends CodesType> = MaybeRefOrGetter<{
/**
* The locale to use.
* @property string | DisplayNameCode
* @default undefined
*/
locale?: MaybeRefOrGetter<DisplayNameCode | string>;
/**
* The codes to include.
* @property string[] | undefined
* @default undefined
*/
onlyCodes?: MaybeRefOrGetter<DisplayNameCode[] | string[] | undefined>;
/**
* The codes to exclude.
* @property string[] | undefined
* @default undefined
*/
excludedCodes?: MaybeRefOrGetter<DisplayNameCode[] | string[] | undefined>;
/**
* The codes to prefer.
* @property string[] | undefined
* @default undefined
*/
preferredCodes?: MaybeRefOrGetter<DisplayNameCode[] | string[] | undefined>;
/**
* The type of codes to use.
* @property 'iso' | 'bcp' | 'country' | 'all'
* @default 'all'
*/
codesType?: MaybeRefOrGetter<T>;
/**
* Remove duplicates from the result.
* @property 'name' | 'code' | false
* @default 'name'
*/
removeDuplicates?: MaybeRefOrGetter<'name' | 'code' | false>;
/**
* Remove unmatched codes from the result.
* @default true
*/
removeUnmatched?: MaybeRefOrGetter<boolean>;
} & DynamicDisplayNamesOptions>;
type CodeResult<T extends CodesType> = T extends 'iso' ? Iso6391Code : T extends 'bcp' ? Bcp47Code : T extends 'country' ? CountryCode : DisplayNameCode | string;
export declare function useDisplayNames(mainLocale?: MaybeRefOrGetter<string | DisplayNameCode>): {
getDisplayName: (code: Parameters<typeof getDisplayName>[0], options?: GetDisplayNameOptions) => import('vue').ComputedRef<string | undefined>;
getAllDisplayNames: <T extends CodesType>(options?: GetAllDisplayNamesOptions<T>) => import('vue').ComputedRef<{
name: string;
code: CodeResult<T>;
}[] | undefined>;
};
export {};