Skip to content

Commit

Permalink
refactor: remove links to vue-i18n-routing repo types
Browse files Browse the repository at this point in the history
  • Loading branch information
BobbieGoede committed Jan 11, 2024
1 parent 33e720c commit c51bb8e
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
10 changes: 5 additions & 5 deletions docs/content/4.API/1.composables.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Composition API for Nuxt i18n module.

## `useLocalePath`

The `useLocalePath` composable returns a function that resolves a path according to the current locale. `useLocalePath` is powered by [vue-i18n-routing](https://github.com/intlify/routing/tree/main/packages/vue-i18n-routing).
The `useLocalePath` composable returns a function that resolves a path according to the current locale.

Example:
```vue
Expand All @@ -25,7 +25,7 @@ declare function useLocalePath(options?: I18nCommonRoutingOptionsWithComposable)

## `useLocaleRoute`

The `useLocaleRoute` composable returns a function that resolves the route according to the current locale. `useLocaleRoute` is powered by [vue-i18n-routing](https://github.com/intlify/routing/tree/main/packages/vue-i18n-routing).
The `useLocaleRoute` composable returns a function that resolves the route according to the current locale.

Example:
```vue
Expand All @@ -51,7 +51,7 @@ declare function useLocaleRoute(options?: I18nCommonRoutingOptionsWithComposable

## `useSwitchLocalePath`

The `useSwitchLocalePath` composable returns a function that allows to switch the locale. `useSwitchLocalePath` is powered by [vue-i18n-routing](https://github.com/intlify/routing/tree/main/packages/vue-i18n-routing).
The `useSwitchLocalePath` composable returns a function that allows to switch the locale.

Example:
```vue
Expand All @@ -73,7 +73,7 @@ declare function useSwitchLocalePath(options?: I18nCommonRoutingOptionsWithCompo

## `useLocaleHead`

The `useLocaleHead` composable returns localized head properties for locale-related aspects. `useLocaleHead` is powered by [vue-i18n-routing](https://github.com/intlify/routing/tree/main/packages/vue-i18n-routing).
The `useLocaleHead` composable returns localized head properties for locale-related aspects.

Example:
```vue
Expand Down Expand Up @@ -170,7 +170,7 @@ declare function useSetI18nParams(options?: SeoAttributesOptions): (locale: Reco

## `useRouteBaseName`

The `useRouteBaseName` composable returns a function that gets the route's base name. `useRouteBaseName` is powered by [vue-i18n-routing](https://github.com/intlify/routing/tree/main/packages/vue-i18n-routing).
The `useRouteBaseName` composable returns a function that gets the route's base name.

Example:
```vue
Expand Down
4 changes: 2 additions & 2 deletions src/runtime/plugins/i18n.ts
Original file line number Diff line number Diff line change
Expand Up @@ -523,9 +523,9 @@ declare module '#app' {
/**
* Returns localized head properties for locale-related aspects.
*
* @param options - An options, see about details [I18nHeadOptions](https://github.com/intlify/routing/blob/main/packages/vue-i18n-routing/api.md#i18nheadoptions).
* @param options - An options object, see `I18nHeadOptions`.
*
* @returns The localized [head properties](https://github.com/intlify/routing/blob/main/packages/vue-i18n-routing/api.md#i18nheadmetainfo).
* @returns The localized head properties.
*/
$localeHead: (...args: Parameters<LocaleHead>) => ReturnType<LocaleHead>
/**
Expand Down
2 changes: 1 addition & 1 deletion src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ interface Route {
}

/**
* Route config for vue-i18n-routing
* Route config for i18n routing
*
* @public
*/
Expand Down

0 comments on commit c51bb8e

Please sign in to comment.