-
Notifications
You must be signed in to change notification settings - Fork 1
/
option-type.d.ts
105 lines (105 loc) · 3.29 KB
/
option-type.d.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
102
103
104
105
export type Options = {
/**
* whether to use babel by default [default: true]
* this is useful if your code is vanilla or vue and your code is es5, if set
* to false, big babel standalone modules will not be loaded
*/
babel?: boolean
/**
* whether to use iframe to render code [default: true]
* if use iframe, the rendering containers are isolated, they do not affect
* each other
*/
iframe?: boolean
/**
* the scope variable declaration [default: { Vue, React, ReactDOM, [...ReactHooks] }]
*/
scope?: Record<string, unknown>
/**
* whether to show jsfiddle in control bar [default: false]
*/
showJsfiddleLink?: boolean
/**
* whether to show codepen in control bar [default: false]
*/
showCodepenLink?: boolean
/**
* whether to show codesandbox in control bar [default: false]
*/
showCodesandboxLink?: boolean
/**
* whether to show the interactive code editor [default: true]
* if set to false, the code section will only readable
*/
live?: boolean
/**
* the layout of code and renderer [default: row]
* display:
* - row: [ code | render ]
* - row-reverse: [ renderer | code ]
* - column: [ render ]
* [ code ]
* - column-reverse: [ code ]
* [ render ]
*/
layout?: 'row' | 'row-reverse' | 'column' | 'column-reverse'
/**
* whether show code section by default [default: true]
* if you only want show renderer of code, set it to true
*/
showCode?: boolean
/**
* whether to show toggle button in control bar [default: false]
*/
showToggleButton?: boolean
/**
* whether to show copy code button in control bar [default: false]
*/
showCopyCodeButton?: boolean
/**
* whether to show code by default [default: false]
*/
showCodeByDefault?: boolean
/**
* declare global variables corresponding to the base library [default: {}]
* if you want to import not all or default module, such as:
* import { bar, baz } from 'foo'
* write config as following:
* libGlobalName: { 'foo': { globalName: 'foo', link: 'https://foo.js' } }
* and it will be convert to:
* const { bar, baz } = window.foo
*/
libGlobalName?: Record<string, { globalName: string; link: string }>
/**
* the lib which you want to import in codepen / jsfiddle and don't want to
* display in code section
*/
libSilenceImport?: { js?: string[]; css?: string[] }
/**
* whether to support import Component [default: false]
* if set to true, inner code will use modules vue, it will be useful if you
* are developing a component library, in this case, you need to import vue
* in scope
* if set to false, inner code will use vueLib instead
*/
supportVueComponent?: boolean
/**
* vue version for your component [default: 3]
*/
vueVersion?: 2 | 3
/**
* vue base lib from codepen / jsfiddle
* default is https://cdn.jsdelivr.net/npm/[email protected]/dist/vue.global.prod.js
*/
vueLib?: string
/**
* react base lib from codepen / jsfiddle
* default is https://cdn.jsdelivr.net/npm/[email protected]/umd/react.production.min.js
*/
reactLib?: string
/**
* reactDOM base lib from codepen / jsfiddle
* default is https://cdn.jsdelivr.net/npm/[email protected]/umd/react-dom.production.min.js
*/
reactDOMLib?: string
}