@orderly.network/ui-scaffold 3.0.0-beta.1 → 3.0.0-beta.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -146,7 +146,7 @@ const sidebarMenus = [
146
146
  telegramUrl: "https://t.me/yourgroup",
147
147
  discordUrl: "https://discord.gg/yourserver",
148
148
  duneUrl: "https://dune.com/youranalytics",
149
- feedbackUrl: "https://feedback.yoursite.com"
149
+ // customFooter: <ReactNode>, // optional. If not provided, default will be rendered.
150
150
  },
151
151
  // Custom layout for main navigation
152
152
  customRender: (components) => {
@@ -208,7 +208,8 @@ const sidebarMenus = [
208
208
  - `telegramUrl`: Telegram community link
209
209
  - `discordUrl`: Discord community link
210
210
  - `duneUrl`: Dune Analytics link
211
- - `feedbackUrl`: Feedback form link (optional - if not provided, feedback section will not be displayed)
211
+ - `feedbackUrl`: Feedback form link (deprecated; does not control the leftNav drawer footer UI)
212
+ - `customFooter`: Slot for TradingView T&C custom content in the leftNav drawer bottom (mweb). If not provided, default `Charts powered by TradingView` link will be rendered.
212
213
  - `customLeftNav`: Custom component to replace the default leftNav trigger
213
214
 
214
215
  #### LeftNavItem Properties
@@ -268,7 +269,7 @@ Each menu item in the `menus` array supports:
268
269
  telegramUrl: "https://t.me/yourgroup",
269
270
  discordUrl: "https://discord.gg/yourserver",
270
271
  duneUrl: "https://dune.com/youranalytics",
271
- feedbackUrl: "https://feedback.yoursite.com"
272
+ // customFooter: <ReactNode>, // optional. If not provided, default will be rendered.
272
273
  }
273
274
  }}
274
275
  >
@@ -286,7 +287,7 @@ Each menu item in the `menus` array supports:
286
287
  3. Sub-account selector (if user is logged in with trading enabled)
287
288
  4. Menu items list (scrollable if needed)
288
289
  5. Social media links at the bottom
289
- 6. Feedback link at the very bottom (only if `feedbackUrl` is provided)
290
+ 6. TradingView T&C at the very bottom (defaults to `Charts powered by TradingView`, customizable via `customFooter`)
290
291
  - **Auto-close**: The drawer automatically closes when a menu item is selected
291
292
  - **Navigation Behavior**:
292
293
  - Items with `target` property will open in new window/tab using `window.open()`
@@ -362,7 +363,7 @@ const bottomMenus = [
362
363
  - `telegramUrl`: Telegram link
363
364
  - `twitterUrl`: Twitter link
364
365
  - `discordUrl`: Discord link
365
- - `trailing`: Content on the right side of the footer
366
+ - `trailing`: Content on the right side of the footer. If not provided, a default `Charts powered by TradingView` link will be rendered.
366
367
 
367
368
  ```typescript
368
369
  <Scaffold
@@ -518,7 +519,7 @@ const App = () => {
518
519
  twitterUrl: "https://twitter.com/yourhandle",
519
520
  telegramUrl: "https://t.me/yourgroup",
520
521
  discordUrl: "https://discord.gg/yourserver",
521
- feedbackUrl: "https://feedback.yoursite.com"
522
+ // customFooter: <ReactNode>
522
523
  }
523
524
  }}
524
525
  bottomNavProps={{
package/dist/index.d.mts CHANGED
@@ -5,7 +5,7 @@ import react__default, { HTMLAttributeAnchorTarget, ReactNode, FC, PropsWithChil
5
5
  import * as react_jsx_runtime from 'react/jsx-runtime';
6
6
  import { WsNetworkStatus } from '@orderly.network/hooks';
7
7
  import * as _orderly_network_i18n from '@orderly.network/i18n';
8
- import { LocaleContextState } from '@orderly.network/i18n';
8
+ import { LanguageContextState } from '@orderly.network/i18n';
9
9
  import { useAnnouncement } from '@orderly.network/ui-notification';
10
10
 
11
11
  type AccountMenuProps = {
@@ -133,7 +133,12 @@ type LeftNavProps = {
133
133
  telegramUrl?: string;
134
134
  discordUrl?: string;
135
135
  duneUrl?: string;
136
+ /**
137
+ * @deprecated Deprecated. This prop will no longer affect the rendered UI
138
+ * in the leftNav drawer footer. Use `customFooter` instead.
139
+ */
136
140
  feedbackUrl?: string;
141
+ customFooter?: ReactNode;
137
142
  customLeftNav?: ReactNode;
138
143
  };
139
144
  type LeftNavItem = {
@@ -487,7 +492,7 @@ type MainLogoProps = {
487
492
  declare const MainLogo: FC<MainLogoProps>;
488
493
 
489
494
  type LanguageSwitcherScriptReturn = ReturnType<typeof useLanguageSwitcherScript>;
490
- type LanguageSwitcherScriptOptions = Pick<LocaleContextState, "popup"> & {
495
+ type LanguageSwitcherScriptOptions = Pick<LanguageContextState, "popup"> & {
491
496
  open?: boolean;
492
497
  onOpenChange?: (open: boolean) => void;
493
498
  };
package/dist/index.d.ts CHANGED
@@ -5,7 +5,7 @@ import react__default, { HTMLAttributeAnchorTarget, ReactNode, FC, PropsWithChil
5
5
  import * as react_jsx_runtime from 'react/jsx-runtime';
6
6
  import { WsNetworkStatus } from '@orderly.network/hooks';
7
7
  import * as _orderly_network_i18n from '@orderly.network/i18n';
8
- import { LocaleContextState } from '@orderly.network/i18n';
8
+ import { LanguageContextState } from '@orderly.network/i18n';
9
9
  import { useAnnouncement } from '@orderly.network/ui-notification';
10
10
 
11
11
  type AccountMenuProps = {
@@ -133,7 +133,12 @@ type LeftNavProps = {
133
133
  telegramUrl?: string;
134
134
  discordUrl?: string;
135
135
  duneUrl?: string;
136
+ /**
137
+ * @deprecated Deprecated. This prop will no longer affect the rendered UI
138
+ * in the leftNav drawer footer. Use `customFooter` instead.
139
+ */
136
140
  feedbackUrl?: string;
141
+ customFooter?: ReactNode;
137
142
  customLeftNav?: ReactNode;
138
143
  };
139
144
  type LeftNavItem = {
@@ -487,7 +492,7 @@ type MainLogoProps = {
487
492
  declare const MainLogo: FC<MainLogoProps>;
488
493
 
489
494
  type LanguageSwitcherScriptReturn = ReturnType<typeof useLanguageSwitcherScript>;
490
- type LanguageSwitcherScriptOptions = Pick<LocaleContextState, "popup"> & {
495
+ type LanguageSwitcherScriptOptions = Pick<LanguageContextState, "popup"> & {
491
496
  open?: boolean;
492
497
  onOpenChange?: (open: boolean) => void;
493
498
  };