super-browser-window-kit/README.zh.md

Super toolkit for enhanced Electron BrowserWindow with rounded corners and macOS liquid glass effects

[![en](https://img.shields.io/badge/lang-en-red.svg)](README.md)
[![ja](https://img.shields.io/badge/lang-ja-blue.svg)](README.ja.md)
[![ko](https://img.shields.io/badge/lang-ko-yellow.svg)](README.ko.md)
[![zh-cn](https://img.shields.io/badge/lang-zh--cn-green.svg)](README.zh.md)

# super-browser-window-kit

高保真 macOS Tahoe 工具包，专为 Electron BrowserWindow 设计。

🏠 **官网**: [https://bytemyth.com/super-browser-window-kit](https://bytemyth.com/super-browser-window-kit)

## 项目简介

为 Electron 应用带来现代的原生 macOS 窗口视觉效果。

## 截图

![Super Browser Window Kit Screenshot](https://raw.githubusercontent.com/gaodeng/super-browser-window-kit-example/main/docs/screenshot.png)

## 安装

```bash
npm install super-browser-window-kit
```

## 快速使用

### 窗口圆角效果

轻松为 Electron BrowserWindow 启用美观、原生风格的圆角效果，让您的应用在 macOS
上更贴合系统美学，提升整体质感。只需在窗口创建后调用相关
API，即可自定义圆角半径。

```js
import { app, BrowserWindow } from "electron";
import SuperBrowserWindowKit, { AutoresizingMask, GlassMaterialVariant } from "super-browser-window-kit";

/**
 * =====================[ 许可证声明 ]=====================
 * 此许可证码仅在 com.github.Electron 测试环境有效，正式环境下无效。
 * 正式发布请获取商业授权。
 *
 * 官网: https://bytemyth.com/super-browser-window-kit
 * 联系方式: hi@bytemyth.com
 * =======================================================
 */
const LICENSE_CODE =
  "GCAYQ-ASCAG-Q76KA-ELXLU-HN8CV-3ZK8P-STALL-QLSVZ-9FFSX-3S2ZU-4QVSC-LLJ7U-KH6K7-G88HA-4TTDJ-58G9H-GZFY6-DDSDJ-L5ZB9-V7UMB-896CS-P9AVC-GULAB-EEAGQ-T77DP-DRBJN-G829M-ZZF9M-L2VEN-RZM8F-SQ4KW-3JLLB-MUVXP-TS3P8-7ZFZM-4L2P3-S4TTA-Z7EVY-Z5H9J-FYDUS-WQCYW-C92PZ-BB23J-QZEVP-QNQ";
app.whenReady().then(() => {
  const win = new BrowserWindow({
    width: 1000,
    height: 700,
    titleBarStyle: "hiddenInset",
    show: false,
  });
  win.loadFile("index.html");
  SuperBrowserWindowKit.setLicense(LICENSE_CODE);
  SuperBrowserWindowKit.enableWindowCornerCustomization();
  SuperBrowserWindowKit.setWindowCornerRadius(win.getNativeWindowHandle(), 26);
  win.show();
});
```

## 主要 API

```ts
// 窗口圆角
enableWindowCornerCustomization(): boolean;
setWindowCornerRadius(handle: Buffer, radius: number): boolean;
disableWindowCornerCustomization(): boolean;

// 背景视图
addBackgroundView(handle: Buffer, options?: BackgroundOptions): number;
setBackgroundCornerRadius(handle: Buffer, id: number, cornerRadius: number): void;
setBackgroundColor(handle: Buffer, id: number, color: string | { light: string; dark: string }): void;

// 玻璃视图
addGlassEffectView(handle: Buffer, options?: GlassOptions): number;
setGlassCornerRadius(handle: Buffer, id: number, cornerRadius: number): void;
setGlassColor(handle: Buffer, id: number, color: string | { light: string; dark: string }): void;
setVariant(handle: Buffer, id: number, variant: GlassMaterialVariant): void;

// 视图通用
removeView(handle: Buffer, id: number): boolean;
setAutoresizingMask(handle: Buffer, id: number, mask: AutoresizingMask | number): boolean;
getFrame(handle: Buffer, id: number): GlassFrame | null;
updateFrame(handle: Buffer, id: number, options: { x?: number; y?: number; width?: number; height?: number }): boolean;

// 全屏通知
setFullScreenNotificationListener(handle: Buffer, callback: FullScreenNotificationCallback): boolean;
removeFullScreenNotificationListener(handle: Buffer): boolean;
```

## 示例

- `dist-examples/main.js`：窗口圆角和侧边栏布局示例

## 作者

bytemyth 团队

## 许可证

Copyright (c) 2025 bytemyth 团队. All rights reserved.

这是专有软件。您可以将其用于评估和测试目的。

如需在生产环境中商业使用，请访问 [https://bytemyth.com/super-browser-window-kit](https://bytemyth.com/super-browser-window-kit) 或携带公司/团队信息联系 hi@bytemyth.com 获取商业许可。