boltdocs 2.5.4 → 2.5.6
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 +1 -1
- package/dist/cache-Cr8W2zgZ.cjs +6 -0
- package/dist/cache-DFdakSmR.mjs +6 -0
- package/dist/client/index.d.mts +1276 -861
- package/dist/client/index.d.ts +1276 -861
- package/dist/client/index.js +6 -1
- package/dist/client/index.mjs +6 -1
- package/dist/client/ssr.cjs +6 -0
- package/dist/client/ssr.d.cts +80 -0
- package/dist/client/ssr.d.mts +63 -61
- package/dist/client/ssr.mjs +6 -1
- package/dist/client/theme/neutral.css +388 -0
- package/dist/node/cli-entry.cjs +8 -0
- package/dist/node/cli-entry.d.cts +2 -0
- package/dist/node/cli-entry.d.mts +2 -1
- package/dist/node/cli-entry.mjs +7 -5
- package/dist/node/index.cjs +6 -0
- package/dist/node/index.d.cts +574 -0
- package/dist/node/index.d.mts +385 -378
- package/dist/node/index.mjs +6 -1
- package/dist/node-CWXme96p.mjs +73 -0
- package/dist/node-VYfhzGrh.cjs +73 -0
- package/dist/package-BY8Jd2j4.cjs +6 -0
- package/dist/package-OFZf0s2j.mjs +6 -0
- package/dist/search-dialog-BeNyI_KQ.mjs +6 -0
- package/dist/search-dialog-dYsCAk5S.js +6 -0
- package/dist/use-search-D25n0PrV.mjs +6 -0
- package/dist/use-search-WuzdH1cJ.js +6 -0
- package/package.json +16 -12
- package/src/client/app/index.tsx +15 -12
- package/src/client/components/default-layout.tsx +21 -19
- package/src/client/hooks/use-i18n.ts +1 -1
- package/src/client/hooks/use-routes.ts +1 -1
- package/src/client/hooks/use-version.ts +1 -1
- package/src/client/store/boltdocs-context.tsx +119 -0
- package/CHANGELOG.md +0 -92
- package/dist/cache-3FOEPC2P.mjs +0 -1
- package/dist/chunk-IMEKU5U3.mjs +0 -75
- package/dist/chunk-J2PTDWZM.mjs +0 -1
- package/dist/chunk-TP5KMRD3.mjs +0 -1
- package/dist/chunk-Y4RE5KI7.mjs +0 -1
- package/dist/client/ssr.d.ts +0 -78
- package/dist/client/ssr.js +0 -1
- package/dist/node/cli-entry.d.ts +0 -1
- package/dist/node/cli-entry.js +0 -80
- package/dist/node/index.d.ts +0 -567
- package/dist/node/index.js +0 -75
- package/dist/package-KCTE4HFV.mjs +0 -1
- package/dist/search-dialog-O6VLVSOA.mjs +0 -1
- package/src/client/store/use-boltdocs-store.ts +0 -44
- package/src/node/cache.ts +0 -408
- package/src/node/cli/build.ts +0 -53
- package/src/node/cli/dev.ts +0 -22
- package/src/node/cli/doctor.ts +0 -243
- package/src/node/cli/index.ts +0 -9
- package/src/node/cli/ui.ts +0 -54
- package/src/node/cli-entry.ts +0 -24
- package/src/node/config.ts +0 -382
- package/src/node/errors.ts +0 -44
- package/src/node/index.ts +0 -84
- package/src/node/mdx/cache.ts +0 -12
- package/src/node/mdx/highlighter.ts +0 -47
- package/src/node/mdx/index.ts +0 -122
- package/src/node/mdx/rehype-shiki.ts +0 -62
- package/src/node/mdx/remark-code-meta.ts +0 -35
- package/src/node/mdx/remark-shiki.ts +0 -61
- package/src/node/plugin/entry.ts +0 -87
- package/src/node/plugin/html.ts +0 -99
- package/src/node/plugin/index.ts +0 -464
- package/src/node/plugin/types.ts +0 -9
- package/src/node/plugins/index.ts +0 -17
- package/src/node/plugins/plugin-errors.ts +0 -62
- package/src/node/plugins/plugin-lifecycle.ts +0 -117
- package/src/node/plugins/plugin-sandbox.ts +0 -59
- package/src/node/plugins/plugin-store.ts +0 -54
- package/src/node/plugins/plugin-types.ts +0 -107
- package/src/node/plugins/plugin-validator.ts +0 -105
- package/src/node/routes/cache.ts +0 -28
- package/src/node/routes/index.ts +0 -293
- package/src/node/routes/parser.ts +0 -262
- package/src/node/routes/sorter.ts +0 -42
- package/src/node/routes/types.ts +0 -61
- package/src/node/schema/config.ts +0 -195
- package/src/node/schema/frontmatter.ts +0 -17
- package/src/node/search/index.ts +0 -55
- package/src/node/security/constants/index.ts +0 -10
- package/src/node/security/csp.ts +0 -31
- package/src/node/security/headers.ts +0 -27
- package/src/node/ssg/index.ts +0 -205
- package/src/node/ssg/meta.ts +0 -33
- package/src/node/ssg/options.ts +0 -15
- package/src/node/ssg/robots.ts +0 -53
- package/src/node/ssg/sitemap.ts +0 -55
- package/src/node/utils.ts +0 -349
- package/tsconfig.json +0 -26
- package/tsup.config.ts +0 -56
package/dist/client/index.d.mts
CHANGED
|
@@ -1,16 +1,18 @@
|
|
|
1
|
-
import * as vite from 'vite';
|
|
2
|
-
import { Plugin } from 'vite';
|
|
3
|
-
import * as React$1 from 'react';
|
|
4
|
-
import React__default, { Component, ReactNode, ErrorInfo, ComponentPropsWithoutRef, ImgHTMLAttributes, RefObject } from 'react';
|
|
5
|
-
import * as react_router_dom from 'react-router-dom';
|
|
6
|
-
import { LinkProps as LinkProps$2 } from 'react-router-dom';
|
|
7
|
-
import * as react_jsx_runtime from 'react/jsx-runtime';
|
|
8
|
-
import * as class_variance_authority_types from 'class-variance-authority/types';
|
|
9
|
-
import * as RAC from 'react-aria-components';
|
|
10
|
-
import { LinkProps as LinkProps$3 } from 'react-aria-components';
|
|
11
|
-
import { VariantProps } from 'class-variance-authority';
|
|
12
|
-
import { ClassValue } from 'clsx';
|
|
13
1
|
|
|
2
|
+
import * as _$react from "react";
|
|
3
|
+
import React$1, { Component, ComponentPropsWithoutRef, ErrorInfo, ImgHTMLAttributes, ReactNode, RefObject } from "react";
|
|
4
|
+
import * as _$react_router_dom0 from "react-router-dom";
|
|
5
|
+
import { LinkProps as LinkProps$1 } from "react-router-dom";
|
|
6
|
+
import * as RAC from "react-aria-components";
|
|
7
|
+
import { LinkProps as LinkProps$2 } from "react-aria-components";
|
|
8
|
+
import * as _$react_jsx_runtime0 from "react/jsx-runtime";
|
|
9
|
+
import { ClassValue } from "clsx";
|
|
10
|
+
import { VariantProps } from "class-variance-authority";
|
|
11
|
+
import * as _$vite from "vite";
|
|
12
|
+
import { Plugin } from "vite";
|
|
13
|
+
import * as _$class_variance_authority_types0 from "class-variance-authority/types";
|
|
14
|
+
|
|
15
|
+
//#region src/node/plugins/plugin-types.d.ts
|
|
14
16
|
/**
|
|
15
17
|
* Permissions that a plugin can request to access specific Boltdocs capabilities.
|
|
16
18
|
*/
|
|
@@ -19,335 +21,330 @@ type PluginPermission = 'fs:read' | 'fs:write' | 'vite:config' | 'mdx:remark' |
|
|
|
19
21
|
* Shared context injected into every plugin lifecycle hook.
|
|
20
22
|
*/
|
|
21
23
|
interface PluginContext {
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
24
|
+
/** The full, resolved Boltdocs configuration (Readonly) */
|
|
25
|
+
readonly config: BoltdocsConfig;
|
|
26
|
+
/** A plugin-specific logger */
|
|
27
|
+
readonly logger: PluginLogger;
|
|
28
|
+
/** A shared store for dependency injection and state sharing between plugins */
|
|
29
|
+
readonly store: PluginStore;
|
|
30
|
+
/** Metadata about the current plugin */
|
|
31
|
+
readonly meta: PluginMeta;
|
|
30
32
|
}
|
|
31
33
|
/**
|
|
32
34
|
* Simple logger interface for plugins.
|
|
33
35
|
*/
|
|
34
36
|
interface PluginLogger {
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
37
|
+
info(message: string): void;
|
|
38
|
+
warn(message: string): void;
|
|
39
|
+
error(message: string | Error): void;
|
|
40
|
+
debug(message: string): void;
|
|
39
41
|
}
|
|
40
42
|
/**
|
|
41
43
|
* A shared key-value store that allows plugins to share state and configuration.
|
|
42
44
|
*/
|
|
43
45
|
interface PluginStore {
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
46
|
+
/** Get a value from the store. Keys are namespaced by plugin internally. */
|
|
47
|
+
get<T = unknown>(pluginName: string, key: string): T | undefined;
|
|
48
|
+
/** Set a value in the store. */
|
|
49
|
+
set(pluginName: string, key: string, value: unknown): void;
|
|
50
|
+
/** Check if a key exists in the store. */
|
|
51
|
+
has(pluginName: string, key: string): boolean;
|
|
50
52
|
}
|
|
51
53
|
/**
|
|
52
54
|
* Metadata for a plugin, used for identification and compatibility checks.
|
|
53
55
|
*/
|
|
54
56
|
interface PluginMeta {
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
57
|
+
/** Unique identifier for the plugin */
|
|
58
|
+
name: string;
|
|
59
|
+
/** Version of the plugin itself (semver) */
|
|
60
|
+
version?: string;
|
|
61
|
+
/** Minimum required version of Boltdocs (semver range) */
|
|
62
|
+
boltdocsVersion?: string;
|
|
61
63
|
}
|
|
62
64
|
/**
|
|
63
65
|
* Lifecycle hooks that a plugin can implement to hook into the build and dev processes.
|
|
64
66
|
*/
|
|
65
67
|
interface PluginLifecycleHooks {
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
}
|
|
79
|
-
|
|
68
|
+
/** Called before the build process starts */
|
|
69
|
+
beforeBuild?: (ctx: PluginContext) => Promise<void> | void;
|
|
70
|
+
/** Called after the build process finishes successfully */
|
|
71
|
+
afterBuild?: (ctx: PluginContext) => Promise<void> | void;
|
|
72
|
+
/** Called before the dev server starts */
|
|
73
|
+
beforeDev?: (ctx: PluginContext) => Promise<void> | void;
|
|
74
|
+
/** Called after the dev server is ready (configureServer) */
|
|
75
|
+
afterDev?: (ctx: PluginContext) => Promise<void> | void;
|
|
76
|
+
/** Called when the final Boltdocs config is resolved */
|
|
77
|
+
configResolved?: (ctx: PluginContext, config: BoltdocsConfig) => void;
|
|
78
|
+
/** Called when the build is closing */
|
|
79
|
+
buildEnd?: (ctx: PluginContext) => Promise<void> | void;
|
|
80
|
+
}
|
|
81
|
+
//#endregion
|
|
82
|
+
//#region src/node/config.d.ts
|
|
80
83
|
/**
|
|
81
84
|
* Represents a single social link in the configuration.
|
|
82
85
|
*/
|
|
83
86
|
interface BoltdocsSocialLink {
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
87
|
+
/** Identifier for the icon (e.g., 'github') */
|
|
88
|
+
icon: 'discord' | 'x' | 'github' | 'bluesky' | string;
|
|
89
|
+
/** The URL the social link points to */
|
|
90
|
+
link: string;
|
|
88
91
|
}
|
|
89
92
|
/**
|
|
90
93
|
* Configuration for the site footer.
|
|
91
94
|
*/
|
|
92
95
|
interface BoltdocsFooterConfig {
|
|
93
|
-
|
|
94
|
-
|
|
96
|
+
/** Text to display in the footer (HTML is supported) */
|
|
97
|
+
text?: string;
|
|
95
98
|
}
|
|
96
99
|
/**
|
|
97
100
|
* Theme-specific configuration options governing the appearance and navigation of the site.
|
|
98
101
|
*/
|
|
99
102
|
interface BoltdocsThemeConfig {
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
text?: string;
|
|
176
|
-
icon?: string;
|
|
177
|
-
};
|
|
103
|
+
/** The global title of the documentation site (can be translated) */
|
|
104
|
+
title?: string | Record<string, string>;
|
|
105
|
+
/** The global description of the site (can be translated) */
|
|
106
|
+
description?: string | Record<string, string>;
|
|
107
|
+
/** URL path to the site logo or an object for light/dark versions */
|
|
108
|
+
logo?: string | {
|
|
109
|
+
dark: string;
|
|
110
|
+
light: string;
|
|
111
|
+
alt?: string;
|
|
112
|
+
width?: number;
|
|
113
|
+
height?: number;
|
|
114
|
+
};
|
|
115
|
+
/** Items to display in the top navigation bar */
|
|
116
|
+
navbar?: Array<{
|
|
117
|
+
/** Text to display (can be a string or a map of translations) */label: string | Record<string, string>; /** URL path or external link */
|
|
118
|
+
href: string;
|
|
119
|
+
}>;
|
|
120
|
+
/** Items to display in the sidebar, organized optionally by group URLs */
|
|
121
|
+
sidebar?: Record<string, Array<{
|
|
122
|
+
text: string;
|
|
123
|
+
link: string;
|
|
124
|
+
}>>;
|
|
125
|
+
/** Social links to display in the navigation bar */
|
|
126
|
+
socialLinks?: BoltdocsSocialLink[];
|
|
127
|
+
/** Site footer configuration */
|
|
128
|
+
footer?: BoltdocsFooterConfig;
|
|
129
|
+
/** Whether to show breadcrumbs navigation (default: true) */
|
|
130
|
+
breadcrumbs?: boolean;
|
|
131
|
+
/** URL template for 'Edit this page'. Use :path as a placeholder. */
|
|
132
|
+
editLink?: string;
|
|
133
|
+
/** URL for the 'Community help' link. */
|
|
134
|
+
communityHelp?: string;
|
|
135
|
+
/** The current version of the project (e.g., 'v2.8.9'). Displayed in the Navbar. */
|
|
136
|
+
version?: string;
|
|
137
|
+
/** The GitHub repository in the format 'owner/repo' to fetch and display star count. */
|
|
138
|
+
githubRepo?: string;
|
|
139
|
+
/**
|
|
140
|
+
* URL path to the site favicon.
|
|
141
|
+
* If not specified, the logo will be used if available.
|
|
142
|
+
*/
|
|
143
|
+
favicon?: string;
|
|
144
|
+
/**
|
|
145
|
+
* The Open Graph image URL to display when the site is shared on social media.
|
|
146
|
+
*/
|
|
147
|
+
ogImage?: string;
|
|
148
|
+
/** Whether to show the 'Powered by LiteDocs' badge in the sidebar (default: true) */
|
|
149
|
+
poweredBy?: boolean;
|
|
150
|
+
/**
|
|
151
|
+
* Top-level tabs for organizing documentation groups.
|
|
152
|
+
* Tab discovery uses the (tab-id) directory syntax.
|
|
153
|
+
*/
|
|
154
|
+
tabs?: Array<{
|
|
155
|
+
id: string; /** Text to display (can be a string or a map of translations) */
|
|
156
|
+
text: string | Record<string, string>;
|
|
157
|
+
icon?: string;
|
|
158
|
+
}>;
|
|
159
|
+
/**
|
|
160
|
+
* The syntax highlighting theme for code blocks.
|
|
161
|
+
* Supports any Shiki theme name (e.g., 'github-dark', 'one-dark-pro', 'aurora-x').
|
|
162
|
+
* Can also be an object for multiple themes (e.g., { light: 'github-light', dark: 'github-dark' }).
|
|
163
|
+
* Default: { light: 'github-light', dark: 'one-dark-pro' }
|
|
164
|
+
*/
|
|
165
|
+
codeTheme?: string | {
|
|
166
|
+
light: string;
|
|
167
|
+
dark: string;
|
|
168
|
+
};
|
|
169
|
+
/**
|
|
170
|
+
* Configuration for the 'Copy Markdown' button.
|
|
171
|
+
* Can be a boolean or an object with text and icon.
|
|
172
|
+
* Default: true
|
|
173
|
+
*/
|
|
174
|
+
copyMarkdown?: boolean | {
|
|
175
|
+
text?: string;
|
|
176
|
+
icon?: string;
|
|
177
|
+
};
|
|
178
178
|
}
|
|
179
179
|
/**
|
|
180
180
|
* Configuration for the robots.txt file.
|
|
181
181
|
*/
|
|
182
182
|
type BoltdocsRobotsConfig = string | {
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
disallow?: string | string[];
|
|
190
|
-
}>;
|
|
191
|
-
/** Sitemaps to include in the robots.txt */
|
|
192
|
-
sitemaps?: string[];
|
|
183
|
+
/** User-agent rules */rules?: Array<{
|
|
184
|
+
userAgent: string; /** Paths allowed to be crawled */
|
|
185
|
+
allow?: string | string[]; /** Paths disallowed to be crawled */
|
|
186
|
+
disallow?: string | string[];
|
|
187
|
+
}>; /** Sitemaps to include in the robots.txt */
|
|
188
|
+
sitemaps?: string[];
|
|
193
189
|
};
|
|
194
190
|
/**
|
|
195
191
|
* Configuration for a specific locale.
|
|
196
192
|
*/
|
|
197
193
|
interface BoltdocsLocaleConfig {
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
194
|
+
/** The display name of the locale */
|
|
195
|
+
label?: string;
|
|
196
|
+
/** The text direction (ltr or rtl) */
|
|
197
|
+
direction?: 'ltr' | 'rtl';
|
|
198
|
+
/** The HTML lang attribute value (e.g., 'en-US') */
|
|
199
|
+
htmlLang?: string;
|
|
200
|
+
/** The calendar system to use (e.g., 'gregory') */
|
|
201
|
+
calendar?: string;
|
|
206
202
|
}
|
|
207
203
|
/**
|
|
208
204
|
* Configuration for internationalization (i18n).
|
|
209
205
|
*/
|
|
210
206
|
interface BoltdocsI18nConfig {
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
207
|
+
/** The default locale (e.g., 'en') */
|
|
208
|
+
defaultLocale: string;
|
|
209
|
+
/** Available locales and their basic display names (e.g., { en: 'English', es: 'Español' }) */
|
|
210
|
+
locales: Record<string, string>;
|
|
211
|
+
/** Detailed configuration for each locale */
|
|
212
|
+
localeConfigs?: Record<string, BoltdocsLocaleConfig>;
|
|
217
213
|
}
|
|
218
214
|
/**
|
|
219
215
|
* Configuration for a specific documentation version.
|
|
220
216
|
*/
|
|
221
217
|
interface BoltdocsVersionConfig {
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
218
|
+
/** The display name of the version (e.g., 'v2.0') */
|
|
219
|
+
label: string;
|
|
220
|
+
/** The URL path prefix for the version (e.g., '2.0') */
|
|
221
|
+
path: string;
|
|
226
222
|
}
|
|
227
223
|
/**
|
|
228
224
|
* Configuration for documentation versioning.
|
|
229
225
|
*/
|
|
230
226
|
interface BoltdocsVersionsConfig {
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
227
|
+
/** The default version path (e.g., 'v2') */
|
|
228
|
+
defaultVersion: string;
|
|
229
|
+
/**
|
|
230
|
+
* Optional prefix for all version paths (e.g., 'v').
|
|
231
|
+
* If set to 'v', version '1.1' will be available at '/docs/v1.1'.
|
|
232
|
+
*/
|
|
233
|
+
prefix?: string;
|
|
234
|
+
/** Available versions configurations */
|
|
235
|
+
versions: BoltdocsVersionConfig[];
|
|
240
236
|
}
|
|
241
237
|
/**
|
|
242
238
|
* Defines a Boltdocs plugin that can extend the build process and client-side functionality.
|
|
243
239
|
*/
|
|
244
240
|
interface BoltdocsPlugin {
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
241
|
+
/** A unique name for the plugin */
|
|
242
|
+
name: string;
|
|
243
|
+
/** Whether to run this plugin before or after default ones (optional) */
|
|
244
|
+
enforce?: 'pre' | 'post';
|
|
245
|
+
/** Version of the plugin (optional) */
|
|
246
|
+
version?: string;
|
|
247
|
+
/** Minimum compatible Boltdocs version (optional, semver range) */
|
|
248
|
+
boltdocsVersion?: string;
|
|
249
|
+
/** List of permissions this plugin requires to operate */
|
|
250
|
+
permissions?: PluginPermission[];
|
|
251
|
+
/** Optional remark plugins to add to the MDX pipeline */
|
|
252
|
+
remarkPlugins?: unknown[];
|
|
253
|
+
/** Optional rehype plugins to add to the MDX pipeline */
|
|
254
|
+
rehypePlugins?: unknown[];
|
|
255
|
+
/** Optional Vite plugins to inject into the build process */
|
|
256
|
+
vitePlugins?: Plugin[];
|
|
257
|
+
/** Optional custom React components to register in MDX. Map of Name -> Module Path. */
|
|
258
|
+
components?: Record<string, string>;
|
|
259
|
+
/** Implementation of lifecycle hooks */
|
|
260
|
+
hooks?: PluginLifecycleHooks;
|
|
265
261
|
}
|
|
266
262
|
/**
|
|
267
263
|
* Configuration for security-related settings.
|
|
268
264
|
*/
|
|
269
265
|
interface BoltdocsSecurityConfig {
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
266
|
+
/** Map of standard security headers to override or supplement defaults */
|
|
267
|
+
headers?: Record<string, string>;
|
|
268
|
+
/** Whether to enable Content Security Policy (CSP) generation (default: false) */
|
|
269
|
+
enableCSP?: boolean;
|
|
270
|
+
/** Additional custom headers to inject into responses */
|
|
271
|
+
customHeaders?: Record<string, string>;
|
|
276
272
|
}
|
|
277
273
|
/**
|
|
278
274
|
* The root configuration object for Boltdocs.
|
|
279
275
|
*/
|
|
280
276
|
interface BoltdocsConfig {
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
}
|
|
302
|
-
|
|
277
|
+
/** The base URL of the site, used for generating the sitemap */
|
|
278
|
+
siteUrl?: string;
|
|
279
|
+
/** The root directory containing markdown documentation files (default: 'docs') */
|
|
280
|
+
docsDir?: string;
|
|
281
|
+
/** Path to a custom HomePage component */
|
|
282
|
+
homePage?: string;
|
|
283
|
+
/** Configuration pertaining to the UI and appearance */
|
|
284
|
+
theme?: BoltdocsThemeConfig;
|
|
285
|
+
/** Configuration for internationalization */
|
|
286
|
+
i18n?: BoltdocsI18nConfig;
|
|
287
|
+
/** Configuration for documentation versioning */
|
|
288
|
+
versions?: BoltdocsVersionsConfig;
|
|
289
|
+
/** Custom plugins for extending functionality */
|
|
290
|
+
plugins?: BoltdocsPlugin[];
|
|
291
|
+
/** Configuration for the robots.txt file */
|
|
292
|
+
robots?: BoltdocsRobotsConfig;
|
|
293
|
+
/** Security-related settings and headers */
|
|
294
|
+
security?: BoltdocsSecurityConfig;
|
|
295
|
+
/** Low-level Vite configuration overrides */
|
|
296
|
+
vite?: _$vite.InlineConfig;
|
|
297
|
+
}
|
|
298
|
+
//#endregion
|
|
299
|
+
//#region src/client/types.d.ts
|
|
303
300
|
/**
|
|
304
301
|
* Metadata provided by the server for a specific route.
|
|
305
302
|
* Maps closely to the `RouteMeta` type in the Node environment.
|
|
306
303
|
*/
|
|
307
304
|
interface ComponentRoute {
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
305
|
+
/** The final URL path */
|
|
306
|
+
path: string;
|
|
307
|
+
/** The absolute filesystem path of the source file */
|
|
308
|
+
componentPath: string;
|
|
309
|
+
/** The page title */
|
|
310
|
+
title: string;
|
|
311
|
+
/** Explicit order in the sidebar */
|
|
312
|
+
sidebarPosition?: number;
|
|
313
|
+
/** The relative path from the docs directory */
|
|
314
|
+
filePath: string;
|
|
315
|
+
/** The group directory name */
|
|
316
|
+
group?: string;
|
|
317
|
+
/** The display title of the group */
|
|
318
|
+
groupTitle?: string;
|
|
319
|
+
/** Explicit order of the group in the sidebar */
|
|
320
|
+
groupPosition?: number;
|
|
321
|
+
/** Extracted markdown headings for search indexing */
|
|
322
|
+
headings?: {
|
|
323
|
+
level: number;
|
|
324
|
+
text: string;
|
|
325
|
+
id: string;
|
|
326
|
+
}[];
|
|
327
|
+
/** The page summary or description */
|
|
328
|
+
description?: string;
|
|
329
|
+
/** The locale this route belongs to, if i18n is configured */
|
|
330
|
+
locale?: string;
|
|
331
|
+
/** The version this route belongs to, if versioning is configured */
|
|
332
|
+
version?: string;
|
|
333
|
+
/** Optional icon to display (Lucide icon name or raw SVG) */
|
|
334
|
+
icon?: string;
|
|
335
|
+
/** The tab this route belongs to, if tabs are configured */
|
|
336
|
+
tab?: string;
|
|
337
|
+
/** Optional badge to display next to the sidebar item */
|
|
338
|
+
badge?: string | {
|
|
339
|
+
text: 'updated' | 'new' | 'deprecated';
|
|
340
|
+
expires?: string;
|
|
341
|
+
};
|
|
342
|
+
/** Optional icon for the route's group */
|
|
343
|
+
groupIcon?: string;
|
|
344
|
+
/** The extracted plain-text content of the page for search indexing */
|
|
345
|
+
_content?: string;
|
|
346
|
+
/** The raw markdown content of the page */
|
|
347
|
+
_rawContent?: string;
|
|
351
348
|
}
|
|
352
349
|
/**
|
|
353
350
|
* Site configuration provided by the server.
|
|
@@ -357,76 +354,77 @@ type SiteConfig = BoltdocsConfig;
|
|
|
357
354
|
* Configuration options for initializing the Boltdocs client app.
|
|
358
355
|
*/
|
|
359
356
|
interface CreateBoltdocsAppOptions {
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
357
|
+
/** CSS selector for the DOM element where the app should mount (e.g. '#root') */
|
|
358
|
+
target: string;
|
|
359
|
+
/** Initial routes generated by the Vite plugin (`virtual:boltdocs-routes`) */
|
|
360
|
+
routes: ComponentRoute[];
|
|
361
|
+
/** The name of the documentation directory (e.g. 'docs') */
|
|
362
|
+
docsDirName: string;
|
|
363
|
+
/** Site configuration (`virtual:boltdocs-config`) */
|
|
364
|
+
config: SiteConfig;
|
|
365
|
+
/** Dynamic import mapping from `import.meta.glob` for the documentation pages */
|
|
366
|
+
modules: Record<string, () => Promise<{
|
|
367
|
+
default: React$1.ComponentType<any>;
|
|
368
|
+
}>>;
|
|
369
|
+
/** The `import.meta.hot` instance necessary for fast refresh/HMR updates */
|
|
370
|
+
hot?: {
|
|
371
|
+
accept: (cb?: (mod: any) => void) => void;
|
|
372
|
+
dispose: (cb: (data: any) => void) => void;
|
|
373
|
+
on: (event: string, cb: (data: any) => void) => void;
|
|
374
|
+
data: any;
|
|
375
|
+
};
|
|
376
|
+
/** Optional custom React component to render when visiting the root path ('/') */
|
|
377
|
+
homePage?: React$1.ComponentType;
|
|
378
|
+
/** Custom external pages mapped by their route path */
|
|
379
|
+
externalPages?: Record<string, React$1.ComponentType>;
|
|
380
|
+
/** Optional custom layout for external pages */
|
|
381
|
+
externalLayout?: React$1.ComponentType<{
|
|
382
|
+
children: React$1.ReactNode;
|
|
383
|
+
}>;
|
|
384
|
+
/** Optional custom MDX components provided by plugins */
|
|
385
|
+
components?: Record<string, React$1.ComponentType>;
|
|
389
386
|
}
|
|
390
387
|
/**
|
|
391
388
|
* Tab configuration for the documentation site.
|
|
392
389
|
*/
|
|
393
390
|
interface BoltdocsTab {
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
391
|
+
id: string;
|
|
392
|
+
/** Text to display (can be a string or a map of translations) */
|
|
393
|
+
text: string | Record<string, string>;
|
|
394
|
+
icon?: string;
|
|
398
395
|
}
|
|
399
396
|
/**
|
|
400
397
|
* Props for the OnThisPage (TOC) component.
|
|
401
398
|
*/
|
|
402
399
|
interface OnThisPageProps {
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
|
|
400
|
+
headings?: {
|
|
401
|
+
level: number;
|
|
402
|
+
text: string;
|
|
403
|
+
id: string;
|
|
404
|
+
}[];
|
|
405
|
+
editLink?: string;
|
|
406
|
+
communityHelp?: string;
|
|
407
|
+
filePath?: string;
|
|
411
408
|
}
|
|
412
409
|
/**
|
|
413
410
|
* Props for user-defined layout components (layout.tsx).
|
|
414
411
|
*/
|
|
415
|
-
interface LayoutProps
|
|
416
|
-
|
|
412
|
+
interface LayoutProps {
|
|
413
|
+
children: React$1.ReactNode;
|
|
417
414
|
}
|
|
418
415
|
/**
|
|
419
416
|
* Unified type for navbar links.
|
|
420
417
|
*/
|
|
421
418
|
interface NavbarLink {
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
}
|
|
429
|
-
|
|
419
|
+
/** Label to display (can be a string or a map of translations) */
|
|
420
|
+
label: string | Record<string, string>;
|
|
421
|
+
href: string;
|
|
422
|
+
active: boolean;
|
|
423
|
+
/** Optional icon or string for external link indication */
|
|
424
|
+
to?: string;
|
|
425
|
+
}
|
|
426
|
+
//#endregion
|
|
427
|
+
//#region src/client/app/index.d.ts
|
|
430
428
|
/**
|
|
431
429
|
* Creates and mounts the Boltdocs documentation app.
|
|
432
430
|
*
|
|
@@ -449,427 +447,586 @@ interface NavbarLink {
|
|
|
449
447
|
* ```
|
|
450
448
|
*/
|
|
451
449
|
declare function createBoltdocsApp(options: CreateBoltdocsAppOptions): void;
|
|
452
|
-
|
|
450
|
+
//#endregion
|
|
451
|
+
//#region src/client/app/config-context.d.ts
|
|
453
452
|
/**
|
|
454
453
|
* Hook to access the Boltdocs configuration.
|
|
455
454
|
*/
|
|
456
455
|
declare function useConfig(): BoltdocsConfig;
|
|
457
|
-
|
|
456
|
+
//#endregion
|
|
457
|
+
//#region src/client/app/theme-context.d.ts
|
|
458
458
|
type Theme = 'light' | 'dark' | 'system';
|
|
459
459
|
interface ThemeContextType {
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
|
|
460
|
+
theme: Theme;
|
|
461
|
+
resolvedTheme: 'light' | 'dark';
|
|
462
|
+
setTheme: (theme: Theme) => void;
|
|
463
463
|
}
|
|
464
464
|
declare function useTheme(): ThemeContextType;
|
|
465
|
-
|
|
465
|
+
//#endregion
|
|
466
|
+
//#region src/client/hooks/use-routes.d.ts
|
|
466
467
|
/**
|
|
467
468
|
* Hook to access the framework's routing state.
|
|
468
469
|
* Returns both the complete set of routes and a filtered list based on the current
|
|
469
470
|
* version and locale.
|
|
470
471
|
*/
|
|
471
472
|
declare function useRoutes(): {
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
|
|
475
|
-
|
|
476
|
-
|
|
477
|
-
|
|
478
|
-
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
|
|
473
|
+
routes: ComponentRoute[];
|
|
474
|
+
allRoutes: ComponentRoute[];
|
|
475
|
+
currentRoute: ComponentRoute | undefined;
|
|
476
|
+
currentLocale: string | undefined;
|
|
477
|
+
currentLocaleLabel: string | undefined;
|
|
478
|
+
availableLocales: {
|
|
479
|
+
key: string;
|
|
480
|
+
label: string;
|
|
481
|
+
isCurrent: boolean;
|
|
482
|
+
}[];
|
|
483
|
+
currentVersion: string | undefined;
|
|
484
|
+
currentVersionLabel: string | undefined;
|
|
485
|
+
availableVersions: {
|
|
486
|
+
key: string;
|
|
487
|
+
label: string;
|
|
488
|
+
isCurrent: boolean;
|
|
489
|
+
}[];
|
|
490
|
+
config: BoltdocsConfig;
|
|
490
491
|
};
|
|
491
|
-
|
|
492
|
+
//#endregion
|
|
493
|
+
//#region src/client/app/mdx-components-context.d.ts
|
|
492
494
|
type MdxComponentsType = Record<string, React.ComponentType<any>>;
|
|
493
495
|
declare function useMdxComponents(): MdxComponentsType;
|
|
494
|
-
|
|
496
|
+
//#endregion
|
|
497
|
+
//#region src/client/hooks/use-navbar.d.ts
|
|
495
498
|
declare function useNavbar(): {
|
|
496
|
-
|
|
497
|
-
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
|
|
499
|
+
links: NavbarLink[];
|
|
500
|
+
title: string;
|
|
501
|
+
logo: any;
|
|
502
|
+
logoProps: {
|
|
503
|
+
alt: any;
|
|
504
|
+
width: any;
|
|
505
|
+
height: any;
|
|
506
|
+
};
|
|
507
|
+
github: string | null;
|
|
508
|
+
social: BoltdocsSocialLink[];
|
|
509
|
+
config: BoltdocsConfig;
|
|
510
|
+
theme: "dark" | "light" | "system";
|
|
508
511
|
};
|
|
509
|
-
|
|
512
|
+
//#endregion
|
|
513
|
+
//#region src/client/hooks/use-sidebar.d.ts
|
|
510
514
|
declare function useSidebar(routes: ComponentRoute[]): {
|
|
511
|
-
|
|
512
|
-
|
|
513
|
-
|
|
514
|
-
|
|
515
|
-
|
|
516
|
-
|
|
517
|
-
|
|
518
|
-
|
|
519
|
-
|
|
520
|
-
|
|
515
|
+
groups: {
|
|
516
|
+
slug: string;
|
|
517
|
+
title: string;
|
|
518
|
+
routes: ComponentRoute[];
|
|
519
|
+
icon?: string;
|
|
520
|
+
}[];
|
|
521
|
+
ungrouped: ComponentRoute[];
|
|
522
|
+
activeRoute: ComponentRoute | undefined;
|
|
523
|
+
activePath: string;
|
|
524
|
+
config: BoltdocsConfig;
|
|
521
525
|
};
|
|
522
|
-
|
|
526
|
+
//#endregion
|
|
527
|
+
//#region src/client/hooks/use-search.d.ts
|
|
523
528
|
declare function useSearch(routes: ComponentRoute[]): {
|
|
524
|
-
|
|
525
|
-
|
|
526
|
-
|
|
527
|
-
|
|
528
|
-
|
|
529
|
-
|
|
530
|
-
|
|
531
|
-
|
|
532
|
-
|
|
529
|
+
isOpen: boolean;
|
|
530
|
+
setIsOpen: _$react.Dispatch<_$react.SetStateAction<boolean>>;
|
|
531
|
+
query: string;
|
|
532
|
+
setQuery: _$react.Dispatch<_$react.SetStateAction<string>>;
|
|
533
|
+
list: any[];
|
|
534
|
+
input: {
|
|
535
|
+
value: string;
|
|
536
|
+
onChange: (e: React.ChangeEvent<HTMLInputElement>) => void;
|
|
537
|
+
};
|
|
533
538
|
};
|
|
534
|
-
|
|
539
|
+
//#endregion
|
|
540
|
+
//#region src/client/hooks/use-onthispage.d.ts
|
|
535
541
|
interface Heading {
|
|
536
|
-
|
|
537
|
-
|
|
538
|
-
|
|
542
|
+
id: string;
|
|
543
|
+
text: string;
|
|
544
|
+
level: number;
|
|
539
545
|
}
|
|
540
546
|
/**
|
|
541
547
|
* Hook to manage and provide current page headings for the OnThisPage component.
|
|
542
548
|
*/
|
|
543
549
|
declare function useOnThisPage(headings?: Heading[]): {
|
|
544
|
-
|
|
545
|
-
|
|
546
|
-
|
|
550
|
+
headings: Heading[];
|
|
551
|
+
activeId: string | null;
|
|
552
|
+
setActiveId: _$react.Dispatch<_$react.SetStateAction<string | null>>;
|
|
547
553
|
};
|
|
548
|
-
|
|
554
|
+
//#endregion
|
|
555
|
+
//#region src/client/hooks/use-tabs.d.ts
|
|
549
556
|
declare function useTabs(tabs?: BoltdocsTab[], routes?: ComponentRoute[]): {
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
|
|
554
|
-
|
|
557
|
+
tabs: BoltdocsTab[];
|
|
558
|
+
activeIndex: number;
|
|
559
|
+
indicatorStyle: _$react.CSSProperties;
|
|
560
|
+
tabRefs: _$react.RefObject<(HTMLAnchorElement | null)[]>;
|
|
561
|
+
activeTabId: string | undefined;
|
|
555
562
|
};
|
|
556
|
-
|
|
563
|
+
//#endregion
|
|
564
|
+
//#region src/client/hooks/use-version.d.ts
|
|
557
565
|
interface VersionOption {
|
|
558
|
-
|
|
559
|
-
|
|
560
|
-
|
|
561
|
-
|
|
566
|
+
key: string;
|
|
567
|
+
label: string;
|
|
568
|
+
value: string;
|
|
569
|
+
isCurrent: boolean;
|
|
562
570
|
}
|
|
563
571
|
interface UseVersionReturn {
|
|
564
|
-
|
|
565
|
-
|
|
566
|
-
|
|
567
|
-
|
|
572
|
+
currentVersion: string | undefined;
|
|
573
|
+
currentVersionLabel: string | undefined;
|
|
574
|
+
availableVersions: VersionOption[];
|
|
575
|
+
handleVersionChange: (version: string) => void;
|
|
568
576
|
}
|
|
569
577
|
/**
|
|
570
578
|
* Hook to manage and switch between different versions of the documentation.
|
|
571
579
|
*/
|
|
572
580
|
declare function useVersion(): UseVersionReturn;
|
|
573
|
-
|
|
581
|
+
//#endregion
|
|
582
|
+
//#region src/client/hooks/use-i18n.d.ts
|
|
574
583
|
interface LocaleOption {
|
|
575
|
-
|
|
576
|
-
|
|
577
|
-
|
|
578
|
-
|
|
584
|
+
key: string;
|
|
585
|
+
label: string;
|
|
586
|
+
value: string;
|
|
587
|
+
isCurrent: boolean;
|
|
579
588
|
}
|
|
580
589
|
interface UseI18nReturn {
|
|
581
|
-
|
|
582
|
-
|
|
583
|
-
|
|
584
|
-
|
|
590
|
+
currentLocale: string | undefined;
|
|
591
|
+
currentLocaleLabel: string | undefined;
|
|
592
|
+
availableLocales: LocaleOption[];
|
|
593
|
+
handleLocaleChange: (locale: string) => void;
|
|
585
594
|
}
|
|
586
595
|
/**
|
|
587
596
|
* Hook to manage and switch between different locales (languages) of the documentation.
|
|
588
597
|
*/
|
|
589
598
|
declare function useI18n(): UseI18nReturn;
|
|
590
|
-
|
|
599
|
+
//#endregion
|
|
600
|
+
//#region src/client/hooks/use-page-nav.d.ts
|
|
591
601
|
/**
|
|
592
602
|
* Hook to manage the previous and next button functionality for documentation pages.
|
|
593
603
|
* Intelligent: respects current locale, version, and tab to keep navigation logical.
|
|
594
604
|
*/
|
|
595
605
|
declare function usePageNav(): {
|
|
596
|
-
|
|
597
|
-
|
|
598
|
-
|
|
606
|
+
prevPage: null;
|
|
607
|
+
nextPage: null;
|
|
608
|
+
currentRoute: null;
|
|
599
609
|
} | {
|
|
600
|
-
|
|
601
|
-
|
|
602
|
-
|
|
610
|
+
prevPage: ComponentRoute | null;
|
|
611
|
+
nextPage: ComponentRoute | null;
|
|
612
|
+
currentRoute: ComponentRoute;
|
|
603
613
|
};
|
|
604
|
-
|
|
614
|
+
//#endregion
|
|
615
|
+
//#region src/client/hooks/use-breadcrumbs.d.ts
|
|
605
616
|
/**
|
|
606
617
|
* Hook to generate breadcrumbs based on the current active route.
|
|
607
618
|
*/
|
|
608
619
|
declare function useBreadcrumbs(): {
|
|
609
|
-
|
|
610
|
-
|
|
611
|
-
|
|
612
|
-
|
|
613
|
-
|
|
620
|
+
crumbs: {
|
|
621
|
+
label: string;
|
|
622
|
+
href?: string;
|
|
623
|
+
}[];
|
|
624
|
+
activeRoute: ComponentRoute | undefined;
|
|
614
625
|
};
|
|
615
|
-
|
|
626
|
+
//#endregion
|
|
627
|
+
//#region src/client/hooks/use-localized-to.d.ts
|
|
616
628
|
/**
|
|
617
629
|
* Hook to automatically localize a path based on the current version and locale context.
|
|
618
630
|
* It ensures that navigation preserves the active version and language across the entire site.
|
|
619
631
|
*/
|
|
620
|
-
declare function useLocalizedTo(to: LinkProps$
|
|
621
|
-
|
|
622
|
-
|
|
623
|
-
|
|
632
|
+
declare function useLocalizedTo(to: LinkProps$1['to']): _$react_router_dom0.To;
|
|
633
|
+
//#endregion
|
|
634
|
+
//#region src/client/hooks/use-location.d.ts
|
|
635
|
+
declare const useLocation: () => _$react_router_dom0.Location<any>;
|
|
636
|
+
//#endregion
|
|
637
|
+
//#region src/client/components/docs-layout.d.ts
|
|
624
638
|
/**
|
|
625
639
|
* Props shared by all layout slot components.
|
|
626
640
|
*/
|
|
627
641
|
interface SlotProps {
|
|
628
|
-
|
|
629
|
-
|
|
630
|
-
|
|
642
|
+
children?: React$1.ReactNode;
|
|
643
|
+
className?: string;
|
|
644
|
+
style?: React$1.CSSProperties;
|
|
631
645
|
}
|
|
632
646
|
/**
|
|
633
647
|
* Horizontal flex container for sidebar + content + toc.
|
|
634
648
|
*/
|
|
635
|
-
declare function Body({
|
|
649
|
+
declare function Body({
|
|
650
|
+
children,
|
|
651
|
+
className,
|
|
652
|
+
style
|
|
653
|
+
}: SlotProps): _$react_jsx_runtime0.JSX.Element;
|
|
636
654
|
/**
|
|
637
655
|
* Main scrollable content area.
|
|
638
656
|
*/
|
|
639
|
-
declare function Content({
|
|
657
|
+
declare function Content({
|
|
658
|
+
children,
|
|
659
|
+
className,
|
|
660
|
+
style
|
|
661
|
+
}: SlotProps): _$react_jsx_runtime0.JSX.Element;
|
|
640
662
|
/**
|
|
641
663
|
* MDX Content wrapper with standard page padding and max-width logic.
|
|
642
664
|
*/
|
|
643
|
-
declare function ContentMdx({
|
|
665
|
+
declare function ContentMdx({
|
|
666
|
+
children,
|
|
667
|
+
className,
|
|
668
|
+
style
|
|
669
|
+
}: SlotProps): _$react_jsx_runtime0.JSX.Element;
|
|
644
670
|
/**
|
|
645
671
|
* Content header row (breadcrumbs + copy markdown).
|
|
646
672
|
*/
|
|
647
|
-
declare function ContentHeader({
|
|
673
|
+
declare function ContentHeader({
|
|
674
|
+
children,
|
|
675
|
+
className,
|
|
676
|
+
style
|
|
677
|
+
}: SlotProps): _$react_jsx_runtime0.JSX.Element;
|
|
648
678
|
/**
|
|
649
679
|
* Footer area inside the content section (page nav).
|
|
650
680
|
*/
|
|
651
|
-
declare function ContentFooter({
|
|
652
|
-
|
|
653
|
-
|
|
654
|
-
|
|
655
|
-
|
|
656
|
-
|
|
657
|
-
|
|
681
|
+
declare function ContentFooter({
|
|
682
|
+
children,
|
|
683
|
+
className,
|
|
684
|
+
style
|
|
685
|
+
}: SlotProps): _$react_jsx_runtime0.JSX.Element;
|
|
686
|
+
interface DocsLayoutComponent extends React$1.FC<SlotProps> {
|
|
687
|
+
Body: typeof Body;
|
|
688
|
+
Content: typeof Content;
|
|
689
|
+
ContentMdx: typeof ContentMdx;
|
|
690
|
+
ContentHeader: typeof ContentHeader;
|
|
691
|
+
ContentFooter: typeof ContentFooter;
|
|
658
692
|
}
|
|
659
693
|
declare const DocsLayout: DocsLayoutComponent;
|
|
660
|
-
|
|
661
|
-
|
|
662
|
-
|
|
694
|
+
//#endregion
|
|
695
|
+
//#region src/client/components/default-layout.d.ts
|
|
696
|
+
interface LayoutProps$1 {
|
|
697
|
+
children: React.ReactNode;
|
|
663
698
|
}
|
|
664
699
|
/**
|
|
665
700
|
* The built-in default layout for Boltdocs.
|
|
666
701
|
* Users who create their own `layout.tsx` can import the same building blocks
|
|
667
702
|
* and rearrange, wrap, or replace any section.
|
|
668
703
|
*/
|
|
669
|
-
declare function DefaultLayout({
|
|
670
|
-
|
|
671
|
-
|
|
672
|
-
|
|
673
|
-
|
|
674
|
-
|
|
675
|
-
|
|
676
|
-
|
|
677
|
-
|
|
678
|
-
|
|
679
|
-
|
|
704
|
+
declare function DefaultLayout({
|
|
705
|
+
children
|
|
706
|
+
}: LayoutProps$1): _$react_jsx_runtime0.JSX.Element;
|
|
707
|
+
//#endregion
|
|
708
|
+
//#region src/client/components/ui-base/navbar.d.ts
|
|
709
|
+
declare function Navbar(): _$react_jsx_runtime0.JSX.Element;
|
|
710
|
+
//#endregion
|
|
711
|
+
//#region src/client/components/ui-base/sidebar.d.ts
|
|
712
|
+
declare function Sidebar$1({
|
|
713
|
+
routes,
|
|
714
|
+
config
|
|
715
|
+
}: {
|
|
716
|
+
routes: ComponentRoute[];
|
|
717
|
+
config: BoltdocsConfig;
|
|
718
|
+
}): _$react_jsx_runtime0.JSX.Element;
|
|
719
|
+
//#endregion
|
|
720
|
+
//#region src/client/components/ui-base/on-this-page.d.ts
|
|
721
|
+
declare function OnThisPage({
|
|
722
|
+
headings: rawHeadings,
|
|
723
|
+
editLink,
|
|
724
|
+
communityHelp,
|
|
725
|
+
filePath
|
|
726
|
+
}: OnThisPageProps): _$react_jsx_runtime0.JSX.Element | null;
|
|
727
|
+
//#endregion
|
|
728
|
+
//#region src/client/components/ui-base/head.d.ts
|
|
680
729
|
interface HeadProps {
|
|
681
|
-
|
|
682
|
-
|
|
683
|
-
|
|
684
|
-
|
|
685
|
-
|
|
686
|
-
|
|
687
|
-
|
|
688
|
-
}
|
|
689
|
-
declare function Head({
|
|
690
|
-
|
|
691
|
-
|
|
692
|
-
|
|
730
|
+
siteTitle: string;
|
|
731
|
+
siteDescription?: string;
|
|
732
|
+
routes: Array<{
|
|
733
|
+
path: string;
|
|
734
|
+
title: string;
|
|
735
|
+
description?: string;
|
|
736
|
+
}>;
|
|
737
|
+
}
|
|
738
|
+
declare function Head({
|
|
739
|
+
siteTitle,
|
|
740
|
+
siteDescription,
|
|
741
|
+
routes
|
|
742
|
+
}: HeadProps): null;
|
|
743
|
+
//#endregion
|
|
744
|
+
//#region src/client/components/ui-base/breadcrumbs.d.ts
|
|
745
|
+
declare function Breadcrumbs(): _$react_jsx_runtime0.JSX.Element | null;
|
|
746
|
+
//#endregion
|
|
747
|
+
//#region src/client/components/ui-base/page-nav.d.ts
|
|
693
748
|
/**
|
|
694
749
|
* Component to display the previous and next page navigation buttons.
|
|
695
750
|
* Enhanced with subtle entrance animations and a modern card layout.
|
|
696
751
|
*/
|
|
697
|
-
declare function PageNav
|
|
698
|
-
|
|
752
|
+
declare function PageNav(): _$react_jsx_runtime0.JSX.Element | null;
|
|
753
|
+
//#endregion
|
|
754
|
+
//#region src/client/components/ui-base/error-boundary.d.ts
|
|
699
755
|
interface Props {
|
|
700
|
-
|
|
701
|
-
|
|
756
|
+
children?: ReactNode;
|
|
757
|
+
fallback?: ReactNode;
|
|
702
758
|
}
|
|
703
759
|
interface State {
|
|
704
|
-
|
|
705
|
-
|
|
760
|
+
hasError: boolean;
|
|
761
|
+
error?: Error;
|
|
706
762
|
}
|
|
707
763
|
declare class ErrorBoundary extends Component<Props, State> {
|
|
708
|
-
|
|
709
|
-
|
|
710
|
-
|
|
711
|
-
|
|
764
|
+
state: State;
|
|
765
|
+
static getDerivedStateFromError(error: Error): State;
|
|
766
|
+
componentDidCatch(error: Error, errorInfo: ErrorInfo): void;
|
|
767
|
+
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;
|
|
712
768
|
}
|
|
713
|
-
|
|
769
|
+
//#endregion
|
|
770
|
+
//#region src/client/components/ui-base/copy-markdown.d.ts
|
|
714
771
|
interface CopyMarkdownProps {
|
|
715
|
-
|
|
716
|
-
|
|
717
|
-
|
|
718
|
-
|
|
719
|
-
|
|
720
|
-
|
|
721
|
-
|
|
722
|
-
}
|
|
723
|
-
declare function CopyMarkdown({
|
|
724
|
-
|
|
725
|
-
|
|
726
|
-
|
|
772
|
+
content?: string;
|
|
773
|
+
mdxRaw?: string;
|
|
774
|
+
route?: ComponentRoute;
|
|
775
|
+
config?: boolean | {
|
|
776
|
+
text?: string;
|
|
777
|
+
icon?: string;
|
|
778
|
+
};
|
|
779
|
+
}
|
|
780
|
+
declare function CopyMarkdown({
|
|
781
|
+
content,
|
|
782
|
+
mdxRaw,
|
|
783
|
+
config
|
|
784
|
+
}: CopyMarkdownProps): _$react_jsx_runtime0.JSX.Element | null;
|
|
785
|
+
//#endregion
|
|
786
|
+
//#region src/client/components/ui-base/not-found.d.ts
|
|
787
|
+
declare function NotFound(): _$react_jsx_runtime0.JSX.Element;
|
|
788
|
+
//#endregion
|
|
789
|
+
//#region src/client/components/ui-base/loading.d.ts
|
|
727
790
|
/**
|
|
728
791
|
* A premium loading component that only skeletons the markdown content area.
|
|
729
792
|
* Designed to be used as a Suspense fallback within a persistent layout.
|
|
730
793
|
*/
|
|
731
|
-
declare function Loading():
|
|
732
|
-
|
|
794
|
+
declare function Loading(): _$react_jsx_runtime0.JSX.Element;
|
|
795
|
+
//#endregion
|
|
796
|
+
//#region src/client/components/mdx/code-block.d.ts
|
|
733
797
|
interface CodeBlockProps {
|
|
734
|
-
|
|
735
|
-
|
|
736
|
-
|
|
737
|
-
|
|
738
|
-
|
|
739
|
-
|
|
740
|
-
|
|
741
|
-
|
|
742
|
-
|
|
743
|
-
}
|
|
744
|
-
declare function CodeBlock(props: CodeBlockProps):
|
|
745
|
-
|
|
798
|
+
children?: React.ReactNode;
|
|
799
|
+
className?: string;
|
|
800
|
+
hideCopy?: boolean;
|
|
801
|
+
title?: string;
|
|
802
|
+
lang?: string;
|
|
803
|
+
highlightedHtml?: string;
|
|
804
|
+
'data-lang'?: string;
|
|
805
|
+
plain?: boolean;
|
|
806
|
+
[key: string]: any;
|
|
807
|
+
}
|
|
808
|
+
declare function CodeBlock(props: CodeBlockProps): _$react_jsx_runtime0.JSX.Element;
|
|
809
|
+
//#endregion
|
|
810
|
+
//#region src/client/components/mdx/video.d.ts
|
|
746
811
|
interface VideoProps {
|
|
747
|
-
|
|
748
|
-
|
|
749
|
-
|
|
750
|
-
|
|
751
|
-
|
|
752
|
-
|
|
753
|
-
|
|
754
|
-
}
|
|
755
|
-
declare function Video({
|
|
756
|
-
|
|
812
|
+
src?: string;
|
|
813
|
+
poster?: string;
|
|
814
|
+
alt?: string;
|
|
815
|
+
controls?: boolean;
|
|
816
|
+
preload?: string;
|
|
817
|
+
children?: React.ReactNode;
|
|
818
|
+
[key: string]: any;
|
|
819
|
+
}
|
|
820
|
+
declare function Video({
|
|
821
|
+
src,
|
|
822
|
+
poster,
|
|
823
|
+
alt,
|
|
824
|
+
children,
|
|
825
|
+
controls,
|
|
826
|
+
preload,
|
|
827
|
+
...rest
|
|
828
|
+
}: VideoProps): _$react_jsx_runtime0.JSX.Element;
|
|
829
|
+
//#endregion
|
|
830
|
+
//#region src/client/components/primitives/button.d.ts
|
|
757
831
|
declare const buttonVariants: (props?: ({
|
|
758
|
-
|
|
759
|
-
|
|
760
|
-
|
|
761
|
-
|
|
762
|
-
|
|
763
|
-
} &
|
|
832
|
+
variant?: "link" | "primary" | "secondary" | "outline" | "ghost" | "danger" | "success" | "warning" | "info" | "subtle" | null | undefined;
|
|
833
|
+
size?: "sm" | "md" | "lg" | null | undefined;
|
|
834
|
+
rounded?: "sm" | "md" | "lg" | "none" | "full" | null | undefined;
|
|
835
|
+
iconSize?: "sm" | "md" | "lg" | null | undefined;
|
|
836
|
+
disabled?: boolean | null | undefined;
|
|
837
|
+
} & _$class_variance_authority_types0.ClassProp) | undefined) => string;
|
|
764
838
|
type ButtonVariantType = VariantProps<typeof buttonVariants>;
|
|
765
839
|
interface ButtonProps extends Omit<RAC.ButtonProps, 'children' | 'className'>, ButtonVariantType {
|
|
766
|
-
|
|
767
|
-
|
|
768
|
-
|
|
769
|
-
|
|
770
|
-
|
|
771
|
-
|
|
772
|
-
}
|
|
773
|
-
declare const Button$1: ({
|
|
774
|
-
|
|
775
|
-
|
|
776
|
-
|
|
840
|
+
icon?: React.ReactNode;
|
|
841
|
+
iconPosition?: 'left' | 'right';
|
|
842
|
+
href?: string;
|
|
843
|
+
children?: React.ReactNode;
|
|
844
|
+
className?: string;
|
|
845
|
+
isIconOnly?: boolean;
|
|
846
|
+
}
|
|
847
|
+
declare const Button$1: ({
|
|
848
|
+
href,
|
|
849
|
+
icon,
|
|
850
|
+
iconPosition,
|
|
851
|
+
isIconOnly,
|
|
852
|
+
children,
|
|
853
|
+
className,
|
|
854
|
+
variant,
|
|
855
|
+
size,
|
|
856
|
+
rounded,
|
|
857
|
+
iconSize,
|
|
858
|
+
disabled,
|
|
859
|
+
...props
|
|
860
|
+
}: ButtonProps) => _$react_jsx_runtime0.JSX.Element;
|
|
861
|
+
//#endregion
|
|
862
|
+
//#region src/client/components/mdx/button.d.ts
|
|
863
|
+
declare const Button: ({
|
|
864
|
+
className,
|
|
865
|
+
variant,
|
|
866
|
+
size,
|
|
867
|
+
rounded,
|
|
868
|
+
iconSize,
|
|
869
|
+
disabled,
|
|
870
|
+
...props
|
|
871
|
+
}: ButtonProps) => _$react_jsx_runtime0.JSX.Element;
|
|
872
|
+
//#endregion
|
|
873
|
+
//#region src/client/components/mdx/tabs.d.ts
|
|
777
874
|
interface TabProps {
|
|
778
|
-
|
|
779
|
-
|
|
780
|
-
|
|
781
|
-
|
|
782
|
-
}
|
|
783
|
-
declare function Tab({
|
|
875
|
+
label: string;
|
|
876
|
+
icon?: React.ReactNode;
|
|
877
|
+
disabled?: boolean;
|
|
878
|
+
children: React.ReactNode;
|
|
879
|
+
}
|
|
880
|
+
declare function Tab({
|
|
881
|
+
children
|
|
882
|
+
}: TabProps): _$react_jsx_runtime0.JSX.Element;
|
|
784
883
|
interface TabsProps {
|
|
785
|
-
|
|
786
|
-
|
|
787
|
-
}
|
|
788
|
-
declare function Tabs$1({
|
|
789
|
-
|
|
884
|
+
defaultIndex?: number;
|
|
885
|
+
children: React.ReactNode;
|
|
886
|
+
}
|
|
887
|
+
declare function Tabs$1({
|
|
888
|
+
defaultIndex,
|
|
889
|
+
children
|
|
890
|
+
}: TabsProps): _$react_jsx_runtime0.JSX.Element;
|
|
891
|
+
//#endregion
|
|
892
|
+
//#region src/client/components/mdx/badge.d.ts
|
|
790
893
|
declare const badgeVariants: (props?: ({
|
|
791
|
-
|
|
792
|
-
} &
|
|
894
|
+
variant?: "default" | "primary" | "danger" | "success" | "warning" | "info" | null | undefined;
|
|
895
|
+
} & _$class_variance_authority_types0.ClassProp) | undefined) => string;
|
|
793
896
|
interface BadgeProps extends React.HTMLAttributes<HTMLSpanElement>, VariantProps<typeof badgeVariants> {
|
|
794
|
-
|
|
795
|
-
}
|
|
796
|
-
declare function Badge({
|
|
797
|
-
|
|
897
|
+
children: React.ReactNode;
|
|
898
|
+
}
|
|
899
|
+
declare function Badge({
|
|
900
|
+
variant,
|
|
901
|
+
children,
|
|
902
|
+
className,
|
|
903
|
+
...rest
|
|
904
|
+
}: BadgeProps): _$react_jsx_runtime0.JSX.Element;
|
|
905
|
+
//#endregion
|
|
906
|
+
//#region src/client/components/mdx/card.d.ts
|
|
798
907
|
declare const cardsVariants: (props?: ({
|
|
799
|
-
|
|
800
|
-
} &
|
|
908
|
+
cols?: 2 | 1 | 3 | 4 | null | undefined;
|
|
909
|
+
} & _$class_variance_authority_types0.ClassProp) | undefined) => string;
|
|
801
910
|
type CardsVariants = VariantProps<typeof cardsVariants>;
|
|
802
|
-
interface CardsProps extends React.HTMLAttributes<HTMLDivElement>, CardsVariants {
|
|
803
|
-
|
|
804
|
-
|
|
911
|
+
interface CardsProps extends React.HTMLAttributes<HTMLDivElement>, CardsVariants {}
|
|
912
|
+
declare function Cards({
|
|
913
|
+
cols,
|
|
914
|
+
children,
|
|
915
|
+
className,
|
|
916
|
+
...rest
|
|
917
|
+
}: CardsProps): _$react_jsx_runtime0.JSX.Element;
|
|
805
918
|
interface CardProps extends React.HTMLAttributes<HTMLDivElement> {
|
|
806
|
-
|
|
807
|
-
|
|
808
|
-
|
|
809
|
-
|
|
810
|
-
}
|
|
811
|
-
declare function Card({
|
|
812
|
-
|
|
919
|
+
title?: string;
|
|
920
|
+
icon?: React.ReactNode;
|
|
921
|
+
href?: string;
|
|
922
|
+
children?: React.ReactNode;
|
|
923
|
+
}
|
|
924
|
+
declare function Card({
|
|
925
|
+
title,
|
|
926
|
+
icon,
|
|
927
|
+
href,
|
|
928
|
+
children,
|
|
929
|
+
className,
|
|
930
|
+
...rest
|
|
931
|
+
}: CardProps): _$react_jsx_runtime0.JSX.Element;
|
|
932
|
+
//#endregion
|
|
933
|
+
//#region src/client/components/mdx/admonition.d.ts
|
|
813
934
|
declare const admonitionVariants: (props?: ({
|
|
814
|
-
|
|
815
|
-
} &
|
|
935
|
+
type?: "danger" | "warning" | "info" | "note" | "tip" | "important" | "caution" | null | undefined;
|
|
936
|
+
} & _$class_variance_authority_types0.ClassProp) | undefined) => string;
|
|
816
937
|
type AdmonitionVariants = VariantProps<typeof admonitionVariants>;
|
|
817
938
|
interface AdmonitionProps extends React.HTMLAttributes<HTMLDivElement>, AdmonitionVariants {
|
|
818
|
-
|
|
819
|
-
|
|
820
|
-
}
|
|
821
|
-
declare function Admonition({
|
|
822
|
-
|
|
823
|
-
|
|
824
|
-
|
|
825
|
-
|
|
826
|
-
|
|
827
|
-
|
|
828
|
-
declare const
|
|
829
|
-
|
|
939
|
+
title?: string;
|
|
940
|
+
children: React.ReactNode;
|
|
941
|
+
}
|
|
942
|
+
declare function Admonition({
|
|
943
|
+
type,
|
|
944
|
+
title,
|
|
945
|
+
children,
|
|
946
|
+
className,
|
|
947
|
+
...rest
|
|
948
|
+
}: AdmonitionProps): _$react_jsx_runtime0.JSX.Element;
|
|
949
|
+
declare const Note: (props: Omit<AdmonitionProps, "type">) => _$react_jsx_runtime0.JSX.Element;
|
|
950
|
+
declare const Tip: (props: Omit<AdmonitionProps, "type">) => _$react_jsx_runtime0.JSX.Element;
|
|
951
|
+
declare const Warning: (props: Omit<AdmonitionProps, "type">) => _$react_jsx_runtime0.JSX.Element;
|
|
952
|
+
declare const Danger: (props: Omit<AdmonitionProps, "type">) => _$react_jsx_runtime0.JSX.Element;
|
|
953
|
+
declare const InfoBox: (props: Omit<AdmonitionProps, "type">) => _$react_jsx_runtime0.JSX.Element;
|
|
954
|
+
declare const Important: (props: Omit<AdmonitionProps, "type">) => _$react_jsx_runtime0.JSX.Element;
|
|
955
|
+
declare const Caution: (props: Omit<AdmonitionProps, "type">) => _$react_jsx_runtime0.JSX.Element;
|
|
956
|
+
//#endregion
|
|
957
|
+
//#region src/client/components/mdx/list.d.ts
|
|
830
958
|
declare const listVariants: (props?: ({
|
|
831
|
-
|
|
832
|
-
|
|
833
|
-
|
|
834
|
-
|
|
835
|
-
} &
|
|
959
|
+
variant?: "number" | "default" | "checked" | "arrow" | "bubble" | null | undefined;
|
|
960
|
+
cols?: 2 | 1 | 3 | 4 | null | undefined;
|
|
961
|
+
isGrid?: boolean | null | undefined;
|
|
962
|
+
dense?: boolean | null | undefined;
|
|
963
|
+
} & _$class_variance_authority_types0.ClassProp) | undefined) => string;
|
|
836
964
|
type ListVariantProps = VariantProps<typeof listVariants>;
|
|
837
965
|
interface ListProps extends ComponentPropsWithoutRef<'ul'>, Omit<ListVariantProps, 'variant'> {
|
|
838
|
-
|
|
839
|
-
|
|
840
|
-
}
|
|
841
|
-
declare function List({
|
|
842
|
-
|
|
966
|
+
variant?: 'checked' | 'arrow' | 'default' | 'bubble' | 'number';
|
|
967
|
+
children: ReactNode;
|
|
968
|
+
}
|
|
969
|
+
declare function List({
|
|
970
|
+
variant,
|
|
971
|
+
cols,
|
|
972
|
+
dense,
|
|
973
|
+
children,
|
|
974
|
+
className,
|
|
975
|
+
...props
|
|
976
|
+
}: ListProps): _$react_jsx_runtime0.JSX.Element;
|
|
977
|
+
//#endregion
|
|
978
|
+
//#region src/client/components/mdx/file-tree.d.ts
|
|
843
979
|
interface FileTreeProps {
|
|
844
|
-
|
|
980
|
+
children: React.ReactNode;
|
|
845
981
|
}
|
|
846
|
-
declare function FileTree({
|
|
847
|
-
|
|
982
|
+
declare function FileTree({
|
|
983
|
+
children
|
|
984
|
+
}: FileTreeProps): _$react_jsx_runtime0.JSX.Element;
|
|
985
|
+
//#endregion
|
|
986
|
+
//#region src/client/components/mdx/table.d.ts
|
|
848
987
|
interface TableProps {
|
|
849
|
-
|
|
850
|
-
|
|
851
|
-
|
|
852
|
-
|
|
853
|
-
|
|
854
|
-
|
|
855
|
-
|
|
856
|
-
}
|
|
857
|
-
declare function Table({
|
|
858
|
-
|
|
988
|
+
headers?: string[];
|
|
989
|
+
data?: (string | React.ReactNode)[][];
|
|
990
|
+
children?: React.ReactNode;
|
|
991
|
+
className?: string;
|
|
992
|
+
sortable?: boolean;
|
|
993
|
+
paginated?: boolean;
|
|
994
|
+
pageSize?: number;
|
|
995
|
+
}
|
|
996
|
+
declare function Table({
|
|
997
|
+
headers,
|
|
998
|
+
data,
|
|
999
|
+
children,
|
|
1000
|
+
className,
|
|
1001
|
+
sortable,
|
|
1002
|
+
paginated,
|
|
1003
|
+
pageSize
|
|
1004
|
+
}: TableProps): _$react_jsx_runtime0.JSX.Element;
|
|
1005
|
+
//#endregion
|
|
1006
|
+
//#region src/client/components/mdx/field.d.ts
|
|
859
1007
|
interface FieldProps {
|
|
860
|
-
|
|
861
|
-
|
|
862
|
-
|
|
863
|
-
|
|
864
|
-
|
|
865
|
-
|
|
866
|
-
|
|
867
|
-
}
|
|
868
|
-
declare function Field({
|
|
869
|
-
|
|
870
|
-
|
|
871
|
-
|
|
872
|
-
|
|
1008
|
+
name: string;
|
|
1009
|
+
type?: string;
|
|
1010
|
+
defaultValue?: string;
|
|
1011
|
+
required?: boolean;
|
|
1012
|
+
children: React.ReactNode;
|
|
1013
|
+
id?: string;
|
|
1014
|
+
className?: string;
|
|
1015
|
+
}
|
|
1016
|
+
declare function Field({
|
|
1017
|
+
name,
|
|
1018
|
+
type,
|
|
1019
|
+
defaultValue,
|
|
1020
|
+
required,
|
|
1021
|
+
children,
|
|
1022
|
+
id,
|
|
1023
|
+
className
|
|
1024
|
+
}: FieldProps): _$react_jsx_runtime0.JSX.Element;
|
|
1025
|
+
//#endregion
|
|
1026
|
+
//#region src/client/components/primitives/link.d.ts
|
|
1027
|
+
interface LinkProps$3 extends LinkProps$2 {
|
|
1028
|
+
/** Should prefetch the page on hover? Default 'hover' */
|
|
1029
|
+
prefetch?: 'hover' | 'none';
|
|
873
1030
|
}
|
|
874
1031
|
/**
|
|
875
1032
|
* A primitive Link component that wraps React Aria Components' Link
|
|
@@ -878,28 +1035,28 @@ interface LinkProps$1 extends LinkProps$3 {
|
|
|
878
1035
|
* It uses the global navigation configuration from BoltdocsRouterProvider
|
|
879
1036
|
* to handle seamless client-side transitions.
|
|
880
1037
|
*/
|
|
881
|
-
declare const Link$1:
|
|
1038
|
+
declare const Link$1: React$1.ForwardRefExoticComponent<LinkProps$3 & React$1.RefAttributes<HTMLAnchorElement>>;
|
|
882
1039
|
/**
|
|
883
1040
|
* Props for the NavLink component, extending standard Link props.
|
|
884
1041
|
*/
|
|
885
|
-
interface NavLinkProps extends Omit<LinkProps$
|
|
886
|
-
|
|
887
|
-
|
|
888
|
-
|
|
889
|
-
|
|
890
|
-
|
|
891
|
-
|
|
892
|
-
|
|
893
|
-
|
|
894
|
-
|
|
895
|
-
|
|
896
|
-
|
|
897
|
-
|
|
898
|
-
|
|
899
|
-
|
|
900
|
-
|
|
901
|
-
|
|
902
|
-
|
|
1042
|
+
interface NavLinkProps extends Omit<LinkProps$3, 'className' | 'children'> {
|
|
1043
|
+
/**
|
|
1044
|
+
* When true, the active state will only be applied if the paths match exactly.
|
|
1045
|
+
* Default is false.
|
|
1046
|
+
*/
|
|
1047
|
+
end?: boolean;
|
|
1048
|
+
/**
|
|
1049
|
+
* Provides access to the active state for conditional children rendering.
|
|
1050
|
+
*/
|
|
1051
|
+
children?: React$1.ReactNode | ((props: {
|
|
1052
|
+
isActive: boolean;
|
|
1053
|
+
}) => React$1.ReactNode);
|
|
1054
|
+
/**
|
|
1055
|
+
* Provides access to the active state for conditional styling.
|
|
1056
|
+
*/
|
|
1057
|
+
className?: string | ((props: {
|
|
1058
|
+
isActive: boolean;
|
|
1059
|
+
}) => string);
|
|
903
1060
|
}
|
|
904
1061
|
/**
|
|
905
1062
|
* A primitive NavLink component that provides active state detection.
|
|
@@ -907,357 +1064,615 @@ interface NavLinkProps extends Omit<LinkProps$1, 'className' | 'children'> {
|
|
|
907
1064
|
* It combines the Link primitive with path matching logic to determine
|
|
908
1065
|
* if the link is currently active based on the browser's location.
|
|
909
1066
|
*/
|
|
910
|
-
declare const NavLink:
|
|
911
|
-
|
|
912
|
-
|
|
913
|
-
|
|
914
|
-
|
|
1067
|
+
declare const NavLink: React$1.ForwardRefExoticComponent<NavLinkProps & React$1.RefAttributes<HTMLAnchorElement>>;
|
|
1068
|
+
//#endregion
|
|
1069
|
+
//#region src/client/components/mdx/link.d.ts
|
|
1070
|
+
type LinkProps = LinkProps$3 & {
|
|
1071
|
+
to: string;
|
|
1072
|
+
children?: React.ReactNode;
|
|
915
1073
|
};
|
|
916
1074
|
/**
|
|
917
1075
|
* A premium Link component for Boltdocs that handles internal and external routing.
|
|
918
1076
|
*/
|
|
919
|
-
declare function Link({
|
|
920
|
-
|
|
1077
|
+
declare function Link({
|
|
1078
|
+
to,
|
|
1079
|
+
children,
|
|
1080
|
+
className,
|
|
1081
|
+
...props
|
|
1082
|
+
}: LinkProps): _$react_jsx_runtime0.JSX.Element;
|
|
1083
|
+
//#endregion
|
|
1084
|
+
//#region src/client/components/mdx/image.d.ts
|
|
921
1085
|
interface ImageProps extends ImgHTMLAttributes<HTMLImageElement> {
|
|
922
|
-
|
|
923
|
-
|
|
924
|
-
|
|
1086
|
+
src: string;
|
|
1087
|
+
darkSrc?: string;
|
|
1088
|
+
theme?: 'light' | 'dark';
|
|
925
1089
|
}
|
|
926
1090
|
/**
|
|
927
1091
|
* A themed Image component for Boltdocs.
|
|
928
1092
|
* It supports rendering based on the current active theme.
|
|
929
1093
|
*/
|
|
930
|
-
declare function Image({
|
|
931
|
-
|
|
1094
|
+
declare function Image({
|
|
1095
|
+
src,
|
|
1096
|
+
alt,
|
|
1097
|
+
theme: imageTheme,
|
|
1098
|
+
...props
|
|
1099
|
+
}: ImageProps): _$react_jsx_runtime0.JSX.Element | null;
|
|
1100
|
+
//#endregion
|
|
1101
|
+
//#region src/client/components/mdx/component-props.d.ts
|
|
932
1102
|
interface PropItem {
|
|
933
|
-
|
|
934
|
-
|
|
935
|
-
|
|
936
|
-
|
|
937
|
-
|
|
1103
|
+
name: string;
|
|
1104
|
+
type: string;
|
|
1105
|
+
defaultValue?: string;
|
|
1106
|
+
required?: boolean;
|
|
1107
|
+
description: React.ReactNode;
|
|
938
1108
|
}
|
|
939
1109
|
interface ComponentPropsProps {
|
|
940
|
-
|
|
941
|
-
|
|
942
|
-
|
|
943
|
-
}
|
|
944
|
-
declare function ComponentProps({
|
|
945
|
-
|
|
1110
|
+
title?: string;
|
|
1111
|
+
props: PropItem[];
|
|
1112
|
+
className?: string;
|
|
1113
|
+
}
|
|
1114
|
+
declare function ComponentProps({
|
|
1115
|
+
title,
|
|
1116
|
+
props,
|
|
1117
|
+
className
|
|
1118
|
+
}: ComponentPropsProps): _$react_jsx_runtime0.JSX.Element;
|
|
1119
|
+
//#endregion
|
|
1120
|
+
//#region src/client/components/mdx/component-preview.d.ts
|
|
946
1121
|
interface ComponentPreviewProps {
|
|
947
|
-
|
|
948
|
-
|
|
949
|
-
|
|
950
|
-
|
|
951
|
-
|
|
952
|
-
|
|
953
|
-
}
|
|
954
|
-
declare function ComponentPreview(props: ComponentPreviewProps):
|
|
955
|
-
|
|
1122
|
+
code?: string;
|
|
1123
|
+
highlightedHtml?: string;
|
|
1124
|
+
children?: string;
|
|
1125
|
+
preview?: React.ReactNode;
|
|
1126
|
+
hideCode?: boolean;
|
|
1127
|
+
hideCopy?: boolean;
|
|
1128
|
+
}
|
|
1129
|
+
declare function ComponentPreview(props: ComponentPreviewProps): _$react_jsx_runtime0.JSX.Element;
|
|
1130
|
+
//#endregion
|
|
1131
|
+
//#region src/client/components/primitives/types.d.ts
|
|
956
1132
|
type ComponentBase = {
|
|
957
|
-
|
|
958
|
-
|
|
1133
|
+
className?: string;
|
|
1134
|
+
children?: ReactNode;
|
|
959
1135
|
};
|
|
960
|
-
|
|
1136
|
+
//#endregion
|
|
1137
|
+
//#region src/client/components/primitives/navbar.d.ts
|
|
961
1138
|
interface NavbarLinkProps extends Omit<ComponentBase, 'children'> {
|
|
962
|
-
|
|
963
|
-
|
|
964
|
-
|
|
965
|
-
|
|
1139
|
+
label: ReactNode;
|
|
1140
|
+
href: string;
|
|
1141
|
+
active?: boolean;
|
|
1142
|
+
to?: 'internal' | 'external';
|
|
966
1143
|
}
|
|
967
1144
|
interface NavbarLogoProps extends Omit<ComponentBase, 'children'> {
|
|
968
|
-
|
|
969
|
-
|
|
970
|
-
|
|
971
|
-
|
|
1145
|
+
src: string;
|
|
1146
|
+
alt: string;
|
|
1147
|
+
width?: number;
|
|
1148
|
+
height?: number;
|
|
972
1149
|
}
|
|
973
1150
|
interface NavbarSearchTriggerProps extends ComponentBase {
|
|
974
|
-
|
|
1151
|
+
onPress: () => void;
|
|
975
1152
|
}
|
|
976
1153
|
interface NavbarThemeProps {
|
|
977
|
-
|
|
978
|
-
|
|
979
|
-
|
|
1154
|
+
className?: string;
|
|
1155
|
+
theme: 'dark' | 'light';
|
|
1156
|
+
onThemeChange: (isSelected: boolean) => void;
|
|
980
1157
|
}
|
|
981
1158
|
interface NavbarSocialsProps extends ComponentBase {
|
|
982
|
-
|
|
983
|
-
|
|
984
|
-
}
|
|
985
|
-
declare const Navbar: {
|
|
986
|
-
|
|
987
|
-
|
|
988
|
-
|
|
989
|
-
|
|
990
|
-
|
|
991
|
-
|
|
992
|
-
|
|
993
|
-
|
|
994
|
-
|
|
995
|
-
|
|
996
|
-
|
|
997
|
-
|
|
998
|
-
|
|
999
|
-
|
|
1159
|
+
icon: string;
|
|
1160
|
+
link: string;
|
|
1161
|
+
}
|
|
1162
|
+
declare const Navbar$1: {
|
|
1163
|
+
({
|
|
1164
|
+
children,
|
|
1165
|
+
className,
|
|
1166
|
+
...props
|
|
1167
|
+
}: ComponentBase): _$react_jsx_runtime0.JSX.Element;
|
|
1168
|
+
Root: /*elided*/any;
|
|
1169
|
+
Left: ({
|
|
1170
|
+
children,
|
|
1171
|
+
className
|
|
1172
|
+
}: ComponentBase) => _$react_jsx_runtime0.JSX.Element;
|
|
1173
|
+
Right: ({
|
|
1174
|
+
children,
|
|
1175
|
+
className
|
|
1176
|
+
}: ComponentBase) => _$react_jsx_runtime0.JSX.Element;
|
|
1177
|
+
Center: ({
|
|
1178
|
+
children,
|
|
1179
|
+
className
|
|
1180
|
+
}: ComponentBase) => _$react_jsx_runtime0.JSX.Element;
|
|
1181
|
+
Logo: ({
|
|
1182
|
+
src,
|
|
1183
|
+
alt,
|
|
1184
|
+
width,
|
|
1185
|
+
height,
|
|
1186
|
+
className
|
|
1187
|
+
}: NavbarLogoProps) => _$react_jsx_runtime0.JSX.Element;
|
|
1188
|
+
Title: ({
|
|
1189
|
+
children,
|
|
1190
|
+
className
|
|
1191
|
+
}: ComponentBase) => _$react_jsx_runtime0.JSX.Element;
|
|
1192
|
+
Links: ({
|
|
1193
|
+
children,
|
|
1194
|
+
className
|
|
1195
|
+
}: ComponentBase) => _$react_jsx_runtime0.JSX.Element;
|
|
1196
|
+
Link: ({
|
|
1197
|
+
label,
|
|
1198
|
+
href,
|
|
1199
|
+
active,
|
|
1200
|
+
to,
|
|
1201
|
+
className
|
|
1202
|
+
}: NavbarLinkProps) => _$react_jsx_runtime0.JSX.Element;
|
|
1203
|
+
SearchTrigger: ({
|
|
1204
|
+
className,
|
|
1205
|
+
onPress
|
|
1206
|
+
}: NavbarSearchTriggerProps) => _$react_jsx_runtime0.JSX.Element;
|
|
1207
|
+
Theme: ({
|
|
1208
|
+
className,
|
|
1209
|
+
theme,
|
|
1210
|
+
onThemeChange
|
|
1211
|
+
}: NavbarThemeProps) => _$react_jsx_runtime0.JSX.Element;
|
|
1212
|
+
Socials: ({
|
|
1213
|
+
icon,
|
|
1214
|
+
link,
|
|
1215
|
+
className
|
|
1216
|
+
}: NavbarSocialsProps) => _$react_jsx_runtime0.JSX.Element;
|
|
1217
|
+
Split: ({
|
|
1218
|
+
className
|
|
1219
|
+
}: ComponentBase) => _$react_jsx_runtime0.JSX.Element;
|
|
1220
|
+
Content: ({
|
|
1221
|
+
children,
|
|
1222
|
+
className
|
|
1223
|
+
}: ComponentBase) => _$react_jsx_runtime0.JSX.Element;
|
|
1000
1224
|
};
|
|
1001
|
-
|
|
1225
|
+
//#endregion
|
|
1226
|
+
//#region src/client/components/primitives/navigation-menu.d.ts
|
|
1002
1227
|
interface NavigationMenuItemProps extends ComponentBase {
|
|
1003
|
-
|
|
1228
|
+
label: string;
|
|
1004
1229
|
}
|
|
1005
1230
|
interface NavigationMenuLinkProps extends Omit<ComponentBase, 'children'> {
|
|
1006
|
-
|
|
1007
|
-
|
|
1008
|
-
|
|
1009
|
-
|
|
1231
|
+
href: string;
|
|
1232
|
+
label: string;
|
|
1233
|
+
description?: string;
|
|
1234
|
+
children?: React.ReactNode | ((opts: RAC.MenuItemRenderProps) => React.ReactNode);
|
|
1010
1235
|
}
|
|
1011
1236
|
declare const NavigationMenu: {
|
|
1012
|
-
|
|
1013
|
-
|
|
1014
|
-
|
|
1015
|
-
|
|
1016
|
-
|
|
1237
|
+
({
|
|
1238
|
+
children,
|
|
1239
|
+
className,
|
|
1240
|
+
...props
|
|
1241
|
+
}: ComponentBase): _$react_jsx_runtime0.JSX.Element;
|
|
1242
|
+
Root: /*elided*/any;
|
|
1243
|
+
List: ({
|
|
1244
|
+
children,
|
|
1245
|
+
className
|
|
1246
|
+
}: ComponentBase) => _$react_jsx_runtime0.JSX.Element;
|
|
1247
|
+
Item: ({
|
|
1248
|
+
children,
|
|
1249
|
+
label,
|
|
1250
|
+
className
|
|
1251
|
+
}: NavigationMenuItemProps) => _$react_jsx_runtime0.JSX.Element;
|
|
1252
|
+
Link: ({
|
|
1253
|
+
label,
|
|
1254
|
+
href,
|
|
1255
|
+
description,
|
|
1256
|
+
className,
|
|
1257
|
+
children,
|
|
1258
|
+
...props
|
|
1259
|
+
}: NavigationMenuLinkProps) => _$react_jsx_runtime0.JSX.Element;
|
|
1017
1260
|
};
|
|
1018
|
-
|
|
1261
|
+
//#endregion
|
|
1262
|
+
//#region src/client/components/primitives/search-dialog.d.ts
|
|
1019
1263
|
interface SearchDialogProps extends ComponentBase {
|
|
1020
|
-
|
|
1021
|
-
|
|
1264
|
+
isOpen?: boolean;
|
|
1265
|
+
onOpenChange?: (isOpen: boolean) => void;
|
|
1022
1266
|
}
|
|
1023
1267
|
interface SearchDialogItemProps extends Omit<RAC.ListBoxItemProps, 'children'> {
|
|
1024
|
-
|
|
1025
|
-
|
|
1268
|
+
className?: string;
|
|
1269
|
+
children: React.ReactNode;
|
|
1026
1270
|
}
|
|
1027
1271
|
interface SearchDialogItemIconProps {
|
|
1028
|
-
|
|
1029
|
-
|
|
1272
|
+
isHeading?: boolean;
|
|
1273
|
+
className?: string;
|
|
1030
1274
|
}
|
|
1031
1275
|
declare const SearchDialog: {
|
|
1032
|
-
|
|
1033
|
-
|
|
1034
|
-
|
|
1035
|
-
|
|
1036
|
-
|
|
1037
|
-
|
|
1038
|
-
|
|
1039
|
-
|
|
1040
|
-
|
|
1041
|
-
|
|
1042
|
-
|
|
1043
|
-
|
|
1044
|
-
|
|
1045
|
-
|
|
1046
|
-
|
|
1047
|
-
|
|
1048
|
-
|
|
1276
|
+
({
|
|
1277
|
+
children,
|
|
1278
|
+
isOpen,
|
|
1279
|
+
onOpenChange,
|
|
1280
|
+
className
|
|
1281
|
+
}: SearchDialogProps): _$react_jsx_runtime0.JSX.Element;
|
|
1282
|
+
Root: /*elided*/any;
|
|
1283
|
+
Autocomplete: <T extends object>({
|
|
1284
|
+
children,
|
|
1285
|
+
className,
|
|
1286
|
+
onSelectionChange,
|
|
1287
|
+
...props
|
|
1288
|
+
}: RAC.AutocompleteProps<T> & {
|
|
1289
|
+
className?: string;
|
|
1290
|
+
onSelectionChange?: (key: RAC.Key) => void;
|
|
1291
|
+
}) => _$react_jsx_runtime0.JSX.Element;
|
|
1292
|
+
Input: ({
|
|
1293
|
+
className,
|
|
1294
|
+
...props
|
|
1295
|
+
}: RAC.InputProps & {
|
|
1296
|
+
className?: string;
|
|
1297
|
+
}) => _$react_jsx_runtime0.JSX.Element;
|
|
1298
|
+
List: <T extends object>({
|
|
1299
|
+
children,
|
|
1300
|
+
className,
|
|
1301
|
+
...props
|
|
1302
|
+
}: RAC.ListBoxProps<T> & {
|
|
1303
|
+
className?: string;
|
|
1304
|
+
}) => _$react_jsx_runtime0.JSX.Element;
|
|
1305
|
+
Item: (({
|
|
1306
|
+
children,
|
|
1307
|
+
className,
|
|
1308
|
+
...props
|
|
1309
|
+
}: SearchDialogItemProps) => _$react_jsx_runtime0.JSX.Element) & {
|
|
1310
|
+
Icon: ({
|
|
1311
|
+
isHeading,
|
|
1312
|
+
className
|
|
1313
|
+
}: SearchDialogItemIconProps) => _$react_jsx_runtime0.JSX.Element;
|
|
1314
|
+
Title: ({
|
|
1315
|
+
children,
|
|
1316
|
+
className
|
|
1317
|
+
}: ComponentBase) => _$react_jsx_runtime0.JSX.Element;
|
|
1318
|
+
Bio: ({
|
|
1319
|
+
children,
|
|
1320
|
+
className
|
|
1321
|
+
}: ComponentBase) => _$react_jsx_runtime0.JSX.Element;
|
|
1322
|
+
};
|
|
1049
1323
|
};
|
|
1050
|
-
|
|
1324
|
+
//#endregion
|
|
1325
|
+
//#region src/client/components/primitives/on-this-page.d.ts
|
|
1051
1326
|
interface TOCItemType {
|
|
1052
|
-
|
|
1053
|
-
|
|
1054
|
-
|
|
1055
|
-
|
|
1327
|
+
title: ReactNode;
|
|
1328
|
+
url: string;
|
|
1329
|
+
depth: number;
|
|
1330
|
+
_step?: number;
|
|
1056
1331
|
}
|
|
1057
1332
|
interface TOCItemInfo {
|
|
1058
|
-
|
|
1059
|
-
|
|
1060
|
-
|
|
1061
|
-
|
|
1062
|
-
|
|
1063
|
-
|
|
1064
|
-
|
|
1333
|
+
id: string;
|
|
1334
|
+
active: boolean;
|
|
1335
|
+
/** last time the item is updated */
|
|
1336
|
+
t: number;
|
|
1337
|
+
/** currently active but not intersecting in viewport */
|
|
1338
|
+
fallback: boolean;
|
|
1339
|
+
original?: TOCItemType;
|
|
1065
1340
|
}
|
|
1066
1341
|
interface AnchorProviderProps {
|
|
1067
|
-
|
|
1068
|
-
|
|
1069
|
-
|
|
1070
|
-
|
|
1071
|
-
|
|
1072
|
-
|
|
1073
|
-
|
|
1342
|
+
toc: TOCItemType[];
|
|
1343
|
+
/**
|
|
1344
|
+
* Only accept one active item at most
|
|
1345
|
+
* @defaultValue false
|
|
1346
|
+
*/
|
|
1347
|
+
single?: boolean;
|
|
1348
|
+
children?: ReactNode;
|
|
1074
1349
|
}
|
|
1075
1350
|
interface ScrollProviderProps {
|
|
1076
|
-
|
|
1077
|
-
|
|
1078
|
-
|
|
1079
|
-
|
|
1080
|
-
|
|
1351
|
+
/**
|
|
1352
|
+
* Scroll into the view of container when active
|
|
1353
|
+
*/
|
|
1354
|
+
containerRef: RefObject<HTMLElement | null>;
|
|
1355
|
+
children?: ReactNode;
|
|
1081
1356
|
}
|
|
1082
1357
|
interface OnThisPageContentProps extends ComponentBase {
|
|
1083
|
-
|
|
1084
|
-
|
|
1358
|
+
ref?: React$1.Ref<HTMLDivElement>;
|
|
1359
|
+
scrollRef?: RefObject<HTMLElement | null>;
|
|
1085
1360
|
}
|
|
1086
1361
|
interface OnThisPageItemProps extends ComponentBase {
|
|
1087
|
-
|
|
1362
|
+
level?: number;
|
|
1088
1363
|
}
|
|
1089
1364
|
interface OnThisPageLinkProps extends ComponentBase {
|
|
1090
|
-
|
|
1091
|
-
|
|
1092
|
-
|
|
1365
|
+
href?: string;
|
|
1366
|
+
active?: boolean;
|
|
1367
|
+
onClick?: (event: React$1.MouseEvent<HTMLAnchorElement>) => void;
|
|
1093
1368
|
}
|
|
1094
1369
|
interface OnThisPageIndicatorProps extends ComponentBase {
|
|
1095
|
-
|
|
1370
|
+
style?: React$1.CSSProperties;
|
|
1096
1371
|
}
|
|
1097
1372
|
declare function useItems(): TOCItemInfo[];
|
|
1098
1373
|
declare function useActiveAnchor(): string | undefined;
|
|
1099
1374
|
declare function useActiveAnchors(): string[];
|
|
1100
1375
|
/** Optional: add auto-scroll to TOC items. */
|
|
1101
|
-
declare function ScrollProvider({
|
|
1102
|
-
|
|
1103
|
-
|
|
1104
|
-
|
|
1105
|
-
|
|
1106
|
-
|
|
1107
|
-
|
|
1108
|
-
|
|
1109
|
-
|
|
1110
|
-
|
|
1111
|
-
|
|
1112
|
-
|
|
1113
|
-
|
|
1114
|
-
|
|
1376
|
+
declare function ScrollProvider({
|
|
1377
|
+
containerRef,
|
|
1378
|
+
children
|
|
1379
|
+
}: ScrollProviderProps): _$react_jsx_runtime0.JSX.Element;
|
|
1380
|
+
declare function AnchorProvider({
|
|
1381
|
+
toc,
|
|
1382
|
+
single,
|
|
1383
|
+
children
|
|
1384
|
+
}: AnchorProviderProps): _$react_jsx_runtime0.JSX.Element;
|
|
1385
|
+
declare const OnThisPage$1: {
|
|
1386
|
+
({
|
|
1387
|
+
children,
|
|
1388
|
+
className
|
|
1389
|
+
}: ComponentBase): _$react_jsx_runtime0.JSX.Element;
|
|
1390
|
+
Root: /*elided*/any;
|
|
1391
|
+
Header: ({
|
|
1392
|
+
children,
|
|
1393
|
+
className,
|
|
1394
|
+
...props
|
|
1395
|
+
}: ComponentBase) => _$react_jsx_runtime0.JSX.Element;
|
|
1396
|
+
Content: {
|
|
1397
|
+
({
|
|
1398
|
+
children,
|
|
1399
|
+
className,
|
|
1400
|
+
ref,
|
|
1401
|
+
...props
|
|
1402
|
+
}: OnThisPageContentProps): _$react_jsx_runtime0.JSX.Element;
|
|
1403
|
+
displayName: string;
|
|
1404
|
+
};
|
|
1405
|
+
List: ({
|
|
1406
|
+
children,
|
|
1407
|
+
className
|
|
1408
|
+
}: ComponentBase) => _$react_jsx_runtime0.JSX.Element;
|
|
1409
|
+
Item: ({
|
|
1410
|
+
level,
|
|
1411
|
+
children,
|
|
1412
|
+
className
|
|
1413
|
+
}: OnThisPageItemProps) => _$react_jsx_runtime0.JSX.Element;
|
|
1414
|
+
Link: ({
|
|
1415
|
+
children,
|
|
1416
|
+
href,
|
|
1417
|
+
active,
|
|
1418
|
+
onClick,
|
|
1419
|
+
className
|
|
1420
|
+
}: OnThisPageLinkProps) => _$react_jsx_runtime0.JSX.Element;
|
|
1421
|
+
Indicator: ({
|
|
1422
|
+
style,
|
|
1423
|
+
className
|
|
1424
|
+
}: OnThisPageIndicatorProps) => _$react_jsx_runtime0.JSX.Element;
|
|
1115
1425
|
};
|
|
1116
|
-
|
|
1426
|
+
//#endregion
|
|
1427
|
+
//#region src/client/components/primitives/page-nav.d.ts
|
|
1117
1428
|
interface PageNavProps extends ComponentBase {
|
|
1118
|
-
|
|
1119
|
-
|
|
1120
|
-
}
|
|
1121
|
-
declare const PageNav: {
|
|
1122
|
-
|
|
1123
|
-
|
|
1124
|
-
|
|
1125
|
-
|
|
1126
|
-
|
|
1127
|
-
|
|
1429
|
+
to: string;
|
|
1430
|
+
direction: 'prev' | 'next';
|
|
1431
|
+
}
|
|
1432
|
+
declare const PageNav$1: {
|
|
1433
|
+
({
|
|
1434
|
+
children,
|
|
1435
|
+
className
|
|
1436
|
+
}: ComponentBase): _$react_jsx_runtime0.JSX.Element;
|
|
1437
|
+
Root: /*elided*/any;
|
|
1438
|
+
Link: ({
|
|
1439
|
+
children,
|
|
1440
|
+
to,
|
|
1441
|
+
direction,
|
|
1442
|
+
className
|
|
1443
|
+
}: PageNavProps) => _$react_jsx_runtime0.JSX.Element;
|
|
1444
|
+
Title: ({
|
|
1445
|
+
children,
|
|
1446
|
+
className
|
|
1447
|
+
}: ComponentBase) => _$react_jsx_runtime0.JSX.Element;
|
|
1448
|
+
Description: ({
|
|
1449
|
+
children,
|
|
1450
|
+
className
|
|
1451
|
+
}: ComponentBase) => _$react_jsx_runtime0.JSX.Element;
|
|
1452
|
+
Icon: ({
|
|
1453
|
+
children
|
|
1454
|
+
}: ComponentBase) => _$react_jsx_runtime0.JSX.Element;
|
|
1128
1455
|
};
|
|
1129
|
-
|
|
1456
|
+
//#endregion
|
|
1457
|
+
//#region src/client/components/primitives/tabs.d.ts
|
|
1130
1458
|
interface TabsItemProps extends ComponentBase {
|
|
1131
|
-
|
|
1132
|
-
|
|
1133
|
-
|
|
1134
|
-
|
|
1135
|
-
|
|
1459
|
+
id: string;
|
|
1460
|
+
selected?: boolean;
|
|
1461
|
+
onClick?: () => void;
|
|
1462
|
+
onKeyDown?: (event: React.KeyboardEvent) => void;
|
|
1463
|
+
disabled?: boolean;
|
|
1136
1464
|
}
|
|
1137
1465
|
interface TabsIndicatorProps extends ComponentBase {
|
|
1138
|
-
|
|
1466
|
+
style?: React.CSSProperties;
|
|
1139
1467
|
}
|
|
1140
1468
|
declare const Tabs: {
|
|
1141
|
-
|
|
1142
|
-
|
|
1143
|
-
|
|
1144
|
-
|
|
1145
|
-
|
|
1146
|
-
|
|
1469
|
+
({
|
|
1470
|
+
children,
|
|
1471
|
+
className,
|
|
1472
|
+
...props
|
|
1473
|
+
}: ComponentBase): _$react_jsx_runtime0.JSX.Element;
|
|
1474
|
+
Root: /*elided*/any;
|
|
1475
|
+
List: ({
|
|
1476
|
+
children,
|
|
1477
|
+
className
|
|
1478
|
+
}: ComponentBase) => _$react_jsx_runtime0.JSX.Element;
|
|
1479
|
+
Item: ({
|
|
1480
|
+
children,
|
|
1481
|
+
id,
|
|
1482
|
+
selected,
|
|
1483
|
+
className,
|
|
1484
|
+
...props
|
|
1485
|
+
}: TabsItemProps) => _$react_jsx_runtime0.JSX.Element;
|
|
1486
|
+
Content: ({
|
|
1487
|
+
children,
|
|
1488
|
+
className
|
|
1489
|
+
}: ComponentBase) => _$react_jsx_runtime0.JSX.Element;
|
|
1490
|
+
Indicator: ({
|
|
1491
|
+
className,
|
|
1492
|
+
style
|
|
1493
|
+
}: TabsIndicatorProps) => _$react_jsx_runtime0.JSX.Element;
|
|
1147
1494
|
};
|
|
1148
|
-
|
|
1495
|
+
//#endregion
|
|
1496
|
+
//#region src/client/components/primitives/sidebar.d.ts
|
|
1149
1497
|
interface SidebarGroupProps extends ComponentBase {
|
|
1150
|
-
|
|
1151
|
-
|
|
1152
|
-
|
|
1153
|
-
|
|
1498
|
+
title?: string;
|
|
1499
|
+
icon?: React.ElementType;
|
|
1500
|
+
isOpen?: boolean;
|
|
1501
|
+
onToggle?: () => void;
|
|
1154
1502
|
}
|
|
1155
1503
|
interface SidebarLinkProps extends ComponentBase {
|
|
1156
|
-
|
|
1157
|
-
|
|
1158
|
-
|
|
1159
|
-
|
|
1160
|
-
|
|
1504
|
+
label: string;
|
|
1505
|
+
href: string;
|
|
1506
|
+
active?: boolean;
|
|
1507
|
+
icon?: React.ElementType;
|
|
1508
|
+
badge?: ComponentRoute['badge'];
|
|
1161
1509
|
}
|
|
1162
1510
|
declare const Sidebar: {
|
|
1163
|
-
|
|
1164
|
-
|
|
1165
|
-
|
|
1166
|
-
|
|
1167
|
-
|
|
1511
|
+
({
|
|
1512
|
+
children,
|
|
1513
|
+
className
|
|
1514
|
+
}: ComponentBase): _$react_jsx_runtime0.JSX.Element;
|
|
1515
|
+
Root: /*elided*/any;
|
|
1516
|
+
Group: ({
|
|
1517
|
+
children,
|
|
1518
|
+
title,
|
|
1519
|
+
icon: Icon,
|
|
1520
|
+
isOpen,
|
|
1521
|
+
onToggle,
|
|
1522
|
+
className
|
|
1523
|
+
}: SidebarGroupProps) => _$react_jsx_runtime0.JSX.Element;
|
|
1524
|
+
GroupItem: ({
|
|
1525
|
+
children,
|
|
1526
|
+
className
|
|
1527
|
+
}: ComponentBase) => _$react_jsx_runtime0.JSX.Element;
|
|
1528
|
+
Link: ({
|
|
1529
|
+
label,
|
|
1530
|
+
href,
|
|
1531
|
+
active,
|
|
1532
|
+
icon: Icon,
|
|
1533
|
+
badge,
|
|
1534
|
+
className
|
|
1535
|
+
}: SidebarLinkProps) => _$react_jsx_runtime0.JSX.Element;
|
|
1168
1536
|
};
|
|
1169
|
-
|
|
1170
|
-
|
|
1171
|
-
|
|
1172
|
-
|
|
1173
|
-
|
|
1174
|
-
|
|
1175
|
-
|
|
1176
|
-
|
|
1177
|
-
|
|
1537
|
+
//#endregion
|
|
1538
|
+
//#region src/client/components/primitives/breadcrumbs.d.ts
|
|
1539
|
+
declare const Breadcrumbs$1: {
|
|
1540
|
+
({
|
|
1541
|
+
children,
|
|
1542
|
+
className,
|
|
1543
|
+
...props
|
|
1544
|
+
}: ComponentBase): _$react_jsx_runtime0.JSX.Element;
|
|
1545
|
+
Root: /*elided*/any;
|
|
1546
|
+
Item: ({
|
|
1547
|
+
children,
|
|
1548
|
+
className,
|
|
1549
|
+
...props
|
|
1550
|
+
}: ComponentBase) => _$react_jsx_runtime0.JSX.Element;
|
|
1551
|
+
Link: ({
|
|
1552
|
+
children,
|
|
1553
|
+
href,
|
|
1554
|
+
className,
|
|
1555
|
+
...props
|
|
1556
|
+
}: LinkProps$2 & {
|
|
1557
|
+
className?: string;
|
|
1558
|
+
}) => _$react_jsx_runtime0.JSX.Element;
|
|
1559
|
+
Separator: ({
|
|
1560
|
+
className
|
|
1561
|
+
}: ComponentBase) => _$react_jsx_runtime0.JSX.Element;
|
|
1178
1562
|
};
|
|
1179
|
-
|
|
1563
|
+
//#endregion
|
|
1564
|
+
//#region src/client/components/primitives/button-group.d.ts
|
|
1180
1565
|
interface ButtonGroupProps extends ComponentBase {
|
|
1181
|
-
|
|
1182
|
-
}
|
|
1183
|
-
declare const ButtonGroup: ({
|
|
1184
|
-
|
|
1566
|
+
vertical?: boolean;
|
|
1567
|
+
}
|
|
1568
|
+
declare const ButtonGroup: ({
|
|
1569
|
+
children,
|
|
1570
|
+
className,
|
|
1571
|
+
vertical
|
|
1572
|
+
}: ButtonGroupProps) => _$react_jsx_runtime0.JSX.Element;
|
|
1573
|
+
//#endregion
|
|
1574
|
+
//#region src/client/components/primitives/popover.d.ts
|
|
1185
1575
|
interface PopoverProps extends Omit<RAC.PopoverProps, 'children'> {
|
|
1186
|
-
|
|
1187
|
-
|
|
1188
|
-
|
|
1576
|
+
children: React.ReactNode;
|
|
1577
|
+
className?: string;
|
|
1578
|
+
showArrow?: boolean;
|
|
1189
1579
|
}
|
|
1190
1580
|
/**
|
|
1191
1581
|
* A reusable Popover primitive with premium glassmorphism styling and smooth animations.
|
|
1192
1582
|
*/
|
|
1193
|
-
declare const Popover: ({
|
|
1194
|
-
|
|
1583
|
+
declare const Popover: ({
|
|
1584
|
+
children,
|
|
1585
|
+
className,
|
|
1586
|
+
showArrow,
|
|
1587
|
+
...props
|
|
1588
|
+
}: PopoverProps) => _$react_jsx_runtime0.JSX.Element;
|
|
1589
|
+
//#endregion
|
|
1590
|
+
//#region src/client/components/primitives/menu.d.ts
|
|
1195
1591
|
/**
|
|
1196
1592
|
* MenuTrigger wraps a trigger (usually a Button) and a Menu.
|
|
1197
1593
|
*/
|
|
1198
1594
|
interface MenuTriggerProps extends RAC.MenuTriggerProps {
|
|
1199
|
-
|
|
1595
|
+
placement?: PopoverProps['placement'];
|
|
1200
1596
|
}
|
|
1201
|
-
declare function MenuTrigger(props: MenuTriggerProps):
|
|
1597
|
+
declare function MenuTrigger(props: MenuTriggerProps): _$react_jsx_runtime0.JSX.Element;
|
|
1202
1598
|
/**
|
|
1203
1599
|
* SubmenuTrigger for nested menus.
|
|
1204
1600
|
*/
|
|
1205
|
-
declare function SubmenuTrigger(props: RAC.SubmenuTriggerProps):
|
|
1601
|
+
declare function SubmenuTrigger(props: RAC.SubmenuTriggerProps): _$react_jsx_runtime0.JSX.Element;
|
|
1206
1602
|
/**
|
|
1207
1603
|
* The Menu container.
|
|
1208
1604
|
*/
|
|
1209
|
-
declare function Menu<T extends object>(props: RAC.MenuProps<T>):
|
|
1605
|
+
declare function Menu<T extends object>(props: RAC.MenuProps<T>): _$react_jsx_runtime0.JSX.Element;
|
|
1210
1606
|
declare namespace Menu {
|
|
1211
|
-
|
|
1212
|
-
|
|
1213
|
-
|
|
1214
|
-
|
|
1215
|
-
|
|
1216
|
-
|
|
1607
|
+
var Root: typeof Menu;
|
|
1608
|
+
var Item: typeof MenuItem;
|
|
1609
|
+
var Trigger: typeof MenuTrigger;
|
|
1610
|
+
var SubTrigger: typeof SubmenuTrigger;
|
|
1611
|
+
var Section: typeof MenuSection;
|
|
1612
|
+
var Separator: typeof MenuSeparator;
|
|
1217
1613
|
}
|
|
1218
1614
|
/**
|
|
1219
1615
|
* MenuItem with support for selection states and submenus.
|
|
1220
1616
|
*/
|
|
1221
|
-
declare function MenuItem(props: RAC.MenuItemProps):
|
|
1617
|
+
declare function MenuItem(props: RAC.MenuItemProps): _$react_jsx_runtime0.JSX.Element;
|
|
1222
1618
|
/**
|
|
1223
1619
|
* MenuSection for grouping items with an optional header.
|
|
1224
1620
|
*/
|
|
1225
1621
|
interface MenuSectionProps<T> extends RAC.MenuSectionProps<T> {
|
|
1226
|
-
|
|
1622
|
+
title?: string;
|
|
1227
1623
|
}
|
|
1228
|
-
declare function MenuSection<T extends object>({
|
|
1624
|
+
declare function MenuSection<T extends object>({
|
|
1625
|
+
title,
|
|
1626
|
+
...props
|
|
1627
|
+
}: MenuSectionProps<T>): _$react_jsx_runtime0.JSX.Element;
|
|
1229
1628
|
/**
|
|
1230
1629
|
* MenuSeparator for visual division.
|
|
1231
1630
|
*/
|
|
1232
|
-
declare function MenuSeparator(props: RAC.SeparatorProps):
|
|
1233
|
-
|
|
1631
|
+
declare function MenuSeparator(props: RAC.SeparatorProps): _$react_jsx_runtime0.JSX.Element;
|
|
1632
|
+
//#endregion
|
|
1633
|
+
//#region src/client/components/primitives/tooltip.d.ts
|
|
1234
1634
|
interface TooltipProps extends Omit<RAC.TooltipProps, 'children'> {
|
|
1235
|
-
|
|
1236
|
-
|
|
1237
|
-
|
|
1238
|
-
|
|
1239
|
-
|
|
1240
|
-
|
|
1241
|
-
|
|
1242
|
-
|
|
1243
|
-
}
|
|
1244
|
-
interface TooltipContentProps extends RAC.TooltipProps {
|
|
1245
|
-
}
|
|
1635
|
+
/** The content to show inside the tooltip */
|
|
1636
|
+
content: ReactNode;
|
|
1637
|
+
/** The trigger element (usually a button or link) */
|
|
1638
|
+
children: React.ReactElement;
|
|
1639
|
+
/** Delay in milliseconds before showing the tooltip */
|
|
1640
|
+
delay?: number;
|
|
1641
|
+
/** Delay in milliseconds before hiding the tooltip */
|
|
1642
|
+
closeDelay?: number;
|
|
1643
|
+
}
|
|
1644
|
+
interface TooltipContentProps extends RAC.TooltipProps {}
|
|
1246
1645
|
declare const Tooltip: {
|
|
1247
|
-
|
|
1248
|
-
|
|
1249
|
-
|
|
1646
|
+
({
|
|
1647
|
+
content,
|
|
1648
|
+
children,
|
|
1649
|
+
delay,
|
|
1650
|
+
closeDelay,
|
|
1651
|
+
...props
|
|
1652
|
+
}: TooltipProps): _$react_jsx_runtime0.JSX.Element;
|
|
1653
|
+
Root: /*elided*/any;
|
|
1654
|
+
Content: ({
|
|
1655
|
+
className,
|
|
1656
|
+
children,
|
|
1657
|
+
...props
|
|
1658
|
+
}: TooltipContentProps) => _$react_jsx_runtime0.JSX.Element;
|
|
1250
1659
|
};
|
|
1251
|
-
|
|
1660
|
+
//#endregion
|
|
1661
|
+
//#region src/client/components/primitives/skeleton.d.ts
|
|
1252
1662
|
interface SkeletonProps extends React.HTMLAttributes<HTMLDivElement> {
|
|
1253
|
-
|
|
1663
|
+
variant?: 'rect' | 'circle';
|
|
1254
1664
|
}
|
|
1255
1665
|
/**
|
|
1256
1666
|
* A flexible skeleton component that mimics the shape of content
|
|
1257
1667
|
* while it is loading. Features a smooth pulse animation.
|
|
1258
1668
|
*/
|
|
1259
|
-
declare function Skeleton({
|
|
1260
|
-
|
|
1669
|
+
declare function Skeleton({
|
|
1670
|
+
className,
|
|
1671
|
+
variant,
|
|
1672
|
+
...props
|
|
1673
|
+
}: SkeletonProps): _$react_jsx_runtime0.JSX.Element;
|
|
1674
|
+
//#endregion
|
|
1675
|
+
//#region src/client/utils/cn.d.ts
|
|
1261
1676
|
declare function cn(...inputs: ClassValue[]): string;
|
|
1262
|
-
|
|
1263
|
-
export { Admonition, type AdmonitionProps, AnchorProvider, Badge, type BadgeProps, type BoltdocsConfig, type BoltdocsThemeConfig, Breadcrumbs
|
|
1677
|
+
//#endregion
|
|
1678
|
+
export { Admonition, type AdmonitionProps, AnchorProvider, Badge, type BadgeProps, type BoltdocsConfig, type BoltdocsThemeConfig, Breadcrumbs, Button, ButtonGroup, type ButtonProps, Card, type CardProps, Cards, type CardsProps, Caution, CodeBlock, ComponentPreview, type ComponentPreviewProps, ComponentProps, type ComponentPropsProps, type ComponentRoute, CopyMarkdown, type CreateBoltdocsAppOptions, Danger, DefaultLayout, DocsLayout, ErrorBoundary, Field, type FieldProps, FileTree, type FileTreeProps, Head, Image, type ImageProps, Important, InfoBox, type LayoutProps, Link, type LinkProps, List, type ListProps, Loading, 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, createBoltdocsApp, useActiveAnchor, useActiveAnchors, useBreadcrumbs, useConfig, useI18n, useItems, useLocalizedTo, useLocation, useMdxComponents, useNavbar, useOnThisPage, usePageNav, useRoutes, useSearch, useSidebar, useTabs, useTheme, useVersion };
|