-
Notifications
You must be signed in to change notification settings - Fork 14
/
options.ts
101 lines (90 loc) · 2.64 KB
/
options.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
import type { ModelOptions } from './model.js';
import type { TipsOptions } from './tips.js';
import type { ImportType } from './index.js';
/**
* # 配置选项
*
* @name 配置选项
*/
export interface Options {
/**
* 移动端是否展示, 开启后将以移动端样式展示各元素
* @default false
*/
mobileDisplay?: boolean;
/**
* 导入类型, 默认使用全量导入: complete
* @default complete
* @valueType complete | cubism2 | cubism5
*/
importType?: ImportType;
/**
* 主题色
*/
primaryColor?: string;
/**
* 自定义 Cubism SDK 外部资源地址
*
* > [!TIP]
* > 从 v0.5.0 版本开始, 不再通过模块方式使用 vite 打包 SDK , 自 v0.5.0 版本起, 将通过 script 标签的 src 属性按需去引入对应版本的 Cubism SDK , 这个过程是完全自动的, 您无需关注这个过程也无需手动的去引入这些资源, 官方将长期维护这个服务器, 保证此 SDK 地址的安全与稳定性. 若发现 SDK 加载出现异常, 请及时联系作者.
* @valueType object
*/
libraryUrls?: {
/**
* 自定义 Cubism2 SDK 地址
* @default oh-my-live2d提供的默认地址
*/
cubism2?: string;
/**
* 自定义 Cubism5 SDK 地址
* @default oh-my-live2d提供的默认地址
*/
cubism5?: string;
};
/**
* 是否在初始化阶段打印项目信息
* @valueType boolean
* @default true
*/
sayHello?: boolean;
/**
* 组件入场和离开的过渡动画时长,单位 ms
* @valueType number
* @default 1000
*/
transitionTime?: number;
/**
* 定制模型配置, 类型是模型配置对象组成的数组, 默认值是空数组, 请至少配置一个有效的模型配置
*
* 前往[模型选项](/options/ModelOptions)查看详细内容
* @valueType Model[]
* @default []
*/
models?: ModelOptions[];
/**
* 自定义提示框样式和内容, 前往[提示框选项](/options/TipsOptions)查看详细内容
*
* @default object
* @valueType Tips
*/
tips?: TipsOptions;
/**
* 为组件提供一个父元素,如果未指定则默认挂载到 body 中
* @valueType HtmlElement
* @default document.body
*/
parentElement?: HTMLElement;
/**
* 组件是否使用固定定位 <Badge type="danger" text="已弃用" />
*
* > [!WARNING]
* > 该属性将在下个版本移除, 现在您可以通过模型选项的stageStyle属性为舞台元素设置定位属性
* @valueType boolean
* @default true
* @deprecated 已弃用将在下个版本移除
*
*/
fixed?: boolean;
}
export * from './model.js';
export * from './tips.js';