Skip to content

Commit e7d25dc

Browse files
Marc-Andre-RivetMarc-Andre-Rivet
committed
3.1 issue143 props typing (#158)
* improve props typing * bump version * improve typing for dropdown values * required props / nested props * remove isRequired from column name (not confirmed yet) * make column name required
1 parent b8b0019 commit e7d25dc

File tree

10 files changed

+243
-70
lines changed

10 files changed

+243
-70
lines changed

‎packages/dash-table/CHANGELOG.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -393,4 +393,10 @@ Derived properties allow the component to expose complex state that can be usefu
393393
derived_viewport_datafram -> derived_viewport_data
394394

395395
## RC7 - Optional id prop
396-
- The id prop of the table is now optional. It will generate a random id if it's not set.
396+
397+
- The id prop of the table is now optional. It will generate a random id if it's not set.
398+
Issue: https://github.com/plotly/dash-table/issues/143
399+
400+
## RC8 - Improve props typing
401+
402+
Issue: https://github.com/plotly/dash-table/issues/143

‎packages/dash-table/dash_table/bundle.js

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎packages/dash-table/dash_table/demo.js

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎packages/dash-table/dash_table/metadata.json

Lines changed: 135 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,104 @@
1919
"type": {
2020
"name": "arrayOf",
2121
"value": {
22-
"name": "object"
22+
"name": "shape",
23+
"value": {
24+
"clearable": {
25+
"name": "bool",
26+
"required": false
27+
},
28+
"deletable": {
29+
"name": "union",
30+
"value": [
31+
{
32+
"name": "bool"
33+
},
34+
{
35+
"name": "number"
36+
}
37+
],
38+
"required": false
39+
},
40+
"editable": {
41+
"name": "bool",
42+
"required": false
43+
},
44+
"editable_name": {
45+
"name": "union",
46+
"value": [
47+
{
48+
"name": "bool"
49+
},
50+
{
51+
"name": "number"
52+
}
53+
],
54+
"required": false
55+
},
56+
"hidden": {
57+
"name": "bool",
58+
"required": false
59+
},
60+
"id": {
61+
"name": "string",
62+
"required": true
63+
},
64+
"name": {
65+
"name": "string",
66+
"required": true
67+
},
68+
"options": {
69+
"name": "arrayOf",
70+
"value": {
71+
"name": "shape",
72+
"value": {
73+
"label": {
74+
"name": "union",
75+
"value": [
76+
{
77+
"name": "number"
78+
},
79+
{
80+
"name": "string"
81+
}
82+
],
83+
"required": true
84+
},
85+
"value": {
86+
"name": "union",
87+
"value": [
88+
{
89+
"name": "number"
90+
},
91+
{
92+
"name": "string"
93+
}
94+
],
95+
"required": true
96+
}
97+
}
98+
},
99+
"required": false
100+
},
101+
"type": {
102+
"name": "enum",
103+
"value": [
104+
{
105+
"value": "'dropdown'",
106+
"computed": false
107+
},
108+
{
109+
"value": "'numeric'",
110+
"computed": false
111+
},
112+
{
113+
"value": "'text'",
114+
"computed": false
115+
}
116+
],
117+
"required": false
118+
}
119+
}
23120
}
24121
},
25122
"required": false,
@@ -58,11 +155,11 @@
58155
"value": {
59156
"selector": {
60157
"name": "string",
61-
"required": false
158+
"required": true
62159
},
63160
"rule": {
64161
"name": "string",
65-
"required": false
162+
"required": true
66163
}
67164
}
68165
}
@@ -100,7 +197,7 @@
100197
},
101198
"data_timestamp": {
102199
"type": {
103-
"name": "any"
200+
"name": "number"
104201
},
105202
"required": false,
106203
"description": ""
@@ -226,7 +323,7 @@
226323
},
227324
"setProps": {
228325
"type": {
229-
"name": "any"
326+
"name": "func"
230327
},
231328
"required": false,
232329
"description": ""
@@ -283,15 +380,15 @@
283380
"value": {
284381
"displayed_pages": {
285382
"name": "number",
286-
"required": false
383+
"required": true
287384
},
288385
"current_page": {
289386
"name": "number",
290-
"required": false
387+
"required": true
291388
},
292389
"page_size": {
293390
"name": "number",
294-
"required": false
391+
"required": true
295392
}
296393
}
297394
},
@@ -321,7 +418,7 @@
321418
"value": {
322419
"id": {
323420
"name": "string",
324-
"required": false
421+
"required": true
325422
},
326423
"dropdowns": {
327424
"name": "arrayOf",
@@ -330,7 +427,7 @@
330427
"value": {
331428
"condition": {
332429
"name": "string",
333-
"required": false
430+
"required": true
334431
},
335432
"dropdown": {
336433
"name": "arrayOf",
@@ -339,19 +436,27 @@
339436
"value": {
340437
"label": {
341438
"name": "string",
342-
"required": false
439+
"required": true
343440
},
344441
"value": {
345-
"name": "any",
346-
"required": false
442+
"name": "union",
443+
"value": [
444+
{
445+
"name": "number"
446+
},
447+
{
448+
"name": "string"
449+
}
450+
],
451+
"required": true
347452
}
348453
}
349454
},
350-
"required": false
455+
"required": true
351456
}
352457
}
353458
},
354-
"required": false
459+
"required": true
355460
}
356461
}
357462
}
@@ -371,7 +476,7 @@
371476
"value": {
372477
"id": {
373478
"name": "string",
374-
"required": false
479+
"required": true
375480
},
376481
"dropdown": {
377482
"name": "arrayOf",
@@ -380,15 +485,23 @@
380485
"value": {
381486
"label": {
382487
"name": "string",
383-
"required": false
488+
"required": true
384489
},
385490
"value": {
386-
"name": "any",
387-
"required": false
491+
"name": "union",
492+
"value": [
493+
{
494+
"name": "number"
495+
},
496+
{
497+
"name": "string"
498+
}
499+
],
500+
"required": true
388501
}
389502
}
390503
},
391-
"required": false
504+
"required": true
392505
}
393506
}
394507
}
@@ -543,7 +656,7 @@
543656
"name": "number"
544657
}
545658
],
546-
"required": false
659+
"required": true
547660
},
548661
"direction": {
549662
"name": "enum",
@@ -557,7 +670,7 @@
557670
"computed": false
558671
}
559672
],
560-
"required": false
673+
"required": true
561674
}
562675
}
563676
}

‎packages/dash-table/dash_table/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "dash-table",
3-
"version": "3.1.0rc7",
3+
"version": "3.1.0rc8",
44
"description": "Dash table",
55
"main": "build/index.js",
66
"scripts": {

‎packages/dash-table/demo/App.js

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -78,8 +78,4 @@ class App extends Component {
7878
}
7979
}
8080

81-
App.propTypes = {
82-
value: PropTypes.any,
83-
};
84-
8581
export default App;

‎packages/dash-table/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "dash-table",
3-
"version": "3.1.0rc7",
3+
"version": "3.1.0rc8",
44
"description": "Dash table",
55
"main": "build/index.js",
66
"scripts": {

0 commit comments

Comments
 (0)