ardo 2.6.0 → 2.7.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (24) hide show
  1. package/dist/{FileTree-BGMcsIGZ.d.ts → FileTree-gHRnoz7O.d.ts} +53 -15
  2. package/dist/{chunk-ZPYFCNRO.js → chunk-2JWOR7PG.js} +194 -92
  3. package/dist/chunk-2JWOR7PG.js.map +1 -0
  4. package/dist/{chunk-M5VLOQYV.js → chunk-EA24YW22.js} +2 -2
  5. package/dist/{chunk-ASEDNN4I.js → chunk-TNUS3B2A.js} +2 -2
  6. package/dist/{chunk-7L64KVOU.js → chunk-U6IRSKHU.js} +20 -1
  7. package/dist/chunk-U6IRSKHU.js.map +1 -0
  8. package/dist/config/index.d.ts +2 -2
  9. package/dist/index.d.ts +2 -2
  10. package/dist/index.js +4 -4
  11. package/dist/runtime/index.d.ts +1 -1
  12. package/dist/typedoc/index.d.ts +2 -0
  13. package/dist/typedoc/index.js +2 -2
  14. package/dist/{types-DArVCX06.d.ts → types-CLkHwCch.d.ts} +5 -1
  15. package/dist/ui/index.d.ts +65 -3
  16. package/dist/ui/index.js +5 -1
  17. package/dist/vite/index.d.ts +1 -1
  18. package/dist/vite/index.js +2 -2
  19. package/package.json +16 -11
  20. package/virtual.d.ts +60 -0
  21. package/dist/chunk-7L64KVOU.js.map +0 -1
  22. package/dist/chunk-ZPYFCNRO.js.map +0 -1
  23. /package/dist/{chunk-M5VLOQYV.js.map → chunk-EA24YW22.js.map} +0 -0
  24. /package/dist/{chunk-ASEDNN4I.js.map → chunk-TNUS3B2A.js.map} +0 -0
package/dist/{FileTree-BGMcsIGZ.d.ts → FileTree-gHRnoz7O.d.ts} RENAMED
@@ -1,8 +1,32 @@
1
1
  import * as react_jsx_runtime from 'react/jsx-runtime';
2
2
  import { ReactNode, ComponentProps, CSSProperties } from 'react';
3
3
  import { NavLink, Link } from 'react-router';
4
- import { S as SidebarItem, b as ProjectMeta, f as SponsorConfig } from './types-DArVCX06.js';
4
+ import { S as SidebarItem, b as ProjectMeta, f as SponsorConfig } from './types-CLkHwCch.js';
5
5
 
6
+ interface RootLayoutProps {
7
+ children: ReactNode;
8
+ /** Favicon URL (renders <link rel="icon">) */
9
+ favicon?: string;
10
+ /** Language attribute for <html> (default: from config or "en") */
11
+ lang?: string;
12
+ }
13
+ /**
14
+ * Default HTML shell for Ardo sites. Replaces the boilerplate `Layout` export
15
+ * that every root.tsx must define for React Router.
16
+ *
17
+ * @example Basic usage
18
+ * ```tsx
19
+ * // app/root.tsx
20
+ * export { RootLayout as Layout } from "ardo/ui"
21
+ * ```
22
+ *
23
+ * @example With favicon
24
+ * ```tsx
25
+ * import logo from "./assets/logo.svg"
26
+ * export const Layout = (props) => <RootLayout favicon={logo} {...props} />
27
+ * ```
28
+ */
29
+ declare function RootLayout({ children, favicon, lang }: RootLayoutProps): react_jsx_runtime.JSX.Element;
6
30
  interface LayoutProps {
7
31
  /** Header content */
8
32
  header?: ReactNode;
@@ -53,7 +77,15 @@ interface HeaderProps {
53
77
  /**
54
78
  * Header component with explicit slot props.
55
79
  *
56
- * @example
80
+ * Automatically pulls `title` from config and `logo`/`siteTitle` from themeConfig.
81
+ * Props serve as overrides.
82
+ *
83
+ * @example Zero-config
84
+ * ```tsx
85
+ * <Header />
86
+ * ```
87
+ *
88
+ * @example With overrides
57
89
  * ```tsx
58
90
  * <Header
59
91
  * logo="/logo.svg"
@@ -64,9 +96,6 @@ interface HeaderProps {
64
96
  * <NavLink to="/api">API</NavLink>
65
97
  * </Nav>
66
98
  * }
67
- * actions={
68
- * <SocialLink href="https://github.com/..." icon="github" />
69
- * }
70
99
  * />
71
100
  * ```
72
101
  */
@@ -102,7 +131,15 @@ interface SidebarProps {
102
131
  className?: string;
103
132
  }
104
133
  /**
105
- * Sidebar component supporting both data-driven and JSX composition patterns.
134
+ * Sidebar component supporting data-driven, JSX composition, and zero-config patterns.
135
+ *
136
+ * When neither `items` nor `children` are provided, automatically renders from
137
+ * the Ardo sidebar context (`virtual:ardo/sidebar`).
138
+ *
139
+ * @example Zero-config (from context)
140
+ * ```tsx
141
+ * <Sidebar />
142
+ * ```
106
143
  *
107
144
  * @example Data-driven (items prop)
108
145
  * ```tsx
@@ -199,24 +236,25 @@ interface FooterProps {
199
236
  /**
200
237
  * Footer component with structured layout for project info, sponsor, and build metadata.
201
238
  *
239
+ * Automatically pulls data from Ardo context (`config.project`, `config.buildTime`,
240
+ * `config.buildHash`, `themeConfig.footer.*`). Props serve as overrides.
241
+ *
202
242
  * When `children` is provided, all automatic rendering is skipped.
203
243
  *
204
- * @example Structured usage
244
+ * @example Automatic (zero-config)
245
+ * ```tsx
246
+ * <Footer />
247
+ * ```
248
+ *
249
+ * @example With overrides
205
250
  * ```tsx
206
251
  * <Footer
207
- * project={config.project}
208
252
  * sponsor={{ text: "Sebastian Software", link: "https://sebastian-software.com/oss" }}
209
- * buildTime={config.buildTime}
210
253
  * message="Released under the MIT License."
211
254
  * copyright="Copyright 2026 Sebastian Software GmbH"
212
255
  * />
213
256
  * ```
214
257
  *
215
- * @example Simple usage
216
- * ```tsx
217
- * <Footer message="MIT License" copyright="2026 Sebastian Software" />
218
- * ```
219
- *
220
258
  * @example Custom content
221
259
  * ```tsx
222
260
  * <Footer>
@@ -601,4 +639,4 @@ interface FileTreeProps {
601
639
  */
602
640
  declare function FileTree({ children }: FileTreeProps): react_jsx_runtime.JSX.Element;
603
641
 
604
- export { type FooterCopyrightProps as $, Steps as A, type StepsProps as B, CodeBlock as C, Danger as D, Tab as E, FeatureCard as F, TabList as G, Header as H, Info as I, type TabListProps as J, TabPanel as K, Layout as L, type TabPanelProps as M, Note as N, TabPanels as O, type TabPanelsProps as P, type TabProps as Q, Tabs as R, Search as S, TOC as T, type TabsProps as U, ThemeToggle as V, Tip as W, type TipProps as X, Warning as Y, type WarningProps as Z, DocContent as _, type CodeBlockProps as a, type FooterMessageProps as a0, type FooterProps as a1, type HeaderProps as a2, type LayoutProps as a3, SidebarGroup as a4, type SidebarGroupProps as a5, SidebarLink as a6, type SidebarLinkProps as a7, type SidebarProps as a8, SocialLink as a9, type SocialLinkProps as aa, CodeGroup as b, type CodeGroupProps as c, Container as d, type ContainerProps as e, type ContainerType as f, Content as g, CopyButton as h, type DangerProps as i, DocLayout as j, DocPage as k, type FeatureCardProps as l, type FeatureItem as m, Features as n, type FeaturesProps as o, FileTree as p, type FileTreeProps as q, Footer as r, Hero as s, type HeroAction as t, type HeroImage as u, type HeroProps as v, HomePage as w, type InfoProps as x, type NoteProps as y, Sidebar as z };
642
+ export { type SidebarProps as $, Steps as A, type StepsProps as B, CodeBlock as C, Danger as D, Tab as E, FeatureCard as F, TabList as G, Header as H, Info as I, type TabListProps as J, TabPanel as K, Layout as L, type TabPanelProps as M, Note as N, TabPanels as O, type TabPanelsProps as P, type TabProps as Q, Tabs as R, Search as S, TOC as T, type TabsProps as U, ThemeToggle as V, Tip as W, type TipProps as X, Warning as Y, type WarningProps as Z, type HeaderProps as _, type CodeBlockProps as a, type FooterProps as a0, DocContent as a1, type FooterCopyrightProps as a2, type FooterMessageProps as a3, type LayoutProps as a4, RootLayout as a5, type RootLayoutProps as a6, SidebarGroup as a7, type SidebarGroupProps as a8, SidebarLink as a9, type SidebarLinkProps as aa, SocialLink as ab, type SocialLinkProps as ac, CodeGroup as b, type CodeGroupProps as c, Container as d, type ContainerProps as e, type ContainerType as f, Content as g, CopyButton as h, type DangerProps as i, DocLayout as j, DocPage as k, type FeatureCardProps as l, type FeatureItem as m, Features as n, type FeaturesProps as o, FileTree as p, type FileTreeProps as q, Footer as r, Hero as s, type HeroAction as t, type HeroImage as u, type HeroProps as v, HomePage as w, type InfoProps as x, type NoteProps as y, Sidebar as z };