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