@vx-oss/docs-react 1.0.3 → 1.0.5
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/README.md +3 -3
- package/css/generated/docs.css +1 -1
- package/css/generated/flux.css +1 -1
- package/css/generated/glass.css +1 -1
- package/css/generated/home.css +1 -1
- package/css/generated/notebook.css +1 -1
- package/css/generated/shared.css +1 -1
- package/css/lib/base.css +0 -127
- package/css/preset.css +1 -2
- package/css/style.css +1 -0
- package/dist/components/accordion.js +1 -68
- package/dist/components/banner.js +1 -85
- package/dist/components/callout.js +1 -60
- package/dist/components/card.js +1 -39
- package/dist/components/codeblock.js +1 -126
- package/dist/components/codeblock.rsc.js +1 -22
- package/dist/components/dialog/search-algolia.js +2 -64
- package/dist/components/dialog/search-default.js +2 -66
- package/dist/components/dialog/search-orama.js +2 -69
- package/dist/components/dialog/search.js +1 -351
- package/dist/components/dynamic-codeblock.core.js +1 -51
- package/dist/components/dynamic-codeblock.js +1 -17
- package/dist/components/files.js +1 -40
- package/dist/components/github-info.js +1 -75
- package/dist/components/heading.js +1 -38
- package/dist/components/image-zoom.js +1 -32
- package/dist/components/inline-toc.js +1 -28
- package/dist/components/sidebar/base.js +1 -277
- package/dist/components/sidebar/link-item.js +1 -37
- package/dist/components/sidebar/page-tree.js +1 -69
- package/dist/components/sidebar/tabs/dropdown.js +1 -83
- package/dist/components/sidebar/tabs/index.js +1 -46
- package/dist/components/steps.js +1 -16
- package/dist/components/tabs.js +1 -95
- package/dist/components/toc/clerk.js +1 -227
- package/dist/components/toc/default.js +1 -260
- package/dist/components/toc/index.js +1 -45
- package/dist/components/type-table.js +1 -117
- package/dist/components/ui/accordion.js +1 -42
- package/dist/components/ui/button.js +1 -20
- package/dist/components/ui/collapsible.js +1 -21
- package/dist/components/ui/popover.js +1 -20
- package/dist/components/ui/scroll-area.js +1 -34
- package/dist/components/ui/tabs.js +1 -102
- package/dist/contexts/i18n.js +1 -37
- package/dist/contexts/search.js +1 -68
- package/dist/contexts/tree.js +1 -91
- package/dist/i18n.js +1 -38
- package/dist/index.js +1 -0
- package/dist/layouts/docs/index.js +1 -23
- package/dist/layouts/docs/page/index.js +1 -124
- package/dist/layouts/docs/page/slots/breadcrumb.js +1 -44
- package/dist/layouts/docs/page/slots/container.js +1 -22
- package/dist/layouts/docs/page/slots/footer.js +1 -56
- package/dist/layouts/docs/page/slots/toc.js +1 -182
- package/dist/layouts/docs/slots/container.js +1 -36
- package/dist/layouts/docs/slots/header.js +1 -38
- package/dist/layouts/docs/slots/sidebar.js +1 -268
- package/dist/layouts/flux/index.js +1 -146
- package/dist/layouts/flux/page/index.js +1 -104
- package/dist/layouts/flux/page/slots/breadcrumb.js +1 -44
- package/dist/layouts/flux/page/slots/container.js +1 -22
- package/dist/layouts/flux/page/slots/footer.js +1 -56
- package/dist/layouts/flux/page/slots/toc.js +1 -181
- package/dist/layouts/flux/slots/container.js +1 -13
- package/dist/layouts/flux/slots/sidebar.js +1 -243
- package/dist/layouts/flux/slots/tab-dropdown.js +1 -88
- package/dist/layouts/glass/index.js +1 -70
- package/dist/layouts/glass/page/index.js +1 -92
- package/dist/layouts/glass/page/slots/breadcrumb.js +1 -44
- package/dist/layouts/glass/page/slots/footer.js +1 -56
- package/dist/layouts/glass/page/slots/toc.js +1 -108
- package/dist/layouts/glass/slots/header.js +1 -68
- package/dist/layouts/glass/slots/sidebar.js +1 -267
- package/dist/layouts/home/index.js +1 -40
- package/dist/layouts/home/navbar.js +1 -34
- package/dist/layouts/home/not-found.js +1 -41
- package/dist/layouts/home/slots/container.js +1 -13
- package/dist/layouts/home/slots/header.js +1 -239
- package/dist/layouts/notebook/index.js +1 -23
- package/dist/layouts/notebook/page/index.js +1 -124
- package/dist/layouts/notebook/page/slots/breadcrumb.js +1 -44
- package/dist/layouts/notebook/page/slots/container.js +1 -22
- package/dist/layouts/notebook/page/slots/footer.js +1 -56
- package/dist/layouts/notebook/page/slots/toc.js +1 -181
- package/dist/layouts/notebook/slots/container.js +1 -38
- package/dist/layouts/notebook/slots/header.js +1 -204
- package/dist/layouts/notebook/slots/sidebar.js +1 -240
- package/dist/layouts/shared/index.js +1 -98
- package/dist/layouts/shared/slots/language-select.js +1 -43
- package/dist/layouts/shared/slots/search-trigger.js +1 -53
- package/dist/layouts/shared/slots/theme-switch.js +1 -70
- package/dist/mdx.d.ts +2 -44
- package/dist/mdx.js +2 -70
- package/dist/mdx.server.js +2 -20
- package/dist/og/takumi.js +1 -91
- package/dist/og.js +1 -91
- package/dist/page.js +1 -33
- package/dist/primitives/accordion.js +1 -0
- package/dist/primitives/collapsible.js +1 -0
- package/dist/primitives/dialog.js +1 -0
- package/dist/primitives/direction-provider.js +1 -0
- package/dist/primitives/drawer.js +1 -0
- package/dist/primitives/navigation-menu.js +1 -0
- package/dist/primitives/popover.js +1 -0
- package/dist/primitives/scroll-area.js +1 -0
- package/dist/primitives/shared.js +1 -0
- package/dist/primitives/tabs.js +1 -0
- package/dist/provider/astro.js +1 -20
- package/dist/provider/base.js +1 -73
- package/dist/provider/next.js +1 -17
- package/dist/provider/react-router.js +1 -17
- package/dist/provider/tanstack.js +1 -17
- package/dist/provider/waku.js +1 -17
- package/dist/style.css +11577 -310
- package/dist/utils/use-copy-button.js +1 -26
- package/dist/utils/use-footer-items.js +1 -24
- package/dist/utils/use-is-scroll-top.js +1 -20
- package/package.json +28 -66
- package/css/preset-legacy.css +0 -43
- package/dist/.translations/index.d.ts +0 -55
- package/dist/.translations/keys.js +0 -55
- package/dist/_virtual/_rolldown/runtime.js +0 -13
- package/dist/components/accordion.d.ts +0 -10
- package/dist/components/banner.d.ts +0 -25
- package/dist/components/callout.d.ts +0 -21
- package/dist/components/card.d.ts +0 -13
- package/dist/components/codeblock.d.ts +0 -45
- package/dist/components/codeblock.rsc.d.ts +0 -15
- package/dist/components/dialog/search-algolia.d.ts +0 -27
- package/dist/components/dialog/search-default.d.ts +0 -29
- package/dist/components/dialog/search-orama.d.ts +0 -32
- package/dist/components/dialog/search.d.ts +0 -76
- package/dist/components/dynamic-codeblock.core.d.ts +0 -26
- package/dist/components/dynamic-codeblock.d.ts +0 -8
- package/dist/components/files.d.ts +0 -21
- package/dist/components/github-info.d.ts +0 -20
- package/dist/components/heading.d.ts +0 -9
- package/dist/components/image-zoom.d.ts +0 -18
- package/dist/components/inline-toc.d.ts +0 -10
- package/dist/components/sidebar/base.d.ts +0 -85
- package/dist/components/sidebar/link-item.d.ts +0 -12
- package/dist/components/sidebar/page-tree.d.ts +0 -20
- package/dist/components/sidebar/tabs/dropdown.d.ts +0 -15
- package/dist/components/sidebar/tabs/index.d.ts +0 -8
- package/dist/components/steps.d.ts +0 -10
- package/dist/components/tabs.d.ts +0 -33
- package/dist/components/toc/clerk.d.ts +0 -11
- package/dist/components/toc/default.d.ts +0 -13
- package/dist/components/toc/index.d.ts +0 -10
- package/dist/components/type-table.d.ts +0 -37
- package/dist/components/ui/accordion.d.ts +0 -10
- package/dist/components/ui/button.d.ts +0 -10
- package/dist/components/ui/collapsible.d.ts +0 -11
- package/dist/components/ui/navigation-menu.d.ts +0 -14
- package/dist/components/ui/navigation-menu.js +0 -41
- package/dist/components/ui/popover.d.ts +0 -9
- package/dist/components/ui/scroll-area.d.ts +0 -9
- package/dist/components/ui/tabs.d.ts +0 -23
- package/dist/contexts/i18n.d.ts +0 -34
- package/dist/contexts/search.d.ts +0 -64
- package/dist/contexts/tree.d.ts +0 -29
- package/dist/i18n.d.ts +0 -15
- package/dist/layouts/docs/client.d.ts +0 -33
- package/dist/layouts/docs/client.js +0 -94
- package/dist/layouts/docs/index.d.ts +0 -32
- package/dist/layouts/docs/page/index.d.ts +0 -76
- package/dist/layouts/docs/page/slots/breadcrumb.d.ts +0 -7
- package/dist/layouts/docs/page/slots/container.d.ts +0 -5
- package/dist/layouts/docs/page/slots/footer.d.ts +0 -16
- package/dist/layouts/docs/page/slots/toc.d.ts +0 -47
- package/dist/layouts/docs/slots/container.d.ts +0 -5
- package/dist/layouts/docs/slots/header.d.ts +0 -5
- package/dist/layouts/docs/slots/sidebar.d.ts +0 -22
- package/dist/layouts/flux/index.d.ts +0 -61
- package/dist/layouts/flux/page/index.d.ts +0 -67
- package/dist/layouts/flux/page/slots/breadcrumb.d.ts +0 -7
- package/dist/layouts/flux/page/slots/container.d.ts +0 -5
- package/dist/layouts/flux/page/slots/footer.d.ts +0 -16
- package/dist/layouts/flux/page/slots/toc.d.ts +0 -29
- package/dist/layouts/flux/slots/container.d.ts +0 -5
- package/dist/layouts/flux/slots/sidebar.d.ts +0 -16
- package/dist/layouts/flux/slots/tab-dropdown.d.ts +0 -10
- package/dist/layouts/glass/index.d.ts +0 -39
- package/dist/layouts/glass/layout-tabs.js +0 -54
- package/dist/layouts/glass/page/index.d.ts +0 -31
- package/dist/layouts/glass/page/slots/breadcrumb.d.ts +0 -7
- package/dist/layouts/glass/page/slots/footer.d.ts +0 -16
- package/dist/layouts/glass/page/slots/toc.d.ts +0 -19
- package/dist/layouts/glass/slots/header.d.ts +0 -6
- package/dist/layouts/glass/slots/sidebar.d.ts +0 -21
- package/dist/layouts/home/index.d.ts +0 -27
- package/dist/layouts/home/navbar.d.ts +0 -9
- package/dist/layouts/home/not-found.d.ts +0 -7
- package/dist/layouts/home/slots/container.d.ts +0 -5
- package/dist/layouts/home/slots/header.d.ts +0 -8
- package/dist/layouts/notebook/client.d.ts +0 -35
- package/dist/layouts/notebook/client.js +0 -69
- package/dist/layouts/notebook/index.d.ts +0 -26
- package/dist/layouts/notebook/page/index.d.ts +0 -76
- package/dist/layouts/notebook/page/slots/breadcrumb.d.ts +0 -7
- package/dist/layouts/notebook/page/slots/container.d.ts +0 -5
- package/dist/layouts/notebook/page/slots/footer.d.ts +0 -16
- package/dist/layouts/notebook/page/slots/toc.d.ts +0 -47
- package/dist/layouts/notebook/slots/container.d.ts +0 -5
- package/dist/layouts/notebook/slots/header.d.ts +0 -5
- package/dist/layouts/notebook/slots/sidebar.d.ts +0 -23
- package/dist/layouts/shared/client.d.ts +0 -37
- package/dist/layouts/shared/client.js +0 -85
- package/dist/layouts/shared/index.d.ts +0 -169
- package/dist/layouts/shared/page-actions.d.ts +0 -27
- package/dist/layouts/shared/page-actions.js +0 -199
- package/dist/layouts/shared/slots/language-select.d.ts +0 -12
- package/dist/layouts/shared/slots/search-trigger.d.ts +0 -13
- package/dist/layouts/shared/slots/theme-switch.d.ts +0 -8
- package/dist/legacy/layout.d.ts +0 -29
- package/dist/legacy/layout.js +0 -44
- package/dist/legacy/sidebar.d.ts +0 -14
- package/dist/legacy/sidebar.js +0 -34
- package/dist/mdx.server.d.ts +0 -14
- package/dist/node_modules/.pnpm/react-medium-image-zoom@5.4.9_react-dom@19.2.8_react@19.2.8__react@19.2.8/node_modules/react-medium-image-zoom/dist/controlled.d.ts +0 -30
- package/dist/node_modules/.pnpm/react-medium-image-zoom@5.4.9_react-dom@19.2.8_react@19.2.8__react@19.2.8/node_modules/react-medium-image-zoom/dist/controlled.js +0 -461
- package/dist/node_modules/.pnpm/react-medium-image-zoom@5.4.9_react-dom@19.2.8_react@19.2.8__react@19.2.8/node_modules/react-medium-image-zoom/dist/index.d.ts +0 -3
- package/dist/node_modules/.pnpm/react-medium-image-zoom@5.4.9_react-dom@19.2.8_react@19.2.8__react@19.2.8/node_modules/react-medium-image-zoom/dist/uncontrolled.d.ts +0 -6
- package/dist/node_modules/.pnpm/react-medium-image-zoom@5.4.9_react-dom@19.2.8_react@19.2.8__react@19.2.8/node_modules/react-medium-image-zoom/dist/uncontrolled.js +0 -17
- package/dist/node_modules/.pnpm/react-medium-image-zoom@5.4.9_react-dom@19.2.8_react@19.2.8__react@19.2.8/node_modules/react-medium-image-zoom/dist/utils/adjust-svg-ids.js +0 -53
- package/dist/node_modules/.pnpm/react-medium-image-zoom@5.4.9_react-dom@19.2.8_react@19.2.8__react@19.2.8/node_modules/react-medium-image-zoom/dist/utils/compute-positioned-style.js +0 -25
- package/dist/node_modules/.pnpm/react-medium-image-zoom@5.4.9_react-dom@19.2.8_react@19.2.8__react@19.2.8/node_modules/react-medium-image-zoom/dist/utils/element-tests.js +0 -12
- package/dist/node_modules/.pnpm/react-medium-image-zoom@5.4.9_react-dom@19.2.8_react@19.2.8__react@19.2.8/node_modules/react-medium-image-zoom/dist/utils/get-div-img-style.js +0 -45
- package/dist/node_modules/.pnpm/react-medium-image-zoom@5.4.9_react-dom@19.2.8_react@19.2.8__react@19.2.8/node_modules/react-medium-image-zoom/dist/utils/get-img-alt.js +0 -10
- package/dist/node_modules/.pnpm/react-medium-image-zoom@5.4.9_react-dom@19.2.8_react@19.2.8__react@19.2.8/node_modules/react-medium-image-zoom/dist/utils/get-img-object-fit-style.js +0 -57
- package/dist/node_modules/.pnpm/react-medium-image-zoom@5.4.9_react-dom@19.2.8_react@19.2.8__react@19.2.8/node_modules/react-medium-image-zoom/dist/utils/get-img-regular-style.js +0 -21
- package/dist/node_modules/.pnpm/react-medium-image-zoom@5.4.9_react-dom@19.2.8_react@19.2.8__react@19.2.8/node_modules/react-medium-image-zoom/dist/utils/get-img-src.js +0 -14
- package/dist/node_modules/.pnpm/react-medium-image-zoom@5.4.9_react-dom@19.2.8_react@19.2.8__react@19.2.8/node_modules/react-medium-image-zoom/dist/utils/get-modal-img-transform.js +0 -22
- package/dist/node_modules/.pnpm/react-medium-image-zoom@5.4.9_react-dom@19.2.8_react@19.2.8__react@19.2.8/node_modules/react-medium-image-zoom/dist/utils/get-scale.js +0 -27
- package/dist/node_modules/.pnpm/react-medium-image-zoom@5.4.9_react-dom@19.2.8_react@19.2.8__react@19.2.8/node_modules/react-medium-image-zoom/dist/utils/get-style-ghost.js +0 -31
- package/dist/node_modules/.pnpm/react-medium-image-zoom@5.4.9_react-dom@19.2.8_react@19.2.8__react@19.2.8/node_modules/react-medium-image-zoom/dist/utils/get-style-modal-img.js +0 -75
- package/dist/node_modules/.pnpm/react-medium-image-zoom@5.4.9_react-dom@19.2.8_react@19.2.8__react@19.2.8/node_modules/react-medium-image-zoom/dist/utils/get-target-dimension.js +0 -4
- package/dist/node_modules/.pnpm/react-medium-image-zoom@5.4.9_react-dom@19.2.8_react@19.2.8__react@19.2.8/node_modules/react-medium-image-zoom/dist/utils/parse-position.js +0 -7
- package/dist/node_modules/.pnpm/react-medium-image-zoom@5.4.9_react-dom@19.2.8_react@19.2.8__react@19.2.8/node_modules/react-medium-image-zoom/dist/utils/test-has-scalable-src.js +0 -5
- package/dist/og/takumi.d.ts +0 -15
- package/dist/og.d.ts +0 -16
- package/dist/page.d.ts +0 -29
- package/dist/provider/astro.d.ts +0 -29
- package/dist/provider/base.d.ts +0 -48
- package/dist/provider/next.d.ts +0 -16
- package/dist/provider/react-router.d.ts +0 -16
- package/dist/provider/tanstack.d.ts +0 -16
- package/dist/provider/waku.d.ts +0 -16
- package/dist/utils/cn.js +0 -2
- package/dist/utils/merge-refs.js +0 -11
- package/dist/utils/urls.js +0 -15
- package/dist/utils/use-copy-button.d.ts +0 -5
- package/dist/utils/use-footer-items.d.ts +0 -8
- package/dist/utils/use-is-scroll-top.d.ts +0 -6
|
@@ -1,29 +0,0 @@
|
|
|
1
|
-
import { TOCItemsProps } from "../../../../components/toc/clerk.js";
|
|
2
|
-
import { TOCItemsProps as TOCItemsProps$1 } from "../../../../components/toc/default.js";
|
|
3
|
-
import { TOCProvider as TOCProvider$1, TOCProviderProps as TOCProviderProps$1 } from "../../../../components/toc/index.js";
|
|
4
|
-
import { ComponentProps, ReactNode } from "react";
|
|
5
|
-
//#region src/layouts/flux/page/slots/toc.d.ts
|
|
6
|
-
type TOCProviderProps = TOCProviderProps$1;
|
|
7
|
-
declare const TOCProvider: typeof TOCProvider$1;
|
|
8
|
-
type TOCProps = {
|
|
9
|
-
container?: ComponentProps<'div'>;
|
|
10
|
-
trigger?: ComponentProps<'button'>;
|
|
11
|
-
content?: ComponentProps<'div'>;
|
|
12
|
-
/**
|
|
13
|
-
* Custom content in TOC container, before the main TOC
|
|
14
|
-
*/
|
|
15
|
-
header?: ReactNode;
|
|
16
|
-
/**
|
|
17
|
-
* Custom content in TOC container, after the main TOC
|
|
18
|
-
*/
|
|
19
|
-
footer?: ReactNode;
|
|
20
|
-
} & ({
|
|
21
|
-
style?: 'normal';
|
|
22
|
-
list?: TOCItemsProps$1;
|
|
23
|
-
} | {
|
|
24
|
-
style: 'clerk';
|
|
25
|
-
list?: TOCItemsProps;
|
|
26
|
-
});
|
|
27
|
-
declare function TOC({ container, trigger, content, header, footer, style, list }: TOCProps): import("react").JSX.Element | undefined;
|
|
28
|
-
//#endregion
|
|
29
|
-
export { TOC, TOCProps, TOCProvider, TOCProviderProps };
|
|
@@ -1,16 +0,0 @@
|
|
|
1
|
-
import { SidebarProviderProps as SidebarProviderProps$1, useSidebar as useSidebar$1 } from "../../../components/sidebar/base.js";
|
|
2
|
-
import { SidebarPageTreeComponents } from "../../../components/sidebar/page-tree.js";
|
|
3
|
-
import { ComponentProps, ReactNode } from "react";
|
|
4
|
-
//#region src/layouts/flux/slots/sidebar.d.ts
|
|
5
|
-
interface SidebarProps extends ComponentProps<'aside'> {
|
|
6
|
-
components?: Partial<SidebarPageTreeComponents>;
|
|
7
|
-
banner?: ReactNode;
|
|
8
|
-
footer?: ReactNode;
|
|
9
|
-
}
|
|
10
|
-
type SidebarProviderProps = SidebarProviderProps$1;
|
|
11
|
-
declare const useSidebar: typeof useSidebar$1;
|
|
12
|
-
declare function SidebarProvider(props: SidebarProviderProps): import("react").JSX.Element;
|
|
13
|
-
declare function Sidebar({ footer, banner, components, ...rest }: SidebarProps): import("react").JSX.Element;
|
|
14
|
-
declare function SidebarTrigger(props: ComponentProps<'button'>): import("react").JSX.Element;
|
|
15
|
-
//#endregion
|
|
16
|
-
export { Sidebar, SidebarProps, SidebarProvider, SidebarProviderProps, SidebarTrigger, useSidebar };
|
|
@@ -1,10 +0,0 @@
|
|
|
1
|
-
import { LayoutTab } from "../../shared/index.js";
|
|
2
|
-
import { ComponentProps, ReactNode } from "react";
|
|
3
|
-
//#region src/layouts/flux/slots/tab-dropdown.d.ts
|
|
4
|
-
interface TabDropdownProps extends ComponentProps<'button'> {
|
|
5
|
-
placeholder?: ReactNode;
|
|
6
|
-
tabs: LayoutTab[];
|
|
7
|
-
}
|
|
8
|
-
declare function TabDropdown({ tabs: allTabs, placeholder, className, ...props }: TabDropdownProps): import("react").JSX.Element | undefined;
|
|
9
|
-
//#endregion
|
|
10
|
-
export { TabDropdown, TabDropdownProps };
|
|
@@ -1,39 +0,0 @@
|
|
|
1
|
-
import { BaseSlots, BaseSlotsProps } from "../shared/client.js";
|
|
2
|
-
import { BaseLayoutProps, GetLayoutTabsOptions, LayoutTab, LinkItemType } from "../shared/index.js";
|
|
3
|
-
import { SidebarDrawerProps, SidebarProps, SidebarProviderProps, useSidebar } from "./slots/sidebar.js";
|
|
4
|
-
import { HeaderProps } from "./slots/header.js";
|
|
5
|
-
import { FC } from "react";
|
|
6
|
-
import * as PageTree from "@vx-oss/docs-core/page-tree";
|
|
7
|
-
//#region src/layouts/glass/index.d.ts
|
|
8
|
-
interface GlassSlots extends BaseSlots {
|
|
9
|
-
header: FC<HeaderProps>;
|
|
10
|
-
sidebar: {
|
|
11
|
-
main: FC<SidebarProps>;
|
|
12
|
-
provider: FC<SidebarProviderProps>;
|
|
13
|
-
use: typeof useSidebar;
|
|
14
|
-
drawer: FC<SidebarDrawerProps>;
|
|
15
|
-
};
|
|
16
|
-
}
|
|
17
|
-
interface GlassLayoutProps extends BaseLayoutProps {
|
|
18
|
-
tree: PageTree.Root;
|
|
19
|
-
tabs?: LayoutTab[] | GetLayoutTabsOptions | false;
|
|
20
|
-
aiChat?: {
|
|
21
|
-
open: boolean;
|
|
22
|
-
onOpenChange: (v: boolean) => void;
|
|
23
|
-
};
|
|
24
|
-
slots?: Partial<GlassSlots>;
|
|
25
|
-
sidebar?: Omit<SidebarProviderProps, 'children'>;
|
|
26
|
-
}
|
|
27
|
-
interface SlotsProps extends BaseSlotsProps<GlassLayoutProps> {
|
|
28
|
-
tabs: LayoutTab[];
|
|
29
|
-
aiChat?: GlassLayoutProps['aiChat'];
|
|
30
|
-
}
|
|
31
|
-
declare function useGlassLayout(): {
|
|
32
|
-
props: SlotsProps;
|
|
33
|
-
navItems: LinkItemType[];
|
|
34
|
-
menuItems: LinkItemType[];
|
|
35
|
-
slots: GlassSlots;
|
|
36
|
-
};
|
|
37
|
-
declare function GlassLayout(props: GlassLayoutProps): import("react").JSX.Element;
|
|
38
|
-
//#endregion
|
|
39
|
-
export { GlassLayout, GlassLayoutProps, GlassSlots, useGlassLayout };
|
|
@@ -1,54 +0,0 @@
|
|
|
1
|
-
import { cn } from "../../utils/cn.js";
|
|
2
|
-
import { useTabsGroups } from "../../contexts/tree.js";
|
|
3
|
-
import { Popover, PopoverContent, PopoverTrigger } from "../../components/ui/popover.js";
|
|
4
|
-
import { isLayoutTabActive } from "../shared/index.js";
|
|
5
|
-
import Link from "@vx-oss/docs-core/link";
|
|
6
|
-
import { usePathname } from "@vx-oss/docs-core/framework";
|
|
7
|
-
import { Fragment, jsx, jsxs } from "react/jsx-runtime";
|
|
8
|
-
import { ChevronsUpDown } from "lucide-react";
|
|
9
|
-
import { useState } from "react";
|
|
10
|
-
import { useTranslations } from "@fuma-translate/react";
|
|
11
|
-
//#region src/layouts/glass/layout-tabs.tsx
|
|
12
|
-
function LayoutTabsDropdown({ tabs: allTabs, className, size = "default", ...props }) {
|
|
13
|
-
const pathname = usePathname();
|
|
14
|
-
const t = useTranslations();
|
|
15
|
-
const tabs = useTabsGroups(allTabs).findLast((group) => typeof group.active?.root !== "string")?.options ?? [];
|
|
16
|
-
const selected = tabs.findLast((t) => isLayoutTabActive(t, pathname));
|
|
17
|
-
const [open, setOpen] = useState(false);
|
|
18
|
-
if (tabs.length === 0) return;
|
|
19
|
-
return /* @__PURE__ */ jsxs(Popover, {
|
|
20
|
-
open,
|
|
21
|
-
onOpenChange: setOpen,
|
|
22
|
-
children: [/* @__PURE__ */ jsxs(PopoverTrigger, {
|
|
23
|
-
className: cn("inline-flex items-center gap-2 text-sm font-medium rounded-full transition-colors hover:bg-fd-accent data-[state=open]:bg-fd-accent", size === "lg" && "text-[0.9375rem]", className),
|
|
24
|
-
...props,
|
|
25
|
-
children: [selected ? /* @__PURE__ */ jsxs(Fragment, { children: [selected.icon, /* @__PURE__ */ jsx("span", {
|
|
26
|
-
className: "truncate",
|
|
27
|
-
children: selected.title
|
|
28
|
-
})] }) : /* @__PURE__ */ jsx("span", {
|
|
29
|
-
className: "text-fd-muted-foreground truncate",
|
|
30
|
-
children: t("Layout Tab", { note: "layout tab trigger" })
|
|
31
|
-
}), /* @__PURE__ */ jsx(ChevronsUpDown, { className: cn("ms-auto shrink-0 text-fd-muted-foreground", size === "default" && "size-3.5!", size === "lg" && "size-4!") })]
|
|
32
|
-
}), /* @__PURE__ */ jsx(PopoverContent, {
|
|
33
|
-
className: "flex flex-col p-1 rounded-xl w-(--radix-popover-trigger-width)",
|
|
34
|
-
align: "start",
|
|
35
|
-
children: tabs.map((t, i) => {
|
|
36
|
-
if (t.unlisted && t !== selected) return;
|
|
37
|
-
return /* @__PURE__ */ jsxs(Link, {
|
|
38
|
-
href: t.url,
|
|
39
|
-
className: cn("text-sm px-2 py-1.5 rounded-lg", selected === t ? "bg-fd-primary/10 text-fd-primary" : "hover:bg-fd-accent hover:text-fd-accent-foreground"),
|
|
40
|
-
onClick: () => setOpen(false),
|
|
41
|
-
children: [/* @__PURE__ */ jsxs("div", {
|
|
42
|
-
className: "font-medium inline-flex items-center gap-2 [&_svg]:size-4",
|
|
43
|
-
children: [t.icon, t.title]
|
|
44
|
-
}), /* @__PURE__ */ jsx("p", {
|
|
45
|
-
className: cn("mt-1 text-xs text-fd-muted-foreground empty:hidden", selected === t && "text-fd-primary/80"),
|
|
46
|
-
children: t.description
|
|
47
|
-
})]
|
|
48
|
-
}, i);
|
|
49
|
-
})
|
|
50
|
-
})]
|
|
51
|
-
});
|
|
52
|
-
}
|
|
53
|
-
//#endregion
|
|
54
|
-
export { LayoutTabsDropdown };
|
|
@@ -1,31 +0,0 @@
|
|
|
1
|
-
import { MarkdownCopyButton, ViewOptionsPopover } from "../../shared/page-actions.js";
|
|
2
|
-
import { TOCProps } from "./slots/toc.js";
|
|
3
|
-
import { ComponentProps } from "react";
|
|
4
|
-
import { TOCItemType } from "@vx-oss/docs-core/toc";
|
|
5
|
-
//#region src/layouts/glass/page/index.d.ts
|
|
6
|
-
interface DocsPageProps extends ComponentProps<'article'> {
|
|
7
|
-
toc?: TOCItemType[];
|
|
8
|
-
/**
|
|
9
|
-
* Extend the page to fill all available space
|
|
10
|
-
*
|
|
11
|
-
* @defaultValue false
|
|
12
|
-
*/
|
|
13
|
-
full?: boolean | undefined;
|
|
14
|
-
tableOfContent?: TOCProps;
|
|
15
|
-
}
|
|
16
|
-
declare function useDocsPage(): {
|
|
17
|
-
full: boolean;
|
|
18
|
-
};
|
|
19
|
-
declare function DocsPage({ full, toc, tableOfContent, children }: DocsPageProps): import("react").JSX.Element;
|
|
20
|
-
declare function EditOnGitHub(props: ComponentProps<'a'>): import("react").JSX.Element;
|
|
21
|
-
/**
|
|
22
|
-
* Add typography styles
|
|
23
|
-
*/
|
|
24
|
-
declare function DocsBody({ children, className, ...props }: ComponentProps<'div'>): import("react").JSX.Element;
|
|
25
|
-
declare function DocsDescription({ children, className, ...props }: ComponentProps<'p'>): import("react").JSX.Element | null;
|
|
26
|
-
declare function DocsTitle({ children, className, ...props }: ComponentProps<'h1'>): import("react").JSX.Element;
|
|
27
|
-
declare function PageLastUpdate({ date: value, ...props }: Omit<ComponentProps<'p'>, 'children'> & {
|
|
28
|
-
date: Date;
|
|
29
|
-
}): import("react").JSX.Element;
|
|
30
|
-
//#endregion
|
|
31
|
-
export { DocsBody, DocsDescription, DocsPage, DocsPageProps, DocsTitle, EditOnGitHub, MarkdownCopyButton, PageLastUpdate, ViewOptionsPopover, useDocsPage };
|
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
import { ComponentProps } from "react";
|
|
2
|
-
import { BreadcrumbOptions } from "@vx-oss/docs-core/breadcrumb";
|
|
3
|
-
//#region src/layouts/glass/page/slots/breadcrumb.d.ts
|
|
4
|
-
type BreadcrumbProps = BreadcrumbOptions & ComponentProps<'div'>;
|
|
5
|
-
declare function Breadcrumb({ includeRoot, includeSeparator, includePage, ...props }: BreadcrumbProps): import("react").JSX.Element | null;
|
|
6
|
-
//#endregion
|
|
7
|
-
export { Breadcrumb, BreadcrumbProps };
|
|
@@ -1,16 +0,0 @@
|
|
|
1
|
-
import { ComponentProps } from "react";
|
|
2
|
-
import * as PageTree from "@vx-oss/docs-core/page-tree";
|
|
3
|
-
//#region src/layouts/glass/page/slots/footer.d.ts
|
|
4
|
-
type Item = Pick<PageTree.Item, 'name' | 'description' | 'url'>;
|
|
5
|
-
interface FooterProps extends ComponentProps<'div'> {
|
|
6
|
-
/**
|
|
7
|
-
* Items including information for the next and previous page
|
|
8
|
-
*/
|
|
9
|
-
items?: {
|
|
10
|
-
previous?: Item;
|
|
11
|
-
next?: Item;
|
|
12
|
-
};
|
|
13
|
-
}
|
|
14
|
-
declare function Footer({ items, children, className, ...props }: FooterProps): import("react").JSX.Element;
|
|
15
|
-
//#endregion
|
|
16
|
-
export { Footer, FooterProps };
|
|
@@ -1,19 +0,0 @@
|
|
|
1
|
-
import { TOCProviderProps as TOCProviderProps$1 } from "../../../../components/toc/index.js";
|
|
2
|
-
import { ComponentProps, ReactNode } from "react";
|
|
3
|
-
//#region src/layouts/glass/page/slots/toc.d.ts
|
|
4
|
-
type TOCProviderProps = TOCProviderProps$1;
|
|
5
|
-
declare function TOCProvider(props: TOCProviderProps): import("react").JSX.Element;
|
|
6
|
-
interface TOCProps {
|
|
7
|
-
container?: ComponentProps<'div'>;
|
|
8
|
-
/**
|
|
9
|
-
* Custom content in TOC container, before the main TOC
|
|
10
|
-
*/
|
|
11
|
-
header?: ReactNode;
|
|
12
|
-
/**
|
|
13
|
-
* Custom content in TOC container, after the main TOC
|
|
14
|
-
*/
|
|
15
|
-
footer?: ReactNode;
|
|
16
|
-
}
|
|
17
|
-
declare function TOC({ container, header, footer }: TOCProps): import("react").JSX.Element | undefined;
|
|
18
|
-
//#endregion
|
|
19
|
-
export { TOC, TOCProps, TOCProvider, TOCProviderProps };
|
|
@@ -1,6 +0,0 @@
|
|
|
1
|
-
import { ComponentProps } from "react";
|
|
2
|
-
//#region src/layouts/glass/slots/header.d.ts
|
|
3
|
-
type HeaderProps = ComponentProps<'div'>;
|
|
4
|
-
declare function Header({ className, ...props }: HeaderProps): import("react").JSX.Element;
|
|
5
|
-
//#endregion
|
|
6
|
-
export { Header, HeaderProps };
|
|
@@ -1,21 +0,0 @@
|
|
|
1
|
-
import { ComponentProps, ReactNode } from "react";
|
|
2
|
-
//#region src/layouts/glass/slots/sidebar.d.ts
|
|
3
|
-
interface SidebarProviderProps {
|
|
4
|
-
/** @default true */
|
|
5
|
-
collapsible?: boolean;
|
|
6
|
-
children: ReactNode;
|
|
7
|
-
}
|
|
8
|
-
declare function SidebarProvider({ children, collapsible }: SidebarProviderProps): import("react").JSX.Element;
|
|
9
|
-
declare function useSidebar(): {
|
|
10
|
-
collapsible: boolean;
|
|
11
|
-
collapsed: boolean;
|
|
12
|
-
setCollapsed: import("react").Dispatch<import("react").SetStateAction<boolean>>;
|
|
13
|
-
};
|
|
14
|
-
interface SidebarDrawerProps {
|
|
15
|
-
contentProps?: ComponentProps<'div'>;
|
|
16
|
-
}
|
|
17
|
-
declare function SidebarDrawer({ contentProps }: SidebarDrawerProps): import("react").JSX.Element;
|
|
18
|
-
type SidebarProps = ComponentProps<'aside'>;
|
|
19
|
-
declare function Sidebar({ className, children, ...props }: SidebarProps): import("react").JSX.Element;
|
|
20
|
-
//#endregion
|
|
21
|
-
export { Sidebar, SidebarDrawer, SidebarDrawerProps, SidebarProps, SidebarProvider, SidebarProviderProps, useSidebar };
|
|
@@ -1,27 +0,0 @@
|
|
|
1
|
-
import { BaseSlots, BaseSlotsProps } from "../shared/client.js";
|
|
2
|
-
import { BaseLayoutProps, LinkItemType, NavOptions } from "../shared/index.js";
|
|
3
|
-
import { ComponentProps, FC } from "react";
|
|
4
|
-
//#region src/layouts/home/index.d.ts
|
|
5
|
-
interface HomeLayoutProps extends BaseLayoutProps, ComponentProps<'main'> {
|
|
6
|
-
nav?: Nav;
|
|
7
|
-
slots?: Partial<HomeSlots>;
|
|
8
|
-
}
|
|
9
|
-
interface Nav extends NavOptions {
|
|
10
|
-
/**
|
|
11
|
-
* Open mobile menu when hovering the trigger
|
|
12
|
-
*/
|
|
13
|
-
enableHoverToOpen?: boolean;
|
|
14
|
-
}
|
|
15
|
-
interface HomeSlots extends BaseSlots {
|
|
16
|
-
header: FC<ComponentProps<'header'>>;
|
|
17
|
-
container: FC<ComponentProps<'main'>>;
|
|
18
|
-
}
|
|
19
|
-
declare function useHomeLayout(): {
|
|
20
|
-
props: BaseSlotsProps<HomeLayoutProps>;
|
|
21
|
-
navItems: LinkItemType[];
|
|
22
|
-
menuItems: LinkItemType[];
|
|
23
|
-
slots: HomeSlots;
|
|
24
|
-
};
|
|
25
|
-
declare function HomeLayout(props: HomeLayoutProps): import("react").JSX.Element;
|
|
26
|
-
//#endregion
|
|
27
|
-
export { HomeLayout, HomeLayoutProps, HomeSlots, useHomeLayout };
|
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
import { NavigationMenuContentProps, NavigationMenuItem, NavigationMenuTriggerProps } from "../../components/ui/navigation-menu.js";
|
|
2
|
-
import { LinkProps } from "@vx-oss/docs-core/link";
|
|
3
|
-
//#region src/layouts/home/navbar.d.ts
|
|
4
|
-
declare const NavbarMenu: typeof NavigationMenuItem;
|
|
5
|
-
declare function NavbarMenuContent(props: NavigationMenuContentProps): import("react").JSX.Element;
|
|
6
|
-
declare function NavbarMenuTrigger(props: NavigationMenuTriggerProps): import("react").JSX.Element;
|
|
7
|
-
declare function NavbarMenuLink(props: LinkProps): import("react").JSX.Element;
|
|
8
|
-
//#endregion
|
|
9
|
-
export { NavbarMenu, NavbarMenuContent, NavbarMenuLink, NavbarMenuTrigger };
|
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
import { ComponentProps } from "react";
|
|
2
|
-
//#region src/layouts/home/slots/header.d.ts
|
|
3
|
-
declare const navItemVariants: (props?: ({
|
|
4
|
-
variant?: "main" | "icon" | "button" | null | undefined;
|
|
5
|
-
} & import("class-variance-authority/types").ClassProp) | undefined) => string;
|
|
6
|
-
declare function Header(props: ComponentProps<'header'>): string | number | bigint | true | import("react").JSX.Element | Iterable<import("react").ReactNode> | Promise<string | number | bigint | boolean | import("react").ReactPortal | import("react").ReactElement<unknown, string | import("react").JSXElementConstructor<any>> | Iterable<import("react").ReactNode> | null | undefined>;
|
|
7
|
-
//#endregion
|
|
8
|
-
export { Header, navItemVariants };
|
|
@@ -1,35 +0,0 @@
|
|
|
1
|
-
import { BaseSlots, BaseSlotsProps } from "../shared/client.js";
|
|
2
|
-
import { LayoutTab, LinkItemType } from "../shared/index.js";
|
|
3
|
-
import { SidebarProps, SidebarProviderProps } from "./slots/sidebar.js";
|
|
4
|
-
import { DocsLayoutProps } from "./index.js";
|
|
5
|
-
import { ComponentProps, FC } from "react";
|
|
6
|
-
//#region src/layouts/notebook/client.d.ts
|
|
7
|
-
interface DocsSlots extends BaseSlots {
|
|
8
|
-
container: FC<ComponentProps<'div'>>;
|
|
9
|
-
header: FC<ComponentProps<'header'>>;
|
|
10
|
-
sidebar: {
|
|
11
|
-
provider: FC<SidebarProviderProps>;
|
|
12
|
-
root: FC<SidebarProps>;
|
|
13
|
-
trigger: FC<ComponentProps<'button'>>;
|
|
14
|
-
collapseTrigger: FC<ComponentProps<'button'>>;
|
|
15
|
-
useSidebar: () => {
|
|
16
|
-
collapsed: boolean;
|
|
17
|
-
open: boolean;
|
|
18
|
-
setOpen: (V: boolean) => void;
|
|
19
|
-
};
|
|
20
|
-
};
|
|
21
|
-
}
|
|
22
|
-
interface SlotsProps extends BaseSlotsProps<DocsLayoutProps> {
|
|
23
|
-
sidebar: SidebarProps;
|
|
24
|
-
tabMode: NonNullable<DocsLayoutProps['tabMode']>;
|
|
25
|
-
tabs: LayoutTab[];
|
|
26
|
-
}
|
|
27
|
-
declare function useNotebookLayout(): {
|
|
28
|
-
props: SlotsProps;
|
|
29
|
-
isNavTransparent: boolean;
|
|
30
|
-
navItems: LinkItemType[];
|
|
31
|
-
menuItems: LinkItemType[];
|
|
32
|
-
slots: DocsSlots;
|
|
33
|
-
};
|
|
34
|
-
//#endregion
|
|
35
|
-
export { DocsSlots, useNotebookLayout };
|
|
@@ -1,69 +0,0 @@
|
|
|
1
|
-
"use client";
|
|
2
|
-
import { TreeContextProvider } from "../../contexts/tree.js";
|
|
3
|
-
import { baseSlots } from "../shared/client.js";
|
|
4
|
-
import { useLinkItems } from "../shared/index.js";
|
|
5
|
-
import { useIsScrollTop } from "../../utils/use-is-scroll-top.js";
|
|
6
|
-
import { Container } from "./slots/container.js";
|
|
7
|
-
import { Sidebar, SidebarCollapseTrigger, SidebarProvider, SidebarTrigger, useSidebar } from "./slots/sidebar.js";
|
|
8
|
-
import { Header } from "./slots/header.js";
|
|
9
|
-
import { jsx, jsxs } from "react/jsx-runtime";
|
|
10
|
-
import { createContext, use } from "react";
|
|
11
|
-
//#region src/layouts/notebook/client.tsx
|
|
12
|
-
const { useBaseSlots } = baseSlots({ useProps() {
|
|
13
|
-
return useNotebookLayout().props;
|
|
14
|
-
} });
|
|
15
|
-
const LayoutContext = createContext(null);
|
|
16
|
-
function useNotebookLayout() {
|
|
17
|
-
const context = use(LayoutContext);
|
|
18
|
-
if (!context) throw new Error("Please use <DocsPage /> (`@vx-oss/docs-react/layouts/notebook/page`) under <DocsLayout /> (`@vx-oss/docs-react/layouts/notebook`).");
|
|
19
|
-
return context;
|
|
20
|
-
}
|
|
21
|
-
function LayoutBody(props) {
|
|
22
|
-
const { nav: { enabled: navEnabled = true, transparentMode: navTransparentMode = "none" } = {}, sidebar: { defaultOpenLevel, prefetch, ...sidebarProps } = {}, slots: defaultSlots, tabMode = "sidebar", tabs, tree, containerProps, children } = props;
|
|
23
|
-
const isTop = useIsScrollTop({ enabled: navTransparentMode === "top" }) ?? true;
|
|
24
|
-
const isNavTransparent = navTransparentMode === "top" ? isTop : navTransparentMode === "always";
|
|
25
|
-
const { baseSlots, baseProps } = useBaseSlots(props);
|
|
26
|
-
const linkItems = useLinkItems(props);
|
|
27
|
-
const slots = {
|
|
28
|
-
...baseSlots,
|
|
29
|
-
header: defaultSlots?.header ?? Header,
|
|
30
|
-
container: defaultSlots?.container ?? Container,
|
|
31
|
-
sidebar: defaultSlots?.sidebar ?? {
|
|
32
|
-
provider: SidebarProvider,
|
|
33
|
-
root: Sidebar,
|
|
34
|
-
trigger: SidebarTrigger,
|
|
35
|
-
collapseTrigger: SidebarCollapseTrigger,
|
|
36
|
-
useSidebar
|
|
37
|
-
}
|
|
38
|
-
};
|
|
39
|
-
return /* @__PURE__ */ jsx(TreeContextProvider, {
|
|
40
|
-
tree,
|
|
41
|
-
children: /* @__PURE__ */ jsx(LayoutContext, {
|
|
42
|
-
value: {
|
|
43
|
-
props: {
|
|
44
|
-
tabs,
|
|
45
|
-
tabMode,
|
|
46
|
-
sidebar: sidebarProps,
|
|
47
|
-
...baseProps
|
|
48
|
-
},
|
|
49
|
-
isNavTransparent,
|
|
50
|
-
slots,
|
|
51
|
-
...linkItems
|
|
52
|
-
},
|
|
53
|
-
children: /* @__PURE__ */ jsx(slots.sidebar.provider, {
|
|
54
|
-
defaultOpenLevel,
|
|
55
|
-
prefetch,
|
|
56
|
-
children: /* @__PURE__ */ jsxs(slots.container, {
|
|
57
|
-
...containerProps,
|
|
58
|
-
children: [
|
|
59
|
-
navEnabled && /* @__PURE__ */ jsx(slots.header, {}),
|
|
60
|
-
/* @__PURE__ */ jsx(slots.sidebar.root, { ...sidebarProps }),
|
|
61
|
-
children
|
|
62
|
-
]
|
|
63
|
-
})
|
|
64
|
-
})
|
|
65
|
-
})
|
|
66
|
-
});
|
|
67
|
-
}
|
|
68
|
-
//#endregion
|
|
69
|
-
export { LayoutBody, useNotebookLayout };
|
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
import { BaseLayoutProps, GetLayoutTabsOptions, LayoutTab, NavOptions } from "../shared/index.js";
|
|
2
|
-
import { SidebarProps, SidebarProviderProps } from "./slots/sidebar.js";
|
|
3
|
-
import { DocsSlots, useNotebookLayout } from "./client.js";
|
|
4
|
-
import { HTMLAttributes } from "react";
|
|
5
|
-
import * as PageTree from "@vx-oss/docs-core/page-tree";
|
|
6
|
-
//#region src/layouts/notebook/index.d.ts
|
|
7
|
-
interface DocsLayoutProps extends Omit<BaseLayoutProps, 'nav'> {
|
|
8
|
-
tree: PageTree.Root;
|
|
9
|
-
tabs?: LayoutTab[] | GetLayoutTabsOptions | false;
|
|
10
|
-
tabMode?: 'sidebar' | 'navbar';
|
|
11
|
-
sidebar?: SidebarOptions;
|
|
12
|
-
nav?: NavOptions & {
|
|
13
|
-
mode?: 'top' | 'auto';
|
|
14
|
-
};
|
|
15
|
-
containerProps?: HTMLAttributes<HTMLDivElement>;
|
|
16
|
-
slots?: Partial<DocsSlots>;
|
|
17
|
-
}
|
|
18
|
-
interface SidebarOptions extends SidebarProps, SidebarProviderProps {
|
|
19
|
-
/**
|
|
20
|
-
* @deprecated use layout-level `tabs` option instead.
|
|
21
|
-
*/
|
|
22
|
-
tabs?: LayoutTab[] | GetLayoutTabsOptions | false;
|
|
23
|
-
}
|
|
24
|
-
declare function DocsLayout({ tree, tabMode, sidebar: { tabs: defaultTabs, ...sidebarProps }, children, tabs, ...props }: DocsLayoutProps): import("react").JSX.Element;
|
|
25
|
-
//#endregion
|
|
26
|
-
export { DocsLayout, DocsLayoutProps, type DocsSlots, SidebarOptions, useNotebookLayout };
|
|
@@ -1,76 +0,0 @@
|
|
|
1
|
-
import { MarkdownCopyButton, ViewOptionsPopover } from "../../shared/page-actions.js";
|
|
2
|
-
import { TOCPopoverProps, TOCProps, TOCProviderProps } from "./slots/toc.js";
|
|
3
|
-
import { Footer, FooterProps } from "./slots/footer.js";
|
|
4
|
-
import { Breadcrumb, BreadcrumbProps } from "./slots/breadcrumb.js";
|
|
5
|
-
import { ComponentProps, FC, ReactNode } from "react";
|
|
6
|
-
import { TOCItemType } from "@vx-oss/docs-core/toc";
|
|
7
|
-
//#region src/layouts/notebook/page/index.d.ts
|
|
8
|
-
interface DocsPageProps extends ComponentProps<'article'> {
|
|
9
|
-
toc?: TOCItemType[];
|
|
10
|
-
/**
|
|
11
|
-
* Extend the page to fill all available space
|
|
12
|
-
*
|
|
13
|
-
* @defaultValue false
|
|
14
|
-
*/
|
|
15
|
-
full?: boolean | undefined;
|
|
16
|
-
slots?: Partial<DocsPageSlots>;
|
|
17
|
-
footer?: FooterOptions;
|
|
18
|
-
breadcrumb?: BreadcrumbOptions;
|
|
19
|
-
tableOfContent?: TableOfContentOptions;
|
|
20
|
-
tableOfContentPopover?: TableOfContentPopoverOptions;
|
|
21
|
-
}
|
|
22
|
-
interface BreadcrumbOptions extends BreadcrumbProps {
|
|
23
|
-
enabled?: boolean;
|
|
24
|
-
/**
|
|
25
|
-
* @deprecated use `slots.breadcrumb` instead.
|
|
26
|
-
*/
|
|
27
|
-
component?: ReactNode;
|
|
28
|
-
}
|
|
29
|
-
interface FooterOptions extends FooterProps {
|
|
30
|
-
enabled?: boolean;
|
|
31
|
-
/**
|
|
32
|
-
* @deprecated use `slots.footer` instead.
|
|
33
|
-
*/
|
|
34
|
-
component?: ReactNode;
|
|
35
|
-
}
|
|
36
|
-
type TableOfContentOptions = Pick<TOCProviderProps, 'single'> & TOCProps & {
|
|
37
|
-
enabled?: boolean;
|
|
38
|
-
/**
|
|
39
|
-
* @deprecated use `slots.toc` instead.
|
|
40
|
-
*/
|
|
41
|
-
component?: ReactNode;
|
|
42
|
-
};
|
|
43
|
-
type TableOfContentPopoverOptions = TOCPopoverProps & {
|
|
44
|
-
enabled?: boolean;
|
|
45
|
-
/**
|
|
46
|
-
* @deprecated use `slots.tocPopover` instead.
|
|
47
|
-
*/
|
|
48
|
-
component?: ReactNode;
|
|
49
|
-
};
|
|
50
|
-
interface DocsPageSlots {
|
|
51
|
-
toc: {
|
|
52
|
-
provider: FC<TOCProviderProps>;
|
|
53
|
-
main: FC<TOCProps>;
|
|
54
|
-
popover: FC<TOCPopoverProps>;
|
|
55
|
-
};
|
|
56
|
-
container: FC<ComponentProps<'article'>>;
|
|
57
|
-
footer: FC<FooterProps>;
|
|
58
|
-
breadcrumb: FC<BreadcrumbProps>;
|
|
59
|
-
}
|
|
60
|
-
declare function useDocsPage(): {
|
|
61
|
-
full: NonNullable<DocsPageProps["full"]>;
|
|
62
|
-
slots: DocsPageSlots;
|
|
63
|
-
};
|
|
64
|
-
declare function DocsPage({ full, tableOfContent: { enabled: tocEnabled, single, ...tocProps }, tableOfContentPopover: { enabled: tocPopoverEnabled, ...tocPopoverProps }, breadcrumb: { enabled: breadcrumbEnabled, ...breadcrumb }, footer: { enabled: footerEnabled, ...footer }, toc, slots: defaultSlots, children, ...containerProps }: DocsPageProps): import("react").JSX.Element;
|
|
65
|
-
declare function EditOnGitHub(props: ComponentProps<'a'>): import("react").JSX.Element;
|
|
66
|
-
/**
|
|
67
|
-
* Add typography styles
|
|
68
|
-
*/
|
|
69
|
-
declare function DocsBody({ children, className, ...props }: ComponentProps<'div'>): import("react").JSX.Element;
|
|
70
|
-
declare function DocsDescription({ children, className, ...props }: ComponentProps<'p'>): import("react").JSX.Element | null;
|
|
71
|
-
declare function DocsTitle({ children, className, ...props }: ComponentProps<'h1'>): import("react").JSX.Element;
|
|
72
|
-
declare function PageLastUpdate({ date: value, ...props }: Omit<ComponentProps<'p'>, 'children'> & {
|
|
73
|
-
date: Date;
|
|
74
|
-
}): import("react").JSX.Element;
|
|
75
|
-
//#endregion
|
|
76
|
-
export { type BreadcrumbProps, DocsBody, DocsDescription, DocsPage, DocsPageProps, DocsTitle, EditOnGitHub, type FooterProps, MarkdownCopyButton, Breadcrumb as PageBreadcrumb, Footer as PageFooter, PageLastUpdate, ViewOptionsPopover, useDocsPage };
|
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
import { ComponentProps } from "react";
|
|
2
|
-
import { BreadcrumbOptions } from "@vx-oss/docs-core/breadcrumb";
|
|
3
|
-
//#region src/layouts/notebook/page/slots/breadcrumb.d.ts
|
|
4
|
-
type BreadcrumbProps = BreadcrumbOptions & ComponentProps<'div'>;
|
|
5
|
-
declare function Breadcrumb({ includeRoot, includeSeparator, includePage, ...props }: BreadcrumbProps): import("react").JSX.Element | null;
|
|
6
|
-
//#endregion
|
|
7
|
-
export { Breadcrumb, BreadcrumbProps };
|
|
@@ -1,16 +0,0 @@
|
|
|
1
|
-
import { ComponentProps } from "react";
|
|
2
|
-
import * as PageTree from "@vx-oss/docs-core/page-tree";
|
|
3
|
-
//#region src/layouts/notebook/page/slots/footer.d.ts
|
|
4
|
-
type Item = Pick<PageTree.Item, 'name' | 'description' | 'url'>;
|
|
5
|
-
interface FooterProps extends ComponentProps<'div'> {
|
|
6
|
-
/**
|
|
7
|
-
* Items including information for the next and previous page
|
|
8
|
-
*/
|
|
9
|
-
items?: {
|
|
10
|
-
previous?: Item;
|
|
11
|
-
next?: Item;
|
|
12
|
-
};
|
|
13
|
-
}
|
|
14
|
-
declare function Footer({ items, children, className, ...props }: FooterProps): import("react").JSX.Element;
|
|
15
|
-
//#endregion
|
|
16
|
-
export { Footer, FooterProps };
|
|
@@ -1,47 +0,0 @@
|
|
|
1
|
-
import { TOCItemsProps } from "../../../../components/toc/clerk.js";
|
|
2
|
-
import { TOCItemsProps as TOCItemsProps$1 } from "../../../../components/toc/default.js";
|
|
3
|
-
import { TOCProviderProps as TOCProviderProps$1 } from "../../../../components/toc/index.js";
|
|
4
|
-
import { ComponentProps, ReactNode } from "react";
|
|
5
|
-
//#region src/layouts/notebook/page/slots/toc.d.ts
|
|
6
|
-
type TOCProviderProps = TOCProviderProps$1;
|
|
7
|
-
declare function TOCProvider(props: TOCProviderProps): import("react").JSX.Element;
|
|
8
|
-
type TOCProps = {
|
|
9
|
-
container?: ComponentProps<'div'>;
|
|
10
|
-
/**
|
|
11
|
-
* Custom content in TOC container, before the main TOC
|
|
12
|
-
*/
|
|
13
|
-
header?: ReactNode;
|
|
14
|
-
/**
|
|
15
|
-
* Custom content in TOC container, after the main TOC
|
|
16
|
-
*/
|
|
17
|
-
footer?: ReactNode;
|
|
18
|
-
} & ({
|
|
19
|
-
style?: 'normal';
|
|
20
|
-
list?: TOCItemsProps$1;
|
|
21
|
-
} | {
|
|
22
|
-
style: 'clerk';
|
|
23
|
-
list?: TOCItemsProps;
|
|
24
|
-
});
|
|
25
|
-
declare function TOC({ container, header, footer, style, list }: TOCProps): import("react").JSX.Element;
|
|
26
|
-
type TOCPopoverProps = {
|
|
27
|
-
container?: ComponentProps<'div'>;
|
|
28
|
-
trigger?: ComponentProps<'button'>;
|
|
29
|
-
content?: ComponentProps<'div'>;
|
|
30
|
-
/**
|
|
31
|
-
* Custom content in TOC container, before the main TOC
|
|
32
|
-
*/
|
|
33
|
-
header?: ReactNode;
|
|
34
|
-
/**
|
|
35
|
-
* Custom content in TOC container, after the main TOC
|
|
36
|
-
*/
|
|
37
|
-
footer?: ReactNode;
|
|
38
|
-
} & ({
|
|
39
|
-
style?: 'normal';
|
|
40
|
-
list?: TOCItemsProps$1;
|
|
41
|
-
} | {
|
|
42
|
-
style: 'clerk';
|
|
43
|
-
list?: TOCItemsProps;
|
|
44
|
-
});
|
|
45
|
-
declare function TOCPopover({ container, trigger, content, header, footer, style, list }: TOCPopoverProps): import("react").JSX.Element;
|
|
46
|
-
//#endregion
|
|
47
|
-
export { TOC, TOCPopover, TOCPopoverProps, TOCProps, TOCProvider, TOCProviderProps };
|
|
@@ -1,5 +0,0 @@
|
|
|
1
|
-
import { ComponentProps } from "react";
|
|
2
|
-
//#region src/layouts/notebook/slots/header.d.ts
|
|
3
|
-
declare function Header(props: ComponentProps<'header'>): string | number | bigint | true | import("react").JSX.Element | Iterable<import("react").ReactNode> | Promise<string | number | bigint | boolean | import("react").ReactPortal | import("react").ReactElement<unknown, string | import("react").JSXElementConstructor<any>> | Iterable<import("react").ReactNode> | null | undefined>;
|
|
4
|
-
//#endregion
|
|
5
|
-
export { Header };
|