Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

feat: configurable ComponentCustomProperties['$i18n'] type #2094

Merged
merged 1 commit into from
Jan 31, 2025
Merged

feat: configurable ComponentCustomProperties['$i18n'] type #2094

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion packages/vue-i18n-core/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,12 @@ export {
} from './legacy'
export { VERSION } from './misc'
export { I18nPluginOptions } from './plugin'
export { Disposer } from './types'
export {
Disposer,
GeneratedInstanceType,
GeneratedTypeConfig,
VueI18nInstance
} from './types'

export type {
IsEmptyObject,
Expand Down
43 changes: 43 additions & 0 deletions packages/vue-i18n-core/src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,44 @@
import type { IsNever } from '@intlify/core-base'
import type { ExportedGlobalComposer } from './i18n'
import type { VueI18n } from './legacy'

export type Disposer = () => void

/**
*
* The interface used for narrowing types using generated types.
*
* @remarks
*
* The type generated by 3rd party (e.g. nuxt/i18n)
*
* @example
* ```ts
* // generated-i18n-types.d.ts (`.d.ts` file at your app)
*
* declare module '@intlify/vue-i18n-core' {
* interface GeneratedTypeConfig {
* legacy: false
* }
* }
* ```
*/
export interface GeneratedTypeConfig {}

/**
* Narrowed i18n instance type based on `GeneratedTypeConfig['legacy']`
*
* - `never` (unset) resolves to `VueI18n | ExportedGlobalComposer`
* - `true` resolves to `VueI18n`
* - `false` resolves to `ExportedGlobalComposer`
*/
export type GeneratedInstanceType =
GeneratedTypeConfig extends Record<'legacy', infer Legacy> ? Legacy : never

/** @VueI18nGeneral */
export type VueI18nInstance =
IsNever<GeneratedInstanceType> extends true
? VueI18n | ExportedGlobalComposer
: GeneratedInstanceType extends true
? VueI18n
: ExportedGlobalComposer
2 changes: 1 addition & 1 deletion packages/vue-i18n/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ export {
} from '../../vue-i18n-core/src/legacy'
export { I18nPluginOptions } from '../../vue-i18n-core/src/plugin'
export { VERSION } from './../../vue-i18n-core/src/misc'
export { Disposer } from './../../vue-i18n-core/src/types'
export { Disposer, VueI18nInstance } from './../../vue-i18n-core/src/types'

export type {
IsEmptyObject,
Expand Down
5 changes: 2 additions & 3 deletions packages/vue-i18n/src/vue.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,13 @@ import type {
DefineDateTimeFormat,
DefineLocaleMessage,
RemovedIndexResources,
VueI18nInstance,
VueMessageType
} from '../../vue-i18n-core/src/composer'
import type { ExportedGlobalComposer } from '../../vue-i18n-core/src/i18n'
import type {
DateTimeFormatResult,
NumberFormatResult,
TranslateResult,
VueI18n,
VueI18nOptions
} from '../../vue-i18n-core/src/legacy'

Expand Down Expand Up @@ -74,7 +73,7 @@ declare module 'vue' {
* The locales, locale messages, and other resources managed by the instance referenced by this property are valid as global scope.
* If the `i18n` component custom option is not specified, it's the same as the VueI18n instance that can be referenced by the i18n instance {@link I18n.global | global} property.
*/
$i18n: VueI18n | ExportedGlobalComposer
$i18n: VueI18nInstance
/**
* Locale message translation
*
Expand Down