@spark-ui/components 12.1.0 → 12.1.2

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/dist/docgen.json CHANGED
@@ -1544,12 +1544,12 @@
1544
1544
  "name": "boolean"
1545
1545
  }
1546
1546
  },
1547
- "design": {
1547
+ "shape": {
1548
1548
  "defaultValue": {
1549
1549
  "value": "circle"
1550
1550
  },
1551
1551
  "description": "",
1552
- "name": "design",
1552
+ "name": "shape",
1553
1553
  "parent": {
1554
1554
  "fileName": "components/src/avatar/types.ts",
1555
1555
  "name": "AvatarProps"
@@ -2788,6 +2788,30 @@
2788
2788
  ]
2789
2789
  }
2790
2790
  },
2791
+ "shape": {
2792
+ "defaultValue": {
2793
+ "value": "rounded"
2794
+ },
2795
+ "description": "Shape of the button.",
2796
+ "name": "shape",
2797
+ "declarations": [],
2798
+ "required": false,
2799
+ "type": {
2800
+ "name": "enum",
2801
+ "raw": "\"square\" | \"rounded\" | \"pill\"",
2802
+ "value": [
2803
+ {
2804
+ "value": "\"square\""
2805
+ },
2806
+ {
2807
+ "value": "\"rounded\""
2808
+ },
2809
+ {
2810
+ "value": "\"pill\""
2811
+ }
2812
+ ]
2813
+ }
2814
+ },
2791
2815
  "intent": {
2792
2816
  "defaultValue": {
2793
2817
  "value": "main"
@@ -2836,30 +2860,6 @@
2836
2860
  ]
2837
2861
  }
2838
2862
  },
2839
- "shape": {
2840
- "defaultValue": {
2841
- "value": "rounded"
2842
- },
2843
- "description": "Shape of the button.",
2844
- "name": "shape",
2845
- "declarations": [],
2846
- "required": false,
2847
- "type": {
2848
- "name": "enum",
2849
- "raw": "\"square\" | \"rounded\" | \"pill\"",
2850
- "value": [
2851
- {
2852
- "value": "\"square\""
2853
- },
2854
- {
2855
- "value": "\"rounded\""
2856
- },
2857
- {
2858
- "value": "\"pill\""
2859
- }
2860
- ]
2861
- }
2862
- },
2863
2863
  "underline": {
2864
2864
  "defaultValue": {
2865
2865
  "value": false
@@ -4942,6 +4942,28 @@
4942
4942
  ]
4943
4943
  }
4944
4944
  },
4945
+ "shape": {
4946
+ "defaultValue": null,
4947
+ "description": "Shape of the button.",
4948
+ "name": "shape",
4949
+ "declarations": [],
4950
+ "required": false,
4951
+ "type": {
4952
+ "name": "enum",
4953
+ "raw": "\"square\" | \"rounded\" | \"pill\"",
4954
+ "value": [
4955
+ {
4956
+ "value": "\"square\""
4957
+ },
4958
+ {
4959
+ "value": "\"rounded\""
4960
+ },
4961
+ {
4962
+ "value": "\"pill\""
4963
+ }
4964
+ ]
4965
+ }
4966
+ },
4945
4967
  "intent": {
4946
4968
  "defaultValue": null,
4947
4969
  "description": "Color scheme of the button.",
@@ -4988,28 +5010,6 @@
4988
5010
  ]
4989
5011
  }
4990
5012
  },
4991
- "shape": {
4992
- "defaultValue": null,
4993
- "description": "Shape of the button.",
4994
- "name": "shape",
4995
- "declarations": [],
4996
- "required": false,
4997
- "type": {
4998
- "name": "enum",
4999
- "raw": "\"square\" | \"rounded\" | \"pill\"",
5000
- "value": [
5001
- {
5002
- "value": "\"square\""
5003
- },
5004
- {
5005
- "value": "\"rounded\""
5006
- },
5007
- {
5008
- "value": "\"pill\""
5009
- }
5010
- ]
5011
- }
5012
- },
5013
5013
  "underline": {
5014
5014
  "defaultValue": null,
5015
5015
  "description": "",
@@ -5326,6 +5326,28 @@
5326
5326
  ]
5327
5327
  }
5328
5328
  },
5329
+ "shape": {
5330
+ "defaultValue": null,
5331
+ "description": "Shape of the button.",
5332
+ "name": "shape",
5333
+ "declarations": [],
5334
+ "required": false,
5335
+ "type": {
5336
+ "name": "enum",
5337
+ "raw": "\"square\" | \"rounded\" | \"pill\"",
5338
+ "value": [
5339
+ {
5340
+ "value": "\"square\""
5341
+ },
5342
+ {
5343
+ "value": "\"rounded\""
5344
+ },
5345
+ {
5346
+ "value": "\"pill\""
5347
+ }
5348
+ ]
5349
+ }
5350
+ },
5329
5351
  "intent": {
5330
5352
  "defaultValue": null,
5331
5353
  "description": "Color scheme of the button.",
@@ -5372,28 +5394,6 @@
5372
5394
  ]
5373
5395
  }
5374
5396
  },
5375
- "shape": {
5376
- "defaultValue": null,
5377
- "description": "Shape of the button.",
5378
- "name": "shape",
5379
- "declarations": [],
5380
- "required": false,
5381
- "type": {
5382
- "name": "enum",
5383
- "raw": "\"square\" | \"rounded\" | \"pill\"",
5384
- "value": [
5385
- {
5386
- "value": "\"square\""
5387
- },
5388
- {
5389
- "value": "\"rounded\""
5390
- },
5391
- {
5392
- "value": "\"pill\""
5393
- }
5394
- ]
5395
- }
5396
- },
5397
5397
  "underline": {
5398
5398
  "defaultValue": null,
5399
5399
  "description": "",
@@ -5870,6 +5870,16 @@
5870
5870
  }
5871
5871
  }
5872
5872
  },
5873
+ "useCarouselVisibility": {
5874
+ "tags": {
5875
+ "param": "carouselRef - Reference to the carousel container element",
5876
+ "returns": "Object with functions to register/unregister slides and check visibility"
5877
+ },
5878
+ "description": "Hook to manage slide visibility using a centralized IntersectionObserver.\nThis optimizes performance by using a single observer per carousel instead of one per slide.",
5879
+ "displayName": "useCarouselVisibility",
5880
+ "methods": [],
5881
+ "props": {}
5882
+ },
5873
5883
  "useEvent": {
5874
5884
  "tags": {},
5875
5885
  "description": "Directly from this gist: https://gist.github.com/diegohaz/695097a06f038a707c3a1b11e4e40195\nUntil React releases a native `useEvent` hook.",
@@ -6099,6 +6109,13 @@
6099
6109
  }
6100
6110
  }
6101
6111
  },
6112
+ "useIsVisible": {
6113
+ "tags": {},
6114
+ "description": "Hook to track slide visibility using the centralized IntersectionObserver.\nThis optimizes performance by using a single observer per carousel instead of one per slide.",
6115
+ "displayName": "useIsVisible",
6116
+ "methods": [],
6117
+ "props": {}
6118
+ },
6102
6119
  "useSnapPoints": {
6103
6120
  "tags": {},
6104
6121
  "description": "Get the scroll value of each slides that serves as the start of a page\nThe array is updated when resize event are caught in the carousel.",
@@ -14891,6 +14908,28 @@
14891
14908
  ]
14892
14909
  }
14893
14910
  },
14911
+ "shape": {
14912
+ "defaultValue": null,
14913
+ "description": "Shape of the button.",
14914
+ "name": "shape",
14915
+ "declarations": [],
14916
+ "required": false,
14917
+ "type": {
14918
+ "name": "enum",
14919
+ "raw": "\"square\" | \"rounded\" | \"pill\"",
14920
+ "value": [
14921
+ {
14922
+ "value": "\"square\""
14923
+ },
14924
+ {
14925
+ "value": "\"rounded\""
14926
+ },
14927
+ {
14928
+ "value": "\"pill\""
14929
+ }
14930
+ ]
14931
+ }
14932
+ },
14894
14933
  "intent": {
14895
14934
  "defaultValue": {
14896
14935
  "value": "neutral"
@@ -14939,28 +14978,6 @@
14939
14978
  ]
14940
14979
  }
14941
14980
  },
14942
- "shape": {
14943
- "defaultValue": null,
14944
- "description": "Shape of the button.",
14945
- "name": "shape",
14946
- "declarations": [],
14947
- "required": false,
14948
- "type": {
14949
- "name": "enum",
14950
- "raw": "\"square\" | \"rounded\" | \"pill\"",
14951
- "value": [
14952
- {
14953
- "value": "\"square\""
14954
- },
14955
- {
14956
- "value": "\"rounded\""
14957
- },
14958
- {
14959
- "value": "\"pill\""
14960
- }
14961
- ]
14962
- }
14963
- },
14964
14981
  "underline": {
14965
14982
  "defaultValue": null,
14966
14983
  "description": "",
@@ -30856,6 +30873,28 @@
30856
30873
  ]
30857
30874
  }
30858
30875
  },
30876
+ "shape": {
30877
+ "defaultValue": null,
30878
+ "description": "Shape of the button.",
30879
+ "name": "shape",
30880
+ "declarations": [],
30881
+ "required": false,
30882
+ "type": {
30883
+ "name": "enum",
30884
+ "raw": "\"square\" | \"rounded\" | \"pill\"",
30885
+ "value": [
30886
+ {
30887
+ "value": "\"square\""
30888
+ },
30889
+ {
30890
+ "value": "\"rounded\""
30891
+ },
30892
+ {
30893
+ "value": "\"pill\""
30894
+ }
30895
+ ]
30896
+ }
30897
+ },
30859
30898
  "intent": {
30860
30899
  "defaultValue": null,
30861
30900
  "description": "Color scheme of the button.",
@@ -30902,28 +30941,6 @@
30902
30941
  ]
30903
30942
  }
30904
30943
  },
30905
- "shape": {
30906
- "defaultValue": null,
30907
- "description": "Shape of the button.",
30908
- "name": "shape",
30909
- "declarations": [],
30910
- "required": false,
30911
- "type": {
30912
- "name": "enum",
30913
- "raw": "\"square\" | \"rounded\" | \"pill\"",
30914
- "value": [
30915
- {
30916
- "value": "\"square\""
30917
- },
30918
- {
30919
- "value": "\"rounded\""
30920
- },
30921
- {
30922
- "value": "\"pill\""
30923
- }
30924
- ]
30925
- }
30926
- },
30927
30944
  "underline": {
30928
30945
  "defaultValue": null,
30929
30946
  "description": "",
@@ -31305,6 +31322,28 @@
31305
31322
  ]
31306
31323
  }
31307
31324
  },
31325
+ "shape": {
31326
+ "defaultValue": null,
31327
+ "description": "Shape of the button.",
31328
+ "name": "shape",
31329
+ "declarations": [],
31330
+ "required": false,
31331
+ "type": {
31332
+ "name": "enum",
31333
+ "raw": "\"square\" | \"rounded\" | \"pill\"",
31334
+ "value": [
31335
+ {
31336
+ "value": "\"square\""
31337
+ },
31338
+ {
31339
+ "value": "\"rounded\""
31340
+ },
31341
+ {
31342
+ "value": "\"pill\""
31343
+ }
31344
+ ]
31345
+ }
31346
+ },
31308
31347
  "intent": {
31309
31348
  "defaultValue": null,
31310
31349
  "description": "Color scheme of the button.",
@@ -31351,28 +31390,6 @@
31351
31390
  ]
31352
31391
  }
31353
31392
  },
31354
- "shape": {
31355
- "defaultValue": null,
31356
- "description": "Shape of the button.",
31357
- "name": "shape",
31358
- "declarations": [],
31359
- "required": false,
31360
- "type": {
31361
- "name": "enum",
31362
- "raw": "\"square\" | \"rounded\" | \"pill\"",
31363
- "value": [
31364
- {
31365
- "value": "\"square\""
31366
- },
31367
- {
31368
- "value": "\"rounded\""
31369
- },
31370
- {
31371
- "value": "\"pill\""
31372
- }
31373
- ]
31374
- }
31375
- },
31376
31393
  "underline": {
31377
31394
  "defaultValue": null,
31378
31395
  "description": "",
@@ -31563,6 +31580,30 @@
31563
31580
  ]
31564
31581
  }
31565
31582
  },
31583
+ "shape": {
31584
+ "defaultValue": {
31585
+ "value": "rounded"
31586
+ },
31587
+ "description": "Shape of the button.",
31588
+ "name": "shape",
31589
+ "declarations": [],
31590
+ "required": false,
31591
+ "type": {
31592
+ "name": "enum",
31593
+ "raw": "\"square\" | \"rounded\" | \"pill\"",
31594
+ "value": [
31595
+ {
31596
+ "value": "\"square\""
31597
+ },
31598
+ {
31599
+ "value": "\"rounded\""
31600
+ },
31601
+ {
31602
+ "value": "\"pill\""
31603
+ }
31604
+ ]
31605
+ }
31606
+ },
31566
31607
  "intent": {
31567
31608
  "defaultValue": {
31568
31609
  "value": "basic"
@@ -31611,30 +31652,6 @@
31611
31652
  ]
31612
31653
  }
31613
31654
  },
31614
- "shape": {
31615
- "defaultValue": {
31616
- "value": "rounded"
31617
- },
31618
- "description": "Shape of the button.",
31619
- "name": "shape",
31620
- "declarations": [],
31621
- "required": false,
31622
- "type": {
31623
- "name": "enum",
31624
- "raw": "\"square\" | \"rounded\" | \"pill\"",
31625
- "value": [
31626
- {
31627
- "value": "\"square\""
31628
- },
31629
- {
31630
- "value": "\"rounded\""
31631
- },
31632
- {
31633
- "value": "\"pill\""
31634
- }
31635
- ]
31636
- }
31637
- },
31638
31655
  "underline": {
31639
31656
  "defaultValue": null,
31640
31657
  "description": "",
@@ -33181,6 +33198,30 @@
33181
33198
  ]
33182
33199
  }
33183
33200
  },
33201
+ "shape": {
33202
+ "defaultValue": {
33203
+ "value": "rounded"
33204
+ },
33205
+ "description": "Shape of the button.",
33206
+ "name": "shape",
33207
+ "declarations": [],
33208
+ "required": false,
33209
+ "type": {
33210
+ "name": "enum",
33211
+ "raw": "\"square\" | \"rounded\" | \"pill\"",
33212
+ "value": [
33213
+ {
33214
+ "value": "\"square\""
33215
+ },
33216
+ {
33217
+ "value": "\"rounded\""
33218
+ },
33219
+ {
33220
+ "value": "\"pill\""
33221
+ }
33222
+ ]
33223
+ }
33224
+ },
33184
33225
  "intent": {
33185
33226
  "defaultValue": {
33186
33227
  "value": "main"
@@ -33229,30 +33270,6 @@
33229
33270
  ]
33230
33271
  }
33231
33272
  },
33232
- "shape": {
33233
- "defaultValue": {
33234
- "value": "rounded"
33235
- },
33236
- "description": "Shape of the button.",
33237
- "name": "shape",
33238
- "declarations": [],
33239
- "required": false,
33240
- "type": {
33241
- "name": "enum",
33242
- "raw": "\"square\" | \"rounded\" | \"pill\"",
33243
- "value": [
33244
- {
33245
- "value": "\"square\""
33246
- },
33247
- {
33248
- "value": "\"rounded\""
33249
- },
33250
- {
33251
- "value": "\"pill\""
33252
- }
33253
- ]
33254
- }
33255
- },
33256
33273
  "underline": {
33257
33274
  "defaultValue": null,
33258
33275
  "description": "",
@@ -39068,6 +39085,28 @@
39068
39085
  ]
39069
39086
  }
39070
39087
  },
39088
+ "shape": {
39089
+ "defaultValue": null,
39090
+ "description": "Shape of the button.",
39091
+ "name": "shape",
39092
+ "declarations": [],
39093
+ "required": false,
39094
+ "type": {
39095
+ "name": "enum",
39096
+ "raw": "\"square\" | \"rounded\" | \"pill\"",
39097
+ "value": [
39098
+ {
39099
+ "value": "\"square\""
39100
+ },
39101
+ {
39102
+ "value": "\"rounded\""
39103
+ },
39104
+ {
39105
+ "value": "\"pill\""
39106
+ }
39107
+ ]
39108
+ }
39109
+ },
39071
39110
  "intent": {
39072
39111
  "defaultValue": null,
39073
39112
  "description": "Color scheme of the button.",
@@ -39114,28 +39153,6 @@
39114
39153
  ]
39115
39154
  }
39116
39155
  },
39117
- "shape": {
39118
- "defaultValue": null,
39119
- "description": "Shape of the button.",
39120
- "name": "shape",
39121
- "declarations": [],
39122
- "required": false,
39123
- "type": {
39124
- "name": "enum",
39125
- "raw": "\"square\" | \"rounded\" | \"pill\"",
39126
- "value": [
39127
- {
39128
- "value": "\"square\""
39129
- },
39130
- {
39131
- "value": "\"rounded\""
39132
- },
39133
- {
39134
- "value": "\"pill\""
39135
- }
39136
- ]
39137
- }
39138
- },
39139
39156
  "underline": {
39140
39157
  "defaultValue": null,
39141
39158
  "description": "",
@@ -39309,6 +39326,28 @@
39309
39326
  ]
39310
39327
  }
39311
39328
  },
39329
+ "shape": {
39330
+ "defaultValue": null,
39331
+ "description": "Shape of the button.",
39332
+ "name": "shape",
39333
+ "declarations": [],
39334
+ "required": false,
39335
+ "type": {
39336
+ "name": "enum",
39337
+ "raw": "\"square\" | \"rounded\" | \"pill\"",
39338
+ "value": [
39339
+ {
39340
+ "value": "\"square\""
39341
+ },
39342
+ {
39343
+ "value": "\"rounded\""
39344
+ },
39345
+ {
39346
+ "value": "\"pill\""
39347
+ }
39348
+ ]
39349
+ }
39350
+ },
39312
39351
  "intent": {
39313
39352
  "defaultValue": null,
39314
39353
  "description": "Color scheme of the button.",
@@ -39355,28 +39394,6 @@
39355
39394
  ]
39356
39395
  }
39357
39396
  },
39358
- "shape": {
39359
- "defaultValue": null,
39360
- "description": "Shape of the button.",
39361
- "name": "shape",
39362
- "declarations": [],
39363
- "required": false,
39364
- "type": {
39365
- "name": "enum",
39366
- "raw": "\"square\" | \"rounded\" | \"pill\"",
39367
- "value": [
39368
- {
39369
- "value": "\"square\""
39370
- },
39371
- {
39372
- "value": "\"rounded\""
39373
- },
39374
- {
39375
- "value": "\"pill\""
39376
- }
39377
- ]
39378
- }
39379
- },
39380
39397
  "underline": {
39381
39398
  "defaultValue": null,
39382
39399
  "description": "",
@@ -42237,6 +42254,25 @@
42237
42254
  "name": "string"
42238
42255
  }
42239
42256
  },
42257
+ "shape": {
42258
+ "defaultValue": null,
42259
+ "description": "",
42260
+ "name": "shape",
42261
+ "declarations": [],
42262
+ "required": false,
42263
+ "type": {
42264
+ "name": "enum",
42265
+ "raw": "\"square\" | \"rounded\"",
42266
+ "value": [
42267
+ {
42268
+ "value": "\"square\""
42269
+ },
42270
+ {
42271
+ "value": "\"rounded\""
42272
+ }
42273
+ ]
42274
+ }
42275
+ },
42240
42276
  "intent": {
42241
42277
  "defaultValue": null,
42242
42278
  "description": "",
@@ -42276,25 +42312,6 @@
42276
42312
  }
42277
42313
  ]
42278
42314
  }
42279
- },
42280
- "shape": {
42281
- "defaultValue": null,
42282
- "description": "",
42283
- "name": "shape",
42284
- "declarations": [],
42285
- "required": false,
42286
- "type": {
42287
- "name": "enum",
42288
- "raw": "\"square\" | \"rounded\"",
42289
- "value": [
42290
- {
42291
- "value": "\"square\""
42292
- },
42293
- {
42294
- "value": "\"rounded\""
42295
- }
42296
- ]
42297
- }
42298
42315
  }
42299
42316
  }
42300
42317
  },
@@ -46403,6 +46420,30 @@
46403
46420
  ]
46404
46421
  }
46405
46422
  },
46423
+ "shape": {
46424
+ "defaultValue": {
46425
+ "value": "pill"
46426
+ },
46427
+ "description": "",
46428
+ "name": "shape",
46429
+ "declarations": [],
46430
+ "required": false,
46431
+ "type": {
46432
+ "name": "enum",
46433
+ "raw": "\"square\" | \"rounded\" | \"pill\"",
46434
+ "value": [
46435
+ {
46436
+ "value": "\"square\""
46437
+ },
46438
+ {
46439
+ "value": "\"rounded\""
46440
+ },
46441
+ {
46442
+ "value": "\"pill\""
46443
+ }
46444
+ ]
46445
+ }
46446
+ },
46406
46447
  "intent": {
46407
46448
  "defaultValue": {
46408
46449
  "value": "basic"
@@ -46461,30 +46502,6 @@
46461
46502
  ]
46462
46503
  }
46463
46504
  },
46464
- "shape": {
46465
- "defaultValue": {
46466
- "value": "pill"
46467
- },
46468
- "description": "",
46469
- "name": "shape",
46470
- "declarations": [],
46471
- "required": false,
46472
- "type": {
46473
- "name": "enum",
46474
- "raw": "\"square\" | \"rounded\" | \"pill\"",
46475
- "value": [
46476
- {
46477
- "value": "\"square\""
46478
- },
46479
- {
46480
- "value": "\"rounded\""
46481
- },
46482
- {
46483
- "value": "\"pill\""
46484
- }
46485
- ]
46486
- }
46487
- },
46488
46505
  "ref": {
46489
46506
  "defaultValue": null,
46490
46507
  "description": "",