UNPKG

7.63 kBJSONView Raw
1{
2 "name": "Calendar",
3 "props": {
4 "defaultValue": {
5 "type": {
6 "name": "custom",
7 "raw": "checkMomentObj"
8 },
9 "required": false,
10 "description": "默认选中的日期(moment 对象)",
11 "docblock": "默认选中的日期(moment 对象)"
12 },
13 "value": {
14 "type": {
15 "name": "custom",
16 "raw": "checkMomentObj"
17 },
18 "required": false,
19 "description": "选中的日期值 (moment 对象)",
20 "docblock": "选中的日期值 (moment 对象)"
21 },
22 "mode": {
23 "type": {
24 "name": "enum",
25 "computed": true,
26 "value": "CALENDAR_MODES"
27 },
28 "required": false,
29 "description": "面板模式",
30 "docblock": "面板模式"
31 },
32 "showOtherMonth": {
33 "type": {
34 "name": "bool"
35 },
36 "required": false,
37 "description": "是否展示非本月的日期",
38 "defaultValue": {
39 "value": "true",
40 "computed": false
41 },
42 "docblock": "是否展示非本月的日期"
43 },
44 "defaultVisibleMonth": {
45 "type": {
46 "name": "func"
47 },
48 "required": false,
49 "description": "默认展示的月份",
50 "docblock": "默认展示的月份",
51 "params": [],
52 "returns": null
53 },
54 "shape": {
55 "type": {
56 "name": "enum",
57 "value": [
58 {
59 "value": "'card'",
60 "computed": false
61 },
62 {
63 "value": "'fullscreen'",
64 "computed": false
65 },
66 {
67 "value": "'panel'",
68 "computed": false
69 }
70 ]
71 },
72 "required": false,
73 "description": "展现形态",
74 "defaultValue": {
75 "value": "'fullscreen'",
76 "computed": false
77 },
78 "docblock": "展现形态"
79 },
80 "onSelect": {
81 "type": {
82 "name": "func"
83 },
84 "required": false,
85 "description": "选择日期单元格时的回调",
86 "defaultValue": {
87 "value": "func.noop",
88 "computed": true
89 },
90 "docblock": "选择日期单元格时的回调\n@param {Object} value 对应的日期值 (moment 对象)",
91 "params": [
92 {
93 "name": "value",
94 "description": "对应的日期值 (moment 对象)",
95 "type": {
96 "name": "Object"
97 }
98 }
99 ],
100 "returns": null
101 },
102 "onModeChange": {
103 "type": {
104 "name": "func"
105 },
106 "required": false,
107 "description": "面板模式变化时的回调",
108 "defaultValue": {
109 "value": "func.noop",
110 "computed": true
111 },
112 "docblock": "面板模式变化时的回调\n@param {String} mode 对应面板模式 date month year",
113 "params": [
114 {
115 "name": "mode",
116 "description": "对应面板模式 date month year",
117 "type": {
118 "name": "String"
119 }
120 }
121 ],
122 "returns": null
123 },
124 "onVisibleMonthChange": {
125 "type": {
126 "name": "func"
127 },
128 "required": false,
129 "description": "展现的月份变化时的回调",
130 "defaultValue": {
131 "value": "func.noop",
132 "computed": true
133 },
134 "docblock": "展现的月份变化时的回调\n@param {Object} value 显示的月份 (moment 对象)\n@param {String} reason 触发月份改变原因",
135 "params": [
136 {
137 "name": "value",
138 "description": "显示的月份 (moment 对象)",
139 "type": {
140 "name": "Object"
141 }
142 },
143 {
144 "name": "reason",
145 "description": "触发月份改变原因",
146 "type": {
147 "name": "String"
148 }
149 }
150 ],
151 "returns": null
152 },
153 "className": {
154 "type": {
155 "name": "string"
156 },
157 "required": false,
158 "description": "自定义样式类",
159 "docblock": "自定义样式类"
160 },
161 "dateCellRender": {
162 "type": {
163 "name": "func"
164 },
165 "required": false,
166 "description": "自定义日期渲染函数",
167 "defaultValue": {
168 "value": "value => value.date()",
169 "computed": false
170 },
171 "docblock": "自定义日期渲染函数\n@param {Object} value 日期值(moment对象)\n@returns {ReactNode}",
172 "params": [
173 {
174 "name": "value",
175 "description": "日期值(moment对象)",
176 "type": {
177 "name": "Object"
178 }
179 }
180 ],
181 "returns": {
182 "description": null,
183 "type": {
184 "name": "ReactNode"
185 }
186 }
187 },
188 "monthCellRender": {
189 "type": {
190 "name": "func"
191 },
192 "required": false,
193 "description": "自定义月份渲染函数",
194 "docblock": "自定义月份渲染函数\n@param {Object} calendarDate 对应 Calendar 返回的自定义日期对象\n@returns {ReactNode}",
195 "params": [
196 {
197 "name": "calendarDate",
198 "description": "对应 Calendar 返回的自定义日期对象",
199 "type": {
200 "name": "Object"
201 }
202 }
203 ],
204 "returns": {
205 "description": null,
206 "type": {
207 "name": "ReactNode"
208 }
209 }
210 },
211 "yearRange": {
212 "type": {
213 "name": "arrayOf",
214 "value": {
215 "name": "number"
216 }
217 },
218 "required": false,
219 "description": "年份范围,[START_YEAR, END_YEAR] (只在shape 为 ‘card’, 'fullscreen' 下生效)",
220 "docblock": "年份范围,[START_YEAR, END_YEAR] (只在shape 为 ‘card’, 'fullscreen' 下生效)"
221 },
222 "disabledDate": {
223 "type": {
224 "name": "func"
225 },
226 "required": false,
227 "description": "不可选择的日期",
228 "docblock": "不可选择的日期\n@param {Object} calendarDate 对应 Calendar 返回的自定义日期对象\n@param {String} view 当前视图类型,year: 年, month: 月, date: 日\n@returns {Boolean}",
229 "params": [
230 {
231 "name": "calendarDate",
232 "description": "对应 Calendar 返回的自定义日期对象",
233 "type": {
234 "name": "Object"
235 }
236 },
237 {
238 "name": "view",
239 "description": "当前视图类型,year: 年, month: 月, date: 日",
240 "type": {
241 "name": "String"
242 }
243 }
244 ],
245 "returns": {
246 "description": null,
247 "type": {
248 "name": "Boolean"
249 }
250 }
251 },
252 "locale": {
253 "type": {
254 "name": "object"
255 },
256 "required": false,
257 "description": "国际化配置",
258 "defaultValue": {
259 "value": "nextLocale.Calendar",
260 "computed": true
261 },
262 "docblock": "国际化配置",
263 "properties": []
264 }
265 },
266 "methods": [
267 {
268 "name": "changeVisibleMonthByOffset",
269 "docblock": "根据日期偏移量设置当前展示的月份\n@param {Number} offset 日期偏移的数量\n@param {String} type 日期偏移的类型 days, months, years",
270 "modifiers": [],
271 "params": [
272 {
273 "name": "offset",
274 "description": "日期偏移的数量",
275 "type": {
276 "name": "Number"
277 }
278 },
279 {
280 "name": "type",
281 "description": "日期偏移的类型 days, months, years",
282 "type": {
283 "name": "String"
284 }
285 }
286 ],
287 "returns": null,
288 "description": "根据日期偏移量设置当前展示的月份"
289 }
290 ],
291 "subComponents": []
292}
\No newline at end of file