morphing-scroll 1.5.18 → 1.5.20

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.
Files changed (2) hide show
  1. package/README.md +96 -37
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -38,7 +38,7 @@ npm install morphing-scroll
38
38
  #### GENERAL SETTINGS:
39
39
 
40
40
  <details>
41
- <summary><strong><code>className</code></strong> : <em>Additional classes for the component.</em></summary><br />
41
+ <summary><strong><code>className</code></strong>: <em>Additional classes for the component.</em></summary><br />
42
42
  <ul>
43
43
  <strong>Type:</strong> string<br />
44
44
  <br />
@@ -57,10 +57,10 @@ npm install morphing-scroll
57
57
  ```
58
58
 
59
59
  </ul>
60
- </details>
61
- <h2></h2>
60
+ </details>&nbsp;
61
+ <h2></h2>&nbsp;
62
62
  <details>
63
- <summary><strong><code>children</code></strong> : <em>Custom user content.</em></summary><br />
63
+ <summary><strong><code>children</code></strong>: <em>Custom user content.</em></summary><br />
64
64
  <ul>
65
65
  <strong>Type:</strong> React.ReactNode<br />
66
66
  <br />
@@ -81,12 +81,13 @@ npm install morphing-scroll
81
81
 
82
82
  </ul>
83
83
  </details>
84
+
84
85
  <h2></h2>
85
86
 
86
87
  #### SCROLL SETTINGS:
87
88
 
88
89
  <details>
89
- <summary><strong><code>type</code></strong> : <em>Type of progress element.</em></summary><br />
90
+ <summary><strong><code>type</code></strong>: <em>Type of progress element.</em></summary><br />
90
91
  <ul>
91
92
  <strong>Type:</strong> "scroll" | "slider"<br />
92
93
  <br />
@@ -110,9 +111,11 @@ npm install morphing-scroll
110
111
 
111
112
  </ul>
112
113
  </details>
114
+
113
115
  <h2></h2>
116
+
114
117
  <details>
115
- <summary><strong><code>direction</code></strong> : <em>Scrolling direction.</em></summary><br />
118
+ <summary><strong><code>direction</code></strong>: <em>Scrolling direction.</em></summary><br />
116
119
  <ul>
117
120
  <strong>Type:</strong> "x" | "y"<br />
118
121
  <br />
@@ -135,9 +138,11 @@ npm install morphing-scroll
135
138
 
136
139
  </ul>
137
140
  </details>
141
+
138
142
  <h2></h2>
143
+
139
144
  <details>
140
- <summary><strong><code>scrollTop</code></strong> : <em>Scroll position and animation duration.</em></summary><br />
145
+ <summary><strong><code>scrollTop</code></strong>: <em>Scroll position and animation duration.</em></summary><br />
141
146
  <ul>
142
147
  <strong>Type:</strong> {<br />
143
148
  value: number | "end";<br />
@@ -171,9 +176,11 @@ npm install morphing-scroll
171
176
 
172
177
  </ul>
173
178
  </details>
179
+
174
180
  <h2></h2>
181
+
175
182
  <details>
176
- <summary><strong><code>stopLoadOnScroll</code></strong> : <em>Stop loading when scrolling.</em></summary><br />
183
+ <summary><strong><code>stopLoadOnScroll</code></strong>: <em>Stop loading when scrolling.</em></summary><br />
177
184
  <ul>
178
185
  <strong>Type:</strong> boolean<br />
179
186
  <br />
@@ -195,9 +202,11 @@ npm install morphing-scroll
195
202
 
196
203
  </ul>
197
204
  </details>
205
+
198
206
  <h2></h2>
207
+
199
208
  <details>
200
- <summary><strong><code>onScrollValue</code></strong> : <em>Callback for scroll value.</em></summary><br />
209
+ <summary><strong><code>onScrollValue</code></strong>: <em>Callback for scroll value.</em></summary><br />
201
210
  <ul>
202
211
  <strong>Type:</strong> (scroll: number) => void<br />
203
212
  <br />
@@ -222,9 +231,11 @@ npm install morphing-scroll
222
231
 
223
232
  </ul>
224
233
  </details>
225
- <h2></h2>
234
+
235
+ <h2></h2>
236
+
226
237
  <details>
227
- <summary><strong><code>isScrolling</code></strong> : <em>Callback function for scroll status.</em></summary><br />
238
+ <summary><strong><code>isScrolling</code></strong>: <em>Callback function for scroll status.</em></summary><br />
228
239
  <ul>
229
240
  <strong>Type:</strong> (motion: boolean) => void<br />
230
241
  <br />
@@ -246,12 +257,13 @@ npm install morphing-scroll
246
257
 
247
258
  </ul>
248
259
  </details>
260
+
249
261
  <h2></h2>
250
262
 
251
263
  #### VISUAL SETTINGS:
252
264
 
253
265
  <details>
254
- <summary><strong><code>size</code></strong> : <em>MorphScroll width and height.</em></summary><br />
266
+ <summary><strong><code>size</code></strong>: <em>MorphScroll width and height.</em></summary><br />
255
267
  <ul>
256
268
  <strong>Type:</strong> number[]<br />
257
269
  <br />
@@ -279,9 +291,11 @@ npm install morphing-scroll
279
291
 
280
292
  </ul>
281
293
  </details>
294
+
282
295
  <h2></h2>
296
+
283
297
  <details>
284
- <summary><strong><code>objectsSize</code> (required)</strong> : <em>Required: Size of cells for each object.</em></summary><br />
298
+ <summary><strong><code>objectsSize</code> (required)</strong>: <em>Required: Size of cells for each object.</em></summary><br />
285
299
  <ul>
286
300
  <strong>Type:</strong> (number | "none" | "firstChild")[]<br />
287
301
  <br />
@@ -310,9 +324,11 @@ npm install morphing-scroll
310
324
 
311
325
  </ul>
312
326
  </details>
327
+
313
328
  <h2></h2>
329
+
314
330
  <details>
315
- <summary><strong><code>gap</code></strong> : <em>Gap between cells.</em></summary><br />
331
+ <summary><strong><code>gap</code></strong>: <em>Gap between cells.</em></summary><br />
316
332
  <ul>
317
333
  <strong>Type:</strong> number[] | number<br />
318
334
  <br />
@@ -336,9 +352,11 @@ npm install morphing-scroll
336
352
 
337
353
  </ul>
338
354
  </details>
355
+
339
356
  <h2></h2>
357
+
340
358
  <details>
341
- <summary><strong><code>padding</code></strong> : <em>Padding for the <code>objectsWrapper</code>.</em></summary><br />
359
+ <summary><strong><code>padding</code></strong>: <em>Padding for the <code>objectsWrapper</code>.</em></summary><br />
342
360
  <ul>
343
361
  <strong>Type:</strong> number[] | number<br />
344
362
  <br />
@@ -373,9 +391,11 @@ npm install morphing-scroll
373
391
 
374
392
  </ul>
375
393
  </details>
394
+
376
395
  <h2></h2>
396
+
377
397
  <details>
378
- <summary><strong><code>contentAlign</code></strong> : <em>Aligns the content when it is smaller than the MorphScroll <code>size</code>.</em></summary><br />
398
+ <summary><strong><code>contentAlign</code></strong>: <em>Aligns the content when it is smaller than the MorphScroll <code>size</code>.</em></summary><br />
379
399
  <ul>
380
400
  <strong>Type:</strong> [<br />
381
401
  "start" | "center" | "end",<br />
@@ -405,9 +425,11 @@ npm install morphing-scroll
405
425
 
406
426
  </ul>
407
427
  </details>
428
+
408
429
  <h2></h2>
430
+
409
431
  <details>
410
- <summary><strong><code>elementsAlign</code></strong> : <em>Aligns the objects within the <code>objectsWrapper</code>.</em></summary><br />
432
+ <summary><strong><code>elementsAlign</code></strong>: <em>Aligns the objects within the <code>objectsWrapper</code>.</em></summary><br />
411
433
  <ul>
412
434
  <strong>Type:</strong> "start" | "center" | "end"<br />
413
435
  <br />
@@ -424,9 +446,11 @@ npm install morphing-scroll
424
446
 
425
447
  </ul>
426
448
  </details>
449
+
427
450
  <h2></h2>
451
+
428
452
  <details>
429
- <summary><strong><code>edgeGradient</code></strong> : <em>Gradient when scrolling overflows.</em></summary><br />
453
+ <summary><strong><code>edgeGradient</code></strong>: <em>Gradient when scrolling overflows.</em></summary><br />
430
454
  <ul>
431
455
  <strong>Type:</strong> boolean | { color?: string; size?: number }<br />
432
456
  <br />
@@ -455,9 +479,11 @@ npm install morphing-scroll
455
479
 
456
480
  </ul>
457
481
  </details>
482
+
458
483
  <h2></h2>
484
+
459
485
  <details>
460
- <summary><strong><code>progressReverse</code></strong> : <em>Reverse the progress bar position.</em></summary><br />
486
+ <summary><strong><code>progressReverse</code></strong>: <em>Reverse the progress bar position.</em></summary><br />
461
487
  <ul>
462
488
  <strong>Type:</strong> boolean<br />
463
489
  <br />
@@ -483,9 +509,11 @@ npm install morphing-scroll
483
509
 
484
510
  </ul>
485
511
  </details>
512
+
486
513
  <h2></h2>
514
+
487
515
  <details>
488
- <summary><strong><code>progressVisibility</code></strong> : <em>Visibility of the progress bar.</em></summary><br />
516
+ <summary><strong><code>progressVisibility</code></strong>: <em>Visibility of the progress bar.</em></summary><br />
489
517
  <ul>
490
518
  <strong>Type:</strong> "visible" | "hover" | "hidden"<br />
491
519
  <br />
@@ -507,9 +535,11 @@ npm install morphing-scroll
507
535
 
508
536
  </ul>
509
537
  </details>
538
+
510
539
  <h2></h2>
540
+
511
541
  <details>
512
- <summary><strong><code>objectsWrapFullMinSize</code></strong> : <em>Sets the <code>min-height</code> CSS property of the <code>objectsWrapper</code> to match the height of the MorphScroll.</em></summary><br />
542
+ <summary><strong><code>objectsWrapFullMinSize</code></strong>: <em>Sets the <code>min-height</code> CSS property of the <code>objectsWrapper</code> to match the height of the MorphScroll.</em></summary><br />
513
543
  <ul>
514
544
  <strong>Type:</strong> boolean<br /><br />
515
545
  <strong>Default:</strong> false<br /><br />
@@ -529,12 +559,13 @@ npm install morphing-scroll
529
559
 
530
560
  </ul>
531
561
  </details>
562
+
532
563
  <h2></h2>
533
564
 
534
565
  #### PROGRESS AND RENDERING:
535
566
 
536
567
  <details>
537
- <summary><strong><code>progressTrigger</code></strong> : <em>Triggers for the progress bar.</em></summary><br />
568
+ <summary><strong><code>progressTrigger</code></strong>: <em>Triggers for the progress bar.</em></summary><br />
538
569
  <ul>
539
570
  <strong>Type:</strong> {<br />
540
571
  wheel?: boolean;<br />
@@ -571,9 +602,11 @@ npm install morphing-scroll
571
602
 
572
603
  </ul>
573
604
  </details>
605
+
574
606
  <h2></h2>
607
+
575
608
  <details>
576
- <summary><strong><code>render</code></strong> : <em>Types of rendering for optimization.</em></summary><br />
609
+ <summary><strong><code>render</code></strong>: <em>Types of rendering for optimization.</em></summary><br />
577
610
  <ul>
578
611
  <strong>Type:</strong><br />
579
612
  | { type: "default" }<br />
@@ -622,9 +655,11 @@ npm install morphing-scroll
622
655
 
623
656
  </ul>
624
657
  </details>
658
+
625
659
  <h2></h2>
660
+
626
661
  <details>
627
- <summary><strong><code>emptyElements</code></strong> : <em>Handling of empty scroll elements.</em></summary><br />
662
+ <summary><strong><code>emptyElements</code></strong>: <em>Handling of empty scroll elements.</em></summary><br />
628
663
  <ul>
629
664
  <strong>Type:</strong><br />
630
665
  | {
@@ -672,9 +707,11 @@ npm install morphing-scroll
672
707
 
673
708
  </ul>
674
709
  </details>
710
+
675
711
  <h2></h2>
712
+
676
713
  <details>
677
- <summary><strong><code>suspending</code></strong> : <em>Adds React Suspense.</em></summary><br />
714
+ <summary><strong><code>suspending</code></strong>: <em>Adds React Suspense.</em></summary><br />
678
715
  <ul>
679
716
  <strong>Type:</strong> boolean<br />
680
717
  <br />
@@ -696,9 +733,11 @@ npm install morphing-scroll
696
733
 
697
734
  </ul>
698
735
  </details>
736
+
699
737
  <h2></h2>
738
+
700
739
  <details>
701
- <summary><strong><code>fallback</code></strong> : <em>Fallback element.</em></summary><br />
740
+ <summary><strong><code>fallback</code></strong>: <em>Fallback element.</em></summary><br />
702
741
  <ul>
703
742
  <strong>Type:</strong> React.ReactNode<br />
704
743
  <br />
@@ -728,7 +767,7 @@ npm install morphing-scroll
728
767
  - ### Props:
729
768
 
730
769
  <details>
731
- <summary><strong><code>children</code></strong> : <em>Render-prop function for size updates and adding content.</em></summary><br />
770
+ <summary><strong><code>children</code></strong>: <em>Render-prop function for size updates and adding content.</em></summary><br />
732
771
  <ul>
733
772
  <strong>Type:</strong> (rect: DOMRectReadOnly) => React.ReactNode<br />
734
773
  <br />
@@ -766,9 +805,11 @@ npm install morphing-scroll
766
805
  </ul>
767
806
 
768
807
  </details>
808
+
769
809
  <h2></h2>
810
+
770
811
  <details>
771
- <summary><strong><code>style</code></strong> : <em>Applies inline styles to the container.</em></summary><br />
812
+ <summary><strong><code>style</code></strong>: <em>Applies inline styles to the container.</em></summary><br />
772
813
  <ul>
773
814
  <strong>Type:</strong> React.CSSProperties<br />
774
815
  <br />
@@ -785,9 +826,11 @@ npm install morphing-scroll
785
826
  </ul>
786
827
 
787
828
  </details>
829
+
788
830
  <h2></h2>
831
+
789
832
  <details>
790
- <summary><strong><code>measure</code></strong> : <em>Defines the measurement strategy.</em></summary><br />
833
+ <summary><strong><code>measure</code></strong>: <em>Defines the measurement strategy.</em></summary><br />
791
834
  <ul>
792
835
  <strong>Type:</strong> "inner" | "outer" | "all"<br />
793
836
  <br />
@@ -815,9 +858,11 @@ npm install morphing-scroll
815
858
  </ul>
816
859
 
817
860
  </details>
861
+
818
862
  <h2></h2>
863
+
819
864
  <details>
820
- <summary><strong><code>onResize</code></strong> : <em>Callback triggered on size changes.</em></summary><br />
865
+ <summary><strong><code>onResize</code></strong>: <em>Callback triggered on size changes.</em></summary><br />
821
866
  <ul>
822
867
  <strong>Type:</strong> (rect: Partial<DOMRectReadOnly>) => void<br />
823
868
  <br />
@@ -842,6 +887,7 @@ npm install morphing-scroll
842
887
  </ul>
843
888
 
844
889
  </details>
890
+
845
891
  <h2></h2>
846
892
 
847
893
  - ### Link:
@@ -857,7 +903,7 @@ npm install morphing-scroll
857
903
  - ### Props:
858
904
 
859
905
  <details>
860
- <summary><strong><code>children</code></strong> : <em>Custom user content.</em></summary><br />
906
+ <summary><strong><code>children</code></strong>: <em>Custom user content.</em></summary><br />
861
907
  <ul>
862
908
  <strong>Type:</strong> React.ReactNode<br />
863
909
  <br />
@@ -870,9 +916,11 @@ npm install morphing-scroll
870
916
  </ul>
871
917
 
872
918
  </details>
919
+
873
920
  <h2></h2>
921
+
874
922
  <details>
875
- <summary><strong><code>style</code></strong> : <em>Applies inline styles to the container.</em></summary><br />
923
+ <summary><strong><code>style</code></strong>: <em>Applies inline styles to the container.</em></summary><br />
876
924
  <ul>
877
925
  <strong>Type:</strong> React.CSSProperties<br />
878
926
  <br />
@@ -887,9 +935,11 @@ npm install morphing-scroll
887
935
  </ul>
888
936
 
889
937
  </details>
938
+
890
939
  <h2></h2>
940
+
891
941
  <details>
892
- <summary><strong><code>root</code></strong> : <em>Defines the observation area.</em></summary><br />
942
+ <summary><strong><code>root</code></strong>: <em>Defines the observation area.</em></summary><br />
893
943
  <ul>
894
944
  <strong>Type:</strong> Element | null<br />
895
945
  <br />
@@ -912,9 +962,11 @@ npm install morphing-scroll
912
962
  </ul>
913
963
 
914
964
  </details>
965
+
915
966
  <h2></h2>
967
+
916
968
  <details>
917
- <summary><strong><code>rootMargin</code></strong> : <em>Sets the margin around the root element.</em></summary><br />
969
+ <summary><strong><code>rootMargin</code></strong>: <em>Sets the margin around the root element.</em></summary><br />
918
970
  <ul>
919
971
  <strong>Type:</strong> number | number[]<br />
920
972
  <br />
@@ -945,9 +997,11 @@ npm install morphing-scroll
945
997
  </ul>
946
998
 
947
999
  </details>
1000
+
948
1001
  <h2></h2>
1002
+
949
1003
  <details>
950
- <summary><strong><code>threshold</code></strong> : <em>Defines when the callback is triggered.</em></summary><br />
1004
+ <summary><strong><code>threshold</code></strong>: <em>Defines when the callback is triggered.</em></summary><br />
951
1005
  <ul>
952
1006
  <strong>Type:</strong> number | number[]<br />
953
1007
  <br />
@@ -975,9 +1029,11 @@ npm install morphing-scroll
975
1029
  </ul>
976
1030
 
977
1031
  </details>
1032
+
978
1033
  <h2></h2>
1034
+
979
1035
  <details>
980
- <summary><strong><code>visibleContent</code></strong> : <em>Makes all elements always visible.</em></summary><br />
1036
+ <summary><strong><code>visibleContent</code></strong>: <em>Makes all elements always visible.</em></summary><br />
981
1037
  <ul>
982
1038
  <strong>Type:</strong> boolean<br />
983
1039
  <br />
@@ -997,9 +1053,11 @@ npm install morphing-scroll
997
1053
  </ul>
998
1054
 
999
1055
  </details>
1056
+
1000
1057
  <h2></h2>
1058
+
1001
1059
  <details>
1002
- <summary><strong><code>onVisible</code></strong> : <em>Callback function triggered when the element becomes visible.</em></summary><br />
1060
+ <summary><strong><code>onVisible</code></strong>: <em>Callback function triggered when the element becomes visible.</em></summary><br />
1003
1061
  <ul>
1004
1062
  <strong>Type:</strong> (key: string) => void<br />
1005
1063
  <br />
@@ -1029,6 +1087,7 @@ npm install morphing-scroll
1029
1087
  </ul>
1030
1088
 
1031
1089
  </details>
1090
+
1032
1091
  <h2></h2>
1033
1092
 
1034
1093
  - ### Link:
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "morphing-scroll",
3
- "version": "1.5.18",
3
+ "version": "1.5.20",
4
4
  "description": "Library for using various methods of scrolling objects〈♦〉",
5
5
  "author": "Georg Schilin",
6
6
  "license": "MIT",