@sakaniui/mcp 0.17.2 → 0.18.0

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.
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "schemaVersion": 6,
3
3
  "name": "@sakaniui/react",
4
- "version": "0.17.2",
4
+ "version": "0.18.0",
5
5
  "description": "Machine-readable contract of the SakaniUI React library, generated from its TypeScript source.",
6
6
  "docs": "https://www.sakaniui.com",
7
7
  "guide": "https://www.sakaniui.com/llms-full.txt",
@@ -24,7 +24,7 @@
24
24
  "@sakaniui/react/emoji": "Fluent Emoji (full colour): EmojiName, one module each (1594 emoji, 311 with skin tones)."
25
25
  },
26
26
  "conventions": {
27
- "version": "This manifest describes @sakaniui/react@0.17.2. Each component has `since`, the first release that contained it; a prop added later has its own `since`, and a value added later is listed in the prop's `valuesSince`. If the project has an older version installed, anything newer than that does not exist there.",
27
+ "version": "This manifest describes @sakaniui/react@0.18.0. Each component has `since`, the first release that contained it; a prop added later has its own `since`, and a value added later is listed in the prop's `valuesSince`. If the project has an older version installed, anything newer than that does not exist there.",
28
28
  "acceptsNativeProps": "Components forward native HTML attributes (className, style, aria-*, event handlers) to their root element unless a prop says otherwise; only the props that are specific to SakaniUI are listed here.",
29
29
  "accessibleName": "When `contract.requiresAccessibleName` is true, a required prop (aria-label, aria-labelledby or an alt text) is the only thing that names the control or image. Do not omit it.",
30
30
  "tokens": "Use only the token names listed under `tokens`. Colour tokens follow the theme (the `.dark` class flips them); do not hard-code colours.",
@@ -473,8 +473,8 @@
473
473
  }
474
474
  },
475
475
  "counts": {
476
- "components": 150,
477
- "blocks": 44,
476
+ "components": 151,
477
+ "blocks": 45,
478
478
  "utilities": 10
479
479
  },
480
480
  "components": [
@@ -4232,6 +4232,55 @@
4232
4232
  "since": "0.3.0",
4233
4233
  "example": "import { FirstPageHeading } from '@sakaniui/react';\n\n<FirstPageHeading title=\"Title\" />"
4234
4234
  },
4235
+ {
4236
+ "name": "Flag",
4237
+ "kind": "component",
4238
+ "category": "Core",
4239
+ "import": "@sakaniui/react",
4240
+ "summary": "A country whose artwork has not been imported yet draws a neutral placeholder of the same shape, so a row of flags never shifts.",
4241
+ "props": [
4242
+ {
4243
+ "name": "country",
4244
+ "type": "string",
4245
+ "required": true,
4246
+ "description": "ISO 3166-1 alpha-2 code, e.g. \"GB\", \"JP\", \"IN\". Case does not matter."
4247
+ },
4248
+ {
4249
+ "name": "size",
4250
+ "type": "number",
4251
+ "required": false,
4252
+ "default": 16,
4253
+ "description": "The box size in px. Defaults to 16."
4254
+ },
4255
+ {
4256
+ "name": "label",
4257
+ "type": "string",
4258
+ "required": false,
4259
+ "description": "The country's name, when the flag is the only thing that says it. Without it the flag is hidden from assistive tech."
4260
+ },
4261
+ {
4262
+ "name": "className",
4263
+ "type": "string",
4264
+ "required": false
4265
+ }
4266
+ ],
4267
+ "contract": {
4268
+ "requiredProps": [
4269
+ "country"
4270
+ ],
4271
+ "requiresAccessibleName": false
4272
+ },
4273
+ "since": "0.18.0",
4274
+ "example": "import { Flag } from '@sakaniui/react';\n\n<Flag country=\"Country\" />",
4275
+ "aliases": [
4276
+ "country flag",
4277
+ "flag icon",
4278
+ "nation flag",
4279
+ "flag emoji",
4280
+ "country icon",
4281
+ "region flag"
4282
+ ]
4283
+ },
4235
4284
  {
4236
4285
  "name": "FunnelChart",
4237
4286
  "kind": "component",
@@ -5443,13 +5492,13 @@
5443
5492
  "description": "Returns the item located at the specified index."
5444
5493
  },
5445
5494
  {
5446
- "name": "__@iterator@16418",
5495
+ "name": "__@iterator@16578",
5447
5496
  "type": "() => ArrayIterator<number>",
5448
5497
  "required": true,
5449
5498
  "description": "Iterator"
5450
5499
  },
5451
5500
  {
5452
- "name": "__@unscopables@16448",
5501
+ "name": "__@unscopables@16608",
5453
5502
  "type": "{ [x: number]: boolean | undefined; length?: boolean | undefined; toString?: boolean | undefined; toLocaleString?: boolean | undefined; pop?: boolean | undefined; push?: boolean | undefined; concat?: boolean | undefined; join?: boolean | undefined; reverse?: boolean | undefined; shift?: boolean | undefined; slice?: boolean | undefined; sort?: boolean | undefined; splice?: boolean | undefined; unshift?: boolean | undefined; indexOf?: boolean | undefined; lastIndexOf?: boolean | undefined; every?: boolean | undefined; some?: boolean | undefined; forEach?: boolean | undefined; map?: boolean | undefined; filter?: boolean | undefined; reduce?: boolean | undefined; reduceRight?: boolean | undefined; find?: boolean | undefined; findIndex?: boolean | undefined; fill?: boolean | undefined; copyWithin?: boolean | undefined; entries?: boolean | undefined; keys?: boolean | undefined; values?: boolean | undefined; includes?: boolean | undefined; flatMap?: boolean | undefined; flat?: boolean | undefined; at?: boolean | undefined; [Symbol.iterator]?: boolean | undefined; readonly [Symbol.unscopables]?: boolean | undefined; }",
5454
5503
  "required": true,
5455
5504
  "description": "Is an object whose properties have the value 'true' when they will be absent when used in a 'with' statement."
@@ -5692,6 +5741,20 @@
5692
5741
  "type": "boolean",
5693
5742
  "required": false
5694
5743
  },
5744
+ {
5745
+ "name": "pressed",
5746
+ "type": "boolean",
5747
+ "required": false,
5748
+ "description": "A toggle that is on: a filled background and `aria-pressed`. Leave it out for a plain button.",
5749
+ "since": "0.18.0"
5750
+ },
5751
+ {
5752
+ "name": "title",
5753
+ "type": "string",
5754
+ "required": false,
5755
+ "description": "A native tooltip.",
5756
+ "since": "0.18.0"
5757
+ },
5695
5758
  {
5696
5759
  "name": "hovered",
5697
5760
  "type": "boolean",
@@ -5812,7 +5875,7 @@
5812
5875
  "type": "LatLng",
5813
5876
  "required": false,
5814
5877
  "default": "[15, 90]",
5815
- "description": "The place facing the viewer at first, as [latitude, longitude].",
5878
+ "description": "The place facing the viewer, as [latitude, longitude]. It is where the globe starts; when it changes, the globe turns to face the new place (the short way round, over about 0.9s; at once under reduced motion).",
5816
5879
  "shape": {
5817
5880
  "type": "LatLng",
5818
5881
  "collection": "object",
@@ -6025,13 +6088,13 @@
6025
6088
  "description": "Returns the item located at the specified index."
6026
6089
  },
6027
6090
  {
6028
- "name": "__@iterator@16418",
6091
+ "name": "__@iterator@16578",
6029
6092
  "type": "() => ArrayIterator<number>",
6030
6093
  "required": true,
6031
6094
  "description": "Iterator"
6032
6095
  },
6033
6096
  {
6034
- "name": "__@unscopables@16448",
6097
+ "name": "__@unscopables@16608",
6035
6098
  "type": "{ [x: number]: boolean | undefined; length?: boolean | undefined; toString?: boolean | undefined; toLocaleString?: boolean | undefined; pop?: boolean | undefined; push?: boolean | undefined; concat?: boolean | undefined; join?: boolean | undefined; reverse?: boolean | undefined; shift?: boolean | undefined; slice?: boolean | undefined; sort?: boolean | undefined; splice?: boolean | undefined; unshift?: boolean | undefined; indexOf?: boolean | undefined; lastIndexOf?: boolean | undefined; every?: boolean | undefined; some?: boolean | undefined; forEach?: boolean | undefined; map?: boolean | undefined; filter?: boolean | undefined; reduce?: boolean | undefined; reduceRight?: boolean | undefined; find?: boolean | undefined; findIndex?: boolean | undefined; fill?: boolean | undefined; copyWithin?: boolean | undefined; entries?: boolean | undefined; keys?: boolean | undefined; values?: boolean | undefined; includes?: boolean | undefined; flatMap?: boolean | undefined; flat?: boolean | undefined; at?: boolean | undefined; [Symbol.iterator]?: boolean | undefined; readonly [Symbol.unscopables]?: boolean | undefined; }",
6036
6099
  "required": true,
6037
6100
  "description": "Is an object whose properties have the value 'true' when they will be absent when used in a 'with' statement."
@@ -6039,6 +6102,40 @@
6039
6102
  ]
6040
6103
  }
6041
6104
  },
6105
+ {
6106
+ "name": "zoom",
6107
+ "type": "number",
6108
+ "required": false,
6109
+ "default": 1,
6110
+ "description": "How big the sphere is, 1 being the default. Changes ease in. Between 0.7 and 2.2; above about 1.19 the sphere reaches the edge of its box and is cropped.",
6111
+ "since": "0.18.0"
6112
+ },
6113
+ {
6114
+ "name": "renderMarkerCard",
6115
+ "type": "((index: number, marker: MapGlobeMarker) => ReactNode)",
6116
+ "required": false,
6117
+ "description": "Your own card on the hovered marker, or the selected one when nothing is hovered. The globe keeps it on the marker as the globe turns (above it, or below when there is no room) and hides it while the marker is on the far side. It does not take the pointer, and it is hidden from assistive tech: put the same information in a list. Replaces the small text label.",
6118
+ "since": "0.18.0"
6119
+ },
6120
+ {
6121
+ "name": "cardPlacement",
6122
+ "type": "\"above\" | \"side\"",
6123
+ "required": false,
6124
+ "values": [
6125
+ "above",
6126
+ "side"
6127
+ ],
6128
+ "default": "above",
6129
+ "description": "Where the card sits on its marker: \"above\" it (default; below when there is no room) or \"side\", beside it (on the side with room), a little above the marker's centre.",
6130
+ "since": "0.18.0"
6131
+ },
6132
+ {
6133
+ "name": "markerScale",
6134
+ "type": "number",
6135
+ "required": false,
6136
+ "description": "How big the markers are drawn: dots, rings, halos and rank chips scale together. By default they follow the globe (its box width over 480), so they shrink with a small globe. Pass 1 to keep them at their design size whatever the globe's size, which keeps the rank numbers readable on a phone.",
6137
+ "since": "0.18.0"
6138
+ },
6042
6139
  {
6043
6140
  "name": "markers",
6044
6141
  "type": "MapGlobeMarker[]",
@@ -6077,6 +6174,23 @@
6077
6174
  "type": "string",
6078
6175
  "required": false,
6079
6176
  "description": "Name shown in a small card above the marker while it is hovered or selected; also its accessible name."
6177
+ },
6178
+ {
6179
+ "name": "size",
6180
+ "type": "MapGlobeMarkerSize",
6181
+ "required": false,
6182
+ "description": "Scales the dot, its ring and its halo: sm 1x, md 1.6x, lg 2.3x. Use it to show a value (bigger = more). Defaults to \"sm\"."
6183
+ },
6184
+ {
6185
+ "name": "rank",
6186
+ "type": "number",
6187
+ "required": false
6188
+ },
6189
+ {
6190
+ "name": "status",
6191
+ "type": "\"healthy\" | \"watch\"",
6192
+ "required": false,
6193
+ "description": "Defaults to \"healthy\"."
6080
6194
  }
6081
6195
  ]
6082
6196
  }
@@ -6415,13 +6529,13 @@
6415
6529
  "description": "Returns the item located at the specified index."
6416
6530
  },
6417
6531
  {
6418
- "name": "__@iterator@16418",
6532
+ "name": "__@iterator@16578",
6419
6533
  "type": "() => ArrayIterator<number>",
6420
6534
  "required": true,
6421
6535
  "description": "Iterator"
6422
6536
  },
6423
6537
  {
6424
- "name": "__@unscopables@16448",
6538
+ "name": "__@unscopables@16608",
6425
6539
  "type": "{ [x: number]: boolean | undefined; length?: boolean | undefined; toString?: boolean | undefined; toLocaleString?: boolean | undefined; pop?: boolean | undefined; push?: boolean | undefined; concat?: boolean | undefined; join?: boolean | undefined; reverse?: boolean | undefined; shift?: boolean | undefined; slice?: boolean | undefined; sort?: boolean | undefined; splice?: boolean | undefined; unshift?: boolean | undefined; indexOf?: boolean | undefined; lastIndexOf?: boolean | undefined; every?: boolean | undefined; some?: boolean | undefined; forEach?: boolean | undefined; map?: boolean | undefined; filter?: boolean | undefined; reduce?: boolean | undefined; reduceRight?: boolean | undefined; find?: boolean | undefined; findIndex?: boolean | undefined; fill?: boolean | undefined; copyWithin?: boolean | undefined; entries?: boolean | undefined; keys?: boolean | undefined; values?: boolean | undefined; includes?: boolean | undefined; flatMap?: boolean | undefined; flat?: boolean | undefined; at?: boolean | undefined; [Symbol.iterator]?: boolean | undefined; readonly [Symbol.unscopables]?: boolean | undefined; }",
6426
6540
  "required": true,
6427
6541
  "description": "Is an object whose properties have the value 'true' when they will be absent when used in a 'with' statement."
@@ -6722,13 +6836,13 @@
6722
6836
  "description": "Returns the item located at the specified index."
6723
6837
  },
6724
6838
  {
6725
- "name": "__@iterator@16418",
6839
+ "name": "__@iterator@16578",
6726
6840
  "type": "() => ArrayIterator<number>",
6727
6841
  "required": true,
6728
6842
  "description": "Iterator"
6729
6843
  },
6730
6844
  {
6731
- "name": "__@unscopables@16448",
6845
+ "name": "__@unscopables@16608",
6732
6846
  "type": "{ [x: number]: boolean | undefined; length?: boolean | undefined; toString?: boolean | undefined; toLocaleString?: boolean | undefined; pop?: boolean | undefined; push?: boolean | undefined; concat?: boolean | undefined; join?: boolean | undefined; reverse?: boolean | undefined; shift?: boolean | undefined; slice?: boolean | undefined; sort?: boolean | undefined; splice?: boolean | undefined; unshift?: boolean | undefined; indexOf?: boolean | undefined; lastIndexOf?: boolean | undefined; every?: boolean | undefined; some?: boolean | undefined; forEach?: boolean | undefined; map?: boolean | undefined; filter?: boolean | undefined; reduce?: boolean | undefined; reduceRight?: boolean | undefined; find?: boolean | undefined; findIndex?: boolean | undefined; fill?: boolean | undefined; copyWithin?: boolean | undefined; entries?: boolean | undefined; keys?: boolean | undefined; values?: boolean | undefined; includes?: boolean | undefined; flatMap?: boolean | undefined; flat?: boolean | undefined; at?: boolean | undefined; [Symbol.iterator]?: boolean | undefined; readonly [Symbol.unscopables]?: boolean | undefined; }",
6733
6847
  "required": true,
6734
6848
  "description": "Is an object whose properties have the value 'true' when they will be absent when used in a 'with' statement."
@@ -13276,6 +13390,349 @@
13276
13390
  "since": "0.4.0",
13277
13391
  "example": "import { LiquidDashboardBlock } from '@sakaniui/react/blocks';\n\n<LiquidDashboardBlock backgroundImage=\"/images/example.jpg\" />"
13278
13392
  },
13393
+ {
13394
+ "name": "LiveMapBlock",
13395
+ "kind": "block",
13396
+ "category": "Blocks/Application",
13397
+ "import": "@sakaniui/react/blocks",
13398
+ "summary": "Live Map block (Application): a composition example. Copy it into your project and edit it.",
13399
+ "props": [
13400
+ {
13401
+ "name": "cities",
13402
+ "type": "LiveMapCity[]",
13403
+ "required": false,
13404
+ "description": "The cities: dots on the globe and rows in the list.",
13405
+ "shape": {
13406
+ "type": "LiveMapCity",
13407
+ "collection": "array",
13408
+ "fields": [
13409
+ {
13410
+ "name": "id",
13411
+ "type": "string",
13412
+ "required": true
13413
+ },
13414
+ {
13415
+ "name": "name",
13416
+ "type": "string",
13417
+ "required": true
13418
+ },
13419
+ {
13420
+ "name": "country",
13421
+ "type": "string",
13422
+ "required": true,
13423
+ "description": "Two-letter code, shown beside the name in the list, e.g. \"GB\"."
13424
+ },
13425
+ {
13426
+ "name": "countryName",
13427
+ "type": "string",
13428
+ "required": true,
13429
+ "description": "Shown in the selection chip, e.g. \"Tokyo, Japan\"."
13430
+ },
13431
+ {
13432
+ "name": "region",
13433
+ "type": "string",
13434
+ "required": true,
13435
+ "description": "The id of one of `regions`."
13436
+ },
13437
+ {
13438
+ "name": "position",
13439
+ "type": "LatLng",
13440
+ "required": true,
13441
+ "description": "[latitude, longitude]."
13442
+ },
13443
+ {
13444
+ "name": "timeZone",
13445
+ "type": "string",
13446
+ "required": true,
13447
+ "description": "IANA time zone, for the \"22:42 local\" in the hover card, e.g. \"Asia/Tokyo\"."
13448
+ },
13449
+ {
13450
+ "name": "revenue",
13451
+ "type": "number",
13452
+ "required": true,
13453
+ "description": "Revenue today, in dollars."
13454
+ },
13455
+ {
13456
+ "name": "payments",
13457
+ "type": "number",
13458
+ "required": true,
13459
+ "description": "Payments today."
13460
+ },
13461
+ {
13462
+ "name": "approvalRate",
13463
+ "type": "number",
13464
+ "required": true,
13465
+ "description": "Approval rate, in percent (97.1)."
13466
+ },
13467
+ {
13468
+ "name": "avgPayment",
13469
+ "type": "number",
13470
+ "required": true,
13471
+ "description": "Average payment, in dollars."
13472
+ },
13473
+ {
13474
+ "name": "vsForecast",
13475
+ "type": "number",
13476
+ "required": true,
13477
+ "description": "Revenue against forecast, in percent: 6 shows \"+6% vs forecast\", -2 shows \"-2% vs forecast\"."
13478
+ },
13479
+ {
13480
+ "name": "status",
13481
+ "type": "\"healthy\" | \"watch\"",
13482
+ "required": false,
13483
+ "description": "\"watch\" gives the city a dashed amber ring on the globe and a Watch badge (approvals dipping). Defaults to \"healthy\"."
13484
+ },
13485
+ {
13486
+ "name": "methods",
13487
+ "type": "{ label: string; share: number; }[]",
13488
+ "required": true,
13489
+ "description": "Share of revenue by payment method, in percent."
13490
+ }
13491
+ ]
13492
+ }
13493
+ },
13494
+ {
13495
+ "name": "regions",
13496
+ "type": "LiveMapRegion[]",
13497
+ "required": false,
13498
+ "description": "The region filters after \"All regions\".",
13499
+ "shape": {
13500
+ "type": "LiveMapRegion",
13501
+ "collection": "array",
13502
+ "fields": [
13503
+ {
13504
+ "name": "id",
13505
+ "type": "string",
13506
+ "required": true
13507
+ },
13508
+ {
13509
+ "name": "label",
13510
+ "type": "string",
13511
+ "required": true,
13512
+ "description": "Shown on the filter chip and beside the city name, e.g. \"EMEA\"."
13513
+ },
13514
+ {
13515
+ "name": "center",
13516
+ "type": "LatLng",
13517
+ "required": true,
13518
+ "description": "Where the globe turns when this region is chosen, as [latitude, longitude]."
13519
+ }
13520
+ ]
13521
+ }
13522
+ },
13523
+ {
13524
+ "name": "hourly",
13525
+ "type": "number[]",
13526
+ "required": false,
13527
+ "description": "Payment volume for each hour of today (24 numbers, UTC). Hours after the current one are not drawn."
13528
+ },
13529
+ {
13530
+ "name": "totals",
13531
+ "type": "LiveMapTotals",
13532
+ "required": false,
13533
+ "description": "Figures across every city, for the headline and \"Top 5 of 40 cities\".",
13534
+ "shape": {
13535
+ "type": "LiveMapTotals",
13536
+ "collection": "object",
13537
+ "fields": [
13538
+ {
13539
+ "name": "revenue",
13540
+ "type": "number",
13541
+ "required": true,
13542
+ "description": "Revenue today across every city, in dollars."
13543
+ },
13544
+ {
13545
+ "name": "payments",
13546
+ "type": "number",
13547
+ "required": true,
13548
+ "description": "Payments today across every city."
13549
+ },
13550
+ {
13551
+ "name": "approvalRate",
13552
+ "type": "number",
13553
+ "required": true,
13554
+ "description": "Approval rate across every city, in percent."
13555
+ },
13556
+ {
13557
+ "name": "vsForecast",
13558
+ "type": "number",
13559
+ "required": true,
13560
+ "description": "Revenue against forecast, in percent."
13561
+ },
13562
+ {
13563
+ "name": "cities",
13564
+ "type": "number",
13565
+ "required": true,
13566
+ "description": "How many cities there are in all (the list shows the top few): \"Top 5 of 40 cities\"."
13567
+ }
13568
+ ]
13569
+ }
13570
+ },
13571
+ {
13572
+ "name": "insight",
13573
+ "type": "LiveMapInsight",
13574
+ "required": false,
13575
+ "description": "The \"Right now\" card (and the phone's pill).",
13576
+ "shape": {
13577
+ "type": "LiveMapInsight",
13578
+ "collection": "object",
13579
+ "fields": [
13580
+ {
13581
+ "name": "title",
13582
+ "type": "string",
13583
+ "required": true
13584
+ },
13585
+ {
13586
+ "name": "body",
13587
+ "type": "string",
13588
+ "required": true
13589
+ },
13590
+ {
13591
+ "name": "short",
13592
+ "type": "string",
13593
+ "required": true,
13594
+ "description": "The one line the phone layout shows in a pill."
13595
+ }
13596
+ ]
13597
+ }
13598
+ },
13599
+ {
13600
+ "name": "hubId",
13601
+ "type": "string",
13602
+ "required": false,
13603
+ "description": "The id of the city the arcs settle to. Defaults to the first city named \"Singapore\", else the first city."
13604
+ },
13605
+ {
13606
+ "name": "state",
13607
+ "type": "\"default\" | \"empty\" | \"loading\"",
13608
+ "required": false,
13609
+ "values": [
13610
+ "default",
13611
+ "empty",
13612
+ "loading"
13613
+ ],
13614
+ "default": "default",
13615
+ "description": "\"default\", \"loading\" (skeletons) or \"empty\" (no payments yet today)."
13616
+ },
13617
+ {
13618
+ "name": "title",
13619
+ "type": "string",
13620
+ "required": false,
13621
+ "default": "Where your payments are coming from"
13622
+ },
13623
+ {
13624
+ "name": "mobileTitle",
13625
+ "type": "string",
13626
+ "required": false,
13627
+ "default": "Where payments come from",
13628
+ "description": "The title on a phone, which has less room."
13629
+ },
13630
+ {
13631
+ "name": "description",
13632
+ "type": "string",
13633
+ "required": false,
13634
+ "description": "The line under the title on a desktop."
13635
+ },
13636
+ {
13637
+ "name": "mobileDescription",
13638
+ "type": "string",
13639
+ "required": false,
13640
+ "default": "Bigger dots mean more revenue. Tap a city for details.",
13641
+ "description": "The line under the title on a phone."
13642
+ },
13643
+ {
13644
+ "name": "selectedId",
13645
+ "type": "string | null",
13646
+ "required": false,
13647
+ "description": "The selected city's id, or null for none (controlled)."
13648
+ },
13649
+ {
13650
+ "name": "defaultSelectedId",
13651
+ "type": "string | null",
13652
+ "required": false,
13653
+ "default": "null",
13654
+ "description": "The city selected first (uncontrolled). Picking it in the list or on the globe turns the globe to it."
13655
+ },
13656
+ {
13657
+ "name": "onSelectedChange",
13658
+ "type": "((id: string | null) => void)",
13659
+ "required": false
13660
+ },
13661
+ {
13662
+ "name": "hoveredId",
13663
+ "type": "string",
13664
+ "required": false,
13665
+ "description": "Pins the hover look (and the card) on one city without a pointer: documentation and visual tests."
13666
+ },
13667
+ {
13668
+ "name": "defaultMetric",
13669
+ "type": "\"revenue\" | \"payments\" | \"approval\"",
13670
+ "required": false,
13671
+ "values": [
13672
+ "revenue",
13673
+ "payments",
13674
+ "approval"
13675
+ ],
13676
+ "default": "revenue",
13677
+ "description": "The metric shown first."
13678
+ },
13679
+ {
13680
+ "name": "now",
13681
+ "type": "Date",
13682
+ "required": false,
13683
+ "description": "The moment to show. Left out, the clock runs on real time and ticks. Given, it is frozen there."
13684
+ },
13685
+ {
13686
+ "name": "autoRotate",
13687
+ "type": "boolean",
13688
+ "required": false,
13689
+ "default": true,
13690
+ "description": "Turn the globe slowly (about 6 degrees a second) and offer a rotate button that stops and restarts it. Defaults to true. It holds still while the pointer is on the globe, and while a city is selected so the globe keeps facing it; under reduced motion it never turns (and the button is not shown)."
13691
+ },
13692
+ {
13693
+ "name": "atmosphere",
13694
+ "type": "boolean",
13695
+ "required": false,
13696
+ "default": true,
13697
+ "description": "Show the atmosphere glow around the globe. Defaults to true."
13698
+ },
13699
+ {
13700
+ "name": "onViewCity",
13701
+ "type": "((city: LiveMapCity) => void)",
13702
+ "required": false,
13703
+ "description": "The primary button in a city's detail (\"View Tokyo payments\")."
13704
+ },
13705
+ {
13706
+ "name": "onViewAll",
13707
+ "type": "(() => void)",
13708
+ "required": false,
13709
+ "description": "\"View all cities\" under the list."
13710
+ },
13711
+ {
13712
+ "name": "className",
13713
+ "type": "string",
13714
+ "required": false
13715
+ }
13716
+ ],
13717
+ "contract": {
13718
+ "requiredProps": [],
13719
+ "requiresAccessibleName": false
13720
+ },
13721
+ "since": "0.18.0",
13722
+ "example": "import { LiveMapBlock } from '@sakaniui/react/blocks';\n\n<LiveMapBlock />",
13723
+ "aliases": [
13724
+ "live map",
13725
+ "payments map",
13726
+ "live payments globe",
13727
+ "revenue by city",
13728
+ "geo dashboard",
13729
+ "world map dashboard",
13730
+ "city leaderboard",
13731
+ "real time map",
13732
+ "map with ranked list",
13733
+ "globe dashboard"
13734
+ ]
13735
+ },
13279
13736
  {
13280
13737
  "name": "LoginBlock",
13281
13738
  "kind": "block",
package/data/package.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@sakaniui/react",
3
- "version": "0.17.2",
3
+ "version": "0.18.0",
4
4
  "private": true
5
5
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sakaniui/mcp",
3
- "version": "0.17.2",
3
+ "version": "0.18.0",
4
4
  "description": "SakaniUI MCP server: lets AI editors look up components, props, tokens and icons, and check code, instead of guessing. Read-only, zero dependencies.",
5
5
  "type": "module",
6
6
  "bin": {