harmony 鸿蒙@ohos.font (注册自定义字体)

2025-06-12
浏览 (9)

@ohos.font (注册自定义字体)

本模块提供注册自定义字体。

说明

本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

本模块功能依赖UI的执行上下文，不可在UI上下文不明确的地方使用，参见UIContext说明。

导入模块

import { font } from '@kit.ArkUI';

font.registerFont^(deprecated)

registerFont(options: FontOptions): void

在字体管理中注册自定义字体。

说明：

从API version 18开始废弃，建议使用UIContext中的getFont获取Font实例，再通过此实例调用替代方法registerFont。

从API version 10开始，可以通过使用UIContext中的getFont方法获取当前UI上下文关联的Font对象。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	说明
options	FontOptions	是	注册的自定义字体信息。

FontOptions

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

名称	类型	必填	说明
familyName	string \|Resource¹⁰⁺	是	设置注册的字体名称。
familySrc	string \|Resource¹⁰⁺	是	设置注册字体文件的路径。

示例：

说明

直接使用font可能导致UI上下文不明确的问题，推荐通过使用UIContext中的getFont方法获取当前UI上下文关联的Font对象。

// xxx.ets
@Entry
@Component
struct FontExample {
  @State message: string = 'Hello World';
  // iconFont示例，假设0000为指定icon的Unicode，实际需要开发者从注册的iconFont的ttf文件里面获取Unicode
  @State unicode: string = '\u0000';
  @State codePoint: string = String.fromCharCode(0x0000);
  private uiContext: UIContext = this.getUIContext();

  aboutToAppear() {
    // familyName和familySrc都支持系统Resource
    this.uiContext.getFont().registerFont({
      // 建议使用 this.getUIContext().getFont().registerFont()接口
      familyName: $r('app.string.font_name'),
      familySrc: $r('app.string.font_src')
    })

    // familySrc支持RawFile
    this.uiContext.getFont().registerFont({
      familyName: 'mediumRawFile',
      familySrc: $rawfile('font/medium.ttf')
    })

    // 注册iconFont
    this.uiContext.getFont().registerFont({
      familyName: 'iconFont',
      familySrc: '/font/iconFont.ttf'
    })

    // familyName和familySrc都支持string
    this.uiContext.getFont().registerFont({
      familyName: 'medium',
      familySrc: '/font/medium.ttf' // font文件夹与pages目录同级
    })
  }

  build() {
    Column() {
      Text(this.message)
        .align(Alignment.Center)
        .fontSize(20)
        .fontFamily('medium') // medium：注册自定义字体的名字（$r('app.string.mediumFamilyName')、'mediumRawFile'等已注册字体也能正常使用）

      // 使用iconFont的两种方式
      Text(this.unicode)
        .align(Alignment.Center)
        .fontSize(20)
        .fontFamily('iconFont')
      Text(this.codePoint)
        .align(Alignment.Center)
        .fontSize(20)
        .fontFamily('iconFont')
    }.width('100%')
  }
}

说明：

应用若需全局使用自定义字体，请在EntryAbility.ets文件的onWindowStageCreate生命周期中，通过windowStage.loadContent回调注册。

在HSP工程中，不推荐采用相对路径的方式注册自定义字体，详见通过$r访问HSP中的资源。

font.getSystemFontList^(deprecated)

getSystemFontList(): Array<string>

获取风格字体列表。

说明：

从API version 10开始支持，从API version 18开始废弃，建议使用UIContext中的getFont获取Font实例，再通过此实例调用替代方法getSystemFontList。

从API version 10开始，可以通过使用UIContext中的getFont方法获取当前UI上下文关联的Font对象。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

返回值：

类型	说明
Array<string>	系统的字体名列表。

说明：

该接口仅在2in1和移动设备上生效。
为获取系统最新支持字体列表数据，推荐使用getSystemFontFullNamesByType接口。

示例：

说明

直接使用font可能导致UI上下文不明确的问题，推荐通过使用UIContext中的getFont方法获取当前UI上下文关联的Font对象。

// xxx.ets
import { font } from '@kit.ArkUI';

@Entry
@Component
struct FontExample {
  fontList: Array<string> = new Array<string>();

  build() {
    Column() {
      Button("getSystemFontList")
        .width('60%')
        .height('6%')
        .onClick(() => {
          this.fontList = font.getSystemFontList(); // 建议使用 this.getUIContext().getFont().getSystemFontList()接口
        })
    }.width('100%')
  }
}

font.getFontByName^(deprecated)

getFontByName(fontName: string): FontInfo

根据传入的系统字体名称获取系统字体的相关信息。

说明：

从API version 10开始支持，从API version 18开始废弃，建议使用UIContext中的getFont获取Font实例，再通过此实例调用替代方法getFontByName。

从API version 10开始，可以通过使用UIContext中的getFont方法获取当前UI上下文关联的Font对象。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	说明
fontName	string	是	系统的字体名。

返回值：

类型	说明
FontInfo	字体的详细信息。

FontInfo¹⁰⁺

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

名称	类型	必填	说明
path	string	是	系统字体的文件路径。
postScriptName	string	是	系统字体的postScript名称。
fullName	string	是	系统字体的名称。
family	string	是	系统字体的字体家族。
subfamily	string	是	系统字体的子字体家族。
weight	number	是	系统字体的字重。取值范围：[0,8]，取值间隔为1，分别对应FontWeight枚举中的值。默认值：0
width	number	是	系统字体的宽度。取值范围：[1,9]，取值间隔为1，分别对应FontWidth枚举中的值。
italic	boolean	是	系统字体是否倾斜。默认值：false 值为true，表示斜体字体，值为false，表示非斜体字体。
monoSpace	boolean	是	系统字体是否紧凑。默认值：false 值为true，表示等宽字体，值为false，表示非等宽字体。
symbolic	boolean	是	系统字体是否支持符号字体。默认值：false 值为true，表示支持符号字体，值为false，表示不支持符号字体。

示例：

说明

直接使用font可能导致实例不明确的问题，推荐通过使用UIContext中的getFont方法获取当前UI上下文关联的Font对象。

// xxx.ets
import { font } from '@kit.ArkUI';

@Entry
@Component
struct FontExample {
  fontList: Array<string> = new Array<string>();
  fontInfo: font.FontInfo = font.getFontByName('');

  build() {
    Column() {
      Button("getFontByName")
        .onClick(() => {
          this.fontInfo =
            font.getFontByName('HarmonyOS Sans Italic'); // 建议使用 this.getUIContext().getFont().getFontByName()接口
          console.log("getFontByName(): path = " + this.fontInfo.path);
          console.log("getFontByName(): postScriptName = " + this.fontInfo.postScriptName);
          console.log("getFontByName(): fullName = " + this.fontInfo.fullName);
          console.log("getFontByName(): Family = " + this.fontInfo.family);
          console.log("getFontByName(): Subfamily = " + this.fontInfo.subfamily);
          console.log("getFontByName(): weight = " + this.fontInfo.weight);
          console.log("getFontByName(): width = " + this.fontInfo.width);
          console.log("getFontByName(): italic = " + this.fontInfo.italic);
          console.log("getFontByName(): monoSpace = " + this.fontInfo.monoSpace);
          console.log("getFontByName(): symbolic = " + this.fontInfo.symbolic);
        })
    }.width('100%')
  }
}