@orderly.network/ui-scaffold 2.8.1 → 2.8.2

package/dist/index.d.mts

@@ -2,10 +2,11 @@ import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as react from 'react';
 import react__default, { ReactNode, HTMLAttributeAnchorTarget, FC, PropsWithChildren } from 'react';
 import * as _orderly_network_types from '@orderly.network/types';
-import { NetworkId, API } from '@orderly.network/types';
+import { RouterAdapter, NetworkId, API } from '@orderly.network/types';
 import { WsNetworkStatus } from '@orderly.network/hooks';
 import * as _orderly_network_i18n from '@orderly.network/i18n';
 import { LocaleContextState } from '@orderly.network/i18n';
+import { useAnnouncement } from '@orderly.network/ui-notification';
 
 declare const AccountMenuWidget: () => react_jsx_runtime.JSX.Element;
 
@@ -36,6 +37,11 @@ type LeftNavItem = {
      * @default false
      **/
     onlyInMainAccount?: boolean;
+    /**
+     * Optional secondary style; secondary items render smaller and gray.
+     * Secondary items are grouped below primary items with a divider in between.
+     */
+    isSecondary?: boolean;
 };
 
 type MainNavItem = {
@@ -72,6 +78,12 @@ type MainNavItem = {
         href: string;
         isActive?: boolean;
     }) => react__default.ReactNode;
+    /**
+     * Custom submenu renderer - provides full control over submenu content
+     * Renders as a free-form component without any predefined structure
+     * @returns React node to render as submenu content
+     */
+    customSubMenuRender?: () => react__default.ReactNode;
     /**
      * if true, this item will only be shown in the main account
      * @default false
@@ -95,144 +107,15 @@ type MainNavClassNames = {
     subMenu?: string;
 };
 
-declare const LeftNavWidget: FC<LeftNavProps>;
-
-type BottomNavItem = {
-    name: string;
-    href: string;
-    activeIcon: ReactNode;
-    inactiveIcon: ReactNode;
-};
-type BottomNavProps$1 = {
-    mainMenus?: BottomNavItem[];
-    current?: string;
-    onRouteChange?: RouterAdapter["onRouteChange"];
-};
-declare const BottomNavWidget: react__default.FC<BottomNavProps$1>;
-
-type FooterReturns = {
-    wsStatus: WsNetworkStatus;
-};
-
-type FooterProps = {
-    telegramUrl?: string;
-    twitterUrl?: string;
-    discordUrl?: string;
-    trailing?: ReactNode;
-};
-declare const FooterWidget: react__default.FC<FooterProps>;
-
-declare const Footer: FC<FooterReturns & FooterProps>;
-
-type SideMenuItem = {
-    name: string;
-    icon?: react__default.ReactNode;
-    href?: string;
-    disabled?: boolean;
-    onClick?: () => void;
-    hide?: boolean;
-};
-type SideBarProps = {
-    title?: react__default.ReactNode;
-    items?: SideMenuItem[];
-    open?: boolean;
-    onOpenChange?: (open: boolean) => void;
-    onItemSelect?: (item: SideMenuItem) => void;
-    current?: string;
-    className?: string;
-    maxWidth?: number;
-    minWidth?: number;
-    style?: react__default.CSSProperties;
-};
-declare const SideBar: react__default.FC<SideBarProps>;
-
-declare const SideNavbarWidget: react__default.FC<Partial<SideBarProps>>;
-
-type RouteOption = {
-    href: string;
-    name: string;
-    scope?: string;
-    target?: string;
-};
-type RouterAdapter = {
-    onRouteChange: (option: RouteOption) => void;
-    currentPath?: string;
-};
-type ScaffoldState = {
-    routerAdapter?: RouterAdapter;
-    expanded?: boolean;
-    setExpand: (expand: boolean) => void;
-    checkChainSupport: (chainId: number | string) => boolean;
-    topNavbarHeight: number;
-    footerHeight: number;
-    announcementHeight: number;
-};
-declare const ScaffoldContext: react.Context<ScaffoldState>;
-declare const useScaffoldContext: () => ScaffoldState;
-
-type ScaffoldProps = {
-    /**
-     * custom left sidebar component, only works on desktop
-     * if provided, the layout will use this component over the default sidebar component
-     */
-    leftSidebar?: ReactNode;
-    /**
-     * custom left sidebar props, only works on desktop
-     */
-    leftSideProps?: SideBarProps;
-    /**
-     * custom left nav props, only works on mobile
-     */
-    leftNavProps?: LeftNavProps;
-    /**
-     * custom top bar component
-     */
-    topBar?: ReactNode;
-    /**
-     * custom top nav props
-     */
-    mainNavProps?: MainNavWidgetProps;
-    /**
-     * custom bottom nav component, only works on mobile
-     */
-    bottomNav?: ReactNode;
-    /**
-     * custom bottom nav component, only works on mobile
-     */
-    bottomNavProps?: BottomNavProps$1;
-    /**
-     * custom footer component, only works on desktop
-     */
-    footer?: ReactNode;
-    /**
-     * custom footer props, only works on desktop
-     */
-    footerProps?: FooterProps;
-    routerAdapter?: RouterAdapter;
-    classNames?: {
-        root?: string;
-        container?: string;
-        content?: string;
-        body?: string;
-        leftSidebar?: string;
-        topNavbar?: string;
-        footer?: string;
-        bottomNav?: string;
-    };
-};
-declare const Scaffold: react__default.FC<PropsWithChildren<ScaffoldProps>>;
-
-type BottomNavProps = {
-    mainMenus?: BottomNavItem[];
-    current?: string | string[];
-    onRouteChange?: RouterAdapter["onRouteChange"];
+declare const useLeftNavScript: () => {
+    open: boolean;
+    onOpenChange: react.Dispatch<react.SetStateAction<boolean>>;
+    showSheet: () => void;
+    hideSheet: () => void;
 };
-declare const BottomNav: react__default.FC<BottomNavProps>;
-
-declare const useLeftNavState: () => {};
-type LeftNavState = ReturnType<typeof useLeftNavState>;
+type LeftNavScriptReturn = ReturnType<typeof useLeftNavScript>;
 
-type LeftNavUIProps = LeftNavProps & LeftNavState & {
+type LeftNavUIProps = LeftNavProps & Partial<LeftNavScriptReturn> & {
     className?: string;
     logo?: {
         src: string;
@@ -243,6 +126,8 @@ type LeftNavUIProps = LeftNavProps & LeftNavState & {
 };
 declare const LeftNavUI: FC<LeftNavUIProps>;
 
+declare const LeftNavWidget: FC<LeftNavUIProps>;
+
 declare enum CampaignPositionEnum {
     menuLeading = "menuLeading",
     menuTailing = "menuTailing",
@@ -297,6 +182,7 @@ type MainNavWidgetProps = {
         chainMenu?: ReactNode;
         /** Wallet connection component (desktop & mobile) */
         walletConnect?: ReactNode;
+        notify?: ReactNode;
         /** Main navigation menu (desktop & mobile) */
         mainNav?: ReactNode;
         /** Account summary component (desktop only) */
@@ -319,6 +205,26 @@ type MainNavMobileProps = {
 } & MainNavWidgetProps;
 declare const MainNavMobile: FC<MainNavMobileProps>;
 
+type BottomNavItem = {
+    name: string;
+    href: string;
+    activeIcon: ReactNode;
+    inactiveIcon: ReactNode;
+};
+type BottomNavProps$1 = {
+    mainMenus?: BottomNavItem[];
+    current?: string;
+    onRouteChange?: RouterAdapter["onRouteChange"];
+};
+declare const BottomNavWidget: react__default.FC<BottomNavProps$1>;
+
+type BottomNavProps = {
+    mainMenus?: BottomNavItem[];
+    current?: string | string[];
+    onRouteChange?: RouterAdapter["onRouteChange"];
+};
+declare const BottomNav: react__default.FC<BottomNavProps>;
+
 declare const AccountSummaryWidget: react__default.FC;
 
 declare const ChainMenuWidget: () => react_jsx_runtime.JSX.Element;
@@ -342,6 +248,30 @@ declare const useChainMenuScript: () => {
 
 declare const ChainMenu: (props: UseChainMenuScriptReturn) => react_jsx_runtime.JSX.Element;
 
+type SideMenuItem = {
+    name: string;
+    icon?: react__default.ReactNode;
+    href?: string;
+    disabled?: boolean;
+    onClick?: () => void;
+    hide?: boolean;
+};
+type SideBarProps = {
+    title?: react__default.ReactNode;
+    items?: SideMenuItem[];
+    open?: boolean;
+    onOpenChange?: (open: boolean) => void;
+    onItemSelect?: (item: SideMenuItem) => void;
+    current?: string;
+    className?: string;
+    maxWidth?: number;
+    minWidth?: number;
+    style?: react__default.CSSProperties;
+};
+declare const SideBar: react__default.FC<SideBarProps>;
+
+declare const SideNavbarWidget: react__default.FC<Partial<SideBarProps>>;
+
 type SubAccountWidgetProps = {
     customTrigger?: ReactNode;
 };
@@ -376,6 +306,20 @@ declare function SubAccountUI(props: SubAccountScriptReturn & {
     customTrigger?: ReactNode;
 }): react_jsx_runtime.JSX.Element;
 
+type FooterReturns = {
+    wsStatus: WsNetworkStatus;
+};
+
+type FooterProps = {
+    telegramUrl?: string;
+    twitterUrl?: string;
+    discordUrl?: string;
+    trailing?: ReactNode;
+};
+declare const FooterWidget: react__default.FC<FooterProps>;
+
+declare const Footer: FC<FooterReturns & FooterProps>;
+
 interface MaintenanceTipInterface {
     tipsContent: string;
     showTips: boolean;
@@ -388,27 +332,6 @@ declare const MaintenanceTipsUI: (props: MaintenanceTipInterface) => react_jsx_r
 
 declare const MaintenanceTipsWidget: () => react_jsx_runtime.JSX.Element;
 
-type AnnouncementScriptOptions = {
-    hideTips?: boolean;
-};
-type AnnouncementScriptReturn = ReturnType<typeof useAnnouncementScript>;
-declare const useAnnouncementScript: (options?: AnnouncementScriptOptions) => {
-    maintenanceDialogInfo: string | undefined;
-    tips: API.AnnouncementRow[];
-    closeTips: () => void;
-    showAnnouncement: boolean;
-};
-
-type AnnouncementProps = AnnouncementScriptReturn & {
-    style?: react__default.CSSProperties;
-    className?: string;
-    hideTips?: boolean;
-};
-declare const AnnouncementUI: react__default.FC<Readonly<AnnouncementProps>>;
-
-type AnnouncementWidgetProps = Pick<AnnouncementProps, "style" | "className" | "hideTips">;
-declare const AnnouncementWidget: react__default.FC<AnnouncementWidgetProps>;
-
 type UseRestrictedInfoScriptReturn = ReturnType<typeof useRestrictedInfoScript> & {
     brokerName?: string;
 };
@@ -440,6 +363,71 @@ declare const RestrictedInfo: FC<RestrictedInfoProps>;
 type RestrictedInfoWidgetProps = Pick<RestrictedInfoProps, "className">;
 declare const RestrictedInfoWidget: FC<RestrictedInfoWidgetProps>;
 
+type ScaffoldProps = {
+    /**
+     * custom left sidebar component, only works on desktop
+     * if provided, the layout will use this component over the default sidebar component
+     */
+    leftSidebar?: ReactNode;
+    /**
+     * custom left sidebar props, only works on desktop
+     */
+    leftSideProps?: SideBarProps;
+    /**
+     * custom left nav props, only works on mobile
+     */
+    leftNavProps?: LeftNavProps;
+    /**
+     * custom top bar component
+     */
+    topBar?: ReactNode;
+    /**
+     * custom top nav props
+     */
+    mainNavProps?: MainNavWidgetProps;
+    /**
+     * custom bottom nav component, only works on mobile
+     */
+    bottomNav?: ReactNode;
+    /**
+     * custom bottom nav component, only works on mobile
+     */
+    bottomNavProps?: BottomNavProps$1;
+    /**
+     * custom footer component, only works on desktop
+     */
+    footer?: ReactNode;
+    /**
+     * custom footer props, only works on desktop
+     */
+    footerProps?: FooterProps;
+    routerAdapter?: RouterAdapter;
+    classNames?: {
+        root?: string;
+        container?: string;
+        content?: string;
+        body?: string;
+        leftSidebar?: string;
+        topNavbar?: string;
+        footer?: string;
+        bottomNav?: string;
+    };
+};
+declare const Scaffold: react__default.FC<PropsWithChildren<ScaffoldProps>>;
+
+type ScaffoldState = {
+    routerAdapter?: RouterAdapter;
+    expanded?: boolean;
+    setExpand: (expand: boolean) => void;
+    checkChainSupport: (chainId: number | string) => boolean;
+    topNavbarHeight: number;
+    footerHeight: number;
+    announcementHeight: number;
+    announcementState: ReturnType<typeof useAnnouncement>;
+};
+declare const ScaffoldContext: react.Context<ScaffoldState>;
+declare const useScaffoldContext: () => ScaffoldState;
+
 type MainLogoProps = {
     src?: string;
     alt?: string;
@@ -486,4 +474,4 @@ declare const useScanQRCodeScript: () => {
 type ScanQRCodeProps = UseScanQRCodeScriptReturn;
 declare const ScanQRCode: FC<ScanQRCodeProps>;
 
-export { AccountMenuWidget, AccountSummaryWidget, AnnouncementUI, AnnouncementWidget, type AnnouncementWidgetProps, BottomNav, type BottomNavProps$1 as BottomNavProps, BottomNavWidget, CampaignPositionEnum, ChainMenu, ChainMenuWidget, Footer, type FooterProps, FooterWidget, LanguageSwitcher, type LanguageSwitcherProps, type LanguageSwitcherScriptReturn, LanguageSwitcherWidget, type LanguageSwitcherWidgetProps, type LeftNavItem, type LeftNavProps, LeftNavUI, LeftNavWidget, MainLogo, MainNavMobile, MainNavWidget, type MainNavWidgetProps, MaintenanceTipsUI, MaintenanceTipsWidget, RestrictedInfo, RestrictedInfoWidget, type RouteOption, type RouterAdapter, Scaffold, ScaffoldContext, type ScaffoldProps, ScanQRCode, ScanQRCodeWidget, SideBar, type SideBarProps, type SideMenuItem, SideNavbarWidget, SubAccountScript, SubAccountUI, SubAccountWidget, useAnnouncementScript, useLanguageSwitcherScript, useRestrictedInfoScript, useScaffoldContext, useScanQRCodeScript };
+export { AccountMenuWidget, AccountSummaryWidget, BottomNav, type BottomNavProps$1 as BottomNavProps, BottomNavWidget, CampaignPositionEnum, ChainMenu, ChainMenuWidget, Footer, type FooterProps, FooterWidget, LanguageSwitcher, type LanguageSwitcherProps, type LanguageSwitcherScriptReturn, LanguageSwitcherWidget, type LanguageSwitcherWidgetProps, type LeftNavItem, type LeftNavProps, LeftNavUI, type LeftNavUIProps, LeftNavWidget, MainLogo, type MainNavItem, MainNavMobile, MainNavWidget, type MainNavWidgetProps, MaintenanceTipsUI, MaintenanceTipsWidget, RestrictedInfo, RestrictedInfoWidget, Scaffold, ScaffoldContext, type ScaffoldProps, ScanQRCode, ScanQRCodeWidget, SideBar, type SideBarProps, type SideMenuItem, SideNavbarWidget, SubAccountScript, SubAccountUI, SubAccountWidget, useLanguageSwitcherScript, useRestrictedInfoScript, useScaffoldContext, useScanQRCodeScript };