@orderly.network/ui-scaffold 2.5.2 → 2.5.3-alpha.1

package/README.md

@@ -208,7 +208,7 @@ const sidebarMenus = [
   - `telegramUrl`: Telegram community link
   - `discordUrl`: Discord community link
   - `duneUrl`: Dune Analytics link
-  - `feedbackUrl`: Feedback form link
+  - `feedbackUrl`: Feedback form link (optional - if not provided, feedback section will not be displayed)
   - `customLeftNav`: Custom component to replace the default leftNav trigger
 
 #### LeftNavItem Properties
@@ -217,6 +217,7 @@ Each menu item in the `menus` array supports:
 
 - `name`: Display name of the menu item
 - `href`: Navigation URL
+- `target`: Link target (e.g., "\_blank" for new window). If provided, will use `window.open()` instead of router navigation (optional)
 - `icon`: Icon component to display (optional)
 - `trailing`: Additional content on the right side (optional)
 - `customRender`: Custom render function for complete control over item appearance
@@ -250,6 +251,12 @@ Each menu item in the `menus` array supports:
               <SpecialBadge />
             </div>
           )
+        },
+        {
+          name: "External Link",
+          href: "https://external-site.com",
+          target: "_blank",
+          icon: <ExternalLinkIcon />
         }
       ],
       leading: (
@@ -279,8 +286,11 @@ Each menu item in the `menus` array supports:
   3. Sub-account selector (if user is logged in with trading enabled)
   4. Menu items list (scrollable if needed)
   5. Social media links at the bottom
-  6. Feedback link at the very bottom
+  6. Feedback link at the very bottom (only if `feedbackUrl` is provided)
 - **Auto-close**: The drawer automatically closes when a menu item is selected
+- **Navigation Behavior**:
+  - Items with `target` property will open in new window/tab using `window.open()`
+  - Items without `target` will use router navigation and close the drawer
 
 #### Advanced Customization
 
@@ -573,3 +583,4 @@ The Scaffold component automatically detects device type and provides appropriat
 - `useScaffoldContext`: Hook to get Scaffold state
 - `MobileScaffold`: Mobile layout component
 - `DesktopScaffold`: Desktop layout component
+- `SubAccountWidget`: Sub-account selection component (exported from ui-scaffold)

package/dist/index.d.mts

@@ -2,7 +2,7 @@ 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 } from '@orderly.network/types';
+import { 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';
@@ -23,6 +23,7 @@ type LeftNavProps = {
 type LeftNavItem = {
     name: string;
     href: string;
+    target?: string;
     icon?: ReactNode;
     trailing?: ReactNode;
     customRender?: (option: {
@@ -332,6 +333,40 @@ declare const useChainMenuScript: () => {
 
 declare const ChainMenu: (props: UseChainMenuScriptReturn) => react_jsx_runtime.JSX.Element;
 
+type SubAccountWidgetProps = {
+    customTrigger?: ReactNode;
+};
+declare const SubAccountWidget: FC<SubAccountWidgetProps>;
+
+type SubAccountScriptReturn = ReturnType<typeof SubAccountScript>;
+declare const SubAccountScript: () => {
+    userAddress: string | undefined;
+    mainAccount: {
+        id: string;
+        userAddress: string;
+        holding: API.Holding[];
+        accountValue: number;
+    } | undefined;
+    currentAccountId: string | undefined;
+    open: boolean;
+    onOpenChange: react.Dispatch<react.SetStateAction<boolean>>;
+    popup: {
+        mode: string;
+    };
+    createSubAccount: (nickName: string) => Promise<any>;
+    subAccounts: {
+        accountValue: number;
+        id: string;
+        description: string;
+        holding: API.Holding[];
+    }[];
+    onSwitch: (accountId: string) => Promise<void>;
+};
+
+declare function SubAccountUI(props: SubAccountScriptReturn & {
+    customTrigger?: ReactNode;
+}): react_jsx_runtime.JSX.Element;
+
 interface MaintenanceTipInterface {
     tipsContent: string;
     showTips: boolean;
@@ -409,16 +444,10 @@ type MainLogoProps = {
 };
 declare const MainLogo: FC<MainLogoProps>;
 
-type LanguageSwitcherWidgetProps = Pick<LocaleContextState, "popup"> & {
-    open?: boolean;
-    setOpen?: (open: boolean) => void;
-};
-declare const LanguageSwitcherWidget: (props: LanguageSwitcherWidgetProps) => react_jsx_runtime.JSX.Element;
-
 type LanguageSwitcherScriptReturn = ReturnType<typeof useLanguageSwitcherScript>;
 type LanguageSwitcherScriptOptions = Pick<LocaleContextState, "popup"> & {
     open?: boolean;
-    setOpen?: (open: boolean) => void;
+    onOpenChange?: (open: boolean) => void;
 };
 declare const useLanguageSwitcherScript: (options?: LanguageSwitcherScriptOptions) => {
     open: boolean;
@@ -434,6 +463,9 @@ declare const useLanguageSwitcherScript: (options?: LanguageSwitcherScriptOption
     };
 };
 
+type LanguageSwitcherWidgetProps = LanguageSwitcherScriptOptions;
+declare const LanguageSwitcherWidget: (props: LanguageSwitcherWidgetProps) => react_jsx_runtime.JSX.Element;
+
 type LanguageSwitcherProps = LanguageSwitcherScriptReturn;
 declare const LanguageSwitcher: FC<LanguageSwitcherProps>;
 
@@ -452,4 +484,4 @@ declare function useScanQRCodeScript(): {
 type ScanQRCodeProps = UseScanQRCodeScriptReturn;
 declare const ScanQRCode: FC<ScanQRCodeProps>;
 
-export { AccountMenuWidget, AccountSummaryWidget, Announcement, 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, useAnnouncementScript, useLanguageSwitcherScript, useRestrictedInfoScript, useScaffoldContext, useScanQRCodeScript };
+export { AccountMenuWidget, AccountSummaryWidget, Announcement, 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 };

package/dist/index.d.ts

@@ -2,7 +2,7 @@ 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 } from '@orderly.network/types';
+import { 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';
@@ -23,6 +23,7 @@ type LeftNavProps = {
 type LeftNavItem = {
     name: string;
     href: string;
+    target?: string;
     icon?: ReactNode;
     trailing?: ReactNode;
     customRender?: (option: {
@@ -332,6 +333,40 @@ declare const useChainMenuScript: () => {
 
 declare const ChainMenu: (props: UseChainMenuScriptReturn) => react_jsx_runtime.JSX.Element;
 
+type SubAccountWidgetProps = {
+    customTrigger?: ReactNode;
+};
+declare const SubAccountWidget: FC<SubAccountWidgetProps>;
+
+type SubAccountScriptReturn = ReturnType<typeof SubAccountScript>;
+declare const SubAccountScript: () => {
+    userAddress: string | undefined;
+    mainAccount: {
+        id: string;
+        userAddress: string;
+        holding: API.Holding[];
+        accountValue: number;
+    } | undefined;
+    currentAccountId: string | undefined;
+    open: boolean;
+    onOpenChange: react.Dispatch<react.SetStateAction<boolean>>;
+    popup: {
+        mode: string;
+    };
+    createSubAccount: (nickName: string) => Promise<any>;
+    subAccounts: {
+        accountValue: number;
+        id: string;
+        description: string;
+        holding: API.Holding[];
+    }[];
+    onSwitch: (accountId: string) => Promise<void>;
+};
+
+declare function SubAccountUI(props: SubAccountScriptReturn & {
+    customTrigger?: ReactNode;
+}): react_jsx_runtime.JSX.Element;
+
 interface MaintenanceTipInterface {
     tipsContent: string;
     showTips: boolean;
@@ -409,16 +444,10 @@ type MainLogoProps = {
 };
 declare const MainLogo: FC<MainLogoProps>;
 
-type LanguageSwitcherWidgetProps = Pick<LocaleContextState, "popup"> & {
-    open?: boolean;
-    setOpen?: (open: boolean) => void;
-};
-declare const LanguageSwitcherWidget: (props: LanguageSwitcherWidgetProps) => react_jsx_runtime.JSX.Element;
-
 type LanguageSwitcherScriptReturn = ReturnType<typeof useLanguageSwitcherScript>;
 type LanguageSwitcherScriptOptions = Pick<LocaleContextState, "popup"> & {
     open?: boolean;
-    setOpen?: (open: boolean) => void;
+    onOpenChange?: (open: boolean) => void;
 };
 declare const useLanguageSwitcherScript: (options?: LanguageSwitcherScriptOptions) => {
     open: boolean;
@@ -434,6 +463,9 @@ declare const useLanguageSwitcherScript: (options?: LanguageSwitcherScriptOption
     };
 };
 
+type LanguageSwitcherWidgetProps = LanguageSwitcherScriptOptions;
+declare const LanguageSwitcherWidget: (props: LanguageSwitcherWidgetProps) => react_jsx_runtime.JSX.Element;
+
 type LanguageSwitcherProps = LanguageSwitcherScriptReturn;
 declare const LanguageSwitcher: FC<LanguageSwitcherProps>;
 
@@ -452,4 +484,4 @@ declare function useScanQRCodeScript(): {
 type ScanQRCodeProps = UseScanQRCodeScriptReturn;
 declare const ScanQRCode: FC<ScanQRCodeProps>;
 
-export { AccountMenuWidget, AccountSummaryWidget, Announcement, 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, useAnnouncementScript, useLanguageSwitcherScript, useRestrictedInfoScript, useScaffoldContext, useScanQRCodeScript };
+export { AccountMenuWidget, AccountSummaryWidget, Announcement, 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 };