@luxalgo/vela 0.8.5 → 0.9.1

package/dist/widget.d.cts

@@ -1,12 +1,13 @@
-import { V as Vela, W as WidgetContext, a1 as SidePanelButton } from './contributions-D8xuYc9U.cjs';
-export { C as CellStateContext, i as ContextMenuPointer, aJ as DEFAULT_PANEL_ORDER, E as ExternalIndicatorEntry, O as OVERRIDABLE_TOPBAR_IDS, a2 as SidePanelDescriptor, a3 as SidePanelHandle, a5 as StatePersistenceHandler, a9 as SymbolRankingHook, ad as WidgetActionDescriptor, ae as WidgetActionTarget, af as WidgetAttachment, ap as registerSidePanel, aq as registerStatePersistence, ar as registerSymbolRanking, as as registerWidgetAction, at as registerWidgetAttachment, av as sidePanels, aw as statePersistenceHandlers, ax as symbolRanking, ay as topbarActionOverride, aD as unregisterSidePanel, aE as unregisterStatePersistence, aF as unregisterWidgetAction, aG as unregisterWidgetAttachment, aH as widgetActions, aI as widgetAttachments } from './contributions-D8xuYc9U.cjs';
-import { b as VelaOptions, d as MarketSession, T as ThemeName, c as VelaTheme, v as DataWindowReadout } from './options-BI5Tp32b.cjs';
-import { c as VelaShellOptions, W as WidgetHistory, b as RangePreset, f as WorkspaceState, j as TopbarComposition, a as StatuslinePart, P as PanelsState } from './statusline-model-CTwtDIca.cjs';
-export { B as Bottombar, k as BottombarOptions, C as CellState, g as ChartState, D as DrawingToolsState, I as IndicatorLoader, l as IndicatorManifest, m as IndicatorManifestEntry, n as RANGE_PRESETS, R as ResolvedIndicator, o as ResolvedTopbarComposition, p as TOPBAR_BUILTIN_IDS, q as TOPBAR_DEFAULT_LEFT, r as TOPBAR_DEFAULT_RIGHT, V as VelaStorage, t as WidgetStorage, h as decodeState, i as encodeState, u as localStorageAdapter, v as pinnedTopbarActionIds, w as resolveIndicators, x as resolveTopbarComposition, s as sanitizeState, y as topbarHas } from './statusline-model-CTwtDIca.cjs';
-import { K as KeymapManager } from './keymap-CGOz5F5f.cjs';
-import { a as SymbolDescriptor } from './DataProvider-DdqMxKdl.cjs';
-import { d as SidePanel } from './side-panel-_2UK1gSm.cjs';
-export { C as CONTEXT_MENU_BUILTIN_ORDER, D as DEFAULT_PANEL_MAX_WIDTH, a as DEFAULT_PANEL_MIN_WIDTH, b as DEFAULT_PANEL_WIDTH, S as SidePanelOptions, c as clampPanelWidth } from './side-panel-_2UK1gSm.cjs';
+import { V as Vela, W as WidgetContext, a1 as SidePanelButton } from './contributions-DupwEkzc.cjs';
+export { C as CellStateContext, i as ContextMenuPointer, aJ as DEFAULT_PANEL_ORDER, E as ExternalIndicatorEntry, O as OVERRIDABLE_TOPBAR_IDS, a2 as SidePanelDescriptor, a3 as SidePanelHandle, a5 as StatePersistenceHandler, a9 as SymbolRankingHook, ad as WidgetActionDescriptor, ae as WidgetActionTarget, af as WidgetAttachment, ap as registerSidePanel, aq as registerStatePersistence, ar as registerSymbolRanking, as as registerWidgetAction, at as registerWidgetAttachment, av as sidePanels, aw as statePersistenceHandlers, ax as symbolRanking, ay as topbarActionOverride, aD as unregisterSidePanel, aE as unregisterStatePersistence, aF as unregisterWidgetAction, aG as unregisterWidgetAttachment, aH as widgetActions, aI as widgetAttachments } from './contributions-DupwEkzc.cjs';
+import { b as VelaOptions, d as MarketSession, T as ThemeName, c as VelaTheme, w as DataWindowReadout } from './options-I1H2HDWw.cjs';
+import { c as VelaShellOptions, W as WidgetHistory, b as RangePreset, f as WorkspaceState, j as TopbarComposition, a as StatuslinePart, P as PanelsState } from './statusline-model-PHt0YhmI.cjs';
+export { B as Bottombar, k as BottombarOptions, C as CellState, g as ChartState, D as DrawingToolsState, I as IndicatorLoader, l as IndicatorManifest, m as IndicatorManifestEntry, n as RANGE_PRESETS, R as ResolvedIndicator, o as ResolvedTopbarComposition, p as TOPBAR_BUILTIN_IDS, q as TOPBAR_DEFAULT_LEFT, r as TOPBAR_DEFAULT_RIGHT, V as VelaStorage, t as WidgetStorage, h as decodeState, i as encodeState, u as localStorageAdapter, v as pinnedTopbarActionIds, w as resolveIndicators, x as resolveTopbarComposition, s as sanitizeState, y as topbarHas } from './statusline-model-PHt0YhmI.cjs';
+import { K as KeymapManager } from './keymap-W0hiajU6.cjs';
+import { T as Translator, b as LocalizationOptions, c as LocaleChangedEvent, M as MessageLike, i as MessageDescriptor } from './types-Bwf63xGI.cjs';
+import { a as SymbolDescriptor } from './DataProvider-B5i0_yY4.cjs';
+import { d as SidePanel } from './side-panel-BEQJqSjR.cjs';
+export { C as CONTEXT_MENU_BUILTIN_ORDER, D as DEFAULT_PANEL_MAX_WIDTH, a as DEFAULT_PANEL_MIN_WIDTH, b as DEFAULT_PANEL_WIDTH, S as SidePanelOptions, c as clampPanelWidth } from './side-panel-BEQJqSjR.cjs';
 
 interface VelaWidgetOptions extends VelaOptions, VelaShellOptions {
     /** @deprecated No longer supported — the option is ignored (a console warning
@@ -41,13 +42,18 @@ declare class VelaWidget {
     setIndicatorValuesVisible(visible: boolean): void;
     setTheme(theme: ThemeName | VelaTheme): void;
     setTimezone(zone: string): void;
+    /** The widget's translator (see `VelaWorkspace.i18n`). */
+    get i18n(): Translator;
+    /** Change the language, direction or formatting at runtime (see `VelaWorkspace.setLocale`). */
+    setLocale(next: string | LocalizationOptions): void;
     applyRange(preset: RangePreset): void;
     /** The unified state document (`layout: '1'`, one cell). */
     getState(): WorkspaceState;
     /** Restore a state document IN PLACE — the chart instance survives. */
     applyState(state: unknown): void;
-    /** Subscribe to `state:changed` (the only widget event — unknown names no-op). */
+    /** Subscribe to `state:changed` or `locale:changed` (unknown names no-op). */
     on(event: 'state:changed', handler: () => void): () => void;
+    on(event: 'locale:changed', handler: (payload: LocaleChangedEvent) => void): () => void;
     destroy(): void;
 }
 
@@ -57,7 +63,8 @@ type LayoutPickerShape = {
     cols: number;
 };
 
-declare function priceStyleLabel(id: string): string;
+/** A price style's name, in `i18n`'s language (English without one). */
+declare function priceStyleLabel(id: string, i18n?: Translator | null): string;
 interface TopbarOptions {
     symbol: string;
     onSymbolClick?: () => void;
@@ -112,6 +119,8 @@ interface TopbarOptions {
      *  The shell that owns this bar also gates the matching mobile entries and
      *  keyboard chords on the same composition — the bar only handles its own DOM. */
     composition?: TopbarComposition;
+    /** The shell's translator (labels, tooltips, menus). Absent: English. */
+    i18n?: Translator;
 }
 declare class Topbar {
     readonly el: HTMLElement;
@@ -160,6 +169,10 @@ declare class Topbar {
     private readonly onHairlineSync;
     private hairlineRo;
     private hairlineRaf;
+    /** Re-apply each fixed label in the current language (see {@link relocalize}). */
+    private readonly relabels;
+    private get i18n();
+    private t;
     constructor(host: HTMLElement, opts: TopbarOptions);
     setSymbol(symbol: string): void;
     setTimeframe(tf: string): void;
@@ -193,6 +206,10 @@ declare class Topbar {
     destroy(): void;
     /** One icon-only tool button with its kit tooltip, parked in `sink` for disposal. */
     private toolButton;
+    /** A kit tooltip whose text follows the language. */
+    private labeledTooltip;
+    /** Re-read every label, tooltip and menu in the current language. */
+    relocalize(): void;
     /** Paint each `.vela-sep` as exactly one device pixel, snapped to the pixel grid. */
     private syncHairlines;
     private tfItems;
@@ -271,6 +288,10 @@ declare class Statusline {
     private fitKey;
     /** Web fonts landing after the last fit change every width without a resize. */
     private readonly onFontsLoaded;
+    /** The bound chart's translator (English until {@link onChart}). */
+    private i18n;
+    private meta;
+    private t;
     constructor(host: HTMLElement, symbol: string, 
     /** The avatar's icon URL for a raw symbol — the shell routes it to the owning
      *  provider's `resolveSymbolIcon`. Absent ⇒ the initials badge. */
@@ -308,6 +329,8 @@ declare class Statusline {
     }) => boolean) | null, readout?: StatuslineReadout): void;
     /** The "· BINANCE · 1h" segment after the symbol — venue first, then resolution. */
     setMeta(timeframe: string, provider: string): void;
+    /** Re-read every label and value in the chart's language. */
+    relocalize(): void;
     /** Dress the market badge for a session state: its icon, tinted circle, and the
      *  hover label. Callers with no session model leave the constructor's 'open'. */
     setMarketStatus(status: MarketStatus): void;
@@ -348,6 +371,7 @@ declare class Statusline {
 }
 
 declare class Watermark {
+    private readonly i18n;
     readonly el: HTMLElement;
     private readonly text;
     private readonly replayLine;
@@ -362,7 +386,11 @@ declare class Watermark {
      *  canvas, so the mark stays out of its way. Starts true: the FIRST `load:start`
      *  fires during chart construction, before any subscriber can see it. */
     private loading;
-    constructor(host: HTMLElement, symbol: string, timeframe: string);
+    private readonly replayText;
+    private symbol;
+    private timeframe;
+    /** `i18n` reads the chart's translator (absent: English). */
+    constructor(host: HTMLElement, symbol: string, timeframe: string, i18n?: () => Translator | null | undefined);
     setVisible(visible: boolean): void;
     /** Show/hide the replay line (the host's toggle); it only ever shows while replaying. */
     setReplayVisible(visible: boolean): void;
@@ -372,6 +400,8 @@ declare class Watermark {
     setLoading(loading: boolean): void;
     private sync;
     update(symbol: string, timeframe: string): void;
+    /** Re-read the mark and the replay line in the chart's language. */
+    relocalize(): void;
     /** Measure the text at the cap and shrink it to the price pane's width. */
     private fit;
     destroy(): void;
@@ -388,6 +418,8 @@ interface SymbolPickerOptions {
     /** The row's icon URL — routed to the descriptor's OWNING provider
      *  (`resolveSymbolIcon`). Absent or `undefined` per row ⇒ the initials badge. */
     iconFor?: (d: SymbolDescriptor) => string | undefined;
+    /** The shell's translator. Absent: English. */
+    i18n?: Translator;
 }
 declare class SymbolPicker {
     private readonly opts;
@@ -399,6 +431,7 @@ declare class SymbolPicker {
     private highlighted;
     private seed;
     private activeTab;
+    private readonly tabButtons;
     private tabs;
     private visible;
     /** The last filter pass returned fewer raw rows than asked — the pool is drained
@@ -434,6 +467,8 @@ declare class SymbolPicker {
      *  keystroke; an async hook resolves onto the next repaint (stale-while-revalidate
      *  in between, the raw pool before the first resolve). */
     private pool;
+    /** The dialog's fixed text in the shell's language, re-read on every open. */
+    relabel(): void;
     private computeRows;
     private refresh;
     /** Append the page the grown `visible` just uncovered — rows already on screen stay put. */
@@ -442,7 +477,12 @@ declare class SymbolPicker {
 }
 
 interface IndicatorRow {
+    /** The name the picker shows, in the shell's language. */
     name: string;
+    /** Other names search matches: the English name when {@link name} is a translation, and
+     *  the short title (`RSI`) in both languages. A reader of any language still finds an
+     *  indicator by the names its literature uses. */
+    aliases?: readonly string[];
     language?: string;
     category?: string;
     /** Core-computed (native) indicator — accent styling + 'native' routing. */
@@ -461,6 +501,8 @@ interface IndicatorPickerOptions {
     onRemove: (instanceIndex: number) => void;
     onOpenChange?: (open: boolean) => void;
     host?: HTMLElement;
+    /** The shell's translator. Absent: English. */
+    i18n?: Translator;
 }
 declare class IndicatorPicker {
     private readonly dialog;
@@ -470,6 +512,9 @@ declare class IndicatorPicker {
     private isOpen;
     constructor(opts: IndicatorPickerOptions);
     open(): void;
+    /** The dialog's fixed text in the shell's language, re-read on every open. */
+    relabel(): void;
+    private t;
     /** Re-render the lists if the dialog is open (async catalog updates land late). */
     sync(): void;
     close(): void;
@@ -481,12 +526,18 @@ interface TimeframeQuickOptions {
     onApply: (canonical: string) => void;
     onOpenChange?: (open: boolean) => void;
     host?: HTMLElement;
+    /** The shell's translator. Absent: English. */
+    i18n?: Translator;
 }
 declare class TimeframeQuick {
     private readonly dialog;
     private readonly input;
     private readonly hint;
+    private readonly i18n;
+    private t;
     constructor(opts: TimeframeQuickOptions);
+    /** The dialog's title in the shell's language, re-read on every open. */
+    relabel(): void;
     open(seed?: string): void;
     get isOpen(): boolean;
     /** Text typed at the entry that never reached its field: closed, it opens seeded
@@ -511,11 +562,13 @@ interface PanelDockDeps {
     context(): WidgetContext;
     /** The dock's persistable state changed (open panel, or a width). */
     changed?(): void;
+    /** The shell's translator (panel titles). Absent: English. */
+    i18n?: Translator;
 }
 /** A panel the SHELL owns and destroys — the dock only docks it. */
 interface BuiltInPanel {
     id: string;
-    title: string;
+    title: MessageLike;
     icon: string;
     order: number;
     panel: SidePanel;
@@ -552,6 +605,8 @@ declare class PanelDock {
     /** The docked panels in dock order — what a non-topbar chrome (the mobile
      *  three-dots drawer) lists so every panel stays reachable there too. */
     list(): ReadonlyArray<SidePanelButton>;
+    /** Re-read every panel's header and the toggle tooltips in the current language. */
+    relocalize(): void;
     /** The dock's persistable state, or null when there is nothing worth saving. */
     getState(): PanelsState | null;
     /**
@@ -608,7 +663,9 @@ declare class ObjectTree extends SidePanel {
     constructor(host: HTMLElement, 
     /** The price row's avatar icon URL for a raw symbol — routed by the shell to the
      *  owning provider's `resolveSymbolIcon`. Absent ⇒ the initials badge. */
-    iconFor?: ((symbol: string) => string | undefined) | undefined);
+    iconFor?: ((symbol: string) => string | undefined) | undefined, 
+    /** The shell's translator. Absent: English. */
+    i18n?: Translator);
     toggle(open?: boolean, instant?: boolean): void;
     setSymbol(symbol: string): void;
     /** (Re)bind to a chart instance — called after every widget rebuild. */
@@ -617,6 +674,7 @@ declare class ObjectTree extends SidePanel {
     private detach;
     /** Read the chart into the layout's input. Every chart query happens here, once a pass. */
     private snapshot;
+    relocalize(): void;
     /**
      * Repaint because something changed — unless the panel is mid-interaction. A live drag
      * resolves drops against the rows as currently rendered, and a rename lives in an input
@@ -742,15 +800,16 @@ interface DataWindowSection {
  * direction), then one section per indicator with a line per plot in the plot's own color.
  * Empty when the chart holds no bar to read.
  */
-declare function dataWindowSections(readout: DataWindowReadout): DataWindowSection[];
+declare function dataWindowSections(readout: DataWindowReadout, i18n?: Translator | null): DataWindowSection[];
 declare class DataWindow extends SidePanel {
     private chart;
     private unsubs;
-    constructor(host: HTMLElement);
+    constructor(host: HTMLElement, i18n?: Translator);
     toggle(open?: boolean, instant?: boolean): void;
     /** (Re)bind to a chart instance — called after every widget rebuild. */
     onChart(chart: Vela): void;
     destroy(): void;
+    relocalize(): void;
     private detach;
     private refresh;
 }
@@ -759,7 +818,9 @@ declare class ShortcutsHelp {
     private readonly dialog;
     private readonly list;
     private readonly keymap;
-    constructor(keymap: KeymapManager, host?: HTMLElement, onOpenChange?: (open: boolean) => void);
+    private readonly i18n;
+    /** `i18n` returns the shell's current translator; the panel reads it each time it opens. */
+    constructor(keymap: KeymapManager, host?: HTMLElement, onOpenChange?: (open: boolean) => void, i18n?: () => Translator);
     open(): void;
     close(): void;
     destroy(): void;
@@ -821,33 +882,46 @@ interface ParsedTimeframe {
     /** Compact chip ("3M"). */
     short?: string;
 }
-/** Parse a typed timeframe string. `valid` is false for empty/garbage input (count ≥ 1). */
-declare function parseTimeframe(text: string): ParsedTimeframe;
+/** Parse a typed timeframe string. `valid` is false for empty/garbage input (count ≥ 1).
+ *  The labels read in `i18n`'s language (English without one). */
+declare function parseTimeframe(text: string, i18n?: Translator | null): ParsedTimeframe;
 /** Duration in ms of an existing timeframe value (`1`, `60`, `4h`, `D`, `W`, …), NaN if unknown. */
 declare function timeframeMs(value: string): number;
-/** Compact display label for any timeframe value ("60" → "1h", "D" → "1D"). */
-declare function timeframeLabel(value: string): string;
+/** Compact display label for any timeframe value ("60" → "1h", "D" → "1D"), in `i18n`'s
+ *  language (English without one). */
+declare function timeframeLabel(value: string, i18n?: Translator | null): string;
 
 interface TimezoneEntry {
     value: string;
+    /** The place the zone is named after, in English. */
     label: string;
+    /** The same name as a message, for pickers in other languages. */
+    name: MessageDescriptor;
 }
 declare const TIMEZONES: readonly TimezoneEntry[];
 /** The renderer's config default is the bare `'UTC'` alias — fold it (and any other
  *  UTC spelling) onto the catalog's `'Etc/UTC'` so selection checks land on one entry. */
 declare function normalizeTimezone(zone: string): string;
-/** Current UTC offset of an IANA zone as `"UTC"`, `"UTC+2"` or `"UTC-9:30"`. */
+/** Current UTC offset of an IANA zone as `"UTC"`, `"UTC+2"` or `"UTC-9:30"`. The
+ *  formatter stays pinned to en-US whatever the chart's locale: the `GMT±h:mm` it emits is
+ *  PARSED below, and a localized one could spell the offset differently. */
 declare function tzOffset(zone: string, date?: Date): string;
-/** Dropdown row label — UTC omits the offset prefix. */
-declare function tzMenuLabel(zone: string, location: string): string;
+/** Dropdown row label — UTC omits the offset prefix. `location` is the zone's place name
+ *  as the picker shows it; `i18n` places the offset the way its language writes it. */
+declare function tzMenuLabel(zone: string, location: string, i18n?: Translator | null): string;
 /** Compact label for the bottom-bar button — just the offset ("UTC", "UTC+2", "UTC-9:30"). */
 declare function tzButtonLabel(zone: string): string;
 
 /** Sensible decimal count for a price magnitude (crypto-friendly). */
 declare function decimalsFor(ref: number): number;
-/** Locale-formatted price; `'—'` for null/non-finite. */
+/** Locale-formatted price; `'—'` for null/non-finite.
+ *  @deprecated English only. Format through the chart's translator:
+ *  `chart.i18n.format.price(n, { decimals, grouping: true, surface: 'statusLine' })`. */
 declare function fmtPrice(n: number | null | undefined, dp?: number): string;
-/** Signed change + percent ("+123.45 (+1.23%)") from open→close; `''` when unavailable. */
+/** Signed change + percent ("+123.45 (+1.23%)") from open→close; `''` when unavailable.
+ *  @deprecated English only. Compose it from the chart's translator:
+ *  `chart.i18n.format.price(diff, { decimals, grouping: true })` and
+ *  `chart.i18n.format.percent(pct)`. */
 declare function fmtChange(open: number | null | undefined, close: number | null | undefined): string;
 
 export { type BuiltInPanel, ChartContextMenu, type ContextMenuCallbacks, DataWindow, type DataWindowLine, type DataWindowSection, IndicatorPicker, type IndicatorPickerOptions, type IndicatorRow, ObjectTree, type PanelChrome, PanelDock, type PanelDockDeps, PanelsState, type ParsedTimeframe, RangePreset, ShortcutsHelp, SidePanel, SidePanelButton, Statusline, type StatuslineMenuHooks, StatuslinePart, SymbolPicker, type SymbolPickerOptions, TIMEZONES, TimeframeQuick, type TimeframeQuickOptions, type TimezoneEntry, Topbar, TopbarComposition, type TopbarOptions, VelaShellOptions, VelaWidget, type VelaWidgetOptions, Watermark, WidgetContext, WorkspaceState, dataWindowSections, decimalsFor, filterSymbols, fmtChange, fmtPrice, normalizeTimezone, parseTimeframe, priceStyleLabel, timeframeLabel, timeframeMs, tzButtonLabel, tzMenuLabel, tzOffset };