1.0.0 • Published 4 months ago

ngx-live2d v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
4 months ago

about

基于 live2d.js 构建的 angular17 版本的 live2d 库

Install

npm install --save ngx-live2d
#or
yarn add ngx-live2d
#or
pnpm add ngx-live2d

Usage

import { Component, signal } from "@angular/core";
import { NgxLive2dComponent, POSITION, ASSETS_TYPE, BUILTIN_MODEL } from "ngx-live2d";
@Component({
  selector: "app-home",
  standalone: true,
  imports: [NgxLive2dComponent],
  templateUrl: "./home.component.html",
  styleUrl: "./home.component.less",
})
export class HomeComponent {
  /**
   * 模型位置 默认POSITION.BOTTOM_RIGTH 右下角
   */
  position = signal(POSITION.BOTTOM_RIGTH);
  /**
   * 配置
   * @assetsType 资源类型,ASSETS_TYPE.INTERIOR内置 ASSETS_TYPE.EXTERNAL 外部资源
   * @assets 资源名称或链接
   */
  configuration = signal({
    assetsType: ASSETS_TYPE.INTERIOR,
    assets: BUILTIN_MODEL.EPSILON2,
  });

  /**
   * 模型单击事件
   */
  modelClickRun() {
    console.log("modelClickRun");
  }
}
<div class="page">
  <ngx-live2d [position]="position()" [configuration]="configuration()" (OnModelClick)="modelClickRun()" />
</div>

API

参数类型默认值说明
POSITIONenumBOTTOM_RIGTH模型展示位置。TOP_LEFT 左上角,BOTTOM_LEFT 左下角,TOP_RIGTH 右上角,BOTTOM_RIGTH 右下角
ASSETS_TYPEenumINTERIOR资源类型。INTERIOR 内部资源,EXTERNAL 外部资源
BUILTIN_MODELenumEPSILON2内置资源名称。有 Z16,EPSILON2,IZUMI,KOHARU,SHIZUKU,MIKU,HIJIKI,TORORO
OnModelClickFunction-模型单击事件。

BUILTIN_MODEL

名称预览
Z16https://ngx-live2d.async.cn?name=Z16
EPSILON2https://ngx-live2d.async.cn?name=EPSILON2
IZUMIhttps://ngx-live2d.async.cn?name=IZUMI
KOHARUhttps://ngx-live2d.async.cn?name=KOHARU
SHIZUKUhttps://ngx-live2d.async.cn?name=SHIZUKU
MIKUhttps://ngx-live2d.async.cn?name=MIKU
HIJIKIhttps://ngx-live2d.async.cn?name=HIJIKI
TOROROhttps://ngx-live2d.async.cn?name=TORORO

bugs

https://github.com/stack-stark/ngx-live2d/issues

1.0.0

4 months ago