OpenHarmony/HarmonyOS开发案例 | 应用配色随系统深浅模式自动切换

实现思路

本文介绍三种不同的方法,让应用能够自如地适配系统的深浅模式:

  • 利用系统颜色资源:这种方法最简单,只需要在应用中引用系统提供的颜色资源,例如ohos_id_color_backgroundohos_id_color_primary等,就可以让应用自动跟随系统的颜色设置变化。
  • 使用限定词目录:这种方法稍微复杂一些,需要在应用中创建不同的限定词目录,例如resources/darkresources/light等,来表示不同的应用场景,然后在每个目录下定义不同资源,来适配不同的模式。最后,在应用中只需要引用这些资源的名称,而不需要指定具体的目录,系统会根据当前的模式自动选择合适的资源。
  • 订阅系统环境变量变化:这种方法最灵活,但也最复杂。它需要在应用中监听系统环境变量的变化,并在变化发生时调用相应的函数来处理。这样,可以在函数中实现任何想要的逻辑,来改变应用外观。

开发步骤

新建一个Empty Ability工程,创建一个仅含"Hello World"页面的新应用。

方式一:系统资源

为了方便不同的开发者快速构建应用,OpenHarmony提供了一套系统资源供开发者直接使用。如果在UI组件中指定颜色属性为系统颜色ID,那么应用就可以自动适配系统深/浅模式,无需额外的工作。

开发者可以使用“$r('sys.type.resource_id')”语法来引用系统资源。其中,sys表示这是一个系统资源,type表示资源的类型,可以是“color”、“string”、“media”等,resource_id表示资源的ID,例如“ohos_id_color_background”、“ohos_id_color_primary”等。

可以查看官方指南中应用UX设计中关于资源的介绍,了解OpenHarmony支持的所有系统资源ID以及它们在不同模式和设备中的具体取值。

完整代码:

@Entry
@Component
struct Index {
    
    
  @State message: string = 'Hello World'

  build() {
    
    
    Row() {
    
    
      Column() {
    
    
        Text(this.message)
          .fontSize(50)
          .fontWeight(FontWeight.Bold)
          // 引入系统资源颜色设置文字颜色
          .fontColor($r('sys.color.ohos_id_color_text_primary'))
      }
      .width('100%')
    }
    // 引入系统资源颜色设置应用背景颜色
    .backgroundColor($r('sys.color.ohos_id_color_sub_background'))
    .height('100%')
  }
}

方式二:限定词目录

为了让应用能够适配系统的深浅模式,我们可以创建一个特殊的Color Mode类型资源目录resources/dark,来存放适用于深色模式的资源。当系统处于深色模式时,应用就会优先读取这个目录下的资源。如果没有找到对应的资源,应用会使用默认的resources/base目录下的资源。

除了Color Mode类型之外,还有很多其他类型的限定词,它们可以根据不同的设备和环境来提供不同的资源。例如,可以使用移动国家码和移动网络码来区分不同地区的运营商,使用语言和文字来区分不同语言和方言,使用横竖屏来区分不同方向的布局,使用设备类型来区分不同大小和形状的设备,使用屏幕密度来区分不同分辨率和像素密度的屏幕等。每种限定词都有一套固定的格式和命名规则,需要遵循这些规则来创建合法的资源目录。同时,每种限定词也有一个相对的优先级顺序,系统会根据这个顺序在多个匹配的资源目录中选择最佳的一个。如果想了解更多关于限定词的信息,可以查看资源分类

img

我们为新增的resources/dark/element目录,创建color.json文件。新建颜色ID并赋予具体色值,bg_color为黑色,txt_color为白色。

{
    
    
  "color": [
    {
    
    
      "name": "bg_color",
      "value": "#000000"
    },
    {
    
    
      "name": "txt_color",
      "value": "#c6c6c6"
    }
  ]
}

在resources/base/element/color.json,同样创建这两个颜色ID并赋予不同的色值,bg_color为白色,txt_color为黑色。

{
    
    
  "color": [
    {
    
    
      "name": "start_window_background",
      "value": "#FFFFFF"
    },
    {
    
    
      "name": "bg_color",
      "value": "#f1f3f5"
    },
    {
    
    
      "name": "txt_color",
      "value": "#121212"
    }
  ]
}

设置组件属性为我们创建的颜色ID,此时,我们的应用在深色模式下取用ID在dark目录下对应的色值,其他情况下会使用base目录下对应的色值。

完整代码:

@Entry
@Component
struct Index {
    
    
  @State message: string = 'Hello World'

  build() {
    
    
    Row() {
    
    
      Column() {
    
    
        Text(this.message)
          .fontSize(50)
          .fontWeight(FontWeight.Bold)
          .fontColor($r('app.color.txt_color'))
      }
      .width('100%')
    }
    .backgroundColor($r('app.color.bg_color'))
    .height('100%')
  }
}

方式三:订阅系统环境变量

系统配置更新时会调用onConfigurationUpdate,我们可以获取系统配置信息中ColorMode(系统深浅模式)属性,再使用AppStorage存储系统深浅模式状态, 使用@StorageProp建立AppStorage和自定义组件的单向数据同步,通过@Watch监听状态变量变化并创建回调方法,在状态变量改变时修改颜色变量值,从而实现应用配色随系统深浅模式自动切换。

1.在AbilityStage的onCreate()生命周期中获取当前的颜色模式并保存到AppStorage。

  onCreate(want, launchParam) {
    
    
    AppStorage.SetOrCreate('currentColorMode', this.context.config.colorMode);
  }

2.在AbilityStage的onConfigurationUpdate()生命周期中获取最新变更的颜色模式并刷新到AppStorage。

  onConfigurationUpdate(newConfig: Configuration): void {
    
    
    AppStorage.SetOrCreate('currentColorMode', newConfig.colorMode);
  }

3.在UI Page中通过@StorageProp + @Watch方式获取当前最新深浅模式并监听设备深浅模式变化。

  @StorageProp('currentColorMode') @Watch('onColorModeChange') currentMode: number

// 深浅模式枚举值如下
// export enum ColorMode {
    
    
//     COLOR_MODE_NOT_SET = -1,
//     COLOR_MODE_DARK = 0,
//     COLOR_MODE_LIGHT = 1
// }

4.创建UI状态变量,设置组件颜色属性为该状态变量。

  @State color_txt: string = ''
  @State color_bg: string = ''

  build() {
    
    
    Row() {
    
    
      Column() {
    
    
        Text(this.message)
          .fontSize(50)
          .fontWeight(FontWeight.Bold)
          .fontColor(this.color_txt)
      }
      .width('100%')
    }
    .height('100%')
    .backgroundColor(this.color_bg)
  }

5.在@Watch回调函数中执行自定义的适配逻辑。

  onColorModeChange(): void {
    
    
    if (this.currentMode === ConfigurationConstant.ColorMode.COLOR_MODE_LIGHT) {
    
    
      this.color_txt = '#121212'
      this.color_bg = '#f1f3f5'
    } else {
    
    
      this.color_txt = '#c6c6c6'
      this.color_bg = '#000000'
    }
  }

6.@Watch装饰器装饰的方法,在第一次初始化的时候不会被调用。只有在后续状态改变时,才会调用@Watch回调方法。所以在第一次初始化时需要根据currentMode的值做一次逻辑适配,具体内容与onColorModeChange保持一致。

  aboutToAppear() {
    
    
    if (this.currentMode === ConfigurationConstant.ColorMode.COLOR_MODE_LIGHT) {
    
    
      this.color_txt = '#121212'
      this.color_bg = '#f1f3f5'
    } else {
    
    
      this.color_txt = '#c6c6c6'
      this.color_bg = '#000000'
    }
  }

在本例中,我们在监听到深浅模式变化后对两个UI状态变量进行控制,从而刷新对应的UI效果。切换深色模式后,文字和背景颜色将会变化。实际开发过程中,应用可根据自己的场景进行扩展,执行自己的自定义适配逻辑。

完整代码:

// index.ets
import ConfigurationConstant from '@ohos.app.ability.ConfigurationConstant';
@Entry
@Component
struct Index {
    
    
  @State message: string = 'Hello World'
  @State color_txt: string = ''
  @State color_bg: string = ''
  @StorageProp('currentColorMode') @Watch('onColorModeChange') currentMode: number = 1;

  build() {
    
    
    Row() {
    
    
      Column() {
    
    
        Text(this.message)
          .fontSize(50)
          .fontWeight(FontWeight.Bold)
          .fontColor(this.color_txt)
      }
      .width('100%')
    }
    .height('100%')
    .backgroundColor(this.color_bg)
  }

  aboutToAppear() {
    
    
    if (this.currentMode === ConfigurationConstant.ColorMode.COLOR_MODE_LIGHT) {
    
    
      this.color_txt = '#121212'
      this.color_bg = '#f1f3f5'
    } else {
    
    
      this.color_txt = '#c6c6c6'
      this.color_bg = '#000000'
    }
  }

  onColorModeChange(): void {
    
    
    if (this.currentMode === ConfigurationConstant.ColorMode.COLOR_MODE_LIGHT) {
    
    
      this.color_txt = '#121212'
      this.color_bg = '#f1f3f5'
    } else {
    
    
      this.color_txt = '#c6c6c6'
      this.color_bg = '#000000'
    }
  }
}

// EntryAbility.ts
import UIAbility from '@ohos.app.ability.UIAbility';
import window from '@ohos.window';
import {
    
     Configuration } from '@ohos.app.ability.Configuration';

export default class EntryAbility extends UIAbility {
    
    
  onCreate(want, launchParam) {
    
    
    AppStorage.SetOrCreate('currentColorMode', this.context.config.colorMode);
  }

  onWindowStageCreate(windowStage: window.WindowStage) {
    
    
    windowStage.loadContent('pages/Index', (err, data) => {
    
    
    });
  }

  onConfigurationUpdate(newConfig: Configuration): void {
    
    
    AppStorage.SetOrCreate('currentColorMode', newConfig.colorMode);
  }
}

猜你喜欢

转载自blog.csdn.net/qq_39132095/article/details/132939579
今日推荐