@xyd-js/framework 0.1.0-build.189

package/dist/react.d.ts

@@ -0,0 +1,100 @@
+import React from 'react';
+import * as _xyd_js_core from '@xyd-js/core';
+import { ComponentLike, Settings, Metadata, SidebarRoute, Segment } from '@xyd-js/core';
+import { F as FwSidebarItemProps } from './FwSidebarItem-CFgVFKj-.js';
+import { a as SurfaceTargetType, R as ROSurface, c as Surfaces } from './surfaces-BCt6G97W.js';
+import { IBreadcrumb, ITOC, INavLinks } from '@xyd-js/ui';
+
+declare function FwBanner(): React.JSX.Element | null;
+
+declare function FwBreadcrumbs(): React.JSX.Element;
+
+declare function FwCopyPage(): React.JSX.Element;
+
+declare function FwJsonComponent(args: ComponentLike): string | React.JSX.Element | null;
+
+declare function FwLink({ children, ...rest }: {
+    [x: string]: any;
+    children: any;
+}): React.JSX.Element;
+
+declare function FwLogo(): React.JSX.Element | null;
+
+declare function FwNav(): React.JSX.Element;
+declare namespace FwNav {
+    var DefaultItems: () => React.JSX.Element;
+}
+
+declare function FwNavLinks(): React.JSX.Element | null;
+
+interface FwSidebarProps {
+}
+declare function FwSidebar(props: FwSidebarProps): React.JSX.Element;
+
+declare function FwSubNav(): React.JSX.Element | null;
+
+declare function FwToc(): React.JSX.Element | null;
+
+interface SurfaceContext {
+    surfaces?: ROSurface;
+}
+declare const SurfaceContext: React.Context<SurfaceContext>;
+interface SurfaceProps {
+    target: SurfaceTargetType;
+    props?: any;
+}
+declare function Surface(props: SurfaceProps): React.JSX.Element | null;
+
+interface FrameworkProps {
+    children: React.ReactNode;
+    settings: Settings;
+    metadata: Metadata;
+    sidebarGroups: FwSidebarItemProps[];
+    surfaces: Surfaces;
+    components?: {
+        [componentName: string]: React.ComponentType<any>;
+    };
+    BannerContent: React.ComponentType<any>;
+}
+declare function Framework(props: FrameworkProps): React.JSX.Element;
+interface FrameworkPageProps {
+    children: React.ReactNode;
+    ContentComponent?: (props: {
+        components: any;
+        children: React.ReactNode;
+    }) => React.JSX.Element;
+    ContentOriginal?: (props: {
+        components: any;
+        children: React.ReactNode;
+    }) => React.JSX.Element;
+    metadata: Metadata;
+    breadcrumbs?: IBreadcrumb[];
+    rawPage?: string;
+    toc?: ITOC[];
+    navlinks?: INavLinks;
+}
+declare function FrameworkPage(props: FrameworkPageProps): React.JSX.Element;
+declare function useSettings(): Readonly<Settings>;
+declare function useMetadata(): Readonly<Metadata<void>>;
+declare function useComponents(): Readonly<{
+    [componentName: string]: React.ComponentType<any>;
+}> | undefined;
+declare function useContentComponent(): (props: {
+    components: any;
+    children?: React.ReactNode;
+}) => React.JSX.Element;
+declare function useContentOriginal(): (props: {
+    components: any;
+    children?: React.ReactNode;
+}) => React.JSX.Element;
+declare function useAppearance(): _xyd_js_core.Appearance | undefined;
+
+declare function useActivePage(match?: boolean): string;
+
+declare function useActivePageRoute(match?: boolean): SidebarRoute | null;
+
+declare function useActiveRoute(): _xyd_js_core.SidebarRoute | null;
+
+declare function useMatchedSubNav(): Segment | null;
+
+export { Framework, FrameworkPage, type FrameworkProps, FwBanner, FwBreadcrumbs, FwCopyPage, FwJsonComponent, FwLink, FwLogo, FwNav, FwNavLinks, FwSidebar, FwSidebarItemProps, FwSubNav, FwToc, Surface, SurfaceContext, useActivePage, useActivePageRoute, useActiveRoute, useAppearance, useComponents, useContentComponent, useContentOriginal, useMatchedSubNav, useMetadata, useSettings };