electron/chrome-rail.d.mts

Rama main · réplica de lectura del repositorio original.

export declare const CHROME_RAIL_WIDTH: number;
export declare const CHROME_RAIL_PATH: string;
export declare const RAIL_OFFER_GRACE_MS: number;
/** What the page beside the window's rail knows of it: whether this window has one (two places or more) and whether the
 * person hid it. Never the places on it. */
export interface ChromeRailState { available: boolean; hidden: boolean }
/** `window.ogb.rail`. The page beside the rail offers the button that hides and shows it: `state()` from a document is
 * that offer, and main hides the rail only beside a document that made it. `drawsFrame()` from a document says it draws
 * the window's frame, so main puts the traffic lights in its top bar; `drawsFrame(false)`, that it draws none (the
 * person turned the frame off), so they go back at once. `expand`, `onSkin` and `onFramed` are the rail's
 * own page's, on this app's pages only. Each is absent on an older app. */
export interface ChromeRailBridge {
  state?(): Promise<ChromeRailState>;
  drawsFrame?(drawn?: boolean): Promise<void>;
  /** From the person's click. */
  setHidden?(hidden: boolean): Promise<ChromeRailState>;
  onState?(callback: (state: ChromeRailState) => void): () => void;
  expand?(on: boolean): Promise<void>;
  onSkin?(callback: (skin: string) => void): () => void;
  /** Whether the page beside the rail draws the window's frame, as main hears it. */
  onFramed?(callback: (framed: boolean) => void): () => void;
}
export interface ChromeRail {
  attach(window: unknown): void;
  refresh(): void;
  holdOpen(on: boolean): void;
  expand(on: boolean): void;
  owns(event: unknown): boolean;
  shown(): boolean;
  framed(): boolean;
  expanded(): boolean;
  send(channel: string, ...values: unknown[]): void;
  install(ipcMain: { handle(channel: string, handler: (...args: any[]) => unknown): void }): void;
}
export declare function createChromeRail(deps: {
  createView: (options: object) => any;
  preload: string;
  args: () => string[];
  url: () => string;
  wanted: () => boolean;
  prefs?: () => { railHidden(): boolean; setRailHidden(hidden: boolean): void; windowFrame?(): boolean } | null;
  changed?: () => void;
  log?: (line: string) => void;
}): ChromeRail;