@@ -17,35 +17,66 @@ import { useData } from './data.js'
17
17
18
18
// page related
19
19
20
+ /**
21
+ * Get page data
22
+ */
20
23
export const usePage = <
21
24
T extends Record < string , unknown > = Record < string , unknown > ,
22
25
> ( ) : PageDataRef < T > => useData < Record < string , unknown > , T > ( ) . page
26
+ /**
27
+ * Get page frontmatter
28
+ */
23
29
export const useFrontmatter = <
24
30
T extends Record < string , unknown > = Record < string , unknown > ,
25
31
> ( ) : PageFrontmatterRef < T > => useData < T > ( ) . frontmatter
32
+ /**
33
+ * Get page head
34
+ */
26
35
export const useHead = ( ) : PageHeadRef => useData ( ) . head
36
+ /**
37
+ * Get page lang
38
+ */
27
39
export const useLang = ( ) : PageLangRef => useData ( ) . lang
28
- export const useComponent = ( ) : PageComponentRef => useData ( ) . component
29
- export const useLayout = ( ) : PageLayoutRef => useData ( ) . layout
30
40
31
41
// router related
42
+ /**
43
+ * Get routes map
44
+ */
32
45
export const useRoutes = ( ) : RoutesRef => useData ( ) . routes
46
+ /**
47
+ * Get redirect records
48
+ */
33
49
export const useRedirects = ( ) : RedirectsRef => useData ( ) . redirects
34
50
35
51
// route related
52
+ /**
53
+ * Get route locale
54
+ */
36
55
export const useRouteLocale = ( ) : RouteLocaleRef => useData ( ) . routeLocale
56
+ /**
57
+ * Get route path
58
+ */
37
59
export const useRoutePath = ( ) : RoutePathRef => useData ( ) . routePath
38
60
39
61
// site related
62
+ /**
63
+ * Get site data
64
+ */
40
65
export const useSite = ( ) : SiteDataRef => useData ( ) . site
66
+ /**
67
+ * Get site locale data
68
+ */
41
69
export const useSiteLocale = ( ) : SiteLocaleDataRef => useData ( ) . siteLocale
70
+
71
+ // internal
72
+ /** @deprecated use useData().pageComponent instead */
73
+ export const usePageComponent = ( ) : PageComponentRef => useData ( ) . pageComponent
74
+ /** @deprecated use useData().pageLayout instead */
75
+ export const usePageLayout = ( ) : PageLayoutRef => useData ( ) . pageLayout
76
+ /** @deprecated use useData().layouts instead */
42
77
export const useLayouts = ( ) : LayoutsRef => useData ( ) . layouts
43
78
44
79
// deprecated
45
-
46
- /** @deprecated use useComponent instead */
47
- export const usePageComponent = ( ) : PageComponentRef => useData ( ) . component
48
-
49
80
/** @deprecated use usePage instead */
50
81
export const usePageData = <
51
82
T extends Record < string , unknown > = Record < string , unknown > ,
@@ -54,12 +85,10 @@ export const usePageData = <
54
85
export const usePageFrontmatter = <
55
86
T extends Record < string , unknown > = Record < string , unknown > ,
56
87
> ( ) : PageFrontmatterRef < T > => useData < T > ( ) . frontmatter
57
- /** @deprecated use useLayout instead */
58
- export const usePageLayout = ( ) : PageLayoutRef => useData ( ) . layout
59
- /** @deprecated use useLang instead */
60
- export const usePageLang = ( ) : PageLangRef => useData ( ) . lang
61
88
/** @deprecated use useHead instead */
62
89
export const usePageHead = ( ) : PageHeadRef => useData ( ) . head
90
+ /** @deprecated use useLang instead */
91
+ export const usePageLang = ( ) : PageLangRef => useData ( ) . lang
63
92
/** @deprecated use useSite instead */
64
93
export const useSiteData = ( ) : SiteDataRef => useData ( ) . site
65
94
/** @deprecated use useSiteLocale instead */
0 commit comments