@orderly.network/ui-scaffold 2.2.0 → 2.3.0

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, { HTMLAttributeAnchorTarget, ReactNode, PropsWithChildren, FC } from 'react';
 import * as _orderly_network_types from '@orderly.network/types';
-import { AccountStatusEnum, NetworkId, API, AnnouncementType } from '@orderly.network/types';
+import { AccountStatusEnum, NetworkId } from '@orderly.network/types';
 import { LogoProps } from '@orderly.network/ui';
 import { WsNetworkStatus } from '@orderly.network/hooks';
 import * as _orderly_network_i18n from '@orderly.network/i18n';
@@ -191,15 +191,37 @@ declare const useScaffoldContext: () => ScaffoldState;
 
 type ScaffoldProps = {
     /**
-     * Custom left sidebar component,
+     * custom left sidebar component, only works on desktop
      * if provided, the layout will use this component over the default sidebar component
      */
-    leftSidebar?: react__default.ReactNode;
+    leftSidebar?: ReactNode;
+    /**
+     * custom left sidebar props, only works on desktop
+     */
     leftSideProps?: SideBarProps;
-    topBar?: react__default.ReactNode;
+    /**
+     * custom top bar component
+     */
+    topBar?: ReactNode;
+    /**
+     * custom top nav props, only works on desktop
+     */
     mainNavProps?: MainNavWidgetProps;
+    /**
+     * custom bottom nav component, only works on mobile
+     */
+    bottomNav?: ReactNode;
+    /**
+     * custom bottom nav component, only works on mobile
+     */
     bottomNavProps?: BottomNavProps$1;
-    footer?: react__default.ReactNode;
+    /**
+     * custom footer component, only works on desktop
+     */
+    footer?: ReactNode;
+    /**
+     * custom footer props, only works on desktop
+     */
     footerProps?: FooterProps;
     routerAdapter?: RouterAdapter;
     classNames?: {
@@ -210,6 +232,7 @@ type ScaffoldProps = {
         leftSidebar?: string;
         topNavbar?: string;
         footer?: string;
+        bottomNav?: string;
     };
 };
 declare const Scaffold: (props: PropsWithChildren<ScaffoldProps>) => react_jsx_runtime.JSX.Element;
@@ -274,16 +297,9 @@ declare const useAnnouncementScript: (options?: AnnouncementScriptOptions) => {
     mutiLine: boolean;
     contentRef: react__default.RefObject<HTMLDivElement>;
     maintenanceDialogInfo: string | undefined;
-    tips: API.Announcement;
+    tips: any[];
     currentIndex: number;
-    currentTip: {
-        announcement_id: number | string;
-        message: string;
-        i18n?: Record<PropertyKey, string | null>;
-        url?: string | null;
-        type?: AnnouncementType | null;
-        updated_time?: number | null;
-    } | undefined;
+    currentTip: any;
     closeTips: () => void;
     nextTips: () => void;
     prevTips: () => void;

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, { HTMLAttributeAnchorTarget, ReactNode, PropsWithChildren, FC } from 'react';
 import * as _orderly_network_types from '@orderly.network/types';
-import { AccountStatusEnum, NetworkId, API, AnnouncementType } from '@orderly.network/types';
+import { AccountStatusEnum, NetworkId } from '@orderly.network/types';
 import { LogoProps } from '@orderly.network/ui';
 import { WsNetworkStatus } from '@orderly.network/hooks';
 import * as _orderly_network_i18n from '@orderly.network/i18n';
@@ -191,15 +191,37 @@ declare const useScaffoldContext: () => ScaffoldState;
 
 type ScaffoldProps = {
     /**
-     * Custom left sidebar component,
+     * custom left sidebar component, only works on desktop
      * if provided, the layout will use this component over the default sidebar component
      */
-    leftSidebar?: react__default.ReactNode;
+    leftSidebar?: ReactNode;
+    /**
+     * custom left sidebar props, only works on desktop
+     */
     leftSideProps?: SideBarProps;
-    topBar?: react__default.ReactNode;
+    /**
+     * custom top bar component
+     */
+    topBar?: ReactNode;
+    /**
+     * custom top nav props, only works on desktop
+     */
     mainNavProps?: MainNavWidgetProps;
+    /**
+     * custom bottom nav component, only works on mobile
+     */
+    bottomNav?: ReactNode;
+    /**
+     * custom bottom nav component, only works on mobile
+     */
     bottomNavProps?: BottomNavProps$1;
-    footer?: react__default.ReactNode;
+    /**
+     * custom footer component, only works on desktop
+     */
+    footer?: ReactNode;
+    /**
+     * custom footer props, only works on desktop
+     */
     footerProps?: FooterProps;
     routerAdapter?: RouterAdapter;
     classNames?: {
@@ -210,6 +232,7 @@ type ScaffoldProps = {
         leftSidebar?: string;
         topNavbar?: string;
         footer?: string;
+        bottomNav?: string;
     };
 };
 declare const Scaffold: (props: PropsWithChildren<ScaffoldProps>) => react_jsx_runtime.JSX.Element;
@@ -274,16 +297,9 @@ declare const useAnnouncementScript: (options?: AnnouncementScriptOptions) => {
     mutiLine: boolean;
     contentRef: react__default.RefObject<HTMLDivElement>;
     maintenanceDialogInfo: string | undefined;
-    tips: API.Announcement;
+    tips: any[];
     currentIndex: number;
-    currentTip: {
-        announcement_id: number | string;
-        message: string;
-        i18n?: Record<PropertyKey, string | null>;
-        url?: string | null;
-        type?: AnnouncementType | null;
-        updated_time?: number | null;
-    } | undefined;
+    currentTip: any;
     closeTips: () => void;
     nextTips: () => void;
     prevTips: () => void;