OhMyLive2D
Search K

Appearance

公共选项 ​

用法: ​

ts
import { loadOml2d } from 'oh-my-live2d';
loadOml2d({
  // 在这里进行配置
});

选项: ​

dockedPosition? ​

optional dockedPosition: "left" | "right"

组件停靠位置, 当您希望组件靠右展示时这个属性会非常有用. 同时影响状态条、舞台、菜单.

默认值: left, 当值为left时舞台和状态条居左, 菜单居右(位置值相反),

默认值: ​

ts
left

importType? ​

optional importType: string

已弃用: ​

不再使用按需导入的方式,默认全量导入,该选项将在下个版本被移除

initialStatus? ​

optional initialStatus: "sleep" | "active"

用于控制组件在浏览器中以当前地址首次访问时的初始状态是否处于睡眠状态或活动状态,

默认值: ​

ts
'active'

libraryUrls? ​

optional libraryUrls: object

已弃用: ​

sdk已内置,该选项已弃用,将在下个版本被移除

complete? ​

optional complete: string

自定义全量SDK地址

cubism2? ​

optional cubism2: string

自定义 Cubism2 SDK 地址

cubism5? ​

optional cubism5: string

自定义 Cubism5 SDK 地址

optional menus: MenusOptions | (currentModel: ModelOptions, modelIndex: number) => MenusOptions

菜单配置, 详见: 菜单选项

mobileDisplay? ​

optional mobileDisplay: boolean

移动端是否展示, 开启将会在移动端设备上以移动端样式展示各元素

默认值: ​

ts
false

models? ​

optional models: ModelOptions[]

模型选项, 类型是模型配置对象组成的数组, 默认值是空数组

详见: 模型选项

默认值: ​

ts
[]

parentElement? ​

optional parentElement: HTMLElement

为组件提供一个父元素，如果未指定则默认挂载到 body 中

默认值: ​

ts
document.body

primaryColor? ​

optional primaryColor: string

定义主题色, 影响所有模块

默认值: ​

ts
'#38B0DE'

sayHello? ​

optional sayHello: boolean

是否在初始化阶段打印项目信息

默认值: ​

ts
true

stageStyle? ​

optional stageStyle: CommonStyleType

公共舞台样式, 作用于所有模型的舞台样式, 优先级低于模型选项中的舞台样式

statusBar? ​

optional statusBar: StatusBarOptions

状态条选项, 详见: 状态条选项

tips? ​

optional tips: TipsOptions | (currentModel: ModelOptions, modelIndex: number) => TipsOptions

自定义提示框样式和内容, 前往提示框选项查看详细内容

transitionTime? ​

optional transitionTime: number

组件入场和离开的过渡动画时长,单位 ms

默认值: ​

ts
1000