@orderly.network/ui-scaffold 2.4.1 → 2.5.0-alpha.1

package/dist/index.d.mts

@@ -1,9 +1,8 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as react from 'react';
-import react__default, { ReactNode, HTMLAttributeAnchorTarget, PropsWithChildren, FC } from 'react';
+import react__default, { ReactNode, HTMLAttributeAnchorTarget, FC, PropsWithChildren } from 'react';
 import * as _orderly_network_types from '@orderly.network/types';
-import { AccountStatusEnum, NetworkId } from '@orderly.network/types';
-import { LogoProps } from '@orderly.network/ui';
+import { NetworkId } 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';
@@ -11,6 +10,8 @@ import { LocaleContextState } from '@orderly.network/i18n';
 declare const AccountMenuWidget: () => react_jsx_runtime.JSX.Element;
 
 type LeftNavProps = {
+    /** custom leading */
+    leading?: ReactNode;
     menus?: LeftNavItem[];
     twitterUrl?: string;
     telegramUrl?: string;
@@ -18,7 +19,6 @@ type LeftNavProps = {
     duneUrl?: string;
     feedbackUrl?: string;
     customLeftNav?: ReactNode;
-    products?: ReactNode;
 };
 type LeftNavItem = {
     name: string;
@@ -58,90 +58,13 @@ type MainNavItem = {
     isHomePageInMobile?: boolean;
 };
 
-type CampaignProps = {
-    item: MainNavItem;
-    className?: string;
-    onItemClick?: (item: MainNavItem[]) => void;
-    current?: string[];
-};
-
 type MainNavClassNames = {
     root?: string;
     navItem?: string;
     subMenu?: string;
 };
-type MainNavItemsProps = {
-    items?: MainNavItem[];
-    current?: string[];
-    classNames?: MainNavClassNames;
-    onItemClick?: (item: MainNavItem[]) => void;
-};
-
-declare enum CampaignPositionEnum {
-    menuLeading = "menuLeading",
-    menuTailing = "menuTailing",
-    navTailing = "navTailing"
-}
 
-type MainNavProps = {
-    className?: string;
-    logo: LogoProps;
-    mainMenus: MainNavItemsProps;
-    leading?: ReactNode;
-    trailing?: ReactNode;
-    wrongNetwork: boolean;
-    isConnected: boolean;
-    campaigns?: CampaignProps;
-    campaignPosition?: CampaignPositionEnum;
-    classNames?: {
-        root?: string;
-        mainNav?: MainNavClassNames;
-        logo?: string;
-        products?: string;
-        account?: string;
-        chains?: string;
-        campaignButton?: string;
-    };
-    status?: AccountStatusEnum;
-    disabledConnect?: boolean;
-};
-
-type MainNavWidgetProps = PropsWithChildren<{
-    leading?: ReactNode;
-    trailing?: ReactNode;
-    logo?: {
-        src: string;
-        alt: string;
-    };
-    mainMenus?: MainNavItem[];
-    campaigns?: MainNavItem;
-    campaignPosition?: CampaignPositionEnum;
-    initialProduct?: string;
-    /**
-     * initial menu path, if it has submenus, use array
-     * @type string | string[]
-     */
-    initialMenu?: string | string[];
-    onItemClick?: (options: {
-        href: string;
-        name: string;
-        scope?: string;
-    }) => void;
-    /** only works on mobile */
-    customRender?: (components: {
-        title?: ReactNode;
-        languageSwitcher?: ReactNode;
-        scanQRCode?: ReactNode;
-        subAccount?: ReactNode;
-        linkDevice?: ReactNode;
-        chainMenu?: ReactNode;
-        walletConnect?: ReactNode;
-    }) => ReactNode;
-    /** only works on mobile */
-    leftNav?: LeftNavProps;
-    customLeftNav?: ReactNode;
-}> & Pick<MainNavProps, "classNames">;
-declare const MainNavWidget: (props: MainNavWidgetProps) => react_jsx_runtime.JSX.Element;
+declare const LeftNavWidget: FC<LeftNavProps>;
 
 type BottomNavProps$1 = {
     mainMenus?: BottomNavItem[];
@@ -170,22 +93,6 @@ declare const FooterWidget: (props: FooterProps) => react_jsx_runtime.JSX.Elemen
 
 declare const Footer: FC<FooterReturns & FooterProps>;
 
-declare const LeftNavWidget: FC<LeftNavProps>;
-
-declare const useLeftNavState: () => {};
-type LeftNavState = ReturnType<typeof useLeftNavState>;
-
-type LeftNavUIProps = LeftNavProps & LeftNavState & {
-    className?: string;
-    logo?: {
-        src: string;
-        alt: string;
-    };
-    routerAdapter?: RouterAdapter;
-    showSubAccount?: boolean;
-};
-declare const LeftNavUI: FC<LeftNavUIProps>;
-
 type SideMenuItem = {
     name: string;
     icon?: react__default.ReactNode;
@@ -254,7 +161,7 @@ type ScaffoldProps = {
      */
     topBar?: ReactNode;
     /**
-     * custom top nav props, only works on desktop
+     * custom top nav props
      */
     mainNavProps?: MainNavWidgetProps;
     /**
@@ -294,7 +201,85 @@ type BottomNavProps = {
 };
 declare const BottomNav: (props: BottomNavProps) => react_jsx_runtime.JSX.Element | null;
 
-type Props = {
+declare const useLeftNavState: () => {};
+type LeftNavState = ReturnType<typeof useLeftNavState>;
+
+type LeftNavUIProps = LeftNavProps & LeftNavState & {
+    className?: string;
+    logo?: {
+        src: string;
+        alt: string;
+    };
+    routerAdapter?: RouterAdapter;
+    showSubAccount?: boolean;
+};
+declare const LeftNavUI: FC<LeftNavUIProps>;
+
+declare enum CampaignPositionEnum {
+    menuLeading = "menuLeading",
+    menuTailing = "menuTailing",
+    navTailing = "navTailing"
+}
+
+type MainNavWidgetProps = {
+    leading?: ReactNode;
+    trailing?: ReactNode;
+    logo?: {
+        src: string;
+        alt: string;
+    };
+    mainMenus?: MainNavItem[];
+    campaigns?: MainNavItem;
+    campaignPosition?: CampaignPositionEnum;
+    /**
+     * initial menu path, if it has submenus, use array
+     * @type string | string[]
+     */
+    initialMenu?: string | string[];
+    onItemClick?: (options: {
+        href: string;
+        name: string;
+        scope?: string;
+    }) => void;
+    /** only works on mobile */
+    leftNav?: LeftNavProps;
+    customLeftNav?: ReactNode;
+    className?: string;
+    classNames?: {
+        root?: string;
+        mainNav?: MainNavClassNames;
+        logo?: string;
+        account?: string;
+        chains?: string;
+        campaignButton?: string;
+    };
+    /** custom render main nav */
+    customRender?: (components: {
+        /** Logo or title component (desktop & mobile) */
+        title?: ReactNode;
+        /** Language selection component (desktop & mobile) */
+        languageSwitcher?: ReactNode;
+        /** Sub-account component (desktop & mobile) */
+        subAccount?: ReactNode;
+        /** Device linking component (desktop & mobile) */
+        linkDevice?: ReactNode;
+        /** Chain selection menu (desktop & mobile) */
+        chainMenu?: ReactNode;
+        /** Wallet connection component (desktop & mobile) */
+        walletConnect?: ReactNode;
+        /** Main navigation menu (desktop & mobile) */
+        mainNav?: ReactNode;
+        /** Account summary component (desktop only) */
+        accountSummary?: ReactNode;
+        /** Left navigation component (mobile only) */
+        leftNav?: ReactNode;
+        /** QR code scanner component (mobile only) */
+        scanQRCode?: ReactNode;
+    }) => ReactNode;
+};
+declare const MainNavWidget: (props: PropsWithChildren<MainNavWidgetProps>) => react_jsx_runtime.JSX.Element;
+
+type MainNavMobileProps = {
     current?: string;
     subItems?: {
         name: string;
@@ -302,7 +287,7 @@ type Props = {
     }[];
     routerAdapter?: RouterAdapter;
 } & MainNavWidgetProps;
-declare const MainNavMobile: FC<Props>;
+declare const MainNavMobile: FC<MainNavMobileProps>;
 
 declare const AccountSummaryWidget: () => react_jsx_runtime.JSX.Element;
 

package/dist/index.d.ts

@@ -1,9 +1,8 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as react from 'react';
-import react__default, { ReactNode, HTMLAttributeAnchorTarget, PropsWithChildren, FC } from 'react';
+import react__default, { ReactNode, HTMLAttributeAnchorTarget, FC, PropsWithChildren } from 'react';
 import * as _orderly_network_types from '@orderly.network/types';
-import { AccountStatusEnum, NetworkId } from '@orderly.network/types';
-import { LogoProps } from '@orderly.network/ui';
+import { NetworkId } 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';
@@ -11,6 +10,8 @@ import { LocaleContextState } from '@orderly.network/i18n';
 declare const AccountMenuWidget: () => react_jsx_runtime.JSX.Element;
 
 type LeftNavProps = {
+    /** custom leading */
+    leading?: ReactNode;
     menus?: LeftNavItem[];
     twitterUrl?: string;
     telegramUrl?: string;
@@ -18,7 +19,6 @@ type LeftNavProps = {
     duneUrl?: string;
     feedbackUrl?: string;
     customLeftNav?: ReactNode;
-    products?: ReactNode;
 };
 type LeftNavItem = {
     name: string;
@@ -58,90 +58,13 @@ type MainNavItem = {
     isHomePageInMobile?: boolean;
 };
 
-type CampaignProps = {
-    item: MainNavItem;
-    className?: string;
-    onItemClick?: (item: MainNavItem[]) => void;
-    current?: string[];
-};
-
 type MainNavClassNames = {
     root?: string;
     navItem?: string;
     subMenu?: string;
 };
-type MainNavItemsProps = {
-    items?: MainNavItem[];
-    current?: string[];
-    classNames?: MainNavClassNames;
-    onItemClick?: (item: MainNavItem[]) => void;
-};
-
-declare enum CampaignPositionEnum {
-    menuLeading = "menuLeading",
-    menuTailing = "menuTailing",
-    navTailing = "navTailing"
-}
 
-type MainNavProps = {
-    className?: string;
-    logo: LogoProps;
-    mainMenus: MainNavItemsProps;
-    leading?: ReactNode;
-    trailing?: ReactNode;
-    wrongNetwork: boolean;
-    isConnected: boolean;
-    campaigns?: CampaignProps;
-    campaignPosition?: CampaignPositionEnum;
-    classNames?: {
-        root?: string;
-        mainNav?: MainNavClassNames;
-        logo?: string;
-        products?: string;
-        account?: string;
-        chains?: string;
-        campaignButton?: string;
-    };
-    status?: AccountStatusEnum;
-    disabledConnect?: boolean;
-};
-
-type MainNavWidgetProps = PropsWithChildren<{
-    leading?: ReactNode;
-    trailing?: ReactNode;
-    logo?: {
-        src: string;
-        alt: string;
-    };
-    mainMenus?: MainNavItem[];
-    campaigns?: MainNavItem;
-    campaignPosition?: CampaignPositionEnum;
-    initialProduct?: string;
-    /**
-     * initial menu path, if it has submenus, use array
-     * @type string | string[]
-     */
-    initialMenu?: string | string[];
-    onItemClick?: (options: {
-        href: string;
-        name: string;
-        scope?: string;
-    }) => void;
-    /** only works on mobile */
-    customRender?: (components: {
-        title?: ReactNode;
-        languageSwitcher?: ReactNode;
-        scanQRCode?: ReactNode;
-        subAccount?: ReactNode;
-        linkDevice?: ReactNode;
-        chainMenu?: ReactNode;
-        walletConnect?: ReactNode;
-    }) => ReactNode;
-    /** only works on mobile */
-    leftNav?: LeftNavProps;
-    customLeftNav?: ReactNode;
-}> & Pick<MainNavProps, "classNames">;
-declare const MainNavWidget: (props: MainNavWidgetProps) => react_jsx_runtime.JSX.Element;
+declare const LeftNavWidget: FC<LeftNavProps>;
 
 type BottomNavProps$1 = {
     mainMenus?: BottomNavItem[];
@@ -170,22 +93,6 @@ declare const FooterWidget: (props: FooterProps) => react_jsx_runtime.JSX.Elemen
 
 declare const Footer: FC<FooterReturns & FooterProps>;
 
-declare const LeftNavWidget: FC<LeftNavProps>;
-
-declare const useLeftNavState: () => {};
-type LeftNavState = ReturnType<typeof useLeftNavState>;
-
-type LeftNavUIProps = LeftNavProps & LeftNavState & {
-    className?: string;
-    logo?: {
-        src: string;
-        alt: string;
-    };
-    routerAdapter?: RouterAdapter;
-    showSubAccount?: boolean;
-};
-declare const LeftNavUI: FC<LeftNavUIProps>;
-
 type SideMenuItem = {
     name: string;
     icon?: react__default.ReactNode;
@@ -254,7 +161,7 @@ type ScaffoldProps = {
      */
     topBar?: ReactNode;
     /**
-     * custom top nav props, only works on desktop
+     * custom top nav props
      */
     mainNavProps?: MainNavWidgetProps;
     /**
@@ -294,7 +201,85 @@ type BottomNavProps = {
 };
 declare const BottomNav: (props: BottomNavProps) => react_jsx_runtime.JSX.Element | null;
 
-type Props = {
+declare const useLeftNavState: () => {};
+type LeftNavState = ReturnType<typeof useLeftNavState>;
+
+type LeftNavUIProps = LeftNavProps & LeftNavState & {
+    className?: string;
+    logo?: {
+        src: string;
+        alt: string;
+    };
+    routerAdapter?: RouterAdapter;
+    showSubAccount?: boolean;
+};
+declare const LeftNavUI: FC<LeftNavUIProps>;
+
+declare enum CampaignPositionEnum {
+    menuLeading = "menuLeading",
+    menuTailing = "menuTailing",
+    navTailing = "navTailing"
+}
+
+type MainNavWidgetProps = {
+    leading?: ReactNode;
+    trailing?: ReactNode;
+    logo?: {
+        src: string;
+        alt: string;
+    };
+    mainMenus?: MainNavItem[];
+    campaigns?: MainNavItem;
+    campaignPosition?: CampaignPositionEnum;
+    /**
+     * initial menu path, if it has submenus, use array
+     * @type string | string[]
+     */
+    initialMenu?: string | string[];
+    onItemClick?: (options: {
+        href: string;
+        name: string;
+        scope?: string;
+    }) => void;
+    /** only works on mobile */
+    leftNav?: LeftNavProps;
+    customLeftNav?: ReactNode;
+    className?: string;
+    classNames?: {
+        root?: string;
+        mainNav?: MainNavClassNames;
+        logo?: string;
+        account?: string;
+        chains?: string;
+        campaignButton?: string;
+    };
+    /** custom render main nav */
+    customRender?: (components: {
+        /** Logo or title component (desktop & mobile) */
+        title?: ReactNode;
+        /** Language selection component (desktop & mobile) */
+        languageSwitcher?: ReactNode;
+        /** Sub-account component (desktop & mobile) */
+        subAccount?: ReactNode;
+        /** Device linking component (desktop & mobile) */
+        linkDevice?: ReactNode;
+        /** Chain selection menu (desktop & mobile) */
+        chainMenu?: ReactNode;
+        /** Wallet connection component (desktop & mobile) */
+        walletConnect?: ReactNode;
+        /** Main navigation menu (desktop & mobile) */
+        mainNav?: ReactNode;
+        /** Account summary component (desktop only) */
+        accountSummary?: ReactNode;
+        /** Left navigation component (mobile only) */
+        leftNav?: ReactNode;
+        /** QR code scanner component (mobile only) */
+        scanQRCode?: ReactNode;
+    }) => ReactNode;
+};
+declare const MainNavWidget: (props: PropsWithChildren<MainNavWidgetProps>) => react_jsx_runtime.JSX.Element;
+
+type MainNavMobileProps = {
     current?: string;
     subItems?: {
         name: string;
@@ -302,7 +287,7 @@ type Props = {
     }[];
     routerAdapter?: RouterAdapter;
 } & MainNavWidgetProps;
-declare const MainNavMobile: FC<Props>;
+declare const MainNavMobile: FC<MainNavMobileProps>;
 
 declare const AccountSummaryWidget: () => react_jsx_runtime.JSX.Element;