# symbolRegister (symbol注册)

> phone 5.1.1(19)+ | 2in1 5.1.1(19)+ | tablet 5.1.1(19)+

本模块提供自定义Symbol图标资源与动效参数资源注册加载能力。

**起始版本：** 5.1.1(19)

## 导入模块

> phone | 2in1 | tablet

```typescript
import { symbolRegister } from '@kit.UIDesignKit';
```

## symbolRegister.registerSymbol

> phone 5.1.1(19)+ | 2in1 5.1.1(19)+ | tablet 5.1.1(19)+

registerSymbol(ttfSrc: resourceManager.Resource, jsonSrc: resourceManager.Resource): boolean

注册自定义Symbol资源。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.UIDesign.Core

**起始版本：** 5.1.1(19)

**参数：**

|**参数名**|**类型**|必填|**说明**|
|:------|:--------------------------------------------------------------------------------------------------------------|:-|:---------------|
|ttfSrc|[resourceManager.Resource](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/ts-types#resource)|是|自定义Symbol图标资源。|
|jsonSrc|[resourceManager.Resource](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/ts-types#resource)|是|自定义Symbol动效参数资源。|

**返回值：**

|类型|说明|
|:------|:---------------------------|
|boolean|返回注册结果，true：注册成功，false：注册失败。|

**错误码：**

以下错误码的详细介绍请参见[通用错误码](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/errorcode-universal)和[ArkTS API错误码](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/errorcode-ui-design)。

|错误码ID|错误信息|
|:---------|:----------------------------------|
|401|Parameter error.|
|801|Device Type error.|
|1012600002|TTF or JSON resource out of size.|
|1012600003|TTF or JSON resource content error.|

**示例：**

```typescript
import { symbolRegister } from '@kit.UIDesignKit';
import { BusinessError } from '@kit.BasicServicesKit';

@Entry
@Component
struct test {
  aboutToAppear(): void {
    try {
      // 注册自定义的Symbol资源，在resource/rawfile目录下配置图标资源
      let result =
        symbolRegister.registerSymbol($rawfile("symbol/symbol_register.ttf"), $rawfile("symbol/symbol_register.json"));
    } catch (error) {
      let err = error as BusinessError;
      console.error("errCode:" + err.code)
      console.error("error " + err.message);
    }
  }

  build() {
    Column() {
      SymbolGlyph($r('app.string.symbol_custom_phone_fill_1'))
    }
  }
}
```

![](https://contentcenter-vali-drcn.dbankcdn.cn/pvt_2/DeveloperAlliance_scene_100_1/5f/v3/gGXRpU6ZRb-UzMRXSZBduw/zh-cn_image_0000002794413227.png?HW-CC-KV=V1&HW-CC-Date=20261015T104549Z&HW-CC-Expire=31536000000&HW-CC-Sign=6219CCD6CE6299248B221447003B48770A074E2BAFCEDF412A39A8469477A0FE)