@progress/kendo-react-animation 10.2.0-develop.5 → 10.2.0-develop.7
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/index.d.mts +225 -52
- package/index.d.ts +225 -52
- package/package.json +2 -2
package/index.d.mts
CHANGED
|
@@ -54,35 +54,61 @@ export declare interface AnimationChildProps extends AnimationInterface {
|
|
|
54
54
|
*/
|
|
55
55
|
in?: boolean;
|
|
56
56
|
/**
|
|
57
|
-
*
|
|
57
|
+
* Custom inline styles to apply to the Animation container.
|
|
58
|
+
*
|
|
59
|
+
* @example
|
|
60
|
+
* <AnimationChild style={{ backgroundColor: "red" }} />
|
|
58
61
|
*/
|
|
59
62
|
style?: any;
|
|
60
63
|
/**
|
|
61
|
-
*
|
|
64
|
+
* Custom CSS class to apply to the Animation container.
|
|
65
|
+
*
|
|
66
|
+
* @example
|
|
67
|
+
* <AnimationChild className="custom-animation-class" />
|
|
62
68
|
*/
|
|
63
69
|
className?: string;
|
|
64
70
|
/**
|
|
65
|
-
* Specifies the
|
|
71
|
+
* Specifies the base class name for the transition. This class will be used
|
|
72
|
+
* to generate the `appear`, `enter`, and `exit` transition classes.
|
|
73
|
+
*
|
|
74
|
+
* @example
|
|
75
|
+
* <AnimationChild transitionName="fade" />
|
|
66
76
|
*/
|
|
67
77
|
transitionName: string;
|
|
68
78
|
/**
|
|
69
79
|
* Specifies the style which will be applied when the Animation reaches its entering state.
|
|
80
|
+
*
|
|
81
|
+
* @example
|
|
82
|
+
* <AnimationChild animationEnteringStyle={{ opacity: 0.5 }} />
|
|
70
83
|
*/
|
|
71
84
|
animationEnteringStyle?: any;
|
|
72
85
|
/**
|
|
73
|
-
*
|
|
86
|
+
* Inline styles applied when the Animation has entered.
|
|
87
|
+
*
|
|
88
|
+
* @example
|
|
89
|
+
* <AnimationChild animationEnteredStyle={{ opacity: 1 }} />
|
|
74
90
|
*/
|
|
75
91
|
animationEnteredStyle?: any;
|
|
76
92
|
/**
|
|
77
93
|
* Specifies the style which will be applied when the Animation reaches its exiting state.
|
|
94
|
+
*
|
|
95
|
+
* @example
|
|
96
|
+
* <AnimationChild animationExitingStyle={{ opacity: 0.5 }} />
|
|
78
97
|
*/
|
|
79
98
|
animationExitingStyle?: any;
|
|
80
99
|
/**
|
|
81
|
-
*
|
|
100
|
+
* Inline styles applied when the Animation has exited.
|
|
101
|
+
*
|
|
102
|
+
* @example
|
|
103
|
+
* <AnimationChild animationExitedStyle={{ opacity: 0 }} />
|
|
82
104
|
*/
|
|
83
105
|
animationExitedStyle?: any;
|
|
84
106
|
/**
|
|
85
|
-
*
|
|
107
|
+
* Provides unstyled options for the Animation. Accepts an object
|
|
108
|
+
* implementing the `AnimationsClassStructure` interface.
|
|
109
|
+
*
|
|
110
|
+
* @example
|
|
111
|
+
* <AnimationChild unstyled={{ appear: "custom-appear-class" }} />
|
|
86
112
|
*/
|
|
87
113
|
unstyled?: AnimationsClassStructure;
|
|
88
114
|
}
|
|
@@ -191,51 +217,87 @@ declare interface AnimationInterface {
|
|
|
191
217
|
*/
|
|
192
218
|
export declare interface AnimationProps extends AnimationInterface {
|
|
193
219
|
/**
|
|
194
|
-
*
|
|
220
|
+
* A function for customizing the rendering of child elements.
|
|
221
|
+
*
|
|
222
|
+
* @example
|
|
223
|
+
* <Animation childFactory={(child) => React.cloneElement(child, { ariaHidden: true })} />
|
|
195
224
|
*/
|
|
196
225
|
childFactory?: any;
|
|
197
226
|
/**
|
|
198
|
-
* Specifies the
|
|
227
|
+
* Specifies the CSS class names to be applied to the Animation container.
|
|
228
|
+
*
|
|
229
|
+
* @example
|
|
230
|
+
* <Animation className="animation-container" />
|
|
199
231
|
*/
|
|
200
232
|
className?: string;
|
|
201
233
|
/**
|
|
202
|
-
* Specifies the
|
|
234
|
+
* Specifies the HTML tag of the parent Animation container. Defaults to `div`.
|
|
235
|
+
*
|
|
236
|
+
* @example
|
|
237
|
+
* <Animation component="main" />
|
|
203
238
|
*/
|
|
204
239
|
component?: string;
|
|
205
240
|
/**
|
|
206
|
-
* Specifies the id of the Animation.
|
|
241
|
+
* Specifies the `id` attribute of the Animation container.
|
|
242
|
+
*
|
|
243
|
+
* @example
|
|
244
|
+
* <Animation id="animation-container" />
|
|
207
245
|
*/
|
|
208
246
|
id?: string;
|
|
209
247
|
/**
|
|
210
|
-
* Specifies the
|
|
248
|
+
* Specifies the inline styles to be applied to the Animation container.
|
|
249
|
+
*
|
|
250
|
+
* @example
|
|
251
|
+
* <Animation style={{ width: "100%" }} />
|
|
211
252
|
*/
|
|
212
253
|
style?: any;
|
|
213
254
|
/**
|
|
214
|
-
*
|
|
255
|
+
* Determines whether child elements will stack on top of each other during the animation.
|
|
256
|
+
*
|
|
257
|
+
* @example
|
|
258
|
+
* <Animation stackChildren={true} />
|
|
215
259
|
*/
|
|
216
260
|
stackChildren?: boolean;
|
|
217
261
|
/**
|
|
218
|
-
* Specifies the
|
|
262
|
+
* Specifies the base class name for the transition.
|
|
263
|
+
*
|
|
264
|
+
* @example
|
|
265
|
+
* <Animation transitionName="fade" />
|
|
219
266
|
*/
|
|
220
267
|
transitionName: string;
|
|
221
268
|
/**
|
|
222
|
-
* Specifies the
|
|
269
|
+
* Specifies the inline styles applied when the Animation is entering.
|
|
270
|
+
*
|
|
271
|
+
* @example
|
|
272
|
+
* <Animation animationEnteringStyle={{ opacity: 0.5 }} />
|
|
223
273
|
*/
|
|
224
274
|
animationEnteringStyle?: any;
|
|
225
275
|
/**
|
|
226
|
-
* Specifies the
|
|
276
|
+
* Specifies the inline styles applied when the Animation has entered.
|
|
277
|
+
*
|
|
278
|
+
* @example
|
|
279
|
+
* <Animation animationEnteredStyle={{ opacity: 1 }} />
|
|
227
280
|
*/
|
|
228
281
|
animationEnteredStyle?: any;
|
|
229
282
|
/**
|
|
230
|
-
* Specifies the
|
|
283
|
+
* Specifies the inline styles applied when the Animation is exiting.
|
|
284
|
+
*
|
|
285
|
+
* @example
|
|
286
|
+
* <Animation animationExitingStyle={{ opacity: 0.5 }} />
|
|
231
287
|
*/
|
|
232
288
|
animationExitingStyle?: any;
|
|
233
289
|
/**
|
|
234
|
-
* Specifies the
|
|
290
|
+
* Specifies the inline styles applied when the Animation has exited.
|
|
291
|
+
*
|
|
292
|
+
* @example
|
|
293
|
+
* <Animation animationExitedStyle={{ opacity: 0 }} />
|
|
235
294
|
*/
|
|
236
295
|
animationExitedStyle?: any;
|
|
237
296
|
/**
|
|
238
|
-
*
|
|
297
|
+
* Provides unstyled options for the Animation.
|
|
298
|
+
*
|
|
299
|
+
* @example
|
|
300
|
+
* <Animation unstyled={{ appear: "unstyled-appear" }} />
|
|
239
301
|
*/
|
|
240
302
|
unstyled?: AnimationsClassStructure;
|
|
241
303
|
}
|
|
@@ -274,27 +336,45 @@ export declare type ExpandDirection = 'horizontal' | 'vertical';
|
|
|
274
336
|
*/
|
|
275
337
|
export declare interface ExpandProps extends AnimationInterface {
|
|
276
338
|
/**
|
|
277
|
-
*
|
|
339
|
+
* A function for customizing the rendering of child elements.
|
|
340
|
+
*
|
|
341
|
+
* @example
|
|
342
|
+
* <Expand childFactory={(child) => React.cloneElement(child, { role: "button" })} />
|
|
278
343
|
*/
|
|
279
344
|
childFactory?: any;
|
|
280
345
|
/**
|
|
281
|
-
* Specifies the CSS class names
|
|
346
|
+
* Specifies the CSS class names to be applied to the Animation container.
|
|
347
|
+
*
|
|
348
|
+
* @example
|
|
349
|
+
* <Expand className="expand-animation" />
|
|
282
350
|
*/
|
|
283
351
|
className?: string;
|
|
284
352
|
/**
|
|
285
353
|
* Specifies the direction of the Expand Animation. Defaults to `vertical`.
|
|
354
|
+
*
|
|
355
|
+
* @example
|
|
356
|
+
* <Expand direction="horizontal" />
|
|
286
357
|
*/
|
|
287
358
|
direction?: ExpandDirection;
|
|
288
359
|
/**
|
|
289
|
-
* Specifies the
|
|
360
|
+
* Specifies the HTML tag of the parent Animation container. Defaults to `div`.
|
|
361
|
+
*
|
|
362
|
+
* @example
|
|
363
|
+
* <Expand component="nav" />
|
|
290
364
|
*/
|
|
291
365
|
component?: string;
|
|
292
366
|
/**
|
|
293
|
-
* Specifies the id of the Animation.
|
|
367
|
+
* Specifies the `id` attribute of the Animation container.
|
|
368
|
+
*
|
|
369
|
+
* @example
|
|
370
|
+
* <Expand id="expand-animation-container" />
|
|
294
371
|
*/
|
|
295
372
|
id?: string;
|
|
296
373
|
/**
|
|
297
|
-
* Specifies the
|
|
374
|
+
* Specifies the inline styles to be applied to the Animation container.
|
|
375
|
+
*
|
|
376
|
+
* @example
|
|
377
|
+
* <Expand style={{ display: "flex" }} />
|
|
298
378
|
*/
|
|
299
379
|
style?: any;
|
|
300
380
|
}
|
|
@@ -323,23 +403,38 @@ export declare const Fade: {
|
|
|
323
403
|
*/
|
|
324
404
|
export declare interface FadeProps extends AnimationInterface {
|
|
325
405
|
/**
|
|
326
|
-
*
|
|
406
|
+
* A function for customizing the rendering of child elements.
|
|
407
|
+
*
|
|
408
|
+
* @example
|
|
409
|
+
* <Fade childFactory={(child) => React.cloneElement(child, { draggable: true })} />
|
|
327
410
|
*/
|
|
328
411
|
childFactory?: any;
|
|
329
412
|
/**
|
|
330
|
-
* Specifies CSS class names
|
|
413
|
+
* Specifies the CSS class names to be applied to the Animation container.
|
|
414
|
+
*
|
|
415
|
+
* @example
|
|
416
|
+
* <Fade className="fade-animation" />
|
|
331
417
|
*/
|
|
332
418
|
className?: string;
|
|
333
419
|
/**
|
|
334
|
-
* Specifies the
|
|
420
|
+
* Specifies the HTML tag of the parent Animation container. Defaults to `div`.
|
|
421
|
+
*
|
|
422
|
+
* @example
|
|
423
|
+
* <Fade component="header" />
|
|
335
424
|
*/
|
|
336
425
|
component?: string;
|
|
337
426
|
/**
|
|
338
|
-
* Specifies the id of the Animation.
|
|
427
|
+
* Specifies the `id` attribute of the Animation container.
|
|
428
|
+
*
|
|
429
|
+
* @example
|
|
430
|
+
* <Fade id="fade-animation-container" />
|
|
339
431
|
*/
|
|
340
432
|
id?: string;
|
|
341
433
|
/**
|
|
342
|
-
* Specifies the
|
|
434
|
+
* Specifies the inline styles to be applied to the Animation container.
|
|
435
|
+
*
|
|
436
|
+
* @example
|
|
437
|
+
* <Fade style={{ color: "blue" }} />
|
|
343
438
|
*/
|
|
344
439
|
style?: any;
|
|
345
440
|
}
|
|
@@ -381,31 +476,52 @@ export declare type PushDirection = 'up' | 'down' | 'left' | 'right';
|
|
|
381
476
|
*/
|
|
382
477
|
export declare interface PushProps extends AnimationInterface {
|
|
383
478
|
/**
|
|
384
|
-
*
|
|
479
|
+
* A function for customizing the rendering of child elements.
|
|
480
|
+
*
|
|
481
|
+
* @example
|
|
482
|
+
* <Push childFactory={(child) => React.cloneElement(child, { tabIndex: 0 })} />
|
|
385
483
|
*/
|
|
386
484
|
childFactory?: any;
|
|
387
485
|
/**
|
|
388
|
-
* Specifies the CSS class names
|
|
486
|
+
* Specifies the CSS class names to be applied to the Animation container.
|
|
487
|
+
*
|
|
488
|
+
* @example
|
|
489
|
+
* <Push className="push-animation" />
|
|
389
490
|
*/
|
|
390
491
|
className?: string;
|
|
391
492
|
/**
|
|
392
|
-
* Specifies the direction of the Push Animation. Defaults to `
|
|
493
|
+
* Specifies the direction of the Push Animation. Defaults to `right`.
|
|
494
|
+
*
|
|
495
|
+
* @example
|
|
496
|
+
* <Push direction="up" />
|
|
393
497
|
*/
|
|
394
498
|
direction?: PushDirection;
|
|
395
499
|
/**
|
|
396
|
-
* Specifies the
|
|
500
|
+
* Specifies the HTML tag of the parent Animation container. Defaults to `div`.
|
|
501
|
+
*
|
|
502
|
+
* @example
|
|
503
|
+
* <Push component="footer" />
|
|
397
504
|
*/
|
|
398
505
|
component?: string;
|
|
399
506
|
/**
|
|
400
|
-
* Specifies the id of the Animation.
|
|
507
|
+
* Specifies the `id` attribute of the Animation container.
|
|
508
|
+
*
|
|
509
|
+
* @example
|
|
510
|
+
* <Push id="push-animation-container" />
|
|
401
511
|
*/
|
|
402
512
|
id?: string;
|
|
403
513
|
/**
|
|
404
|
-
* Specifies the
|
|
514
|
+
* Specifies the inline styles to be applied to the Animation container.
|
|
515
|
+
*
|
|
516
|
+
* @example
|
|
517
|
+
* <Push style={{ border: "1px solid black" }} />
|
|
405
518
|
*/
|
|
406
519
|
style?: any;
|
|
407
520
|
/**
|
|
408
|
-
*
|
|
521
|
+
* Determines whether child elements will stack on top of each other during the animation. Defaults to `false`.
|
|
522
|
+
*
|
|
523
|
+
* @example
|
|
524
|
+
* <Push stackChildren={true} />
|
|
409
525
|
*/
|
|
410
526
|
stackChildren?: boolean;
|
|
411
527
|
}
|
|
@@ -444,27 +560,45 @@ export declare type RevealDirection = 'horizontal' | 'vertical';
|
|
|
444
560
|
*/
|
|
445
561
|
export declare interface RevealProps extends AnimationInterface {
|
|
446
562
|
/**
|
|
447
|
-
*
|
|
563
|
+
* A function for customizing the rendering of child elements.
|
|
564
|
+
*
|
|
565
|
+
* @example
|
|
566
|
+
* <Reveal childFactory={(child) => React.cloneElement(child, { hidden: true })} />
|
|
448
567
|
*/
|
|
449
568
|
childFactory?: any;
|
|
450
569
|
/**
|
|
451
|
-
* Specifies the CSS class names
|
|
570
|
+
* Specifies the CSS class names to be applied to the Animation container.
|
|
571
|
+
*
|
|
572
|
+
* @example
|
|
573
|
+
* <Reveal className="reveal-animation" />
|
|
452
574
|
*/
|
|
453
575
|
className?: string;
|
|
454
576
|
/**
|
|
455
577
|
* Specifies the direction of the Reveal Animation. Defaults to `vertical`.
|
|
578
|
+
*
|
|
579
|
+
* @example
|
|
580
|
+
* <Reveal direction="horizontal" />
|
|
456
581
|
*/
|
|
457
582
|
direction?: RevealDirection;
|
|
458
583
|
/**
|
|
459
|
-
* Specifies the
|
|
584
|
+
* Specifies the HTML tag of the parent Animation container. Defaults to `div`.
|
|
585
|
+
*
|
|
586
|
+
* @example
|
|
587
|
+
* <Reveal component="aside" />
|
|
460
588
|
*/
|
|
461
589
|
component?: string;
|
|
462
590
|
/**
|
|
463
|
-
* Specifies the id of the Animation.
|
|
591
|
+
* Specifies the `id` attribute of the Animation container.
|
|
592
|
+
*
|
|
593
|
+
* @example
|
|
594
|
+
* <Reveal id="reveal-animation-container" />
|
|
464
595
|
*/
|
|
465
596
|
id?: string;
|
|
466
597
|
/**
|
|
467
|
-
* Specifies the
|
|
598
|
+
* Specifies the inline styles to be applied to the Animation container.
|
|
599
|
+
*
|
|
600
|
+
* @example
|
|
601
|
+
* <Reveal style={{ padding: "20px" }} />
|
|
468
602
|
*/
|
|
469
603
|
style?: any;
|
|
470
604
|
/**
|
|
@@ -510,27 +644,45 @@ export declare type SlideDirection = 'up' | 'down' | 'left' | 'right';
|
|
|
510
644
|
*/
|
|
511
645
|
export declare interface SlideProps extends AnimationInterface {
|
|
512
646
|
/**
|
|
513
|
-
*
|
|
647
|
+
* A function for customizing the rendering of child elements.
|
|
648
|
+
*
|
|
649
|
+
* @example
|
|
650
|
+
* <Slide childFactory={(child) => React.cloneElement(child, { style: { opacity: 0.5 } })} />
|
|
514
651
|
*/
|
|
515
652
|
childFactory?: any;
|
|
516
653
|
/**
|
|
517
|
-
* Specifies the CSS class names
|
|
654
|
+
* Specifies the CSS class names to be applied to the Animation container.
|
|
655
|
+
*
|
|
656
|
+
* @example
|
|
657
|
+
* <Slide className="slide-animation" />
|
|
518
658
|
*/
|
|
519
659
|
className?: string;
|
|
520
660
|
/**
|
|
521
661
|
* Specifies the direction of the Slide Animation. Defaults to `down`.
|
|
662
|
+
*
|
|
663
|
+
* @example
|
|
664
|
+
* <Slide direction="left" />
|
|
522
665
|
*/
|
|
523
666
|
direction?: SlideDirection;
|
|
524
667
|
/**
|
|
525
|
-
* Specifies the
|
|
668
|
+
* Specifies the HTML tag of the parent Animation container. Defaults to `div`.
|
|
669
|
+
*
|
|
670
|
+
* @example
|
|
671
|
+
* <Slide component="article" />
|
|
526
672
|
*/
|
|
527
673
|
component?: string;
|
|
528
674
|
/**
|
|
529
|
-
* Specifies the id of the Animation.
|
|
675
|
+
* Specifies the `id` attribute of the Animation container.
|
|
676
|
+
*
|
|
677
|
+
* @example
|
|
678
|
+
* <Slide id="slide-animation-container" />
|
|
530
679
|
*/
|
|
531
680
|
id?: string;
|
|
532
681
|
/**
|
|
533
|
-
* Specifies the
|
|
682
|
+
* Specifies the inline styles to be applied to the Animation container.
|
|
683
|
+
*
|
|
684
|
+
* @example
|
|
685
|
+
* <Slide style={{ margin: "10px" }} />
|
|
534
686
|
*/
|
|
535
687
|
style?: any;
|
|
536
688
|
}
|
|
@@ -573,31 +725,52 @@ export declare type ZoomDirection = 'in' | 'out';
|
|
|
573
725
|
*/
|
|
574
726
|
export declare interface ZoomProps extends AnimationInterface {
|
|
575
727
|
/**
|
|
576
|
-
*
|
|
728
|
+
* A function for customizing the rendering of child elements.
|
|
729
|
+
*
|
|
730
|
+
* @example
|
|
731
|
+
* <Zoom childFactory={(child) => React.cloneElement(child, { className: 'custom-class' })} />
|
|
577
732
|
*/
|
|
578
733
|
childFactory?: any;
|
|
579
734
|
/**
|
|
580
|
-
* Specifies the CSS class names
|
|
735
|
+
* Specifies the CSS class names to be applied to the Animation container.
|
|
736
|
+
*
|
|
737
|
+
* @example
|
|
738
|
+
* <Zoom className="zoom-animation" />
|
|
581
739
|
*/
|
|
582
740
|
className?: string;
|
|
583
741
|
/**
|
|
584
|
-
* Specifies the direction of the Zoom Animation. Defaults to `
|
|
742
|
+
* Specifies the direction of the Zoom Animation. Defaults to `out`.
|
|
743
|
+
*
|
|
744
|
+
* @example
|
|
745
|
+
* <Zoom direction="in" />
|
|
585
746
|
*/
|
|
586
747
|
direction?: ZoomDirection;
|
|
587
748
|
/**
|
|
588
|
-
* Specifies the
|
|
749
|
+
* Specifies the HTML tag of the parent Animation container. Defaults to `div`.
|
|
750
|
+
*
|
|
751
|
+
* @example
|
|
752
|
+
* <Zoom component="section" />
|
|
589
753
|
*/
|
|
590
754
|
component?: string;
|
|
591
755
|
/**
|
|
592
|
-
* Specifies the id of the Animation.
|
|
756
|
+
* Specifies the `id` attribute of the Animation container.
|
|
757
|
+
*
|
|
758
|
+
* @example
|
|
759
|
+
* <Zoom id="zoom-animation-container" />
|
|
593
760
|
*/
|
|
594
761
|
id?: string;
|
|
595
762
|
/**
|
|
596
|
-
* Specifies the
|
|
763
|
+
* Specifies the inline styles to be applied to the Animation container.
|
|
764
|
+
*
|
|
765
|
+
* @example
|
|
766
|
+
* <Zoom style={{ backgroundColor: "red" }} />
|
|
597
767
|
*/
|
|
598
768
|
style?: any;
|
|
599
769
|
/**
|
|
600
|
-
*
|
|
770
|
+
* Determines whether child elements will stack on top of each other during the animation. Defaults to `false`.
|
|
771
|
+
*
|
|
772
|
+
* @example
|
|
773
|
+
* <Zoom stackChildren={true} />
|
|
601
774
|
*/
|
|
602
775
|
stackChildren?: boolean;
|
|
603
776
|
}
|
package/index.d.ts
CHANGED
|
@@ -54,35 +54,61 @@ export declare interface AnimationChildProps extends AnimationInterface {
|
|
|
54
54
|
*/
|
|
55
55
|
in?: boolean;
|
|
56
56
|
/**
|
|
57
|
-
*
|
|
57
|
+
* Custom inline styles to apply to the Animation container.
|
|
58
|
+
*
|
|
59
|
+
* @example
|
|
60
|
+
* <AnimationChild style={{ backgroundColor: "red" }} />
|
|
58
61
|
*/
|
|
59
62
|
style?: any;
|
|
60
63
|
/**
|
|
61
|
-
*
|
|
64
|
+
* Custom CSS class to apply to the Animation container.
|
|
65
|
+
*
|
|
66
|
+
* @example
|
|
67
|
+
* <AnimationChild className="custom-animation-class" />
|
|
62
68
|
*/
|
|
63
69
|
className?: string;
|
|
64
70
|
/**
|
|
65
|
-
* Specifies the
|
|
71
|
+
* Specifies the base class name for the transition. This class will be used
|
|
72
|
+
* to generate the `appear`, `enter`, and `exit` transition classes.
|
|
73
|
+
*
|
|
74
|
+
* @example
|
|
75
|
+
* <AnimationChild transitionName="fade" />
|
|
66
76
|
*/
|
|
67
77
|
transitionName: string;
|
|
68
78
|
/**
|
|
69
79
|
* Specifies the style which will be applied when the Animation reaches its entering state.
|
|
80
|
+
*
|
|
81
|
+
* @example
|
|
82
|
+
* <AnimationChild animationEnteringStyle={{ opacity: 0.5 }} />
|
|
70
83
|
*/
|
|
71
84
|
animationEnteringStyle?: any;
|
|
72
85
|
/**
|
|
73
|
-
*
|
|
86
|
+
* Inline styles applied when the Animation has entered.
|
|
87
|
+
*
|
|
88
|
+
* @example
|
|
89
|
+
* <AnimationChild animationEnteredStyle={{ opacity: 1 }} />
|
|
74
90
|
*/
|
|
75
91
|
animationEnteredStyle?: any;
|
|
76
92
|
/**
|
|
77
93
|
* Specifies the style which will be applied when the Animation reaches its exiting state.
|
|
94
|
+
*
|
|
95
|
+
* @example
|
|
96
|
+
* <AnimationChild animationExitingStyle={{ opacity: 0.5 }} />
|
|
78
97
|
*/
|
|
79
98
|
animationExitingStyle?: any;
|
|
80
99
|
/**
|
|
81
|
-
*
|
|
100
|
+
* Inline styles applied when the Animation has exited.
|
|
101
|
+
*
|
|
102
|
+
* @example
|
|
103
|
+
* <AnimationChild animationExitedStyle={{ opacity: 0 }} />
|
|
82
104
|
*/
|
|
83
105
|
animationExitedStyle?: any;
|
|
84
106
|
/**
|
|
85
|
-
*
|
|
107
|
+
* Provides unstyled options for the Animation. Accepts an object
|
|
108
|
+
* implementing the `AnimationsClassStructure` interface.
|
|
109
|
+
*
|
|
110
|
+
* @example
|
|
111
|
+
* <AnimationChild unstyled={{ appear: "custom-appear-class" }} />
|
|
86
112
|
*/
|
|
87
113
|
unstyled?: AnimationsClassStructure;
|
|
88
114
|
}
|
|
@@ -191,51 +217,87 @@ declare interface AnimationInterface {
|
|
|
191
217
|
*/
|
|
192
218
|
export declare interface AnimationProps extends AnimationInterface {
|
|
193
219
|
/**
|
|
194
|
-
*
|
|
220
|
+
* A function for customizing the rendering of child elements.
|
|
221
|
+
*
|
|
222
|
+
* @example
|
|
223
|
+
* <Animation childFactory={(child) => React.cloneElement(child, { ariaHidden: true })} />
|
|
195
224
|
*/
|
|
196
225
|
childFactory?: any;
|
|
197
226
|
/**
|
|
198
|
-
* Specifies the
|
|
227
|
+
* Specifies the CSS class names to be applied to the Animation container.
|
|
228
|
+
*
|
|
229
|
+
* @example
|
|
230
|
+
* <Animation className="animation-container" />
|
|
199
231
|
*/
|
|
200
232
|
className?: string;
|
|
201
233
|
/**
|
|
202
|
-
* Specifies the
|
|
234
|
+
* Specifies the HTML tag of the parent Animation container. Defaults to `div`.
|
|
235
|
+
*
|
|
236
|
+
* @example
|
|
237
|
+
* <Animation component="main" />
|
|
203
238
|
*/
|
|
204
239
|
component?: string;
|
|
205
240
|
/**
|
|
206
|
-
* Specifies the id of the Animation.
|
|
241
|
+
* Specifies the `id` attribute of the Animation container.
|
|
242
|
+
*
|
|
243
|
+
* @example
|
|
244
|
+
* <Animation id="animation-container" />
|
|
207
245
|
*/
|
|
208
246
|
id?: string;
|
|
209
247
|
/**
|
|
210
|
-
* Specifies the
|
|
248
|
+
* Specifies the inline styles to be applied to the Animation container.
|
|
249
|
+
*
|
|
250
|
+
* @example
|
|
251
|
+
* <Animation style={{ width: "100%" }} />
|
|
211
252
|
*/
|
|
212
253
|
style?: any;
|
|
213
254
|
/**
|
|
214
|
-
*
|
|
255
|
+
* Determines whether child elements will stack on top of each other during the animation.
|
|
256
|
+
*
|
|
257
|
+
* @example
|
|
258
|
+
* <Animation stackChildren={true} />
|
|
215
259
|
*/
|
|
216
260
|
stackChildren?: boolean;
|
|
217
261
|
/**
|
|
218
|
-
* Specifies the
|
|
262
|
+
* Specifies the base class name for the transition.
|
|
263
|
+
*
|
|
264
|
+
* @example
|
|
265
|
+
* <Animation transitionName="fade" />
|
|
219
266
|
*/
|
|
220
267
|
transitionName: string;
|
|
221
268
|
/**
|
|
222
|
-
* Specifies the
|
|
269
|
+
* Specifies the inline styles applied when the Animation is entering.
|
|
270
|
+
*
|
|
271
|
+
* @example
|
|
272
|
+
* <Animation animationEnteringStyle={{ opacity: 0.5 }} />
|
|
223
273
|
*/
|
|
224
274
|
animationEnteringStyle?: any;
|
|
225
275
|
/**
|
|
226
|
-
* Specifies the
|
|
276
|
+
* Specifies the inline styles applied when the Animation has entered.
|
|
277
|
+
*
|
|
278
|
+
* @example
|
|
279
|
+
* <Animation animationEnteredStyle={{ opacity: 1 }} />
|
|
227
280
|
*/
|
|
228
281
|
animationEnteredStyle?: any;
|
|
229
282
|
/**
|
|
230
|
-
* Specifies the
|
|
283
|
+
* Specifies the inline styles applied when the Animation is exiting.
|
|
284
|
+
*
|
|
285
|
+
* @example
|
|
286
|
+
* <Animation animationExitingStyle={{ opacity: 0.5 }} />
|
|
231
287
|
*/
|
|
232
288
|
animationExitingStyle?: any;
|
|
233
289
|
/**
|
|
234
|
-
* Specifies the
|
|
290
|
+
* Specifies the inline styles applied when the Animation has exited.
|
|
291
|
+
*
|
|
292
|
+
* @example
|
|
293
|
+
* <Animation animationExitedStyle={{ opacity: 0 }} />
|
|
235
294
|
*/
|
|
236
295
|
animationExitedStyle?: any;
|
|
237
296
|
/**
|
|
238
|
-
*
|
|
297
|
+
* Provides unstyled options for the Animation.
|
|
298
|
+
*
|
|
299
|
+
* @example
|
|
300
|
+
* <Animation unstyled={{ appear: "unstyled-appear" }} />
|
|
239
301
|
*/
|
|
240
302
|
unstyled?: AnimationsClassStructure;
|
|
241
303
|
}
|
|
@@ -274,27 +336,45 @@ export declare type ExpandDirection = 'horizontal' | 'vertical';
|
|
|
274
336
|
*/
|
|
275
337
|
export declare interface ExpandProps extends AnimationInterface {
|
|
276
338
|
/**
|
|
277
|
-
*
|
|
339
|
+
* A function for customizing the rendering of child elements.
|
|
340
|
+
*
|
|
341
|
+
* @example
|
|
342
|
+
* <Expand childFactory={(child) => React.cloneElement(child, { role: "button" })} />
|
|
278
343
|
*/
|
|
279
344
|
childFactory?: any;
|
|
280
345
|
/**
|
|
281
|
-
* Specifies the CSS class names
|
|
346
|
+
* Specifies the CSS class names to be applied to the Animation container.
|
|
347
|
+
*
|
|
348
|
+
* @example
|
|
349
|
+
* <Expand className="expand-animation" />
|
|
282
350
|
*/
|
|
283
351
|
className?: string;
|
|
284
352
|
/**
|
|
285
353
|
* Specifies the direction of the Expand Animation. Defaults to `vertical`.
|
|
354
|
+
*
|
|
355
|
+
* @example
|
|
356
|
+
* <Expand direction="horizontal" />
|
|
286
357
|
*/
|
|
287
358
|
direction?: ExpandDirection;
|
|
288
359
|
/**
|
|
289
|
-
* Specifies the
|
|
360
|
+
* Specifies the HTML tag of the parent Animation container. Defaults to `div`.
|
|
361
|
+
*
|
|
362
|
+
* @example
|
|
363
|
+
* <Expand component="nav" />
|
|
290
364
|
*/
|
|
291
365
|
component?: string;
|
|
292
366
|
/**
|
|
293
|
-
* Specifies the id of the Animation.
|
|
367
|
+
* Specifies the `id` attribute of the Animation container.
|
|
368
|
+
*
|
|
369
|
+
* @example
|
|
370
|
+
* <Expand id="expand-animation-container" />
|
|
294
371
|
*/
|
|
295
372
|
id?: string;
|
|
296
373
|
/**
|
|
297
|
-
* Specifies the
|
|
374
|
+
* Specifies the inline styles to be applied to the Animation container.
|
|
375
|
+
*
|
|
376
|
+
* @example
|
|
377
|
+
* <Expand style={{ display: "flex" }} />
|
|
298
378
|
*/
|
|
299
379
|
style?: any;
|
|
300
380
|
}
|
|
@@ -323,23 +403,38 @@ export declare const Fade: {
|
|
|
323
403
|
*/
|
|
324
404
|
export declare interface FadeProps extends AnimationInterface {
|
|
325
405
|
/**
|
|
326
|
-
*
|
|
406
|
+
* A function for customizing the rendering of child elements.
|
|
407
|
+
*
|
|
408
|
+
* @example
|
|
409
|
+
* <Fade childFactory={(child) => React.cloneElement(child, { draggable: true })} />
|
|
327
410
|
*/
|
|
328
411
|
childFactory?: any;
|
|
329
412
|
/**
|
|
330
|
-
* Specifies CSS class names
|
|
413
|
+
* Specifies the CSS class names to be applied to the Animation container.
|
|
414
|
+
*
|
|
415
|
+
* @example
|
|
416
|
+
* <Fade className="fade-animation" />
|
|
331
417
|
*/
|
|
332
418
|
className?: string;
|
|
333
419
|
/**
|
|
334
|
-
* Specifies the
|
|
420
|
+
* Specifies the HTML tag of the parent Animation container. Defaults to `div`.
|
|
421
|
+
*
|
|
422
|
+
* @example
|
|
423
|
+
* <Fade component="header" />
|
|
335
424
|
*/
|
|
336
425
|
component?: string;
|
|
337
426
|
/**
|
|
338
|
-
* Specifies the id of the Animation.
|
|
427
|
+
* Specifies the `id` attribute of the Animation container.
|
|
428
|
+
*
|
|
429
|
+
* @example
|
|
430
|
+
* <Fade id="fade-animation-container" />
|
|
339
431
|
*/
|
|
340
432
|
id?: string;
|
|
341
433
|
/**
|
|
342
|
-
* Specifies the
|
|
434
|
+
* Specifies the inline styles to be applied to the Animation container.
|
|
435
|
+
*
|
|
436
|
+
* @example
|
|
437
|
+
* <Fade style={{ color: "blue" }} />
|
|
343
438
|
*/
|
|
344
439
|
style?: any;
|
|
345
440
|
}
|
|
@@ -381,31 +476,52 @@ export declare type PushDirection = 'up' | 'down' | 'left' | 'right';
|
|
|
381
476
|
*/
|
|
382
477
|
export declare interface PushProps extends AnimationInterface {
|
|
383
478
|
/**
|
|
384
|
-
*
|
|
479
|
+
* A function for customizing the rendering of child elements.
|
|
480
|
+
*
|
|
481
|
+
* @example
|
|
482
|
+
* <Push childFactory={(child) => React.cloneElement(child, { tabIndex: 0 })} />
|
|
385
483
|
*/
|
|
386
484
|
childFactory?: any;
|
|
387
485
|
/**
|
|
388
|
-
* Specifies the CSS class names
|
|
486
|
+
* Specifies the CSS class names to be applied to the Animation container.
|
|
487
|
+
*
|
|
488
|
+
* @example
|
|
489
|
+
* <Push className="push-animation" />
|
|
389
490
|
*/
|
|
390
491
|
className?: string;
|
|
391
492
|
/**
|
|
392
|
-
* Specifies the direction of the Push Animation. Defaults to `
|
|
493
|
+
* Specifies the direction of the Push Animation. Defaults to `right`.
|
|
494
|
+
*
|
|
495
|
+
* @example
|
|
496
|
+
* <Push direction="up" />
|
|
393
497
|
*/
|
|
394
498
|
direction?: PushDirection;
|
|
395
499
|
/**
|
|
396
|
-
* Specifies the
|
|
500
|
+
* Specifies the HTML tag of the parent Animation container. Defaults to `div`.
|
|
501
|
+
*
|
|
502
|
+
* @example
|
|
503
|
+
* <Push component="footer" />
|
|
397
504
|
*/
|
|
398
505
|
component?: string;
|
|
399
506
|
/**
|
|
400
|
-
* Specifies the id of the Animation.
|
|
507
|
+
* Specifies the `id` attribute of the Animation container.
|
|
508
|
+
*
|
|
509
|
+
* @example
|
|
510
|
+
* <Push id="push-animation-container" />
|
|
401
511
|
*/
|
|
402
512
|
id?: string;
|
|
403
513
|
/**
|
|
404
|
-
* Specifies the
|
|
514
|
+
* Specifies the inline styles to be applied to the Animation container.
|
|
515
|
+
*
|
|
516
|
+
* @example
|
|
517
|
+
* <Push style={{ border: "1px solid black" }} />
|
|
405
518
|
*/
|
|
406
519
|
style?: any;
|
|
407
520
|
/**
|
|
408
|
-
*
|
|
521
|
+
* Determines whether child elements will stack on top of each other during the animation. Defaults to `false`.
|
|
522
|
+
*
|
|
523
|
+
* @example
|
|
524
|
+
* <Push stackChildren={true} />
|
|
409
525
|
*/
|
|
410
526
|
stackChildren?: boolean;
|
|
411
527
|
}
|
|
@@ -444,27 +560,45 @@ export declare type RevealDirection = 'horizontal' | 'vertical';
|
|
|
444
560
|
*/
|
|
445
561
|
export declare interface RevealProps extends AnimationInterface {
|
|
446
562
|
/**
|
|
447
|
-
*
|
|
563
|
+
* A function for customizing the rendering of child elements.
|
|
564
|
+
*
|
|
565
|
+
* @example
|
|
566
|
+
* <Reveal childFactory={(child) => React.cloneElement(child, { hidden: true })} />
|
|
448
567
|
*/
|
|
449
568
|
childFactory?: any;
|
|
450
569
|
/**
|
|
451
|
-
* Specifies the CSS class names
|
|
570
|
+
* Specifies the CSS class names to be applied to the Animation container.
|
|
571
|
+
*
|
|
572
|
+
* @example
|
|
573
|
+
* <Reveal className="reveal-animation" />
|
|
452
574
|
*/
|
|
453
575
|
className?: string;
|
|
454
576
|
/**
|
|
455
577
|
* Specifies the direction of the Reveal Animation. Defaults to `vertical`.
|
|
578
|
+
*
|
|
579
|
+
* @example
|
|
580
|
+
* <Reveal direction="horizontal" />
|
|
456
581
|
*/
|
|
457
582
|
direction?: RevealDirection;
|
|
458
583
|
/**
|
|
459
|
-
* Specifies the
|
|
584
|
+
* Specifies the HTML tag of the parent Animation container. Defaults to `div`.
|
|
585
|
+
*
|
|
586
|
+
* @example
|
|
587
|
+
* <Reveal component="aside" />
|
|
460
588
|
*/
|
|
461
589
|
component?: string;
|
|
462
590
|
/**
|
|
463
|
-
* Specifies the id of the Animation.
|
|
591
|
+
* Specifies the `id` attribute of the Animation container.
|
|
592
|
+
*
|
|
593
|
+
* @example
|
|
594
|
+
* <Reveal id="reveal-animation-container" />
|
|
464
595
|
*/
|
|
465
596
|
id?: string;
|
|
466
597
|
/**
|
|
467
|
-
* Specifies the
|
|
598
|
+
* Specifies the inline styles to be applied to the Animation container.
|
|
599
|
+
*
|
|
600
|
+
* @example
|
|
601
|
+
* <Reveal style={{ padding: "20px" }} />
|
|
468
602
|
*/
|
|
469
603
|
style?: any;
|
|
470
604
|
/**
|
|
@@ -510,27 +644,45 @@ export declare type SlideDirection = 'up' | 'down' | 'left' | 'right';
|
|
|
510
644
|
*/
|
|
511
645
|
export declare interface SlideProps extends AnimationInterface {
|
|
512
646
|
/**
|
|
513
|
-
*
|
|
647
|
+
* A function for customizing the rendering of child elements.
|
|
648
|
+
*
|
|
649
|
+
* @example
|
|
650
|
+
* <Slide childFactory={(child) => React.cloneElement(child, { style: { opacity: 0.5 } })} />
|
|
514
651
|
*/
|
|
515
652
|
childFactory?: any;
|
|
516
653
|
/**
|
|
517
|
-
* Specifies the CSS class names
|
|
654
|
+
* Specifies the CSS class names to be applied to the Animation container.
|
|
655
|
+
*
|
|
656
|
+
* @example
|
|
657
|
+
* <Slide className="slide-animation" />
|
|
518
658
|
*/
|
|
519
659
|
className?: string;
|
|
520
660
|
/**
|
|
521
661
|
* Specifies the direction of the Slide Animation. Defaults to `down`.
|
|
662
|
+
*
|
|
663
|
+
* @example
|
|
664
|
+
* <Slide direction="left" />
|
|
522
665
|
*/
|
|
523
666
|
direction?: SlideDirection;
|
|
524
667
|
/**
|
|
525
|
-
* Specifies the
|
|
668
|
+
* Specifies the HTML tag of the parent Animation container. Defaults to `div`.
|
|
669
|
+
*
|
|
670
|
+
* @example
|
|
671
|
+
* <Slide component="article" />
|
|
526
672
|
*/
|
|
527
673
|
component?: string;
|
|
528
674
|
/**
|
|
529
|
-
* Specifies the id of the Animation.
|
|
675
|
+
* Specifies the `id` attribute of the Animation container.
|
|
676
|
+
*
|
|
677
|
+
* @example
|
|
678
|
+
* <Slide id="slide-animation-container" />
|
|
530
679
|
*/
|
|
531
680
|
id?: string;
|
|
532
681
|
/**
|
|
533
|
-
* Specifies the
|
|
682
|
+
* Specifies the inline styles to be applied to the Animation container.
|
|
683
|
+
*
|
|
684
|
+
* @example
|
|
685
|
+
* <Slide style={{ margin: "10px" }} />
|
|
534
686
|
*/
|
|
535
687
|
style?: any;
|
|
536
688
|
}
|
|
@@ -573,31 +725,52 @@ export declare type ZoomDirection = 'in' | 'out';
|
|
|
573
725
|
*/
|
|
574
726
|
export declare interface ZoomProps extends AnimationInterface {
|
|
575
727
|
/**
|
|
576
|
-
*
|
|
728
|
+
* A function for customizing the rendering of child elements.
|
|
729
|
+
*
|
|
730
|
+
* @example
|
|
731
|
+
* <Zoom childFactory={(child) => React.cloneElement(child, { className: 'custom-class' })} />
|
|
577
732
|
*/
|
|
578
733
|
childFactory?: any;
|
|
579
734
|
/**
|
|
580
|
-
* Specifies the CSS class names
|
|
735
|
+
* Specifies the CSS class names to be applied to the Animation container.
|
|
736
|
+
*
|
|
737
|
+
* @example
|
|
738
|
+
* <Zoom className="zoom-animation" />
|
|
581
739
|
*/
|
|
582
740
|
className?: string;
|
|
583
741
|
/**
|
|
584
|
-
* Specifies the direction of the Zoom Animation. Defaults to `
|
|
742
|
+
* Specifies the direction of the Zoom Animation. Defaults to `out`.
|
|
743
|
+
*
|
|
744
|
+
* @example
|
|
745
|
+
* <Zoom direction="in" />
|
|
585
746
|
*/
|
|
586
747
|
direction?: ZoomDirection;
|
|
587
748
|
/**
|
|
588
|
-
* Specifies the
|
|
749
|
+
* Specifies the HTML tag of the parent Animation container. Defaults to `div`.
|
|
750
|
+
*
|
|
751
|
+
* @example
|
|
752
|
+
* <Zoom component="section" />
|
|
589
753
|
*/
|
|
590
754
|
component?: string;
|
|
591
755
|
/**
|
|
592
|
-
* Specifies the id of the Animation.
|
|
756
|
+
* Specifies the `id` attribute of the Animation container.
|
|
757
|
+
*
|
|
758
|
+
* @example
|
|
759
|
+
* <Zoom id="zoom-animation-container" />
|
|
593
760
|
*/
|
|
594
761
|
id?: string;
|
|
595
762
|
/**
|
|
596
|
-
* Specifies the
|
|
763
|
+
* Specifies the inline styles to be applied to the Animation container.
|
|
764
|
+
*
|
|
765
|
+
* @example
|
|
766
|
+
* <Zoom style={{ backgroundColor: "red" }} />
|
|
597
767
|
*/
|
|
598
768
|
style?: any;
|
|
599
769
|
/**
|
|
600
|
-
*
|
|
770
|
+
* Determines whether child elements will stack on top of each other during the animation. Defaults to `false`.
|
|
771
|
+
*
|
|
772
|
+
* @example
|
|
773
|
+
* <Zoom stackChildren={true} />
|
|
601
774
|
*/
|
|
602
775
|
stackChildren?: boolean;
|
|
603
776
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@progress/kendo-react-animation",
|
|
3
|
-
"version": "10.2.0-develop.
|
|
3
|
+
"version": "10.2.0-develop.7",
|
|
4
4
|
"description": "React Animation component assists with animating HTML elements. KendoReact Animation package",
|
|
5
5
|
"author": "Progress",
|
|
6
6
|
"license": "SEE LICENSE IN LICENSE.md",
|
|
@@ -26,7 +26,7 @@
|
|
|
26
26
|
"sideEffects": false,
|
|
27
27
|
"peerDependencies": {
|
|
28
28
|
"@progress/kendo-licensing": "^1.5.1",
|
|
29
|
-
"@progress/kendo-react-common": "10.2.0-develop.
|
|
29
|
+
"@progress/kendo-react-common": "10.2.0-develop.7",
|
|
30
30
|
"@progress/kendo-svg-icons": "^4.0.0",
|
|
31
31
|
"react": "^16.8.2 || ^17.0.0 || ^18.0.0 || ^19.0.0 || ^19.0.0-rc",
|
|
32
32
|
"react-dom": "^16.8.2 || ^17.0.0 || ^18.0.0 || ^19.0.0 || ^19.0.0-rc",
|