@elliemae/ds-shuttle 2.0.2 → 2.1.0-rc.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +11 -11
- package/types/DSShuttle.d.ts +72 -72
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@elliemae/ds-shuttle",
|
|
3
|
-
"version": "2.0.
|
|
3
|
+
"version": "2.1.0-rc.3",
|
|
4
4
|
"license": "MIT",
|
|
5
5
|
"description": "ICE MT - Dimsum - Shuttle",
|
|
6
6
|
"module": "./esm/index.js",
|
|
@@ -152,16 +152,16 @@
|
|
|
152
152
|
"build": "node ../../scripts/build/build.js"
|
|
153
153
|
},
|
|
154
154
|
"dependencies": {
|
|
155
|
-
"@elliemae/ds-basic": "2.0.
|
|
156
|
-
"@elliemae/ds-button": "2.0.
|
|
157
|
-
"@elliemae/ds-circular-progress-indicator": "2.0.
|
|
158
|
-
"@elliemae/ds-classnames": "2.0.
|
|
159
|
-
"@elliemae/ds-form": "2.0.
|
|
160
|
-
"@elliemae/ds-icons": "2.0.
|
|
161
|
-
"@elliemae/ds-indeterminate-progress-indicator": "2.0.
|
|
162
|
-
"@elliemae/ds-system": "2.0.
|
|
163
|
-
"@elliemae/ds-truncated-tooltip-text": "2.0.
|
|
164
|
-
"@elliemae/ds-utilities": "2.0.
|
|
155
|
+
"@elliemae/ds-basic": "2.1.0-rc.3",
|
|
156
|
+
"@elliemae/ds-button": "2.1.0-rc.3",
|
|
157
|
+
"@elliemae/ds-circular-progress-indicator": "2.1.0-rc.3",
|
|
158
|
+
"@elliemae/ds-classnames": "2.1.0-rc.3",
|
|
159
|
+
"@elliemae/ds-form": "2.1.0-rc.3",
|
|
160
|
+
"@elliemae/ds-icons": "2.1.0-rc.3",
|
|
161
|
+
"@elliemae/ds-indeterminate-progress-indicator": "2.1.0-rc.3",
|
|
162
|
+
"@elliemae/ds-system": "2.1.0-rc.3",
|
|
163
|
+
"@elliemae/ds-truncated-tooltip-text": "2.1.0-rc.3",
|
|
164
|
+
"@elliemae/ds-utilities": "2.1.0-rc.3",
|
|
165
165
|
"constate": "~1.3.2",
|
|
166
166
|
"prop-types": "~15.7.2",
|
|
167
167
|
"react-desc": "~4.1.3",
|
package/types/DSShuttle.d.ts
CHANGED
|
@@ -43,255 +43,255 @@ declare const DSShuttle: {
|
|
|
43
43
|
propTypes: {
|
|
44
44
|
/** inject props to shuttle wrapper */
|
|
45
45
|
containerProps: {
|
|
46
|
-
defaultValue
|
|
46
|
+
defaultValue(arg: import("react-desc").ReactDescPossibleDefaultValues): {
|
|
47
47
|
deprecated: import("react-desc").PropTypesDescValidator;
|
|
48
48
|
};
|
|
49
|
-
isRequired: import("react-desc").
|
|
49
|
+
isRequired: import("react-desc").PropTypesDescValue;
|
|
50
50
|
};
|
|
51
51
|
/** The identifier field for the item object */
|
|
52
52
|
idField: {
|
|
53
|
-
defaultValue
|
|
53
|
+
defaultValue(arg: import("react-desc").ReactDescPossibleDefaultValues): {
|
|
54
54
|
deprecated: import("react-desc").PropTypesDescValidator;
|
|
55
55
|
};
|
|
56
|
-
isRequired: import("react-desc").
|
|
56
|
+
isRequired: import("react-desc").PropTypesDescValue;
|
|
57
57
|
};
|
|
58
58
|
/** The parent identifier field for the item object */
|
|
59
59
|
parentIdField: {
|
|
60
|
-
defaultValue
|
|
60
|
+
defaultValue(arg: import("react-desc").ReactDescPossibleDefaultValues): {
|
|
61
61
|
deprecated: import("react-desc").PropTypesDescValidator;
|
|
62
62
|
};
|
|
63
|
-
isRequired: import("react-desc").
|
|
63
|
+
isRequired: import("react-desc").PropTypesDescValue;
|
|
64
64
|
};
|
|
65
65
|
/** Whether to show the icons or not */
|
|
66
66
|
showIcons: {
|
|
67
|
-
defaultValue
|
|
67
|
+
defaultValue(arg: import("react-desc").ReactDescPossibleDefaultValues): {
|
|
68
68
|
deprecated: import("react-desc").PropTypesDescValidator;
|
|
69
69
|
};
|
|
70
|
-
isRequired: import("react-desc").
|
|
70
|
+
isRequired: import("react-desc").PropTypesDescValue;
|
|
71
71
|
};
|
|
72
72
|
/** List of items */
|
|
73
73
|
items: {
|
|
74
|
-
defaultValue
|
|
74
|
+
defaultValue(arg: import("react-desc").ReactDescPossibleDefaultValues): {
|
|
75
75
|
deprecated: import("react-desc").PropTypesDescValidator;
|
|
76
76
|
};
|
|
77
|
-
isRequired: import("react-desc").
|
|
77
|
+
isRequired: import("react-desc").PropTypesDescValue;
|
|
78
78
|
};
|
|
79
79
|
/** Array of item ids that are selected. If passed the component behaves as controlled */
|
|
80
80
|
selectedItems: {
|
|
81
|
-
defaultValue
|
|
81
|
+
defaultValue(arg: import("react-desc").ReactDescPossibleDefaultValues): {
|
|
82
82
|
deprecated: import("react-desc").PropTypesDescValidator;
|
|
83
83
|
};
|
|
84
|
-
isRequired: import("react-desc").
|
|
84
|
+
isRequired: import("react-desc").PropTypesDescValue;
|
|
85
85
|
};
|
|
86
86
|
/** Array of item ids that aren't selected. Should include ALL non selected items, even those not rendered */
|
|
87
87
|
nonSelectedItems: {
|
|
88
|
-
defaultValue
|
|
88
|
+
defaultValue(arg: import("react-desc").ReactDescPossibleDefaultValues): {
|
|
89
89
|
deprecated: import("react-desc").PropTypesDescValidator;
|
|
90
90
|
};
|
|
91
|
-
isRequired: import("react-desc").
|
|
91
|
+
isRequired: import("react-desc").PropTypesDescValue;
|
|
92
92
|
};
|
|
93
93
|
/** Handler on search */
|
|
94
94
|
onSearch: {
|
|
95
|
-
defaultValue
|
|
95
|
+
defaultValue(arg: import("react-desc").ReactDescPossibleDefaultValues): {
|
|
96
96
|
deprecated: import("react-desc").PropTypesDescValidator;
|
|
97
97
|
};
|
|
98
|
-
isRequired: import("react-desc").
|
|
98
|
+
isRequired: import("react-desc").PropTypesDescValue;
|
|
99
99
|
};
|
|
100
100
|
/** Handler when the searchbox is visible */
|
|
101
101
|
onSearchOpen: {
|
|
102
|
-
defaultValue
|
|
102
|
+
defaultValue(arg: import("react-desc").ReactDescPossibleDefaultValues): {
|
|
103
103
|
deprecated: import("react-desc").PropTypesDescValidator;
|
|
104
104
|
};
|
|
105
|
-
isRequired: import("react-desc").
|
|
105
|
+
isRequired: import("react-desc").PropTypesDescValue;
|
|
106
106
|
};
|
|
107
107
|
/** Handler when the searchbox is not visible */
|
|
108
108
|
onSearchClose: {
|
|
109
|
-
defaultValue
|
|
109
|
+
defaultValue(arg: import("react-desc").ReactDescPossibleDefaultValues): {
|
|
110
110
|
deprecated: import("react-desc").PropTypesDescValidator;
|
|
111
111
|
};
|
|
112
|
-
isRequired: import("react-desc").
|
|
112
|
+
isRequired: import("react-desc").PropTypesDescValue;
|
|
113
113
|
};
|
|
114
114
|
/** Source handler when a user navigates to a level down on the nested structure. First param: item drilled. Second param: direction ("up" | "down") */
|
|
115
115
|
onDrillDown: {
|
|
116
|
-
defaultValue
|
|
116
|
+
defaultValue(arg: import("react-desc").ReactDescPossibleDefaultValues): {
|
|
117
117
|
deprecated: import("react-desc").PropTypesDescValidator;
|
|
118
118
|
};
|
|
119
|
-
isRequired: import("react-desc").
|
|
119
|
+
isRequired: import("react-desc").PropTypesDescValue;
|
|
120
120
|
};
|
|
121
121
|
/** Target handler when a user navigates to a level down on the nested structure. First param: item drilled. Second param: direction ("up" | "down") */
|
|
122
122
|
onDrillDownTarget: {
|
|
123
|
-
defaultValue
|
|
123
|
+
defaultValue(arg: import("react-desc").ReactDescPossibleDefaultValues): {
|
|
124
124
|
deprecated: import("react-desc").PropTypesDescValidator;
|
|
125
125
|
};
|
|
126
|
-
isRequired: import("react-desc").
|
|
126
|
+
isRequired: import("react-desc").PropTypesDescValue;
|
|
127
127
|
};
|
|
128
128
|
/** Target handler when user stops dragging an item */
|
|
129
129
|
onTargetSortEnd: {
|
|
130
|
-
defaultValue
|
|
130
|
+
defaultValue(arg: import("react-desc").ReactDescPossibleDefaultValues): {
|
|
131
131
|
deprecated: import("react-desc").PropTypesDescValidator;
|
|
132
132
|
};
|
|
133
|
-
isRequired: import("react-desc").
|
|
133
|
+
isRequired: import("react-desc").PropTypesDescValue;
|
|
134
134
|
};
|
|
135
135
|
/** Callback function that gets more items for Infinite Scroll */
|
|
136
136
|
onGetMoreItems: {
|
|
137
|
-
defaultValue
|
|
137
|
+
defaultValue(arg: import("react-desc").ReactDescPossibleDefaultValues): {
|
|
138
138
|
deprecated: import("react-desc").PropTypesDescValidator;
|
|
139
139
|
};
|
|
140
|
-
isRequired: import("react-desc").
|
|
140
|
+
isRequired: import("react-desc").PropTypesDescValue;
|
|
141
141
|
};
|
|
142
142
|
/** Wheter there are mor items loading for Infinite Scroll */
|
|
143
143
|
moreItemsLoading: {
|
|
144
|
-
defaultValue
|
|
144
|
+
defaultValue(arg: import("react-desc").ReactDescPossibleDefaultValues): {
|
|
145
145
|
deprecated: import("react-desc").PropTypesDescValidator;
|
|
146
146
|
};
|
|
147
|
-
isRequired: import("react-desc").
|
|
147
|
+
isRequired: import("react-desc").PropTypesDescValue;
|
|
148
148
|
};
|
|
149
149
|
/** Wheter there is a next page for Infinite Scroll, controls when to trigger onGetMoreItems */
|
|
150
150
|
hasNextPage: {
|
|
151
|
-
defaultValue
|
|
151
|
+
defaultValue(arg: import("react-desc").ReactDescPossibleDefaultValues): {
|
|
152
152
|
deprecated: import("react-desc").PropTypesDescValidator;
|
|
153
153
|
};
|
|
154
|
-
isRequired: import("react-desc").
|
|
154
|
+
isRequired: import("react-desc").PropTypesDescValue;
|
|
155
155
|
};
|
|
156
156
|
/** Function that takes as a parameter an internal getter for the state */
|
|
157
157
|
setGetStatus: {
|
|
158
|
-
defaultValue
|
|
158
|
+
defaultValue(arg: import("react-desc").ReactDescPossibleDefaultValues): {
|
|
159
159
|
deprecated: import("react-desc").PropTypesDescValidator;
|
|
160
160
|
};
|
|
161
|
-
isRequired: import("react-desc").
|
|
161
|
+
isRequired: import("react-desc").PropTypesDescValue;
|
|
162
162
|
};
|
|
163
163
|
/** Whether the target can be sortable with DnD */
|
|
164
164
|
targetSortable: {
|
|
165
|
-
defaultValue
|
|
165
|
+
defaultValue(arg: import("react-desc").ReactDescPossibleDefaultValues): {
|
|
166
166
|
deprecated: import("react-desc").PropTypesDescValidator;
|
|
167
167
|
};
|
|
168
|
-
isRequired: import("react-desc").
|
|
168
|
+
isRequired: import("react-desc").PropTypesDescValue;
|
|
169
169
|
};
|
|
170
170
|
/** Handler when the searchbox is visible */
|
|
171
171
|
sourceRootTitle: {
|
|
172
|
-
defaultValue
|
|
172
|
+
defaultValue(arg: import("react-desc").ReactDescPossibleDefaultValues): {
|
|
173
173
|
deprecated: import("react-desc").PropTypesDescValidator;
|
|
174
174
|
};
|
|
175
|
-
isRequired: import("react-desc").
|
|
175
|
+
isRequired: import("react-desc").PropTypesDescValue;
|
|
176
176
|
};
|
|
177
177
|
/** Source text when there is no items */
|
|
178
178
|
sourceEmptyMessage: {
|
|
179
|
-
defaultValue
|
|
179
|
+
defaultValue(arg: import("react-desc").ReactDescPossibleDefaultValues): {
|
|
180
180
|
deprecated: import("react-desc").PropTypesDescValidator;
|
|
181
181
|
};
|
|
182
|
-
isRequired: import("react-desc").
|
|
182
|
+
isRequired: import("react-desc").PropTypesDescValue;
|
|
183
183
|
};
|
|
184
184
|
/** Target text when there is no items */
|
|
185
185
|
targetEmptyMessage: {
|
|
186
|
-
defaultValue
|
|
186
|
+
defaultValue(arg: import("react-desc").ReactDescPossibleDefaultValues): {
|
|
187
187
|
deprecated: import("react-desc").PropTypesDescValidator;
|
|
188
188
|
};
|
|
189
|
-
isRequired: import("react-desc").
|
|
189
|
+
isRequired: import("react-desc").PropTypesDescValue;
|
|
190
190
|
};
|
|
191
191
|
/** Target text for the first hierarchy item */
|
|
192
192
|
targetRootTitle: {
|
|
193
|
-
defaultValue
|
|
193
|
+
defaultValue(arg: import("react-desc").ReactDescPossibleDefaultValues): {
|
|
194
194
|
deprecated: import("react-desc").PropTypesDescValidator;
|
|
195
195
|
};
|
|
196
|
-
isRequired: import("react-desc").
|
|
196
|
+
isRequired: import("react-desc").PropTypesDescValue;
|
|
197
197
|
};
|
|
198
198
|
/** Function that allow to compose the item props in the source */
|
|
199
199
|
composeSourceItemProps: {
|
|
200
|
-
defaultValue
|
|
200
|
+
defaultValue(arg: import("react-desc").ReactDescPossibleDefaultValues): {
|
|
201
201
|
deprecated: import("react-desc").PropTypesDescValidator;
|
|
202
202
|
};
|
|
203
|
-
isRequired: import("react-desc").
|
|
203
|
+
isRequired: import("react-desc").PropTypesDescValue;
|
|
204
204
|
};
|
|
205
205
|
/** Function that allow to compose the item props in the target */
|
|
206
206
|
composeTargetItemProps: {
|
|
207
|
-
defaultValue
|
|
207
|
+
defaultValue(arg: import("react-desc").ReactDescPossibleDefaultValues): {
|
|
208
208
|
deprecated: import("react-desc").PropTypesDescValidator;
|
|
209
209
|
};
|
|
210
|
-
isRequired: import("react-desc").
|
|
210
|
+
isRequired: import("react-desc").PropTypesDescValue;
|
|
211
211
|
};
|
|
212
212
|
/** Handler when a users moves an item to the target */
|
|
213
213
|
onAddToTarget: {
|
|
214
|
-
defaultValue
|
|
214
|
+
defaultValue(arg: import("react-desc").ReactDescPossibleDefaultValues): {
|
|
215
215
|
deprecated: import("react-desc").PropTypesDescValidator;
|
|
216
216
|
};
|
|
217
|
-
isRequired: import("react-desc").
|
|
217
|
+
isRequired: import("react-desc").PropTypesDescValue;
|
|
218
218
|
};
|
|
219
219
|
/** Handler when a users moves all the 'checked' items to the target */
|
|
220
220
|
onAddCheckedItems: {
|
|
221
|
-
defaultValue
|
|
221
|
+
defaultValue(arg: import("react-desc").ReactDescPossibleDefaultValues): {
|
|
222
222
|
deprecated: import("react-desc").PropTypesDescValidator;
|
|
223
223
|
};
|
|
224
|
-
isRequired: import("react-desc").
|
|
224
|
+
isRequired: import("react-desc").PropTypesDescValue;
|
|
225
225
|
};
|
|
226
226
|
/** Handler when a user removes an item from the target */
|
|
227
227
|
onRemoveFromTarget: {
|
|
228
|
-
defaultValue
|
|
228
|
+
defaultValue(arg: import("react-desc").ReactDescPossibleDefaultValues): {
|
|
229
229
|
deprecated: import("react-desc").PropTypesDescValidator;
|
|
230
230
|
};
|
|
231
|
-
isRequired: import("react-desc").
|
|
231
|
+
isRequired: import("react-desc").PropTypesDescValue;
|
|
232
232
|
};
|
|
233
233
|
/** Handler when a user removes all the items from the target */
|
|
234
234
|
onRemoveAllFromTarget: {
|
|
235
|
-
defaultValue
|
|
235
|
+
defaultValue(arg: import("react-desc").ReactDescPossibleDefaultValues): {
|
|
236
236
|
deprecated: import("react-desc").PropTypesDescValidator;
|
|
237
237
|
};
|
|
238
|
-
isRequired: import("react-desc").
|
|
238
|
+
isRequired: import("react-desc").PropTypesDescValue;
|
|
239
239
|
};
|
|
240
240
|
/** Handler for every change on the state */
|
|
241
241
|
onChange: {
|
|
242
|
-
defaultValue
|
|
242
|
+
defaultValue(arg: import("react-desc").ReactDescPossibleDefaultValues): {
|
|
243
243
|
deprecated: import("react-desc").PropTypesDescValidator;
|
|
244
244
|
};
|
|
245
|
-
isRequired: import("react-desc").
|
|
245
|
+
isRequired: import("react-desc").PropTypesDescValue;
|
|
246
246
|
};
|
|
247
247
|
/** Function that returns an element for the source counter */
|
|
248
248
|
renderSourceCounter: {
|
|
249
|
-
defaultValue
|
|
249
|
+
defaultValue(arg: import("react-desc").ReactDescPossibleDefaultValues): {
|
|
250
250
|
deprecated: import("react-desc").PropTypesDescValidator;
|
|
251
251
|
};
|
|
252
|
-
isRequired: import("react-desc").
|
|
252
|
+
isRequired: import("react-desc").PropTypesDescValue;
|
|
253
253
|
};
|
|
254
254
|
/** Function that returns an element for the target counter */
|
|
255
255
|
renderTargetCounter: {
|
|
256
|
-
defaultValue
|
|
256
|
+
defaultValue(arg: import("react-desc").ReactDescPossibleDefaultValues): {
|
|
257
257
|
deprecated: import("react-desc").PropTypesDescValidator;
|
|
258
258
|
};
|
|
259
|
-
isRequired: import("react-desc").
|
|
259
|
+
isRequired: import("react-desc").PropTypesDescValue;
|
|
260
260
|
};
|
|
261
261
|
/** Source text for the clear items button */
|
|
262
262
|
sourceClearItemsText: {
|
|
263
|
-
defaultValue
|
|
263
|
+
defaultValue(arg: import("react-desc").ReactDescPossibleDefaultValues): {
|
|
264
264
|
deprecated: import("react-desc").PropTypesDescValidator;
|
|
265
265
|
};
|
|
266
|
-
isRequired: import("react-desc").
|
|
266
|
+
isRequired: import("react-desc").PropTypesDescValue;
|
|
267
267
|
};
|
|
268
268
|
/** Target text for the clear items button */
|
|
269
269
|
targetClearItemsText: {
|
|
270
|
-
defaultValue
|
|
270
|
+
defaultValue(arg: import("react-desc").ReactDescPossibleDefaultValues): {
|
|
271
271
|
deprecated: import("react-desc").PropTypesDescValidator;
|
|
272
272
|
};
|
|
273
|
-
isRequired: import("react-desc").
|
|
273
|
+
isRequired: import("react-desc").PropTypesDescValue;
|
|
274
274
|
};
|
|
275
275
|
/** Searchbox placeholder */
|
|
276
276
|
searchPlaceholder: {
|
|
277
|
-
defaultValue
|
|
277
|
+
defaultValue(arg: import("react-desc").ReactDescPossibleDefaultValues): {
|
|
278
278
|
deprecated: import("react-desc").PropTypesDescValidator;
|
|
279
279
|
};
|
|
280
|
-
isRequired: import("react-desc").
|
|
280
|
+
isRequired: import("react-desc").PropTypesDescValue;
|
|
281
281
|
};
|
|
282
282
|
/** Displays loading indicator on source section */
|
|
283
283
|
loadingSource: {
|
|
284
|
-
defaultValue
|
|
284
|
+
defaultValue(arg: import("react-desc").ReactDescPossibleDefaultValues): {
|
|
285
285
|
deprecated: import("react-desc").PropTypesDescValidator;
|
|
286
286
|
};
|
|
287
|
-
isRequired: import("react-desc").
|
|
287
|
+
isRequired: import("react-desc").PropTypesDescValue;
|
|
288
288
|
};
|
|
289
289
|
/** Displays loading indicator on target section */
|
|
290
290
|
loadingTarget: {
|
|
291
|
-
defaultValue
|
|
291
|
+
defaultValue(arg: import("react-desc").ReactDescPossibleDefaultValues): {
|
|
292
292
|
deprecated: import("react-desc").PropTypesDescValidator;
|
|
293
293
|
};
|
|
294
|
-
isRequired: import("react-desc").
|
|
294
|
+
isRequired: import("react-desc").PropTypesDescValue;
|
|
295
295
|
};
|
|
296
296
|
};
|
|
297
297
|
};
|