import { ChildrenLike, VirtualDOM, AttributeLike, CSSAttribute, AnyVirtualDOM } from '@youwol/rx-vdom'; import { Router, Navigation } from '..'; import { Subject } from 'rxjs'; import { DisplayMode, LayoutOptions } from './default-layout.view'; /** * Parameters for {@link TopBannerClassicView}. */ export type TopBannerClassicParams = { /** * Router, forwared when used within {@link DefaultLayoutView}. */ router: Router; /** * Emit the current display mode regarding navigation, forwared when used within {@link DefaultLayoutView}. */ displayModeNav$: Subject; /** * Emit the current display mode regarding TOC, forwared when used within {@link DefaultLayoutView}. */ displayModeToc$: Subject; /** * Layout sizing options, forwarded when used within {@link DefaultLayoutView}. */ layoutOptions: LayoutOptions; /** * The title, forwarded when used within {@link DefaultLayoutView}. */ title: AnyVirtualDOM | string; /** * The logo. */ logo: AnyVirtualDOM; /** * The badge. */ badge: AnyVirtualDOM; }; /** * This tob banner includes a logo, a badge (displayed above the TOC view), and navigation short-cuts. * * It is usually used as `topBanner` parameters of {@link DefaultLayoutView}'s constructor. */ export declare class TopBannerClassicView implements VirtualDOM<'div'> { readonly tag = "div"; readonly class = "mkdocs-TopBannerClassicView w-100 mkdocs-bg-5 mkdocs-text-5 py-2 d-flex justify-content-center"; readonly children: ChildrenLike; /** * Initializes a new instance. * * @param params Most of them are forwarded from {@link DefaultLayoutView}. */ constructor(params: TopBannerClassicParams); } export declare class NavItemsView implements VirtualDOM<'div'> { readonly tag = "div"; readonly class = "mt-2 mb-1 d-flex align-items-center justify-content-left"; readonly children: ChildrenLike; constructor({ router }: { router: Router; }); } export declare class NavItem implements VirtualDOM<'div'> { readonly tag = "div"; readonly class = "mkdocs-NavItem me-5"; readonly children: ChildrenLike; constructor({ node, href, router, }: { node: Navigation; href: string; router: Router; }); } export declare class MainColumn implements VirtualDOM<'div'> { readonly tag = "div"; readonly id = "LeftColumn"; readonly class = "d-flex flex-column"; readonly children: ChildrenLike; readonly style: AttributeLike; readonly connectedCallback: any; constructor({ displayModeNav$, displayModeToc$, layoutOptions, router, logo, title, badge, }: TopBannerClassicParams); } export declare class RightColumn implements VirtualDOM<'div'> { readonly tag = "div"; readonly children: ChildrenLike; readonly style: AttributeLike; constructor(params: TopBannerClassicParams); } /** * A badge to encapsulate a link on an online repository of source code. */ export declare class SourcesLink implements VirtualDOM<'a'> { readonly tag = "a"; readonly href: string; readonly target = "_blank"; readonly class = "d-flex align-items-center mkdocs-text-4 mkdocs-hover-text-5 fv-pointer"; readonly children: ChildrenLike; /** * Initializes a new instance. * * @param _p * @param _p.href URL to the repo. * @param _p.name Displayed name. * @param _p.version Displayed version. */ constructor({ href, name, version, }: { href: string; name: string; version: string; }); }