1 | {
|
2 | "name": "ConfigProvider",
|
3 | "props": {
|
4 | "prefix": {
|
5 | "type": {
|
6 | "name": "string"
|
7 | },
|
8 | "required": false,
|
9 | "description": "样式类名的品牌前缀",
|
10 | "docblock": "样式类名的品牌前缀"
|
11 | },
|
12 | "locale": {
|
13 | "type": {
|
14 | "name": "object"
|
15 | },
|
16 | "required": false,
|
17 | "description": "国际化文案对象,属性为组件的 displayName",
|
18 | "docblock": "国际化文案对象,属性为组件的 displayName",
|
19 | "properties": []
|
20 | },
|
21 | "defaultPropsConfig": {
|
22 | "type": {
|
23 | "name": "object"
|
24 | },
|
25 | "required": false,
|
26 | "description": "组件 API 的默认配置",
|
27 | "docblock": "组件 API 的默认配置",
|
28 | "properties": []
|
29 | },
|
30 | "errorBoundary": {
|
31 | "type": {
|
32 | "name": "union",
|
33 | "value": [
|
34 | {
|
35 | "name": "bool"
|
36 | },
|
37 | {
|
38 | "name": "object"
|
39 | }
|
40 | ]
|
41 | },
|
42 | "required": false,
|
43 | "description": "是否开启错误捕捉 errorBoundary\n如需自定义参数,请传入对象 对象接受参数列表如下:\n\nfallbackUI `Function(error?: {}, errorInfo?: {}) => Element` 捕获错误后的展示\nafterCatch `Function(error?: {}, errorInfo?: {})` 捕获错误后的行为, 比如埋点上传",
|
44 | "defaultValue": {
|
45 | "value": "false",
|
46 | "computed": false
|
47 | },
|
48 | "docblock": "是否开启错误捕捉 errorBoundary\n如需自定义参数,请传入对象 对象接受参数列表如下:\n\nfallbackUI `Function(error?: {}, errorInfo?: {}) => Element` 捕获错误后的展示\nafterCatch `Function(error?: {}, errorInfo?: {})` 捕获错误后的行为, 比如埋点上传"
|
49 | },
|
50 | "pure": {
|
51 | "type": {
|
52 | "name": "bool"
|
53 | },
|
54 | "required": false,
|
55 | "description": "是否开启 Pure Render 模式,会提高性能,但是也会带来副作用",
|
56 | "docblock": "是否开启 Pure Render 模式,会提高性能,但是也会带来副作用"
|
57 | },
|
58 | "warning": {
|
59 | "type": {
|
60 | "name": "bool"
|
61 | },
|
62 | "required": false,
|
63 | "description": "是否在开发模式下显示组件属性被废弃的 warning 提示",
|
64 | "defaultValue": {
|
65 | "value": "true",
|
66 | "computed": false
|
67 | },
|
68 | "docblock": "是否在开发模式下显示组件属性被废弃的 warning 提示"
|
69 | },
|
70 | "rtl": {
|
71 | "type": {
|
72 | "name": "bool"
|
73 | },
|
74 | "required": false,
|
75 | "description": "是否开启 rtl 模式",
|
76 | "docblock": "是否开启 rtl 模式"
|
77 | },
|
78 | "device": {
|
79 | "type": {
|
80 | "name": "enum",
|
81 | "value": [
|
82 | {
|
83 | "value": "'tablet'",
|
84 | "computed": false
|
85 | },
|
86 | {
|
87 | "value": "'desktop'",
|
88 | "computed": false
|
89 | },
|
90 | {
|
91 | "value": "'phone'",
|
92 | "computed": false
|
93 | }
|
94 | ]
|
95 | },
|
96 | "required": false,
|
97 | "description": "设备类型,针对不同的设备类型组件做出对应的响应式变化",
|
98 | "docblock": "设备类型,针对不同的设备类型组件做出对应的响应式变化"
|
99 | },
|
100 | "children": {
|
101 | "type": {
|
102 | "name": "any"
|
103 | },
|
104 | "required": false,
|
105 | "description": "组件树",
|
106 | "docblock": "组件树"
|
107 | },
|
108 | "popupContainer": {
|
109 | "type": {
|
110 | "name": "any"
|
111 | },
|
112 | "required": false,
|
113 | "description": "指定浮层渲染的父节点, 可以为节点id的字符串,也可以返回节点的函数",
|
114 | "docblock": "指定浮层渲染的父节点, 可以为节点id的字符串,也可以返回节点的函数"
|
115 | }
|
116 | },
|
117 | "methods": [
|
118 | {
|
119 | "name": "config",
|
120 | "docblock": "传入组件,生成受 ConfigProvider 控制的 HOC 组件\n@param {Component} Component 组件类\n@param {Object} options 可选项\n@returns {Component} HOC",
|
121 | "modifiers": [
|
122 | "static"
|
123 | ],
|
124 | "params": [
|
125 | {
|
126 | "name": "Component",
|
127 | "description": "组件类",
|
128 | "type": {
|
129 | "name": "Component"
|
130 | }
|
131 | },
|
132 | {
|
133 | "name": "options",
|
134 | "description": "可选项",
|
135 | "type": {
|
136 | "name": "Object"
|
137 | }
|
138 | }
|
139 | ],
|
140 | "returns": {
|
141 | "description": "HOC",
|
142 | "type": {
|
143 | "name": "Component"
|
144 | }
|
145 | },
|
146 | "description": "传入组件,生成受 ConfigProvider 控制的 HOC 组件"
|
147 | },
|
148 | {
|
149 | "name": "getContextProps",
|
150 | "docblock": "传入组件的 props 和 displayName,得到和 childContext 计算过的包含有 preifx/locale/pure 的对象,一般用于通过静态方法生成脱离组件树的组件\n@param {Object} props 组件的 props\n@param {String} displayName 组件的 displayName\n@returns {Object} 新的 context props",
|
151 | "modifiers": [
|
152 | "static"
|
153 | ],
|
154 | "params": [
|
155 | {
|
156 | "name": "props",
|
157 | "description": "组件的 props",
|
158 | "type": {
|
159 | "name": "Object"
|
160 | }
|
161 | },
|
162 | {
|
163 | "name": "displayName",
|
164 | "description": "组件的 displayName",
|
165 | "type": {
|
166 | "name": "String"
|
167 | }
|
168 | }
|
169 | ],
|
170 | "returns": {
|
171 | "description": "新的 context props",
|
172 | "type": {
|
173 | "name": "Object"
|
174 | }
|
175 | },
|
176 | "description": "传入组件的 props 和 displayName,得到和 childContext 计算过的包含有 preifx/locale/pure 的对象,一般用于通过静态方法生成脱离组件树的组件"
|
177 | }
|
178 | ],
|
179 | "propsExtends": false,
|
180 | "subComponents": []
|
181 | } |
\ | No newline at end of file |