Skip to content

configureLaunchScreen

配置 iOS 启动屏,自动生成和配置启动屏图片。

前置依赖

依赖参数

参数名类型说明
deps.existsSyncFileSystem['existsSync']检查文件是否存在
deps.readFileSyncFileSystem['readFileSync']读取文件内容
deps.writeFileSyncFileSystem['writeFileSync']写入文件内容
deps.mkdirSyncFileSystem['mkdirSync']创建目录
deps.joinPath['join']路径拼接
deps.dirnamePath['dirname']获取目录名
deps.sharpSharpSharp 图像处理函数

环境要求

  • Node.js 环境: 需要文件系统、路径等 Node.js API
  • sharp: 图像处理库
bash
npm install sharp

函数签名

typescript
function configureLaunchScreen(
  projectPath: string,
  projectName: string,
  launchImagePath: string,
  deps: ConfigureLaunchScreenDeps
): Promise<ConfigureLaunchScreenResult>

参数

参数名类型必填说明
projectPathstringiOS 项目路径
projectNamestring项目名称(如 'HBuilder-Hello')
launchImagePathstring启动屏图片路径
depsConfigureLaunchScreenDeps依赖函数对象

返回值

类型说明
Promise<ConfigureLaunchScreenResult>配置结果,包含成功状态、错误信息和日志

工作原理

  1. 读取启动屏图片 - 读取指定的启动屏图片
  2. 生成不同尺寸 - 使用 Sharp 生成不同设备尺寸的启动屏图片
  3. 配置 LaunchScreen - 更新 LaunchScreen.storyboard 或 LaunchImage 配置
  4. 复制图片资源 - 将生成的图片复制到项目中

注意事项

  • 需要在 macOS 环境下运行
  • 需要提供高质量的启动屏图片源文件
  • 支持 iPhone 和 iPad 的不同尺寸