boltdocs 2.6.1 → 2.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (177) hide show
  1. package/bin/boltdocs.js +0 -1
  2. package/dist/cache-CQKlT4fI.mjs +6 -0
  3. package/dist/cache-DorPMFgW.cjs +6 -0
  4. package/dist/cards-BLoSiRuL.d.ts +30 -0
  5. package/dist/cards-CQn9mXZS.d.cts +30 -0
  6. package/dist/chunk-Ds5LZdWN.cjs +6 -0
  7. package/dist/client/index.cjs +1 -1
  8. package/dist/client/index.d.cts +173 -1328
  9. package/dist/client/index.d.ts +172 -1327
  10. package/dist/client/index.js +1 -1
  11. package/dist/{package-c99Cs7mD.cjs → client/mdx.cjs} +1 -1
  12. package/dist/client/mdx.d.cts +128 -0
  13. package/dist/client/mdx.d.ts +129 -0
  14. package/dist/client/mdx.js +6 -0
  15. package/dist/client/primitives.cjs +6 -0
  16. package/dist/client/primitives.d.cts +818 -0
  17. package/dist/client/primitives.d.ts +818 -0
  18. package/dist/client/primitives.js +6 -0
  19. package/dist/client/theme/neutral.css +74 -361
  20. package/dist/client/theme/reset.css +189 -0
  21. package/dist/docs-layout-BlDhcQRv.cjs +6 -0
  22. package/dist/docs-layout-BvAOWEJw.js +6 -0
  23. package/dist/doctor-BQiQhCTl.cjs +6 -0
  24. package/dist/doctor-COpf35L2.cjs +20 -0
  25. package/dist/doctor-Dh1XP7Pz.mjs +20 -0
  26. package/dist/generator-DGW6pkCC.cjs +22 -0
  27. package/dist/generator-Dv3wEmhZ.mjs +22 -0
  28. package/dist/icons-dev-CrQLjoQp.js +6 -0
  29. package/dist/icons-dev-rzdz6Lf3.cjs +6 -0
  30. package/dist/image-BkIfa9oo.js +6 -0
  31. package/dist/image-DIGjCPe6.cjs +6 -0
  32. package/dist/mdx-K0WYBAJ3.js +7 -0
  33. package/dist/mdx-hpErbRUe.cjs +7 -0
  34. package/dist/meta-loader-0gJ4PtBC.cjs +6 -0
  35. package/dist/meta-loader-9IpAHWDS.mjs +6 -0
  36. package/dist/node/cli-entry.cjs +1 -2
  37. package/dist/node/cli-entry.mjs +1 -2
  38. package/dist/node/index.cjs +1 -1
  39. package/dist/node/index.d.cts +66 -13
  40. package/dist/node/index.d.mts +66 -14
  41. package/dist/node/index.mjs +1 -1
  42. package/dist/node/routes/worker.cjs +6 -0
  43. package/dist/node/routes/worker.d.cts +2 -0
  44. package/dist/node/routes/worker.d.mts +2 -0
  45. package/dist/node/routes/worker.mjs +6 -0
  46. package/dist/node-C2nWXElP.mjs +112 -0
  47. package/dist/node-CinkUtxV.cjs +112 -0
  48. package/dist/package-BMYLDBBP.cjs +6 -0
  49. package/dist/{package-DukYeKmD.mjs → package-HegMOTL_.mjs} +1 -1
  50. package/dist/parser-Bh11BsdA.cjs +6 -0
  51. package/dist/parser-D8eQvE7N.mjs +6 -0
  52. package/dist/parser-DYRzXWmA.cjs +6 -0
  53. package/dist/routes-CHf76Ye4.cjs +6 -0
  54. package/dist/routes-CMUZGI6T.mjs +6 -0
  55. package/dist/routes-Co1mRM58.cjs +6 -0
  56. package/dist/search-dialog-BACuzoVX.cjs +6 -0
  57. package/dist/search-dialog-BKagVT17.js +6 -0
  58. package/dist/search-dialog-C8w12eUx.js +6 -0
  59. package/dist/search-dialog-CGyrozZE.cjs +6 -0
  60. package/dist/search-dialog-D26rUnJ_.cjs +6 -0
  61. package/dist/sidebar-DKvg6KOc.d.cts +491 -0
  62. package/dist/sidebar-Dr1TiRIy.d.ts +491 -0
  63. package/dist/utils-BxNAXhZZ.mjs +7 -0
  64. package/dist/utils-Clzu7jvb.cjs +7 -0
  65. package/dist/worker-pool-Bd8Y9KDv.mjs +6 -0
  66. package/dist/worker-pool-BwU8ckrg.cjs +6 -0
  67. package/package.json +27 -8
  68. package/src/client/app/doc-page.tsx +9 -5
  69. package/src/client/app/docs-layout.tsx +17 -3
  70. package/src/client/app/head.tsx +122 -0
  71. package/src/client/app/helmet-compat.tsx +36 -0
  72. package/src/client/app/mdx-component.tsx +5 -52
  73. package/src/client/app/mdx-components-context.tsx +32 -8
  74. package/src/client/app/routes-context.tsx +2 -2
  75. package/src/client/app/scroll-handler.tsx +1 -1
  76. package/src/client/app/theme-context.tsx +5 -5
  77. package/src/client/app/ui-context.tsx +42 -0
  78. package/src/client/components/docs-layout-default.tsx +85 -0
  79. package/src/client/components/icons-dev.tsx +38 -15
  80. package/src/client/components/mdx/callout.tsx +97 -0
  81. package/src/client/components/mdx/card.tsx +73 -98
  82. package/src/client/components/mdx/cards.tsx +27 -0
  83. package/src/client/components/mdx/code-block.tsx +37 -17
  84. package/src/client/components/mdx/field.tsx +24 -56
  85. package/src/client/components/mdx/image.tsx +36 -15
  86. package/src/client/components/mdx/index.ts +19 -53
  87. package/src/client/components/mdx/table.tsx +46 -148
  88. package/src/client/components/mdx/typographics.tsx +120 -0
  89. package/src/client/components/mdx/{hooks/use-code-block.ts → use-code-block.ts} +5 -7
  90. package/src/client/components/primitives/breadcrumbs.tsx +5 -24
  91. package/src/client/components/primitives/button.tsx +3 -142
  92. package/src/client/components/primitives/code-block.tsx +104 -97
  93. package/src/client/components/{docs-layout.tsx → primitives/docs-layout.tsx} +15 -24
  94. package/src/client/components/primitives/error-boundary.tsx +107 -0
  95. package/src/client/components/primitives/heading.tsx +128 -0
  96. package/src/client/components/primitives/helpers/observer.ts +62 -32
  97. package/src/client/components/primitives/image.tsx +26 -0
  98. package/src/client/components/primitives/link.tsx +50 -52
  99. package/src/client/components/primitives/menu.tsx +25 -49
  100. package/src/client/components/primitives/navbar.tsx +234 -59
  101. package/src/client/components/primitives/on-this-page.tsx +169 -40
  102. package/src/client/components/primitives/page-nav.tsx +11 -39
  103. package/src/client/components/primitives/popover.tsx +12 -30
  104. package/src/client/components/primitives/search-dialog.tsx +77 -71
  105. package/src/client/components/primitives/sidebar.tsx +312 -119
  106. package/src/client/components/primitives/skeleton.tsx +1 -1
  107. package/src/client/components/primitives/tabs.tsx +5 -16
  108. package/src/client/components/primitives/tooltip.tsx +1 -1
  109. package/src/client/components/ui-base/banner.tsx +66 -0
  110. package/src/client/components/ui-base/breadcrumbs.tsx +26 -20
  111. package/src/client/components/ui-base/copy-markdown.tsx +43 -35
  112. package/src/client/components/ui-base/error-boundary.tsx +9 -46
  113. package/src/client/components/ui-base/github-stars.tsx +5 -3
  114. package/src/client/components/ui-base/index.ts +3 -3
  115. package/src/client/components/ui-base/last-updated.tsx +27 -0
  116. package/src/client/components/ui-base/navbar.tsx +183 -89
  117. package/src/client/components/ui-base/not-found.tsx +11 -9
  118. package/src/client/components/ui-base/on-this-page.tsx +8 -104
  119. package/src/client/components/ui-base/page-nav.tsx +23 -9
  120. package/src/client/components/ui-base/search-dialog.tsx +111 -36
  121. package/src/client/components/ui-base/search-highlight.tsx +10 -0
  122. package/src/client/components/ui-base/sidebar.tsx +77 -154
  123. package/src/client/components/ui-base/tabs.tsx +20 -7
  124. package/src/client/components/ui-base/theme-toggle.tsx +88 -10
  125. package/src/client/components/ui-base/version-i18n.tsx +80 -0
  126. package/src/client/hooks/index.ts +2 -1
  127. package/src/client/hooks/use-analytics.ts +272 -0
  128. package/src/client/hooks/use-i18n.ts +120 -53
  129. package/src/client/hooks/use-localized-to.ts +70 -30
  130. package/src/client/hooks/use-navbar.ts +69 -39
  131. package/src/client/hooks/use-page-nav.ts +28 -25
  132. package/src/client/hooks/use-routes.ts +64 -81
  133. package/src/client/hooks/use-search-highlight.ts +185 -0
  134. package/src/client/hooks/use-search.ts +12 -3
  135. package/src/client/hooks/use-sidebar.ts +183 -77
  136. package/src/client/hooks/use-tabs.ts +3 -4
  137. package/src/client/hooks/use-version.ts +46 -18
  138. package/src/client/index.ts +13 -86
  139. package/src/client/mdx.ts +2 -0
  140. package/src/client/primitives.ts +19 -0
  141. package/src/client/ssg/boltdocs-shell.tsx +78 -57
  142. package/src/client/ssg/create-routes.tsx +290 -50
  143. package/src/client/ssg/mdx-page.tsx +2 -1
  144. package/src/client/store/boltdocs-context.tsx +83 -12
  145. package/src/client/theme/neutral.css +74 -361
  146. package/src/client/theme/reset.css +189 -0
  147. package/src/client/types.ts +10 -2
  148. package/src/client/utils/path.ts +9 -0
  149. package/src/client/utils/react-to-text.ts +24 -24
  150. package/src/client/virtual.d.ts +1 -1
  151. package/src/shared/types.ts +97 -21
  152. package/dist/node-CWN8U_p8.mjs +0 -88
  153. package/dist/node-D5iosYXv.cjs +0 -88
  154. package/dist/search-dialog-3lvKsbVG.js +0 -6
  155. package/dist/search-dialog-DMK5OpgH.cjs +0 -6
  156. package/dist/use-search-C9bxCqfF.js +0 -6
  157. package/dist/use-search-DcfZSunO.cjs +0 -6
  158. package/src/client/components/mdx/admonition.tsx +0 -91
  159. package/src/client/components/mdx/badge.tsx +0 -41
  160. package/src/client/components/mdx/button.tsx +0 -35
  161. package/src/client/components/mdx/component-preview.tsx +0 -37
  162. package/src/client/components/mdx/component-props.tsx +0 -83
  163. package/src/client/components/mdx/file-tree.tsx +0 -325
  164. package/src/client/components/mdx/hooks/use-component-preview.ts +0 -16
  165. package/src/client/components/mdx/hooks/useTable.ts +0 -74
  166. package/src/client/components/mdx/hooks/useTabs.ts +0 -68
  167. package/src/client/components/mdx/link.tsx +0 -38
  168. package/src/client/components/mdx/list.tsx +0 -192
  169. package/src/client/components/mdx/tabs.tsx +0 -135
  170. package/src/client/components/mdx/video.tsx +0 -68
  171. package/src/client/components/primitives/index.ts +0 -19
  172. package/src/client/components/primitives/navigation-menu.tsx +0 -114
  173. package/src/client/components/ui-base/head.tsx +0 -76
  174. package/src/client/components/ui-base/loading.tsx +0 -57
  175. package/src/client/components/ui-base/powered-by.tsx +0 -25
  176. package/src/client/hooks/use-onthispage.ts +0 -23
  177. package/src/client/utils/use-on-change.ts +0 -15
@@ -1,287 +1,27 @@
1
1
 
2
- import { Plugin } from "vite";
2
+ import { C as BoltdocsConfig, D as BoltdocsSocialLink, E as BoltdocsMdxComponents, O as BoltdocsTypes, S as TabsProps, T as BoltdocsLocale, _ as LayoutProps, a as SidebarItem, b as SidebarProps, d as SidebarMobile, f as SidebarRoot, g as ComponentRoute, h as BoltdocsTab, i as SidebarHeader, k as BoltdocsVersion, m as ComponentBase, n as SidebarContent, s as SidebarItems, u as SidebarLinkProps, v as NavbarLink, w as BoltdocsIntegrationsConfig, x as SiteConfig, y as OnThisPageProps } from "../sidebar-DKvg6KOc.cjs";
3
+ import { n as Card, t as Cards } from "../cards-CQn9mXZS.cjs";
4
+ import * as _$react from "react";
5
+ import React$1, { JSXElementConstructor, ReactNode } from "react";
3
6
  import { RouteRecord } from "@bdocs/ssg";
4
7
  import * as _$react_jsx_runtime0 from "react/jsx-runtime";
5
- import * as _$react from "react";
6
- import { Component, ComponentPropsWithoutRef, ErrorInfo, ImgHTMLAttributes, ReactNode, RefObject } from "react";
7
8
  import * as _$react_router_dom0 from "react-router-dom";
8
- import { LinkProps as LinkProps$1 } from "react-router-dom";
9
- import * as _$class_variance_authority_types0 from "class-variance-authority/types";
10
- import * as RAC from "react-aria-components";
11
- import { LinkProps as LinkProps$2 } from "react-aria-components";
12
- import { VariantProps } from "class-variance-authority";
9
+ import { LinkProps } from "react-router-dom";
13
10
  import { ClassValue } from "clsx";
14
11
 
15
- //#region src/shared/types.d.ts
16
- /**
17
- * Represents a single social link in the configuration.
18
- */
19
- interface BoltdocsSocialLink {
20
- icon: 'discord' | 'x' | 'github' | 'bluesky' | string;
21
- link: string;
22
- }
23
- /**
24
- * Configuration for the site footer.
25
- */
26
- interface BoltdocsFooterConfig {
27
- text?: string;
28
- }
29
- /**
30
- * Theme-specific configuration options.
31
- */
32
- interface BoltdocsThemeConfig {
33
- title?: string | Record<string, string>;
34
- description?: string | Record<string, string>;
35
- logo?: string | {
36
- dark: string;
37
- light: string;
38
- alt?: string;
39
- width?: number;
40
- height?: number;
41
- };
42
- navbar?: Array<{
43
- label: string | Record<string, string>;
44
- href: string;
45
- }>;
46
- sidebar?: Record<string, Array<{
47
- text: string;
48
- link: string;
49
- }>>;
50
- sidebarGroups?: Record<string, {
51
- title?: string;
52
- icon?: string;
53
- }>;
54
- socialLinks?: BoltdocsSocialLink[];
55
- footer?: BoltdocsFooterConfig;
56
- breadcrumbs?: boolean;
57
- editLink?: string;
58
- communityHelp?: string;
59
- version?: string;
60
- githubRepo?: string;
61
- favicon?: string;
62
- poweredBy?: boolean;
63
- tabs?: Array<{
64
- id: string;
65
- text: string | Record<string, string>;
66
- icon?: string;
67
- }>;
68
- codeTheme?: ShikiTheme | {
69
- light: ShikiTheme;
70
- dark: ShikiTheme;
71
- };
72
- copyMarkdown?: boolean | {
73
- text?: string;
74
- icon?: string;
75
- };
76
- }
77
- /**
78
- * List of supported syntax highlighting themes.
79
- */
80
- type ShikiTheme = 'github-dark' | 'github-light' | 'tokyo-night' | 'dracula' | 'nord' | 'one-dark-pro' | 'one-light';
81
- /**
82
- * Configuration for the robots.txt file.
83
- */
84
- type BoltdocsRobotsConfig = string | {
85
- rules?: Array<{
86
- userAgent: string;
87
- allow?: string | string[];
88
- disallow?: string | string[];
89
- }>;
90
- sitemaps?: string[];
91
- };
92
- /**
93
- * Configuration for a specific locale.
94
- */
95
- interface BoltdocsLocaleConfig {
96
- label?: string;
97
- direction?: 'ltr' | 'rtl';
98
- htmlLang?: string;
99
- calendar?: string;
100
- }
101
- /**
102
- * Configuration for internationalization (i18n).
103
- */
104
- interface BoltdocsI18nConfig {
105
- defaultLocale: string;
106
- locales: Record<string, string>;
107
- localeConfigs?: Record<string, BoltdocsLocaleConfig>;
108
- }
109
- /**
110
- * Configuration for a specific documentation version.
111
- */
112
- interface BoltdocsVersionConfig {
113
- label: string;
114
- path: string;
115
- }
116
- /**
117
- * Configuration for documentation versioning.
118
- */
119
- interface BoltdocsVersionsConfig {
120
- defaultVersion: string;
121
- prefix?: string;
122
- versions: BoltdocsVersionConfig[];
123
- }
124
- /**
125
- * Defines a Boltdocs plugin.
126
- */
127
- interface BoltdocsPlugin {
128
- name: string;
129
- enforce?: 'pre' | 'post';
130
- version?: string;
131
- boltdocsVersion?: string;
132
- permissions?: string[];
133
- remarkPlugins?: unknown[];
134
- rehypePlugins?: unknown[];
135
- vitePlugins?: Plugin[];
136
- components?: Record<string, string>;
137
- hooks?: Record<string, any>;
138
- }
139
- /**
140
- * Configuration for security-related settings.
141
- */
142
- interface BoltdocsSecurityConfig {
143
- headers?: Record<string, string>;
144
- enableCSP?: boolean;
145
- customHeaders?: Record<string, string>;
146
- }
147
- /**
148
- * Configuration for SEO.
149
- */
150
- interface BoltdocsSeoConfig {
151
- metatags?: Record<string, string>;
152
- indexing?: 'all' | 'public';
153
- thumbnails?: {
154
- background?: string;
155
- };
156
- }
157
- /**
158
- * The root configuration object for Boltdocs.
159
- */
160
- interface BoltdocsConfig$1 {
161
- siteUrl?: string;
162
- docsDir?: string;
163
- base?: string;
164
- homePage?: string;
165
- theme?: BoltdocsThemeConfig;
166
- i18n?: BoltdocsI18nConfig;
167
- versions?: BoltdocsVersionsConfig;
168
- plugins?: BoltdocsPlugin[];
169
- robots?: BoltdocsRobotsConfig;
170
- security?: BoltdocsSecurityConfig;
171
- seo?: BoltdocsSeoConfig;
172
- vite?: any;
173
- }
174
- //#endregion
175
- //#region src/client/types.d.ts
176
- /**
177
- * Metadata provided by the server for a specific route.
178
- * Maps closely to the `RouteMeta` type in the Node environment.
179
- */
180
- interface ComponentRoute {
181
- /** The final URL path */
182
- path: string;
183
- /** The absolute filesystem path of the source file */
184
- componentPath: string;
185
- /** The page title */
186
- title: string;
187
- /** Explicit order in the sidebar */
188
- sidebarPosition?: number;
189
- /** The relative path from the docs directory */
190
- filePath: string;
191
- /** The group directory name */
192
- group?: string;
193
- /** The display title of the group */
194
- groupTitle?: string;
195
- /** Explicit order of the group in the sidebar */
196
- groupPosition?: number;
197
- /** Extracted markdown headings for search indexing */
198
- headings?: {
199
- level: number;
200
- text: string;
201
- id: string;
202
- }[];
203
- /** The page summary or description */
204
- description?: string;
205
- /** The locale this route belongs to, if i18n is configured */
206
- locale?: string;
207
- /** The version this route belongs to, if versioning is configured */
208
- version?: string;
209
- /** Optional icon to display (Lucide icon name or raw SVG) */
210
- icon?: string;
211
- /** The tab this route belongs to, if tabs are configured */
212
- tab?: string;
213
- /** Optional badge to display next to the sidebar item */
214
- badge?: string | {
215
- text: 'updated' | 'new' | 'deprecated';
216
- expires?: string;
217
- };
218
- /** Optional icon for the route's group */
219
- groupIcon?: string;
220
- /** The sub-route group this route belongs to (from folders starting with _) */
221
- subRouteGroup?: string;
222
- /** The nested sub-routes if this route acts as the parent of a subRouteGroup */
223
- subRoutes?: ComponentRoute[];
224
- /** The extracted plain-text content of the page for search indexing */
225
- _content?: string;
226
- /** The raw markdown content of the page */
227
- _rawContent?: string;
228
- }
229
- /**
230
- * Tab configuration for the documentation site.
231
- */
232
- interface BoltdocsTab {
233
- id: string;
234
- /** Text to display (can be a string or a map of translations) */
235
- text: string | Record<string, string>;
236
- icon?: string;
237
- }
238
- /**
239
- * Props for the OnThisPage (TOC) component.
240
- */
241
- interface OnThisPageProps {
242
- headings?: {
243
- level: number;
244
- text: string;
245
- id: string;
246
- }[];
247
- editLink?: string;
248
- communityHelp?: string;
249
- filePath?: string;
250
- }
251
- /**
252
- * Props for user-defined layout components (layout.tsx).
253
- */
254
- interface LayoutProps {
255
- children: React.ReactNode;
256
- }
257
- /**
258
- * Unified type for navbar links.
259
- */
260
- interface NavbarLink {
261
- /** Label to display (can be a string or a map of translations) */
262
- label: string | Record<string, string>;
263
- href: string;
264
- active: boolean;
265
- /** Optional icon or string for external link indication */
266
- to?: string;
267
- }
268
- //#endregion
269
12
  //#region src/client/ssg/create-routes.d.ts
270
13
  interface CreateRoutesOptions {
271
14
  routesData: ComponentRoute[];
272
- config: BoltdocsConfig$1;
273
- mdxModules: Record<string, {
274
- default?: React.ComponentType;
15
+ config: BoltdocsConfig;
16
+ mdxModules: Record<string, any>;
17
+ Layout: React$1.ComponentType<{
18
+ children: React$1.ReactNode;
275
19
  }>;
276
- Layout: React.ComponentType<{
277
- children: React.ReactNode;
20
+ externalPages?: Record<string, React$1.ComponentType>;
21
+ externalLayout?: React$1.ComponentType<{
22
+ children: React$1.ReactNode;
278
23
  }>;
279
- homePage?: React.ComponentType;
280
- externalPages?: Record<string, React.ComponentType>;
281
- externalLayout?: React.ComponentType<{
282
- children: React.ReactNode;
283
- }>;
284
- components?: Record<string, React.ComponentType>;
24
+ components?: Record<string, React$1.ComponentType>;
285
25
  }
286
26
  declare function createRoutes(options: CreateRoutesOptions): RouteRecord[];
287
27
  //#endregion
@@ -301,7 +41,7 @@ declare function BoltdocsShell({
301
41
  routes,
302
42
  components
303
43
  }: {
304
- config: BoltdocsConfig$1;
44
+ config: BoltdocsConfig;
305
45
  routes: ComponentRoute[];
306
46
  components?: Record<string, React.ComponentType>;
307
47
  }): _$react_jsx_runtime0.JSX.Element;
@@ -310,7 +50,7 @@ declare function BoltdocsShell({
310
50
  /**
311
51
  * Hook to access the Boltdocs configuration.
312
52
  */
313
- declare function useConfig(): BoltdocsConfig$1;
53
+ declare function useConfig(): BoltdocsConfig;
314
54
  //#endregion
315
55
  //#region src/client/app/theme-context.d.ts
316
56
  type Theme = 'light' | 'dark' | 'system';
@@ -322,35 +62,15 @@ interface ThemeContextType {
322
62
  }
323
63
  declare function useTheme(): ThemeContextType;
324
64
  //#endregion
325
- //#region src/client/hooks/use-routes.d.ts
326
- /**
327
- * Hook to access the framework's routing state.
328
- * Returns both the complete set of routes and a filtered list based on the current
329
- * version and locale.
330
- */
331
- declare function useRoutes(): {
332
- routes: ComponentRoute[];
333
- allRoutes: ComponentRoute[];
334
- currentRoute: ComponentRoute | undefined;
335
- currentLocale: string | undefined;
336
- currentLocaleLabel: string | undefined;
337
- availableLocales: {
338
- key: string;
339
- label: string;
340
- isCurrent: boolean;
341
- }[];
342
- currentVersion: string | undefined;
343
- currentVersionLabel: string | undefined;
344
- availableVersions: {
345
- key: string;
346
- label: string;
347
- isCurrent: boolean;
348
- }[];
349
- config: BoltdocsConfig$1;
350
- };
351
- //#endregion
352
65
  //#region src/client/app/mdx-components-context.d.ts
353
- declare function useMdxComponents(): any;
66
+ declare function useMdxComponents(): BoltdocsMdxComponents;
67
+ //#endregion
68
+ //#region src/client/app/ui-context.d.ts
69
+ declare function useUI(): {
70
+ isSidebarOpen: boolean;
71
+ toggleSidebar: () => void;
72
+ closeSidebar: () => void;
73
+ };
354
74
  //#endregion
355
75
  //#region src/client/hooks/use-navbar.d.ts
356
76
  declare function useNavbar(): {
@@ -364,22 +84,17 @@ declare function useNavbar(): {
364
84
  };
365
85
  github: string | null;
366
86
  social: BoltdocsSocialLink[];
367
- config: BoltdocsConfig$1;
87
+ config: BoltdocsConfig;
368
88
  theme: Theme;
369
89
  };
370
90
  //#endregion
371
91
  //#region src/client/hooks/use-sidebar.d.ts
372
92
  declare function useSidebar(routes: ComponentRoute[]): {
373
- groups: {
374
- routes: ComponentRoute[];
375
- slug: string;
376
- title: string;
377
- icon?: string;
378
- }[];
93
+ groups: any[];
379
94
  ungrouped: ComponentRoute[];
380
95
  activeRoute: ComponentRoute | undefined;
381
96
  activePath: string;
382
- config: BoltdocsConfig$1;
97
+ config: BoltdocsConfig;
383
98
  };
384
99
  //#endregion
385
100
  //#region src/client/hooks/use-search.d.ts
@@ -395,21 +110,6 @@ declare function useSearch(routes: ComponentRoute[]): {
395
110
  };
396
111
  };
397
112
  //#endregion
398
- //#region src/client/hooks/use-onthispage.d.ts
399
- interface Heading {
400
- id: string;
401
- text: string;
402
- level: number;
403
- }
404
- /**
405
- * Hook to manage and provide current page headings for the OnThisPage component.
406
- */
407
- declare function useOnThisPage(headings?: Heading[]): {
408
- headings: Heading[];
409
- activeId: string | null;
410
- setActiveId: _$react.Dispatch<_$react.SetStateAction<string | null>>;
411
- };
412
- //#endregion
413
113
  //#region src/client/hooks/use-tabs.d.ts
414
114
  declare function useTabs(tabs?: BoltdocsTab[], routes?: ComponentRoute[]): {
415
115
  tabs: BoltdocsTab[];
@@ -421,16 +121,16 @@ declare function useTabs(tabs?: BoltdocsTab[], routes?: ComponentRoute[]): {
421
121
  //#endregion
422
122
  //#region src/client/hooks/use-version.d.ts
423
123
  interface VersionOption {
424
- key: string;
124
+ key: BoltdocsVersion;
425
125
  label: string;
426
126
  value: string;
427
127
  isCurrent: boolean;
428
128
  }
429
129
  interface UseVersionReturn {
430
- currentVersion: string | undefined;
130
+ currentVersion: BoltdocsVersion | undefined;
431
131
  currentVersionLabel: string | undefined;
432
132
  availableVersions: VersionOption[];
433
- handleVersionChange: (version: string) => void;
133
+ handleVersionChange: (version: BoltdocsVersion) => void;
434
134
  }
435
135
  /**
436
136
  * Hook to manage and switch between different versions of the documentation.
@@ -439,16 +139,16 @@ declare function useVersion(): UseVersionReturn;
439
139
  //#endregion
440
140
  //#region src/client/hooks/use-i18n.d.ts
441
141
  interface LocaleOption {
442
- key: string;
142
+ key: BoltdocsLocale;
443
143
  label: string;
444
144
  value: string;
445
145
  isCurrent: boolean;
446
146
  }
447
147
  interface UseI18nReturn {
448
- currentLocale: string | undefined;
148
+ currentLocale: BoltdocsLocale | undefined;
449
149
  currentLocaleLabel: string | undefined;
450
150
  availableLocales: LocaleOption[];
451
- handleLocaleChange: (locale: string) => void;
151
+ handleLocaleChange: (locale: BoltdocsLocale) => void;
452
152
  }
453
153
  /**
454
154
  * Hook to manage and switch between different locales (languages) of the documentation.
@@ -482,1055 +182,176 @@ declare function useBreadcrumbs(): {
482
182
  activeRoute: ComponentRoute | undefined;
483
183
  };
484
184
  //#endregion
185
+ //#region src/client/hooks/use-routes.d.ts
186
+ /**
187
+ * Hook to access the framework's routing state.
188
+ * Returns both the complete set of routes and a filtered list based on the current
189
+ * version and locale.
190
+ */
191
+ declare function useRoutes(): {
192
+ routes: ComponentRoute[];
193
+ allRoutes: ComponentRoute[];
194
+ currentRoute: ComponentRoute | undefined;
195
+ currentLocale: BoltdocsLocale;
196
+ currentVersion: BoltdocsVersion;
197
+ };
198
+ //#endregion
485
199
  //#region src/client/hooks/use-localized-to.d.ts
486
200
  /**
487
201
  * Hook to automatically localize a path based on the current version and locale context.
488
202
  * It ensures that navigation preserves the active version and language across the entire site.
489
203
  */
490
- declare function useLocalizedTo(to: LinkProps$1['to']): _$react_router_dom0.To;
204
+ declare function useLocalizedTo(to: string): string;
205
+ declare function useLocalizedTo(to: LinkProps['to']): LinkProps['to'];
491
206
  //#endregion
492
207
  //#region src/client/hooks/use-location.d.ts
493
208
  declare const useLocation: () => _$react_router_dom0.Location<any>;
494
209
  //#endregion
495
- //#region src/client/components/docs-layout.d.ts
496
- /**
497
- * Props shared by all layout slot components.
498
- */
499
- interface SlotProps {
500
- children?: React.ReactNode;
501
- className?: string;
502
- style?: React.CSSProperties;
503
- }
504
- /**
505
- * Horizontal flex container for sidebar + content + toc.
506
- */
507
- declare function Body({
508
- children,
509
- className,
510
- style
511
- }: SlotProps): _$react_jsx_runtime0.JSX.Element;
512
- /**
513
- * Main scrollable content area.
514
- */
515
- declare function Content({
516
- children,
517
- className,
518
- style
519
- }: SlotProps): _$react_jsx_runtime0.JSX.Element;
210
+ //#region src/client/hooks/use-search-highlight.d.ts
520
211
  /**
521
- * MDX Content wrapper with standard page padding and max-width logic.
212
+ * Hook to highlight search terms based on the 'hl' query parameter.
522
213
  */
523
- declare function ContentMdx({
524
- children,
525
- className,
526
- style
527
- }: SlotProps): _$react_jsx_runtime0.JSX.Element;
528
- /**
529
- * Content header row (breadcrumbs + copy markdown).
530
- */
531
- declare function ContentHeader({
532
- children,
533
- className,
534
- style
535
- }: SlotProps): _$react_jsx_runtime0.JSX.Element;
536
- /**
537
- * Footer area inside the content section (page nav).
538
- */
539
- declare function ContentFooter({
540
- children,
541
- className,
542
- style
543
- }: SlotProps): _$react_jsx_runtime0.JSX.Element;
544
- interface DocsLayoutComponent extends React.FC<SlotProps> {
545
- Body: typeof Body;
546
- Content: typeof Content;
547
- ContentMdx: typeof ContentMdx;
548
- ContentHeader: typeof ContentHeader;
549
- ContentFooter: typeof ContentFooter;
214
+ declare function useSearchHighlight(containerSelector?: string): void;
215
+ //#endregion
216
+ //#region src/client/hooks/use-analytics.d.ts
217
+ declare global {
218
+ interface Window {
219
+ gtag?: (...args: unknown[]) => void;
220
+ dataLayer?: unknown[];
221
+ gtag_report_conversion?: (url?: string) => boolean;
222
+ }
550
223
  }
551
- declare const DocsLayout: DocsLayoutComponent;
224
+ interface AnalyticsEvent {
225
+ action: string;
226
+ category?: string;
227
+ label?: string;
228
+ value?: number;
229
+ params?: Record<string, unknown>;
230
+ }
231
+ interface AnalyticsInstance {
232
+ trackPageView: (path: string, title?: string) => void;
233
+ trackEvent: (event: AnalyticsEvent) => void;
234
+ trackSearch: (query: string, resultsCount?: number) => void;
235
+ trackDownload: (file: string, type?: string) => void;
236
+ trackExternalLink: (url: string) => void;
237
+ isEnabled: boolean;
238
+ }
239
+ interface UseAnalyticsOptions {
240
+ config?: BoltdocsIntegrationsConfig;
241
+ autoTrackPageViews?: boolean;
242
+ autoTrackDownloads?: boolean;
243
+ autoTrackExternalLinks?: boolean;
244
+ excludePatterns?: RegExp[];
245
+ }
246
+ declare function useAnalytics(options?: UseAnalyticsOptions): AnalyticsInstance;
247
+ declare function useTrackPageView(): (path: string, title?: string) => void;
248
+ declare function useTrackEvent(): (event: AnalyticsEvent) => void;
249
+ //#endregion
250
+ //#region src/client/components/docs-layout-default.d.ts
251
+ declare const DocsLayout: any;
552
252
  //#endregion
553
253
  //#region src/client/components/ui-base/navbar.d.ts
554
254
  declare function Navbar(): _$react_jsx_runtime0.JSX.Element;
555
255
  //#endregion
556
256
  //#region src/client/components/ui-base/sidebar.d.ts
557
- declare function Sidebar$1({
257
+ interface SidebarProps$1 {
258
+ routes: ComponentRoute[];
259
+ config: BoltdocsConfig;
260
+ }
261
+ declare function SidebarMain({
558
262
  routes,
559
263
  config
560
- }: {
561
- routes: ComponentRoute[];
562
- config: BoltdocsConfig$1;
563
- }): _$react_jsx_runtime0.JSX.Element;
264
+ }: SidebarProps$1): _$react_jsx_runtime0.JSX.Element;
265
+ declare const Sidebar: typeof SidebarMain & {
266
+ Root: typeof SidebarRoot;
267
+ Mobile: typeof SidebarMobile;
268
+ Header: typeof SidebarHeader;
269
+ Content: typeof SidebarContent;
270
+ Group: ({
271
+ title,
272
+ icon: Icon,
273
+ children,
274
+ className
275
+ }: {
276
+ title?: string;
277
+ icon?: React.ElementType;
278
+ } & ComponentBase) => _$react_jsx_runtime0.JSX.Element;
279
+ Link: ({
280
+ label,
281
+ href,
282
+ active,
283
+ icon: Icon,
284
+ badge,
285
+ className
286
+ }: SidebarLinkProps) => _$react_jsx_runtime0.JSX.Element;
287
+ SubGroup: ({
288
+ label,
289
+ href,
290
+ active,
291
+ icon: Icon,
292
+ badge,
293
+ isOpen,
294
+ onToggle,
295
+ children,
296
+ className
297
+ }: SidebarLinkProps & {
298
+ isOpen: boolean;
299
+ onToggle: () => void;
300
+ children: _$react.ReactNode;
301
+ }) => _$react_jsx_runtime0.JSX.Element;
302
+ Item: typeof SidebarItem;
303
+ Items: typeof SidebarItems;
304
+ };
564
305
  //#endregion
565
306
  //#region src/client/components/ui-base/on-this-page.d.ts
566
307
  declare function OnThisPage({
567
- headings: rawHeadings,
308
+ headings,
568
309
  editLink,
569
310
  communityHelp,
570
311
  filePath
571
312
  }: OnThisPageProps): _$react_jsx_runtime0.JSX.Element | null;
572
313
  //#endregion
573
- //#region src/client/components/ui-base/head.d.ts
574
- interface HeadProps {
575
- siteTitle: string;
576
- siteDescription?: string;
577
- routes: Array<{
578
- path: string;
579
- title: string;
580
- description?: string;
581
- seo?: Record<string, any>;
582
- }>;
583
- }
584
- declare function Head({
585
- siteTitle,
586
- siteDescription,
587
- routes
588
- }: HeadProps): _$react_jsx_runtime0.JSX.Element;
589
- //#endregion
590
314
  //#region src/client/components/ui-base/breadcrumbs.d.ts
591
315
  declare function Breadcrumbs(): _$react_jsx_runtime0.JSX.Element | null;
592
316
  //#endregion
593
317
  //#region src/client/components/ui-base/page-nav.d.ts
594
318
  /**
595
319
  * Component to display the previous and next page navigation buttons.
596
- * Enhanced with subtle entrance animations and a modern card layout.
320
+ * Enhanced with subtle entrance animations, modern card layout, and hover highlights.
597
321
  */
598
322
  declare function PageNav(): _$react_jsx_runtime0.JSX.Element | null;
599
323
  //#endregion
600
324
  //#region src/client/components/ui-base/error-boundary.d.ts
601
- interface Props {
325
+ interface ErrorBoundaryProps {
602
326
  children?: ReactNode;
603
327
  fallback?: ReactNode;
604
328
  }
605
- interface State {
606
- hasError: boolean;
607
- error?: Error;
608
- }
609
- declare class ErrorBoundary extends Component<Props, State> {
610
- state: State;
611
- static getDerivedStateFromError(error: Error): State;
612
- componentDidCatch(error: Error, errorInfo: ErrorInfo): void;
613
- render(): string | number | bigint | boolean | Iterable<ReactNode> | Promise<string | number | bigint | boolean | _$react.ReactPortal | _$react.ReactElement<unknown, string | _$react.JSXElementConstructor<any>> | Iterable<ReactNode> | null | undefined> | _$react_jsx_runtime0.JSX.Element | null | undefined;
614
- }
329
+ declare function ErrorBoundary({
330
+ children,
331
+ fallback
332
+ }: ErrorBoundaryProps): _$react_jsx_runtime0.JSX.Element;
615
333
  //#endregion
616
334
  //#region src/client/components/ui-base/copy-markdown.d.ts
617
335
  interface CopyMarkdownProps {
618
336
  content?: string;
619
337
  mdxRaw?: string;
620
338
  route?: ComponentRoute;
621
- config?: boolean | {
622
- text?: string;
623
- icon?: string;
624
- };
625
339
  }
626
340
  declare function CopyMarkdown({
627
341
  content,
628
- mdxRaw,
629
- config
342
+ mdxRaw
630
343
  }: CopyMarkdownProps): _$react_jsx_runtime0.JSX.Element | null;
631
344
  //#endregion
345
+ //#region src/client/components/ui-base/search-dialog.d.ts
346
+ declare function SearchDialog({
347
+ routes
348
+ }: {
349
+ routes: ComponentRoute[];
350
+ }): _$react_jsx_runtime0.JSX.Element;
351
+ //#endregion
632
352
  //#region src/client/components/ui-base/not-found.d.ts
633
353
  declare function NotFound(): _$react_jsx_runtime0.JSX.Element;
634
354
  //#endregion
635
- //#region src/client/components/ui-base/loading.d.ts
636
- /**
637
- * A premium loading component that only skeletons the markdown content area.
638
- * Designed to be used as a Suspense fallback within a persistent layout.
639
- */
640
- declare function Loading(): _$react_jsx_runtime0.JSX.Element;
641
- //#endregion
642
- //#region src/client/components/mdx/code-block.d.ts
643
- interface CodeBlockProps {
644
- children?: React.ReactNode;
645
- className?: string;
646
- hideCopy?: boolean;
647
- title?: string;
648
- lang?: string;
649
- highlightedHtml?: string;
650
- 'data-lang'?: string;
651
- 'data-title'?: string;
652
- plain?: boolean;
653
- [key: string]: any;
654
- }
655
- declare function CodeBlock(props: CodeBlockProps): _$react_jsx_runtime0.JSX.Element;
656
- //#endregion
657
- //#region src/client/components/mdx/video.d.ts
658
- interface VideoProps {
659
- src?: string;
660
- poster?: string;
661
- alt?: string;
662
- controls?: boolean;
663
- preload?: string;
664
- children?: React.ReactNode;
665
- [key: string]: any;
666
- }
667
- declare function Video({
668
- src,
669
- poster,
670
- alt,
671
- children,
672
- controls,
673
- preload,
674
- ...rest
675
- }: VideoProps): _$react_jsx_runtime0.JSX.Element;
676
- //#endregion
677
- //#region src/client/components/primitives/button.d.ts
678
- declare const buttonVariants: (props?: ({
679
- variant?: "link" | "primary" | "secondary" | "outline" | "ghost" | "danger" | "success" | "warning" | "info" | "subtle" | null | undefined;
680
- size?: "sm" | "md" | "lg" | null | undefined;
681
- rounded?: "sm" | "md" | "lg" | "none" | "full" | null | undefined;
682
- iconSize?: "sm" | "md" | "lg" | null | undefined;
683
- disabled?: boolean | null | undefined;
684
- } & _$class_variance_authority_types0.ClassProp) | undefined) => string;
685
- type ButtonVariantType = VariantProps<typeof buttonVariants>;
686
- interface ButtonProps extends Omit<RAC.ButtonProps, 'children' | 'className'>, ButtonVariantType {
687
- icon?: React.ReactNode;
688
- iconPosition?: 'left' | 'right';
689
- href?: string;
690
- children?: React.ReactNode;
691
- className?: string;
692
- isIconOnly?: boolean;
693
- }
694
- declare const Button$1: ({
695
- href,
696
- icon,
697
- iconPosition,
698
- isIconOnly,
699
- children,
700
- className,
701
- variant,
702
- size,
703
- rounded,
704
- iconSize,
705
- disabled,
706
- ...props
707
- }: ButtonProps) => _$react_jsx_runtime0.JSX.Element;
708
- //#endregion
709
- //#region src/client/components/mdx/button.d.ts
710
- declare const Button: ({
711
- className,
712
- variant,
713
- size,
714
- rounded,
715
- iconSize,
716
- disabled,
717
- ...props
718
- }: ButtonProps) => _$react_jsx_runtime0.JSX.Element;
719
- //#endregion
720
- //#region src/client/components/mdx/tabs.d.ts
721
- interface TabProps {
722
- label: string;
723
- icon?: React.ReactNode;
724
- disabled?: boolean;
725
- children: React.ReactNode;
726
- }
727
- declare function Tab({
728
- children
729
- }: TabProps): _$react_jsx_runtime0.JSX.Element;
730
- interface TabsProps {
731
- defaultIndex?: number;
732
- children: React.ReactNode;
733
- }
734
- declare function Tabs$1({
735
- defaultIndex,
736
- children
737
- }: TabsProps): _$react_jsx_runtime0.JSX.Element;
738
- //#endregion
739
- //#region src/client/components/mdx/badge.d.ts
740
- declare const badgeVariants: (props?: ({
741
- variant?: "default" | "primary" | "danger" | "success" | "warning" | "info" | null | undefined;
742
- } & _$class_variance_authority_types0.ClassProp) | undefined) => string;
743
- interface BadgeProps extends React.HTMLAttributes<HTMLSpanElement>, VariantProps<typeof badgeVariants> {
744
- children: React.ReactNode;
745
- }
746
- declare function Badge({
747
- variant,
748
- children,
749
- className,
750
- ...rest
751
- }: BadgeProps): _$react_jsx_runtime0.JSX.Element;
752
- //#endregion
753
- //#region src/client/components/mdx/card.d.ts
754
- declare const cardsVariants: (props?: ({
755
- cols?: 1 | 2 | 3 | 4 | null | undefined;
756
- } & _$class_variance_authority_types0.ClassProp) | undefined) => string;
757
- type CardsVariants = VariantProps<typeof cardsVariants>;
758
- interface CardsProps extends React.HTMLAttributes<HTMLDivElement>, CardsVariants {}
759
- declare function Cards({
760
- cols,
761
- children,
762
- className,
763
- ...rest
764
- }: CardsProps): _$react_jsx_runtime0.JSX.Element;
765
- interface CardProps extends React.HTMLAttributes<HTMLDivElement> {
766
- title?: string;
767
- icon?: React.ReactNode;
768
- href?: string;
769
- children?: React.ReactNode;
770
- }
771
- declare function Card({
772
- title,
773
- icon,
774
- href,
775
- children,
776
- className,
777
- ...rest
778
- }: CardProps): _$react_jsx_runtime0.JSX.Element;
779
- //#endregion
780
- //#region src/client/components/mdx/admonition.d.ts
781
- declare const admonitionVariants: (props?: ({
782
- type?: "danger" | "warning" | "info" | "note" | "tip" | "important" | "caution" | null | undefined;
783
- } & _$class_variance_authority_types0.ClassProp) | undefined) => string;
784
- type AdmonitionVariants = VariantProps<typeof admonitionVariants>;
785
- interface AdmonitionProps extends React.HTMLAttributes<HTMLDivElement>, AdmonitionVariants {
786
- title?: string;
787
- children: React.ReactNode;
788
- }
789
- declare function Admonition({
790
- type,
791
- title,
792
- children,
793
- className,
794
- ...rest
795
- }: AdmonitionProps): _$react_jsx_runtime0.JSX.Element;
796
- declare const Note: (props: Omit<AdmonitionProps, "type">) => _$react_jsx_runtime0.JSX.Element;
797
- declare const Tip: (props: Omit<AdmonitionProps, "type">) => _$react_jsx_runtime0.JSX.Element;
798
- declare const Warning: (props: Omit<AdmonitionProps, "type">) => _$react_jsx_runtime0.JSX.Element;
799
- declare const Danger: (props: Omit<AdmonitionProps, "type">) => _$react_jsx_runtime0.JSX.Element;
800
- declare const InfoBox: (props: Omit<AdmonitionProps, "type">) => _$react_jsx_runtime0.JSX.Element;
801
- declare const Important: (props: Omit<AdmonitionProps, "type">) => _$react_jsx_runtime0.JSX.Element;
802
- declare const Caution: (props: Omit<AdmonitionProps, "type">) => _$react_jsx_runtime0.JSX.Element;
803
- //#endregion
804
- //#region src/client/components/mdx/list.d.ts
805
- declare const listVariants: (props?: ({
806
- variant?: "number" | "default" | "checked" | "arrow" | "bubble" | null | undefined;
807
- cols?: 1 | 2 | 3 | 4 | null | undefined;
808
- isGrid?: boolean | null | undefined;
809
- dense?: boolean | null | undefined;
810
- } & _$class_variance_authority_types0.ClassProp) | undefined) => string;
811
- type ListVariantProps = VariantProps<typeof listVariants>;
812
- interface ListProps extends ComponentPropsWithoutRef<'ul'>, Omit<ListVariantProps, 'variant'> {
813
- variant?: 'checked' | 'arrow' | 'default' | 'bubble' | 'number';
814
- children: ReactNode;
815
- }
816
- declare function List({
817
- variant,
818
- cols,
819
- dense,
820
- children,
821
- className,
822
- ...props
823
- }: ListProps): _$react_jsx_runtime0.JSX.Element;
824
- //#endregion
825
- //#region src/client/components/mdx/file-tree.d.ts
826
- interface FileTreeProps {
827
- children: React.ReactNode;
828
- }
829
- declare function FileTree({
830
- children
831
- }: FileTreeProps): _$react_jsx_runtime0.JSX.Element;
832
- //#endregion
833
- //#region src/client/components/mdx/table.d.ts
834
- interface TableProps {
835
- headers?: string[];
836
- data?: (string | React.ReactNode)[][];
837
- children?: React.ReactNode;
838
- className?: string;
839
- sortable?: boolean;
840
- paginated?: boolean;
841
- pageSize?: number;
842
- }
843
- declare function Table({
844
- headers,
845
- data,
846
- children,
847
- className,
848
- sortable,
849
- paginated,
850
- pageSize
851
- }: TableProps): _$react_jsx_runtime0.JSX.Element;
852
- //#endregion
853
- //#region src/client/components/mdx/field.d.ts
854
- interface FieldProps {
855
- name: string;
856
- type?: string;
857
- defaultValue?: string;
858
- required?: boolean;
859
- children: React.ReactNode;
860
- id?: string;
861
- className?: string;
862
- }
863
- declare function Field({
864
- name,
865
- type,
866
- defaultValue,
867
- required,
868
- children,
869
- id,
870
- className
871
- }: FieldProps): _$react_jsx_runtime0.JSX.Element;
872
- //#endregion
873
- //#region src/client/components/primitives/link.d.ts
874
- interface LinkProps$3 extends LinkProps$2 {
875
- /** Should prefetch the page on hover? Default 'hover' */
876
- prefetch?: 'hover' | 'none';
877
- }
878
- /**
879
- * A primitive Link component that wraps React Aria Components' Link
880
- * and adds framework-specific logic for path localization and preloading.
881
- *
882
- * It uses the global navigation configuration from BoltdocsRouterProvider
883
- * to handle seamless client-side transitions.
884
- */
885
- declare const Link$1: _$react.ForwardRefExoticComponent<LinkProps$3 & _$react.RefAttributes<HTMLAnchorElement>>;
886
- /**
887
- * Props for the NavLink component, extending standard Link props.
888
- */
889
- interface NavLinkProps extends Omit<LinkProps$3, 'className' | 'children'> {
890
- /**
891
- * When true, the active state will only be applied if the paths match exactly.
892
- * Default is false.
893
- */
894
- end?: boolean;
895
- /**
896
- * Provides access to the active state for conditional children rendering.
897
- */
898
- children?: React.ReactNode | ((props: {
899
- isActive: boolean;
900
- }) => React.ReactNode);
901
- /**
902
- * Provides access to the active state for conditional styling.
903
- */
904
- className?: string | ((props: {
905
- isActive: boolean;
906
- }) => string);
907
- }
908
- /**
909
- * A primitive NavLink component that provides active state detection.
910
- *
911
- * It combines the Link primitive with path matching logic to determine
912
- * if the link is currently active based on the browser's location.
913
- */
914
- declare const NavLink: _$react.ForwardRefExoticComponent<NavLinkProps & _$react.RefAttributes<HTMLAnchorElement>>;
915
- //#endregion
916
- //#region src/client/components/mdx/link.d.ts
917
- type LinkProps = LinkProps$3 & {
918
- to: string;
919
- children?: React.ReactNode;
920
- };
921
- /**
922
- * A premium Link component for Boltdocs that handles internal and external routing.
923
- */
924
- declare function Link({
925
- to,
926
- children,
927
- className,
928
- ...props
929
- }: LinkProps): _$react_jsx_runtime0.JSX.Element;
930
- //#endregion
931
- //#region src/client/components/mdx/image.d.ts
932
- interface ImageProps extends ImgHTMLAttributes<HTMLImageElement> {
933
- src: string;
934
- darkSrc?: string;
935
- theme?: 'light' | 'dark';
936
- }
937
- /**
938
- * A themed Image component for Boltdocs.
939
- * It supports rendering based on the current active theme.
940
- */
941
- declare function Image({
942
- src,
943
- alt,
944
- theme: imageTheme,
945
- ...props
946
- }: ImageProps): _$react_jsx_runtime0.JSX.Element | null;
947
- //#endregion
948
- //#region src/client/components/mdx/component-props.d.ts
949
- interface PropItem {
950
- name: string;
951
- type: string;
952
- defaultValue?: string;
953
- required?: boolean;
954
- description: React.ReactNode;
955
- }
956
- interface ComponentPropsProps {
957
- title?: string;
958
- props: PropItem[];
959
- className?: string;
960
- }
961
- declare function ComponentProps({
962
- title,
963
- props,
964
- className
965
- }: ComponentPropsProps): _$react_jsx_runtime0.JSX.Element;
966
- //#endregion
967
- //#region src/client/components/mdx/component-preview.d.ts
968
- interface ComponentPreviewProps {
969
- code?: string;
970
- highlightedHtml?: string;
971
- children?: string;
972
- preview?: React.ReactNode;
973
- hideCode?: boolean;
974
- hideCopy?: boolean;
975
- }
976
- declare function ComponentPreview(props: ComponentPreviewProps): _$react_jsx_runtime0.JSX.Element;
977
- //#endregion
978
- //#region src/client/components/primitives/types.d.ts
979
- type ComponentBase = {
980
- className?: string;
981
- children?: ReactNode;
982
- };
983
- //#endregion
984
- //#region src/client/components/primitives/navbar.d.ts
985
- interface NavbarLinkProps extends Omit<ComponentBase, 'children'> {
986
- label: ReactNode;
987
- href: string;
988
- active?: boolean;
989
- to?: 'internal' | 'external';
990
- }
991
- interface NavbarLogoProps extends Omit<ComponentBase, 'children'> {
992
- src: string;
993
- alt: string;
994
- width?: number;
995
- height?: number;
996
- }
997
- interface NavbarSearchTriggerProps extends ComponentBase {
998
- onPress: () => void;
999
- }
1000
- interface NavbarThemeProps {
1001
- className?: string;
1002
- theme: 'dark' | 'light';
1003
- onThemeChange: (isSelected: boolean) => void;
1004
- }
1005
- interface NavbarSocialsProps extends ComponentBase {
1006
- icon: string;
1007
- link: string;
1008
- }
1009
- declare const Navbar$1: {
1010
- ({
1011
- children,
1012
- className,
1013
- ...props
1014
- }: ComponentBase): _$react_jsx_runtime0.JSX.Element;
1015
- Root: /*elided*/any;
1016
- Left: ({
1017
- children,
1018
- className
1019
- }: ComponentBase) => _$react_jsx_runtime0.JSX.Element;
1020
- Right: ({
1021
- children,
1022
- className
1023
- }: ComponentBase) => _$react_jsx_runtime0.JSX.Element;
1024
- Center: ({
1025
- children,
1026
- className
1027
- }: ComponentBase) => _$react_jsx_runtime0.JSX.Element;
1028
- Logo: ({
1029
- src,
1030
- alt,
1031
- width,
1032
- height,
1033
- className
1034
- }: NavbarLogoProps) => _$react_jsx_runtime0.JSX.Element;
1035
- Title: ({
1036
- children,
1037
- className
1038
- }: ComponentBase) => _$react_jsx_runtime0.JSX.Element;
1039
- Links: ({
1040
- children,
1041
- className
1042
- }: ComponentBase) => _$react_jsx_runtime0.JSX.Element;
1043
- Link: ({
1044
- label,
1045
- href,
1046
- active,
1047
- to,
1048
- className
1049
- }: NavbarLinkProps) => _$react_jsx_runtime0.JSX.Element;
1050
- SearchTrigger: ({
1051
- className,
1052
- onPress
1053
- }: NavbarSearchTriggerProps) => _$react_jsx_runtime0.JSX.Element;
1054
- Theme: ({
1055
- className,
1056
- theme,
1057
- onThemeChange
1058
- }: NavbarThemeProps) => _$react_jsx_runtime0.JSX.Element;
1059
- Socials: ({
1060
- icon,
1061
- link,
1062
- className
1063
- }: NavbarSocialsProps) => _$react_jsx_runtime0.JSX.Element;
1064
- Split: ({
1065
- className
1066
- }: ComponentBase) => _$react_jsx_runtime0.JSX.Element;
1067
- Content: ({
1068
- children,
1069
- className
1070
- }: ComponentBase) => _$react_jsx_runtime0.JSX.Element;
1071
- };
1072
- //#endregion
1073
- //#region src/client/components/primitives/navigation-menu.d.ts
1074
- interface NavigationMenuItemProps extends ComponentBase {
1075
- label: string;
1076
- }
1077
- interface NavigationMenuLinkProps extends Omit<ComponentBase, 'children'> {
1078
- href: string;
1079
- label: string;
1080
- description?: string;
1081
- children?: React.ReactNode | ((opts: RAC.MenuItemRenderProps) => React.ReactNode);
1082
- }
1083
- declare const NavigationMenu: {
1084
- ({
1085
- children,
1086
- className,
1087
- ...props
1088
- }: ComponentBase): _$react_jsx_runtime0.JSX.Element;
1089
- Root: /*elided*/any;
1090
- List: ({
1091
- children,
1092
- className
1093
- }: ComponentBase) => _$react_jsx_runtime0.JSX.Element;
1094
- Item: ({
1095
- children,
1096
- label,
1097
- className
1098
- }: NavigationMenuItemProps) => _$react_jsx_runtime0.JSX.Element;
1099
- Link: ({
1100
- label,
1101
- href,
1102
- description,
1103
- className,
1104
- children,
1105
- ...props
1106
- }: NavigationMenuLinkProps) => _$react_jsx_runtime0.JSX.Element;
1107
- };
1108
- //#endregion
1109
- //#region src/client/components/primitives/search-dialog.d.ts
1110
- interface SearchDialogProps extends ComponentBase {
1111
- isOpen?: boolean;
1112
- onOpenChange?: (isOpen: boolean) => void;
1113
- }
1114
- interface SearchDialogItemProps extends Omit<RAC.ListBoxItemProps, 'children'> {
1115
- className?: string;
1116
- children: React.ReactNode;
1117
- }
1118
- interface SearchDialogItemIconProps {
1119
- isHeading?: boolean;
1120
- className?: string;
1121
- }
1122
- declare const SearchDialog: {
1123
- ({
1124
- children,
1125
- isOpen,
1126
- onOpenChange,
1127
- className
1128
- }: SearchDialogProps): _$react_jsx_runtime0.JSX.Element;
1129
- Root: /*elided*/any;
1130
- Autocomplete: <T extends object>({
1131
- children,
1132
- className,
1133
- onSelectionChange,
1134
- ...props
1135
- }: RAC.AutocompleteProps<T> & {
1136
- className?: string;
1137
- onSelectionChange?: (key: RAC.Key) => void;
1138
- }) => _$react_jsx_runtime0.JSX.Element;
1139
- Input: ({
1140
- className,
1141
- ...props
1142
- }: RAC.InputProps & {
1143
- className?: string;
1144
- }) => _$react_jsx_runtime0.JSX.Element;
1145
- List: <T extends object>({
1146
- children,
1147
- className,
1148
- ...props
1149
- }: RAC.ListBoxProps<T> & {
1150
- className?: string;
1151
- }) => _$react_jsx_runtime0.JSX.Element;
1152
- Item: (({
1153
- children,
1154
- className,
1155
- ...props
1156
- }: SearchDialogItemProps) => _$react_jsx_runtime0.JSX.Element) & {
1157
- Icon: ({
1158
- isHeading,
1159
- className
1160
- }: SearchDialogItemIconProps) => _$react_jsx_runtime0.JSX.Element;
1161
- Title: ({
1162
- children,
1163
- className
1164
- }: ComponentBase) => _$react_jsx_runtime0.JSX.Element;
1165
- Bio: ({
1166
- children,
1167
- className
1168
- }: ComponentBase) => _$react_jsx_runtime0.JSX.Element;
1169
- };
1170
- };
1171
- //#endregion
1172
- //#region src/client/components/primitives/on-this-page.d.ts
1173
- interface TOCItemType {
1174
- title: ReactNode;
1175
- url: string;
1176
- depth: number;
1177
- _step?: number;
1178
- }
1179
- interface TOCItemInfo {
1180
- id: string;
1181
- active: boolean;
1182
- /** last time the item is updated */
1183
- t: number;
1184
- /** currently active but not intersecting in viewport */
1185
- fallback: boolean;
1186
- original?: TOCItemType;
1187
- }
1188
- interface AnchorProviderProps {
1189
- toc: TOCItemType[];
1190
- /**
1191
- * Only accept one active item at most
1192
- * @defaultValue false
1193
- */
1194
- single?: boolean;
1195
- children?: ReactNode;
1196
- }
1197
- interface ScrollProviderProps {
1198
- /**
1199
- * Scroll into the view of container when active
1200
- */
1201
- containerRef: RefObject<HTMLElement | null>;
1202
- children?: ReactNode;
1203
- }
1204
- interface OnThisPageContentProps extends ComponentBase {
1205
- ref?: React.Ref<HTMLDivElement>;
1206
- scrollRef?: RefObject<HTMLElement | null>;
1207
- }
1208
- interface OnThisPageItemProps extends ComponentBase {
1209
- level?: number;
1210
- }
1211
- interface OnThisPageLinkProps extends ComponentBase {
1212
- href?: string;
1213
- active?: boolean;
1214
- onClick?: (event: React.MouseEvent<HTMLAnchorElement>) => void;
1215
- }
1216
- interface OnThisPageIndicatorProps extends ComponentBase {
1217
- style?: React.CSSProperties;
1218
- }
1219
- declare function useItems(): TOCItemInfo[];
1220
- declare function useActiveAnchor(): string | undefined;
1221
- declare function useActiveAnchors(): string[];
1222
- /** Optional: add auto-scroll to TOC items. */
1223
- declare function ScrollProvider({
1224
- containerRef,
1225
- children
1226
- }: ScrollProviderProps): _$react_jsx_runtime0.JSX.Element;
1227
- declare function AnchorProvider({
1228
- toc,
1229
- single,
1230
- children
1231
- }: AnchorProviderProps): _$react_jsx_runtime0.JSX.Element;
1232
- declare const OnThisPage$1: {
1233
- ({
1234
- children,
1235
- className
1236
- }: ComponentBase): _$react_jsx_runtime0.JSX.Element;
1237
- Root: /*elided*/any;
1238
- Header: ({
1239
- children,
1240
- className,
1241
- ...props
1242
- }: ComponentBase) => _$react_jsx_runtime0.JSX.Element;
1243
- Content: {
1244
- ({
1245
- children,
1246
- className,
1247
- ref,
1248
- ...props
1249
- }: OnThisPageContentProps): _$react_jsx_runtime0.JSX.Element;
1250
- displayName: string;
1251
- };
1252
- List: ({
1253
- children,
1254
- className
1255
- }: ComponentBase) => _$react_jsx_runtime0.JSX.Element;
1256
- Item: ({
1257
- level,
1258
- children,
1259
- className
1260
- }: OnThisPageItemProps) => _$react_jsx_runtime0.JSX.Element;
1261
- Link: ({
1262
- children,
1263
- href,
1264
- active,
1265
- onClick,
1266
- className
1267
- }: OnThisPageLinkProps) => _$react_jsx_runtime0.JSX.Element;
1268
- Indicator: ({
1269
- style,
1270
- className
1271
- }: OnThisPageIndicatorProps) => _$react_jsx_runtime0.JSX.Element;
1272
- };
1273
- //#endregion
1274
- //#region src/client/components/primitives/page-nav.d.ts
1275
- interface PageNavProps extends ComponentBase {
1276
- to: string;
1277
- direction: 'prev' | 'next';
1278
- }
1279
- declare const PageNav$1: {
1280
- ({
1281
- children,
1282
- className
1283
- }: ComponentBase): _$react_jsx_runtime0.JSX.Element;
1284
- Root: /*elided*/any;
1285
- Link: ({
1286
- children,
1287
- to,
1288
- direction,
1289
- className
1290
- }: PageNavProps) => _$react_jsx_runtime0.JSX.Element;
1291
- Title: ({
1292
- children,
1293
- className
1294
- }: ComponentBase) => _$react_jsx_runtime0.JSX.Element;
1295
- Description: ({
1296
- children,
1297
- className
1298
- }: ComponentBase) => _$react_jsx_runtime0.JSX.Element;
1299
- Icon: ({
1300
- children
1301
- }: ComponentBase) => _$react_jsx_runtime0.JSX.Element;
1302
- };
1303
- //#endregion
1304
- //#region src/client/components/primitives/tabs.d.ts
1305
- interface TabsItemProps extends ComponentBase {
1306
- id: string;
1307
- selected?: boolean;
1308
- onClick?: () => void;
1309
- onKeyDown?: (event: React.KeyboardEvent) => void;
1310
- disabled?: boolean;
1311
- }
1312
- interface TabsIndicatorProps extends ComponentBase {
1313
- style?: React.CSSProperties;
1314
- }
1315
- declare const Tabs: {
1316
- ({
1317
- children,
1318
- className,
1319
- ...props
1320
- }: ComponentBase): _$react_jsx_runtime0.JSX.Element;
1321
- Root: /*elided*/any;
1322
- List: ({
1323
- children,
1324
- className
1325
- }: ComponentBase) => _$react_jsx_runtime0.JSX.Element;
1326
- Item: ({
1327
- children,
1328
- id,
1329
- selected,
1330
- className,
1331
- ...props
1332
- }: TabsItemProps) => _$react_jsx_runtime0.JSX.Element;
1333
- Content: ({
1334
- children,
1335
- className
1336
- }: ComponentBase) => _$react_jsx_runtime0.JSX.Element;
1337
- Indicator: ({
1338
- className,
1339
- style
1340
- }: TabsIndicatorProps) => _$react_jsx_runtime0.JSX.Element;
1341
- };
1342
- //#endregion
1343
- //#region src/client/components/primitives/sidebar.d.ts
1344
- interface SidebarGroupProps extends ComponentBase {
1345
- title?: string;
1346
- icon?: React.ElementType;
1347
- }
1348
- interface SidebarSubGroupProps extends SidebarLinkProps {
1349
- isOpen?: boolean;
1350
- onToggle?: () => void;
1351
- children?: React.ReactNode;
1352
- }
1353
- interface SidebarLinkProps extends ComponentBase {
1354
- label: string;
1355
- href: string;
1356
- active?: boolean;
1357
- icon?: React.ElementType;
1358
- badge?: ComponentRoute['badge'];
1359
- }
1360
- declare const Sidebar: {
1361
- ({
1362
- children,
1363
- className
1364
- }: ComponentBase): _$react_jsx_runtime0.JSX.Element;
1365
- Root: /*elided*/any;
1366
- Group: ({
1367
- children,
1368
- title,
1369
- icon: Icon,
1370
- className
1371
- }: SidebarGroupProps) => _$react_jsx_runtime0.JSX.Element;
1372
- SubGroup: ({
1373
- label,
1374
- href,
1375
- active,
1376
- icon: Icon,
1377
- badge,
1378
- className,
1379
- isOpen,
1380
- onToggle,
1381
- children
1382
- }: SidebarSubGroupProps) => _$react_jsx_runtime0.JSX.Element;
1383
- GroupItem: ({
1384
- children,
1385
- className
1386
- }: ComponentBase) => _$react_jsx_runtime0.JSX.Element;
1387
- Link: ({
1388
- label,
1389
- href,
1390
- active,
1391
- icon: Icon,
1392
- badge,
1393
- className
1394
- }: SidebarLinkProps) => _$react_jsx_runtime0.JSX.Element;
1395
- };
1396
- //#endregion
1397
- //#region src/client/components/primitives/breadcrumbs.d.ts
1398
- declare const Breadcrumbs$1: {
1399
- ({
1400
- children,
1401
- className,
1402
- ...props
1403
- }: ComponentBase): _$react_jsx_runtime0.JSX.Element;
1404
- Root: /*elided*/any;
1405
- Item: ({
1406
- children,
1407
- className,
1408
- ...props
1409
- }: ComponentBase) => _$react_jsx_runtime0.JSX.Element;
1410
- Link: ({
1411
- children,
1412
- href,
1413
- className,
1414
- ...props
1415
- }: LinkProps$2 & {
1416
- className?: string;
1417
- }) => _$react_jsx_runtime0.JSX.Element;
1418
- Separator: ({
1419
- className
1420
- }: ComponentBase) => _$react_jsx_runtime0.JSX.Element;
1421
- };
1422
- //#endregion
1423
- //#region src/client/components/primitives/button-group.d.ts
1424
- interface ButtonGroupProps extends ComponentBase {
1425
- vertical?: boolean;
1426
- }
1427
- declare const ButtonGroup: ({
1428
- children,
1429
- className,
1430
- vertical
1431
- }: ButtonGroupProps) => _$react_jsx_runtime0.JSX.Element;
1432
- //#endregion
1433
- //#region src/client/components/primitives/popover.d.ts
1434
- interface PopoverProps extends Omit<RAC.PopoverProps, 'children'> {
1435
- children: React.ReactNode;
1436
- className?: string;
1437
- showArrow?: boolean;
1438
- }
1439
- /**
1440
- * A reusable Popover primitive with premium glassmorphism styling and smooth animations.
1441
- */
1442
- declare const Popover: ({
1443
- children,
1444
- className,
1445
- showArrow,
1446
- ...props
1447
- }: PopoverProps) => _$react_jsx_runtime0.JSX.Element;
1448
- //#endregion
1449
- //#region src/client/components/primitives/menu.d.ts
1450
- /**
1451
- * MenuTrigger wraps a trigger (usually a Button) and a Menu.
1452
- */
1453
- interface MenuTriggerProps extends RAC.MenuTriggerProps {
1454
- placement?: PopoverProps['placement'];
1455
- }
1456
- declare function MenuTrigger(props: MenuTriggerProps): _$react_jsx_runtime0.JSX.Element;
1457
- /**
1458
- * SubmenuTrigger for nested menus.
1459
- */
1460
- declare function SubmenuTrigger(props: RAC.SubmenuTriggerProps): _$react_jsx_runtime0.JSX.Element;
1461
- /**
1462
- * The Menu container.
1463
- */
1464
- declare function Menu<T extends object>(props: RAC.MenuProps<T>): _$react_jsx_runtime0.JSX.Element;
1465
- declare namespace Menu {
1466
- var Root: typeof Menu;
1467
- var Item: typeof MenuItem;
1468
- var Trigger: typeof MenuTrigger;
1469
- var SubTrigger: typeof SubmenuTrigger;
1470
- var Section: typeof MenuSection;
1471
- var Separator: typeof MenuSeparator;
1472
- }
1473
- /**
1474
- * MenuItem with support for selection states and submenus.
1475
- */
1476
- declare function MenuItem(props: RAC.MenuItemProps): _$react_jsx_runtime0.JSX.Element;
1477
- /**
1478
- * MenuSection for grouping items with an optional header.
1479
- */
1480
- interface MenuSectionProps<T> extends RAC.MenuSectionProps<T> {
1481
- title?: string;
1482
- }
1483
- declare function MenuSection<T extends object>({
1484
- title,
1485
- ...props
1486
- }: MenuSectionProps<T>): _$react_jsx_runtime0.JSX.Element;
1487
- /**
1488
- * MenuSeparator for visual division.
1489
- */
1490
- declare function MenuSeparator(props: RAC.SeparatorProps): _$react_jsx_runtime0.JSX.Element;
1491
- //#endregion
1492
- //#region src/client/components/primitives/tooltip.d.ts
1493
- interface TooltipProps extends Omit<RAC.TooltipProps, 'children'> {
1494
- /** The content to show inside the tooltip */
1495
- content: ReactNode;
1496
- /** The trigger element (usually a button or link) */
1497
- children: React.ReactElement;
1498
- /** Delay in milliseconds before showing the tooltip */
1499
- delay?: number;
1500
- /** Delay in milliseconds before hiding the tooltip */
1501
- closeDelay?: number;
1502
- }
1503
- interface TooltipContentProps extends RAC.TooltipProps {}
1504
- declare const Tooltip: {
1505
- ({
1506
- content,
1507
- children,
1508
- delay,
1509
- closeDelay,
1510
- ...props
1511
- }: TooltipProps): _$react_jsx_runtime0.JSX.Element;
1512
- Root: /*elided*/any;
1513
- Content: ({
1514
- className,
1515
- children,
1516
- ...props
1517
- }: TooltipContentProps) => _$react_jsx_runtime0.JSX.Element;
1518
- };
1519
- //#endregion
1520
- //#region src/client/components/primitives/skeleton.d.ts
1521
- interface SkeletonProps extends React.HTMLAttributes<HTMLDivElement> {
1522
- variant?: 'rect' | 'circle';
1523
- }
1524
- /**
1525
- * A flexible skeleton component that mimics the shape of content
1526
- * while it is loading. Features a smooth pulse animation.
1527
- */
1528
- declare function Skeleton({
1529
- className,
1530
- variant,
1531
- ...props
1532
- }: SkeletonProps): _$react_jsx_runtime0.JSX.Element;
1533
- //#endregion
1534
355
  //#region src/client/utils/cn.d.ts
1535
356
  declare function cn(...inputs: ClassValue[]): string;
1536
357
  //#endregion
@@ -1545,4 +366,28 @@ declare function cn(...inputs: ClassValue[]): string;
1545
366
  */
1546
367
  declare function getTranslated(value: string | Record<string, string> | undefined, locale?: string): string;
1547
368
  //#endregion
1548
- export { Admonition, type AdmonitionProps, AnchorProvider, Badge, type BadgeProps, BoltdocsShell, Breadcrumbs, Button, ButtonGroup, type ButtonProps, Card, type CardProps, Cards, type CardsProps, Caution, CodeBlock, ComponentPreview, type ComponentPreviewProps, ComponentProps, type ComponentPropsProps, type ComponentRoute, CopyMarkdown, Danger, DocsLayout, ErrorBoundary, Field, type FieldProps, FileTree, type FileTreeProps, Head, Image, type ImageProps, Important, InfoBox, type LayoutProps, Link, type LinkProps, List, type ListProps, Loading, MdxPage, Navbar, NotFound, Note, OnThisPage, PageNav, Breadcrumbs$1 as PrimitiveBreadcrumbs, Button$1 as PrimitiveButton, Link$1 as PrimitiveLink, Menu as PrimitiveMenu, NavLink as PrimitiveNavLink, Navbar$1 as PrimitiveNavbar, NavigationMenu as PrimitiveNavigationMenu, OnThisPage$1 as PrimitiveOnThisPage, PageNav$1 as PrimitivePageNav, Popover as PrimitivePopover, Sidebar as PrimitiveSidebar, Skeleton as PrimitiveSkeleton, Tabs as PrimitiveTabs, Tooltip as PrimitiveTooltip, ScrollProvider, SearchDialog as SearchDialogPrimitive, Sidebar$1 as Sidebar, Tab, type TabProps, Table, type TableProps, Tabs$1 as Tabs, type TabsProps, Tip, Video, Warning, cn, createRoutes, getTranslated, useActiveAnchor, useActiveAnchors, useBreadcrumbs, useConfig, useI18n, useItems, useLocalizedTo, useLocation, useMdxComponents, useNavbar, useOnThisPage, usePageNav, useRoutes, useSearch, useSidebar, useTabs, useTheme, useVersion };
369
+ //#region src/client/utils/react-to-text.d.ts
370
+ type ResolverMap = Map<string | JSXElementConstructor<object>, (props: object) => string>;
371
+ declare const reactToText: (node: ReactNode, resolvers?: ResolverMap) => string;
372
+ //#endregion
373
+ //#region src/client/utils/copy-clipboard.d.ts
374
+ /**
375
+ * Copy text to clipboard.
376
+ * @param text - The text to copy.
377
+ * @returns True if the text was copied successfully.
378
+ */
379
+ declare const copyToClipboard: (text: string) => Promise<boolean>;
380
+ //#endregion
381
+ //#region src/client/utils/github.d.ts
382
+ /**
383
+ * Get the number of stars for a GitHub repository.
384
+ * @param repo - owner/repo
385
+ * @param token - The GitHub token.
386
+ * @param baseUrl - The GitHub API base URL.
387
+ * @returns The number of stars for the repository.
388
+ * @example
389
+ * getStarsRepo('owner/repo') // 100k
390
+ */
391
+ declare function getStarsRepo(repo: string, token?: string, baseUrl?: string): Promise<string>;
392
+ //#endregion
393
+ export { BoltdocsConfig, type BoltdocsLocale, BoltdocsShell, BoltdocsTab, type BoltdocsTypes, type BoltdocsVersion, Breadcrumbs, Card, Cards, ComponentRoute, CopyMarkdown, DocsLayout, ErrorBoundary, LayoutProps, MdxPage, Navbar, NavbarLink, NotFound, OnThisPage, OnThisPageProps, PageNav, SearchDialog, Sidebar, SidebarProps, SiteConfig, TabsProps, cn, copyToClipboard, createRoutes, getStarsRepo, getTranslated, reactToText, useAnalytics, useBreadcrumbs, useConfig, useI18n, useLocalizedTo, useLocation, useMdxComponents, useNavbar, usePageNav, useRoutes, useSearch, useSearchHighlight, useSidebar, useTabs, useTheme, useTrackEvent, useTrackPageView, useUI, useVersion };