@orderly.network/ui-scaffold 2.1.1 → 2.1.2

package/dist/index.d.mts

@@ -1,11 +1,12 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as react from 'react';
-import react__default, { HTMLAttributeAnchorTarget, FC, PropsWithChildren } from 'react';
-import { LogoProps } from '@orderly.network/ui';
+import react__default, { HTMLAttributeAnchorTarget, ReactNode, PropsWithChildren, FC } from 'react';
 import * as _orderly_network_types from '@orderly.network/types';
-import { AccountStatusEnum, NetworkId, API } from '@orderly.network/types';
+import { AccountStatusEnum, NetworkId, API, AnnouncementType } 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';
+import { LocaleContextState } from '@orderly.network/i18n';
 
 declare const AccountMenuWidget: () => react_jsx_runtime.JSX.Element;
 
@@ -25,6 +26,13 @@ type MainNavItem = {
     asChild?: boolean;
 };
 
+type CampaignProps = {
+    item: MainNavItem;
+    className?: string;
+    onItemClick?: (item: MainNavItem[]) => void;
+    current?: string[];
+};
+
 type MainNavClassNames = {
     root?: string;
     navItem?: string;
@@ -37,42 +45,18 @@ type MainNavItemsProps = {
     onItemClick?: (item: MainNavItem[]) => void;
 };
 
-type ProductItem = {
-    name: string;
-    href: string;
-};
-declare const ProductItem: FC<{
-    item: ProductItem;
-    active?: boolean;
-    onClick?: (product: ProductItem) => void;
-}>;
-
-type ProductsProps = {
-    items?: ProductItem[];
-    current?: string;
-    className?: string;
-    onItemClick?: (product: ProductItem) => void;
-};
-declare const ProductsMenu: FC<ProductsProps>;
-
 declare enum CampaignPositionEnum {
     menuLeading = "menuLeading",
     menuTailing = "menuTailing",
     navTailing = "navTailing"
 }
 
-type CampaignProps = {
-    item: MainNavItem;
-    className?: string;
-    onItemClick?: (item: MainNavItem[]) => void;
-    current?: string[];
-};
-
 type MainNavProps = {
     className?: string;
     logo: LogoProps;
-    products: ProductsProps;
     mainMenus: MainNavItemsProps;
+    leading?: ReactNode;
+    trailing?: ReactNode;
     wrongNetwork: boolean;
     isConnected: boolean;
     campaigns?: CampaignProps;
@@ -91,12 +75,13 @@ type MainNavProps = {
 };
 
 type MainNavWidgetProps = PropsWithChildren<{
+    leading?: ReactNode;
+    trailing?: ReactNode;
     logo?: {
         src: string;
         alt: string;
     };
     mainMenus?: MainNavItem[];
-    products?: MainNavItem[];
     campaigns?: MainNavItem;
     campaignPosition?: CampaignPositionEnum;
     initialProduct?: string;
@@ -193,11 +178,18 @@ type AnnouncementScriptOptions = {
 type AnnouncementScriptReturn = ReturnType<typeof useAnnouncementScript>;
 declare const useAnnouncementScript: (options?: AnnouncementScriptOptions) => {
     mutiLine: boolean;
-    contentRef: react.RefObject<HTMLDivElement>;
+    contentRef: react__default.RefObject<HTMLDivElement>;
     maintenanceDialogInfo: string | undefined;
-    tips: API.Announcement[];
+    tips: API.Announcement;
     currentIndex: number;
-    currentTip: API.Announcement;
+    currentTip: {
+        announcement_id: number | string;
+        message: string;
+        i18n?: Record<PropertyKey, string | null>;
+        url?: string | null;
+        type?: AnnouncementType | null;
+        updated_time?: number | null;
+    } | undefined;
     closeTips: () => void;
     nextTips: () => void;
     prevTips: () => void;
@@ -206,11 +198,11 @@ declare const useAnnouncementScript: (options?: AnnouncementScriptOptions) => {
 };
 
 type AnnouncementProps = AnnouncementScriptReturn & {
-    style?: React.CSSProperties;
+    style?: react__default.CSSProperties;
     className?: string;
     hideTips?: boolean;
 };
-declare const Announcement: (props: AnnouncementProps) => react_jsx_runtime.JSX.Element | null;
+declare const Announcement: react__default.FC<Readonly<AnnouncementProps>>;
 
 type AnnouncementWidgetProps = Pick<AnnouncementProps, "style" | "className" | "hideTips">;
 declare const AnnouncementWidget: (props: AnnouncementWidgetProps) => react_jsx_runtime.JSX.Element;
@@ -293,19 +285,26 @@ type MainLogoProps = {
 };
 declare const MainLogo: FC<MainLogoProps>;
 
-declare const LanguageSwitcherWidget: () => react_jsx_runtime.JSX.Element;
+type LanguageSwitcherWidgetProps = Pick<LocaleContextState, "popup">;
+declare const LanguageSwitcherWidget: (props: LanguageSwitcherWidgetProps) => react_jsx_runtime.JSX.Element;
 
 type LanguageSwitcherScriptReturn = ReturnType<typeof useLanguageSwitcherScript>;
-declare const useLanguageSwitcherScript: () => {
+type LanguageSwitcherScriptOptions = Pick<LocaleContextState, "popup">;
+declare const useLanguageSwitcherScript: (options?: LanguageSwitcherScriptOptions) => {
     open: boolean;
     onOpenChange: react.Dispatch<react.SetStateAction<boolean>>;
     languages: _orderly_network_i18n.Language[];
     selectedLang: string;
     onLangChange: (lang: string, displayName: string) => Promise<void>;
     loading: boolean;
+    popup: {
+        mode: _orderly_network_i18n.PopupMode;
+        className?: string;
+        style?: React.CSSProperties;
+    };
 };
 
 type LanguageSwitcherProps = LanguageSwitcherScriptReturn;
 declare const LanguageSwitcher: FC<LanguageSwitcherProps>;
 
-export { AccountMenuWidget, AccountSummaryWidget, Announcement, AnnouncementWidget, type AnnouncementWidgetProps, CampaignPositionEnum, ChainMenu, ChainMenuWidget, Footer, type FooterProps, FooterWidget, LanguageSwitcher, LanguageSwitcherWidget, MainLogo, MainNavWidget, type MainNavWidgetProps, MaintenanceTipsUI, MaintenanceTipsWidget, ProductsMenu, RestrictedInfo, RestrictedInfoWidget, type RouteOption, type RouterAdapter, Scaffold, ScaffoldContext, type ScaffoldProps, SideBar, type SideBarProps, type SideMenuItem, SideNavbarWidget, useAnnouncementScript, useLanguageSwitcherScript, useRestrictedInfoScript, useScaffoldContext };
+export { AccountMenuWidget, AccountSummaryWidget, Announcement, AnnouncementWidget, type AnnouncementWidgetProps, CampaignPositionEnum, ChainMenu, ChainMenuWidget, Footer, type FooterProps, FooterWidget, LanguageSwitcher, type LanguageSwitcherProps, type LanguageSwitcherScriptReturn, LanguageSwitcherWidget, type LanguageSwitcherWidgetProps, MainLogo, MainNavWidget, type MainNavWidgetProps, MaintenanceTipsUI, MaintenanceTipsWidget, RestrictedInfo, RestrictedInfoWidget, type RouteOption, type RouterAdapter, Scaffold, ScaffoldContext, type ScaffoldProps, SideBar, type SideBarProps, type SideMenuItem, SideNavbarWidget, useAnnouncementScript, useLanguageSwitcherScript, useRestrictedInfoScript, useScaffoldContext };

package/dist/index.d.ts

@@ -1,11 +1,12 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as react from 'react';
-import react__default, { HTMLAttributeAnchorTarget, FC, PropsWithChildren } from 'react';
-import { LogoProps } from '@orderly.network/ui';
+import react__default, { HTMLAttributeAnchorTarget, ReactNode, PropsWithChildren, FC } from 'react';
 import * as _orderly_network_types from '@orderly.network/types';
-import { AccountStatusEnum, NetworkId, API } from '@orderly.network/types';
+import { AccountStatusEnum, NetworkId, API, AnnouncementType } 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';
+import { LocaleContextState } from '@orderly.network/i18n';
 
 declare const AccountMenuWidget: () => react_jsx_runtime.JSX.Element;
 
@@ -25,6 +26,13 @@ type MainNavItem = {
     asChild?: boolean;
 };
 
+type CampaignProps = {
+    item: MainNavItem;
+    className?: string;
+    onItemClick?: (item: MainNavItem[]) => void;
+    current?: string[];
+};
+
 type MainNavClassNames = {
     root?: string;
     navItem?: string;
@@ -37,42 +45,18 @@ type MainNavItemsProps = {
     onItemClick?: (item: MainNavItem[]) => void;
 };
 
-type ProductItem = {
-    name: string;
-    href: string;
-};
-declare const ProductItem: FC<{
-    item: ProductItem;
-    active?: boolean;
-    onClick?: (product: ProductItem) => void;
-}>;
-
-type ProductsProps = {
-    items?: ProductItem[];
-    current?: string;
-    className?: string;
-    onItemClick?: (product: ProductItem) => void;
-};
-declare const ProductsMenu: FC<ProductsProps>;
-
 declare enum CampaignPositionEnum {
     menuLeading = "menuLeading",
     menuTailing = "menuTailing",
     navTailing = "navTailing"
 }
 
-type CampaignProps = {
-    item: MainNavItem;
-    className?: string;
-    onItemClick?: (item: MainNavItem[]) => void;
-    current?: string[];
-};
-
 type MainNavProps = {
     className?: string;
     logo: LogoProps;
-    products: ProductsProps;
     mainMenus: MainNavItemsProps;
+    leading?: ReactNode;
+    trailing?: ReactNode;
     wrongNetwork: boolean;
     isConnected: boolean;
     campaigns?: CampaignProps;
@@ -91,12 +75,13 @@ type MainNavProps = {
 };
 
 type MainNavWidgetProps = PropsWithChildren<{
+    leading?: ReactNode;
+    trailing?: ReactNode;
     logo?: {
         src: string;
         alt: string;
     };
     mainMenus?: MainNavItem[];
-    products?: MainNavItem[];
     campaigns?: MainNavItem;
     campaignPosition?: CampaignPositionEnum;
     initialProduct?: string;
@@ -193,11 +178,18 @@ type AnnouncementScriptOptions = {
 type AnnouncementScriptReturn = ReturnType<typeof useAnnouncementScript>;
 declare const useAnnouncementScript: (options?: AnnouncementScriptOptions) => {
     mutiLine: boolean;
-    contentRef: react.RefObject<HTMLDivElement>;
+    contentRef: react__default.RefObject<HTMLDivElement>;
     maintenanceDialogInfo: string | undefined;
-    tips: API.Announcement[];
+    tips: API.Announcement;
     currentIndex: number;
-    currentTip: API.Announcement;
+    currentTip: {
+        announcement_id: number | string;
+        message: string;
+        i18n?: Record<PropertyKey, string | null>;
+        url?: string | null;
+        type?: AnnouncementType | null;
+        updated_time?: number | null;
+    } | undefined;
     closeTips: () => void;
     nextTips: () => void;
     prevTips: () => void;
@@ -206,11 +198,11 @@ declare const useAnnouncementScript: (options?: AnnouncementScriptOptions) => {
 };
 
 type AnnouncementProps = AnnouncementScriptReturn & {
-    style?: React.CSSProperties;
+    style?: react__default.CSSProperties;
     className?: string;
     hideTips?: boolean;
 };
-declare const Announcement: (props: AnnouncementProps) => react_jsx_runtime.JSX.Element | null;
+declare const Announcement: react__default.FC<Readonly<AnnouncementProps>>;
 
 type AnnouncementWidgetProps = Pick<AnnouncementProps, "style" | "className" | "hideTips">;
 declare const AnnouncementWidget: (props: AnnouncementWidgetProps) => react_jsx_runtime.JSX.Element;
@@ -293,19 +285,26 @@ type MainLogoProps = {
 };
 declare const MainLogo: FC<MainLogoProps>;
 
-declare const LanguageSwitcherWidget: () => react_jsx_runtime.JSX.Element;
+type LanguageSwitcherWidgetProps = Pick<LocaleContextState, "popup">;
+declare const LanguageSwitcherWidget: (props: LanguageSwitcherWidgetProps) => react_jsx_runtime.JSX.Element;
 
 type LanguageSwitcherScriptReturn = ReturnType<typeof useLanguageSwitcherScript>;
-declare const useLanguageSwitcherScript: () => {
+type LanguageSwitcherScriptOptions = Pick<LocaleContextState, "popup">;
+declare const useLanguageSwitcherScript: (options?: LanguageSwitcherScriptOptions) => {
     open: boolean;
     onOpenChange: react.Dispatch<react.SetStateAction<boolean>>;
     languages: _orderly_network_i18n.Language[];
     selectedLang: string;
     onLangChange: (lang: string, displayName: string) => Promise<void>;
     loading: boolean;
+    popup: {
+        mode: _orderly_network_i18n.PopupMode;
+        className?: string;
+        style?: React.CSSProperties;
+    };
 };
 
 type LanguageSwitcherProps = LanguageSwitcherScriptReturn;
 declare const LanguageSwitcher: FC<LanguageSwitcherProps>;
 
-export { AccountMenuWidget, AccountSummaryWidget, Announcement, AnnouncementWidget, type AnnouncementWidgetProps, CampaignPositionEnum, ChainMenu, ChainMenuWidget, Footer, type FooterProps, FooterWidget, LanguageSwitcher, LanguageSwitcherWidget, MainLogo, MainNavWidget, type MainNavWidgetProps, MaintenanceTipsUI, MaintenanceTipsWidget, ProductsMenu, RestrictedInfo, RestrictedInfoWidget, type RouteOption, type RouterAdapter, Scaffold, ScaffoldContext, type ScaffoldProps, SideBar, type SideBarProps, type SideMenuItem, SideNavbarWidget, useAnnouncementScript, useLanguageSwitcherScript, useRestrictedInfoScript, useScaffoldContext };
+export { AccountMenuWidget, AccountSummaryWidget, Announcement, AnnouncementWidget, type AnnouncementWidgetProps, CampaignPositionEnum, ChainMenu, ChainMenuWidget, Footer, type FooterProps, FooterWidget, LanguageSwitcher, type LanguageSwitcherProps, type LanguageSwitcherScriptReturn, LanguageSwitcherWidget, type LanguageSwitcherWidgetProps, MainLogo, MainNavWidget, type MainNavWidgetProps, MaintenanceTipsUI, MaintenanceTipsWidget, RestrictedInfo, RestrictedInfoWidget, type RouteOption, type RouterAdapter, Scaffold, ScaffoldContext, type ScaffoldProps, SideBar, type SideBarProps, type SideMenuItem, SideNavbarWidget, useAnnouncementScript, useLanguageSwitcherScript, useRestrictedInfoScript, useScaffoldContext };