vue-i18n-routing
Advanced tools
Comparing version 0.11.0-166e3c5 to 0.11.0-23b3b0c
@@ -661,2 +661,18 @@ import type { Composer } from '@intlify/vue-i18n-bridge'; | ||
/** | ||
* The function that resolves the route base name. | ||
* | ||
* @remarks | ||
* The parameter signatures of this function is the same as {@link getRouteBaseName}. | ||
* | ||
* @param givenRoute - A route location. The path or name of the route or an object for more complex routes. | ||
* | ||
* @returns The route base name, if route name is not defined, return `null`. | ||
* | ||
* @see {@link useRouteBaseName} | ||
* | ||
* @public | ||
*/ | ||
export declare type RouteBaseNameFunction = (givenRoute?: Route | RouteLocationNormalizedLoaded) => string | undefined; | ||
/** | ||
* Route config for lagacy vue-router v3 | ||
@@ -844,17 +860,14 @@ * | ||
/** | ||
* The `useRouteBaseName` composable returns the route base name. | ||
* The `useRouteBaseName` composable returns a function which returns the route base name. | ||
* | ||
* @remarks | ||
* The `useRouteBaseName` is the composable function which is {@link getRouteBaseName} wrapper. | ||
* The function returned by `useRouteBaseName` is the wrapper function with the same signature as {@link getRouteBaseName}. | ||
* | ||
* @param givenRoute - A route object. if not provided, the route is returned with `useRoute` will be used internally | ||
* @param options - An options, which has `router` and `routesNameSeparator` fields. see about details {@link I18nCommonRoutingOptionsWithComposable} for these option fields. | ||
* @param options - An options see about details {@link I18nCommonRoutingOptionsWithComposable}. | ||
* | ||
* @returns The route base name, if route name is not defined, return `null`. | ||
* @returns A {@link RouteBaseNameFunction}. | ||
* | ||
* @see {@link getRouteBaseName} | ||
* | ||
* @public | ||
*/ | ||
export declare function useRouteBaseName(givenRoute?: Route | RouteLocationNormalizedLoaded, { router, routesNameSeparator }?: I18nCommonRoutingOptionsWithComposable): string | undefined; | ||
export declare function useRouteBaseName({ router, route, i18n, defaultLocale, defaultLocaleRouteNameSuffix, routesNameSeparator, strategy, trailingSlash }?: I18nCommonRoutingOptionsWithComposable): RouteBaseNameFunction; | ||
@@ -861,0 +874,0 @@ /** |
@@ -961,9 +961,16 @@ var VueI18nRouting = function(exports, VueRouter3, vueDemi, vueI18nBridge) { | ||
} | ||
function useRouteBaseName(givenRoute = VueRouter3.useRoute(), { router = VueRouter3.useRouter(), routesNameSeparator = void 0 } = {}) { | ||
const proxy = { | ||
router, | ||
route: givenRoute, | ||
routesNameSeparator | ||
}; | ||
return getRouteBaseName.call(proxy, givenRoute); | ||
function useRouteBaseName({ | ||
router = VueRouter3.useRouter(), | ||
route = VueRouter3.useRoute(), | ||
i18n = vueI18nBridge.useI18n(), | ||
defaultLocale = void 0, | ||
defaultLocaleRouteNameSuffix = void 0, | ||
routesNameSeparator = void 0, | ||
strategy = void 0, | ||
trailingSlash = void 0 | ||
} = {}) { | ||
return proxyForComposable( | ||
{ router, route, i18n, defaultLocale, defaultLocaleRouteNameSuffix, routesNameSeparator, strategy, trailingSlash }, | ||
getRouteBaseName | ||
); | ||
} | ||
@@ -970,0 +977,0 @@ function useLocalePath({ |
@@ -964,9 +964,16 @@ "use strict"; | ||
} | ||
function useRouteBaseName(givenRoute = VueRouter3.useRoute(), { router = VueRouter3.useRouter(), routesNameSeparator = void 0 } = {}) { | ||
const proxy = { | ||
router, | ||
route: givenRoute, | ||
routesNameSeparator | ||
}; | ||
return getRouteBaseName.call(proxy, givenRoute); | ||
function useRouteBaseName({ | ||
router = VueRouter3.useRouter(), | ||
route = VueRouter3.useRoute(), | ||
i18n = vueI18nBridge.useI18n(), | ||
defaultLocale = void 0, | ||
defaultLocaleRouteNameSuffix = void 0, | ||
routesNameSeparator = void 0, | ||
strategy = void 0, | ||
trailingSlash = void 0 | ||
} = {}) { | ||
return proxyForComposable( | ||
{ router, route, i18n, defaultLocale, defaultLocaleRouteNameSuffix, routesNameSeparator, strategy, trailingSlash }, | ||
getRouteBaseName | ||
); | ||
} | ||
@@ -973,0 +980,0 @@ function useLocalePath({ |
{ | ||
"name": "vue-i18n-routing", | ||
"description": "The i18n routing with using vue-i18n", | ||
"version": "0.11.0-166e3c5", | ||
"version": "0.11.0-23b3b0c", | ||
"dependencies": { | ||
@@ -6,0 +6,0 @@ "@intlify/shared": "next", |
Sorry, the diff of this file is not supported yet
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
163332
4477