Chikoo's Blog

📋 属性 (Properties)

🖥️ 窗口与显示

• title (str) – 窗口标题。

• route (str) – 当前 URL 路由。

• bgcolor (str) – 页面背景色。

• padding (PaddingValue) – 页面内边距。

• spacing (float) – 子控件间距。

• scroll (ScrollMode) – 滚动模式。

• vertical_alignment (MainAxisAlignment) – 垂直对齐。

• horizontal_alignment (CrossAxisAlignment) – 水平对齐。

• theme_mode (ThemeMode) – 主题模式（SYSTEM/LIGHT/DARK）。

• theme (Theme) – 亮色主题配置。

• dark_theme (Theme) – 暗色主题配置。

• window (Window) – 桌面端原生窗口控制。

• locale_configuration (LocaleConfiguration) – 国际化区域设置。

📡 运行时环境 (只读)

• web (bool) – 是否运行在浏览器中。

• pwa (bool) – 是否为 PWA 模式。

• wasm (bool) – 是否为 WebAssembly 模式。

• pyodide (bool) – 是否在 Pyodide 中运行。

• debug (bool) – Flutter 客户端是否处于调试模式。

• platform (PagePlatform) – 操作系统平台。

• platform_brightness (Brightness) – 系统亮度模式。

• client_ip (str) – Web端客户端 IP。

• client_user_agent (str) – Web端浏览器 User Agent。

• url (str) – Web端当前完整 URL。

• query (dict) – Web端 URL 查询参数。

• auth – OAuth 授权上下文。

🧩 高级功能

• fonts (dict) – 自定义字体映射。

• pubsub (PubSub) – 跨会话/用户通信客户端。

• session (Session) – 当前会话对象。

• executor – 线程池执行器。

• loop – 事件循环对象。

• multi_view (bool) – 是否启用多视图（多窗口）。

• multi_views (list) – 桌面端多视图列表。

• media (MediaQueryData) – 屏幕尺寸、像素密度等媒体信息。

⚙️ 方法 (Methods)

🎨 核心渲染

• add(control): 添加控件到页面。

• update(): 将待处理的状态更改推送到客户端。

• schedule_update(): 将页面排队以进行延迟的批处理更新。

• clean(): 清空页面所有控件。

• remove(control): 移除指定控件。

• get_control(id): 通过 ID 获取控件实例。

🧭 导航与路由

• go(route): 导航到新路由（自动触发 on_route_change 并调用 update()）。

• push_route(route): 将新路由推送到浏览器历史堆栈。

• can_launch_url(url): 检查 URL 是否可由设备处理。

• launch_url(url): 在浏览器或弹窗中打开 URL。

• close_in_app_web_view(): 关闭应用内浏览器。

🪟 桌面与设备

• close(): 关闭当前会话/页面窗口。

• set_allowed_device_orientations(): 限制移动端屏幕旋转方向。

• get_device_info(): 获取设备详细信息。

🔐 OAuth 与存储

• login(provider): 启动 OAuth 登录流程。

• logout(): 清除当前认证上下文。

• get_upload_url(file_path): 生成内置上传存储的预签名 URL。

📡 事件 (Events)

🧭 导航事件

• on_route_change: 最常用。URL 路由变化时触发（URL 编辑或前进/后退）。

• on_view_pop: 用户点击 AppBar 返回按钮时触发。

⌨️ 交互事件

• on_keyboard_event: 键盘按键事件。

• on_error: 未捕获异常发生时触发。

• on_close: 会话超时或即将断开时触发。

📱 应用状态事件

• on_app_lifecycle_state_change: App 生命周期状态变化（前后台切换）。

• on_platform_brightness_change: 系统明暗主题切换时触发。

• on_locale_change: 系统语言/区域设置变化时触发。

🌐 Web 与多视图

• on_connect: Web端客户端重新连接时触发。

• on_disconnect: Web端客户端断开连接时触发。

• on_login: OAuth 授权完成时触发（成功或失败）。

• on_logout: logout() 调用后触发。

• on_multi_view_add / on_multi_view_remove: 桌面端多窗口添加/移除时触发。