@sakaniui/mcp 0.10.1 → 0.12.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.10.1",
4
+ "version": "0.12.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.10.1. 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.12.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.",
@@ -459,9 +459,9 @@
459
459
  }
460
460
  },
461
461
  "counts": {
462
- "components": 127,
462
+ "components": 139,
463
463
  "blocks": 42,
464
- "utilities": 7
464
+ "utilities": 10
465
465
  },
466
466
  "components": [
467
467
  {
@@ -2174,6 +2174,200 @@
2174
2174
  "since": "0.3.0",
2175
2175
  "example": "import { CartItem } from '@sakaniui/react';\n\n<CartItem image=\"/images/example.jpg\" name=\"Name\" price={49} quantity={1} />"
2176
2176
  },
2177
+ {
2178
+ "name": "ChainOfThought",
2179
+ "kind": "component",
2180
+ "category": "Composite",
2181
+ "import": "@sakaniui/react",
2182
+ "summary": "An AI agent's visible work: a header, steps joined by a rail (ChainOfThoughtStep), and a live Working line. `open` / `defaultOpen` toggles it; `status` and `elapsed` or `startedAt` drive the working line.",
2183
+ "props": [
2184
+ {
2185
+ "name": "title",
2186
+ "type": "ReactNode",
2187
+ "required": true,
2188
+ "description": "The header text, e.g. \"Ran 3 searches\" or \"Thinking\"."
2189
+ },
2190
+ {
2191
+ "name": "icon",
2192
+ "type": "IconComponent",
2193
+ "required": false,
2194
+ "description": "The header icon, drawn at 16px. Defaults to a magnifier."
2195
+ },
2196
+ {
2197
+ "name": "open",
2198
+ "type": "boolean",
2199
+ "required": false,
2200
+ "description": "Controlled open state. Omit it to let the component keep its own (see defaultOpen)."
2201
+ },
2202
+ {
2203
+ "name": "defaultOpen",
2204
+ "type": "boolean",
2205
+ "required": false,
2206
+ "default": true,
2207
+ "description": "Initial open state when uncontrolled. Defaults to true."
2208
+ },
2209
+ {
2210
+ "name": "onOpenChange",
2211
+ "type": "((open: boolean) => void)",
2212
+ "required": false,
2213
+ "description": "Called with the new state when the header is clicked."
2214
+ },
2215
+ {
2216
+ "name": "status",
2217
+ "type": "\"done\" | \"working\"",
2218
+ "required": false,
2219
+ "values": [
2220
+ "done",
2221
+ "working"
2222
+ ],
2223
+ "default": "done",
2224
+ "description": "Adds the working line under the steps: \"working\" (sparkle, shimmer) or \"done\" (\"Worked for 11.2s\")."
2225
+ },
2226
+ {
2227
+ "name": "elapsed",
2228
+ "type": "number",
2229
+ "required": false,
2230
+ "description": "Elapsed seconds for the working line."
2231
+ },
2232
+ {
2233
+ "name": "startedAt",
2234
+ "type": "number",
2235
+ "required": false,
2236
+ "description": "Epoch ms when the work started; the working line then counts up on its own."
2237
+ },
2238
+ {
2239
+ "name": "children",
2240
+ "type": "ReactNode",
2241
+ "required": false,
2242
+ "description": "ChainOfThoughtStep elements."
2243
+ },
2244
+ {
2245
+ "name": "className",
2246
+ "type": "string",
2247
+ "required": false
2248
+ }
2249
+ ],
2250
+ "contract": {
2251
+ "requiredProps": [
2252
+ "title"
2253
+ ],
2254
+ "requiresAccessibleName": false
2255
+ },
2256
+ "since": "0.12.0",
2257
+ "example": "import { ChainOfThought } from '@sakaniui/react';\n\n<ChainOfThought title=\"Title\" />",
2258
+ "recipes": [
2259
+ {
2260
+ "title": "Stream an agent run: steps arrive, the timer ticks, then it finishes",
2261
+ "description": "ChainOfThought is presentational. Keep the steps in state, append one as your agent starts it, mark the previous one `done`, and pass `status=\"working\"` with `startedAt` so the time counts up on its own. When the run ends switch to `status=\"done\"` with the final `elapsed` (seconds) and change the title. The rail stops at the last step by itself.",
2262
+ "code": "import React from 'react';\nimport { ChainOfThought, ChainOfThoughtStep, SourceStack } from '@sakaniui/react';\nimport { IconBrandReddit } from '@sakaniui/react/icons';\n\ntype Step = { id: string; label: string; query?: string; count?: string };\n\nexport const Example = ({ steps, finished, startedAt, elapsed }: { steps: Step[]; finished: boolean; startedAt: number; elapsed?: number }) => (\n <ChainOfThought\n title={finished ? `Ran ${steps.length} searches` : 'Researching'}\n status={finished ? 'done' : 'working'}\n startedAt={startedAt}\n elapsed={elapsed}\n >\n {steps.map((s, i) => (\n <ChainOfThoughtStep\n key={s.id}\n status={!finished && i === steps.length - 1 ? 'active' : 'done'}\n icon={IconBrandReddit}\n label={s.label}\n query={s.query}\n count={s.count}\n sources={<SourceStack sources={[{ label: 'Reddit', icon: IconBrandReddit }]} />}\n />\n ))}\n </ChainOfThought>\n);"
2263
+ }
2264
+ ],
2265
+ "aliases": [
2266
+ "thought chain",
2267
+ "reasoning steps",
2268
+ "reasoning trace",
2269
+ "agent steps",
2270
+ "agent activity",
2271
+ "agent trace",
2272
+ "thinking steps",
2273
+ "tool calls",
2274
+ "tool call log",
2275
+ "activity trace",
2276
+ "ai steps",
2277
+ "research steps"
2278
+ ]
2279
+ },
2280
+ {
2281
+ "name": "ChainOfThoughtStep",
2282
+ "kind": "component",
2283
+ "category": "Composite",
2284
+ "import": "@sakaniui/react",
2285
+ "summary": "One step of an agent run: an icon, a label, an optional monospace `query`, a `count` and a `sources` row. `status` is pending, active (read in full) or done (muted).",
2286
+ "props": [
2287
+ {
2288
+ "name": "status",
2289
+ "type": "\"active\" | \"done\" | \"pending\"",
2290
+ "required": false,
2291
+ "values": [
2292
+ "active",
2293
+ "done",
2294
+ "pending"
2295
+ ],
2296
+ "default": "done",
2297
+ "description": "pending (not started), active (in progress, read in full) or done (muted). Defaults to \"done\"."
2298
+ },
2299
+ {
2300
+ "name": "icon",
2301
+ "type": "IconComponent",
2302
+ "required": false,
2303
+ "description": "The step's icon, drawn at 16px. Defaults to a magnifier."
2304
+ },
2305
+ {
2306
+ "name": "label",
2307
+ "type": "ReactNode",
2308
+ "required": true,
2309
+ "description": "What happened, e.g. \"Searched X for\"."
2310
+ },
2311
+ {
2312
+ "name": "query",
2313
+ "type": "string",
2314
+ "required": false,
2315
+ "description": "The query or argument, shown in monospace after the label."
2316
+ },
2317
+ {
2318
+ "name": "count",
2319
+ "type": "ReactNode",
2320
+ "required": false,
2321
+ "description": "A result count on the right, e.g. \"7 posts\"."
2322
+ },
2323
+ {
2324
+ "name": "accent",
2325
+ "type": "string",
2326
+ "required": false,
2327
+ "description": "Colour of the spark that runs into the step while it is active. Defaults to the icon's brand colour when it is a logo from `sourceLogo()`."
2328
+ },
2329
+ {
2330
+ "name": "sources",
2331
+ "type": "ReactNode",
2332
+ "required": false,
2333
+ "description": "A row under the step, usually a <SourceStack>."
2334
+ },
2335
+ {
2336
+ "name": "sourcesLabel",
2337
+ "type": "string",
2338
+ "required": false,
2339
+ "default": "Sources",
2340
+ "description": "Text before the sources. Defaults to \"Sources\"."
2341
+ },
2342
+ {
2343
+ "name": "onSourcesClick",
2344
+ "type": "(() => void)",
2345
+ "required": false,
2346
+ "description": "Makes the sources row a button with a chevron, so the sources can be opened."
2347
+ },
2348
+ {
2349
+ "name": "className",
2350
+ "type": "string",
2351
+ "required": false
2352
+ }
2353
+ ],
2354
+ "contract": {
2355
+ "requiredProps": [
2356
+ "label"
2357
+ ],
2358
+ "requiresAccessibleName": false
2359
+ },
2360
+ "since": "0.12.0",
2361
+ "example": "import { ChainOfThoughtStep } from '@sakaniui/react';\n\n<ChainOfThoughtStep label=\"Label\" />",
2362
+ "aliases": [
2363
+ "reasoning step",
2364
+ "thought step",
2365
+ "agent step",
2366
+ "tool call",
2367
+ "search step",
2368
+ "task step"
2369
+ ]
2370
+ },
2177
2371
  {
2178
2372
  "name": "ChatComposer",
2179
2373
  "kind": "component",
@@ -3906,99 +4100,1673 @@
3906
4100
  ],
3907
4101
  "default": "check"
3908
4102
  },
3909
- {
3910
- "name": "className",
3911
- "type": "string",
3912
- "required": false
3913
- }
3914
- ],
3915
- "contract": {
3916
- "requiredProps": [
3917
- "items"
3918
- ],
3919
- "requiresAccessibleName": false
3920
- },
3921
- "since": "0.3.0",
3922
- "example": "import { List } from '@sakaniui/react';\n\n<List items={[\"Item\"]} />"
3923
- },
3924
- {
3925
- "name": "ListItem",
3926
- "kind": "component",
3927
- "category": "Composite",
3928
- "import": "@sakaniui/react",
3929
- "summary": "Row for lists/menus. Supports leading (icon/avatar) and trailing (badge/action) slots.",
3930
- "props": [
4103
+ {
4104
+ "name": "className",
4105
+ "type": "string",
4106
+ "required": false
4107
+ }
4108
+ ],
4109
+ "contract": {
4110
+ "requiredProps": [
4111
+ "items"
4112
+ ],
4113
+ "requiresAccessibleName": false
4114
+ },
4115
+ "since": "0.3.0",
4116
+ "example": "import { List } from '@sakaniui/react';\n\n<List items={[\"Item\"]} />"
4117
+ },
4118
+ {
4119
+ "name": "ListItem",
4120
+ "kind": "component",
4121
+ "category": "Composite",
4122
+ "import": "@sakaniui/react",
4123
+ "summary": "Row for lists/menus. Supports leading (icon/avatar) and trailing (badge/action) slots.",
4124
+ "props": [
4125
+ {
4126
+ "name": "title",
4127
+ "type": "string",
4128
+ "required": true
4129
+ },
4130
+ {
4131
+ "name": "description",
4132
+ "type": "string",
4133
+ "required": false
4134
+ },
4135
+ {
4136
+ "name": "leading",
4137
+ "type": "ReactNode",
4138
+ "required": false
4139
+ },
4140
+ {
4141
+ "name": "trailing",
4142
+ "type": "ReactNode",
4143
+ "required": false
4144
+ },
4145
+ {
4146
+ "name": "selected",
4147
+ "type": "boolean",
4148
+ "required": false
4149
+ },
4150
+ {
4151
+ "name": "disabled",
4152
+ "type": "boolean",
4153
+ "required": false
4154
+ },
4155
+ {
4156
+ "name": "onClick",
4157
+ "type": "(() => void)",
4158
+ "required": false
4159
+ },
4160
+ {
4161
+ "name": "className",
4162
+ "type": "string",
4163
+ "required": false
4164
+ }
4165
+ ],
4166
+ "contract": {
4167
+ "requiredProps": [
4168
+ "title"
4169
+ ],
4170
+ "requiresAccessibleName": false
4171
+ },
4172
+ "since": "0.1.0",
4173
+ "example": "import { ListItem } from '@sakaniui/react';\n\n<ListItem title=\"Title\" />"
4174
+ },
4175
+ {
4176
+ "name": "LocationDot",
4177
+ "kind": "component",
4178
+ "category": "Marketing",
4179
+ "import": "@sakaniui/react",
4180
+ "summary": "A status dot and location label; `status` \"active\" is green (a real office), \"remote\" is gray.",
4181
+ "props": [
4182
+ {
4183
+ "name": "location",
4184
+ "type": "string",
4185
+ "required": true
4186
+ },
4187
+ {
4188
+ "name": "status",
4189
+ "type": "\"active\" | \"remote\"",
4190
+ "required": false,
4191
+ "values": [
4192
+ "active",
4193
+ "remote"
4194
+ ],
4195
+ "default": "active"
4196
+ },
4197
+ {
4198
+ "name": "className",
4199
+ "type": "string",
4200
+ "required": false
4201
+ }
4202
+ ],
4203
+ "contract": {
4204
+ "requiredProps": [
4205
+ "location"
4206
+ ],
4207
+ "requiresAccessibleName": false
4208
+ },
4209
+ "since": "0.3.0",
4210
+ "example": "import { LocationDot } from '@sakaniui/react';\n\n<LocationDot location=\"Location\" />"
4211
+ },
4212
+ {
4213
+ "name": "Map",
4214
+ "kind": "component",
4215
+ "category": "Composite",
4216
+ "import": "@sakaniui/react",
4217
+ "summary": "Interactive tile map with pan, zoom and controls. Place MapMarker and MapPopup children by [latitude, longitude]; `tileUrl` swaps the tile provider (OpenStreetMap by default).",
4218
+ "props": [
4219
+ {
4220
+ "name": "center",
4221
+ "type": "LatLng",
4222
+ "required": false,
4223
+ "default": "[51.505, -0.09]",
4224
+ "description": "Where the map starts, as [latitude, longitude]. Changing it later flies the map there.",
4225
+ "shape": {
4226
+ "type": "LatLng",
4227
+ "collection": "object",
4228
+ "fields": [
4229
+ {
4230
+ "name": "0",
4231
+ "type": "number",
4232
+ "required": true
4233
+ },
4234
+ {
4235
+ "name": "1",
4236
+ "type": "number",
4237
+ "required": true
4238
+ },
4239
+ {
4240
+ "name": "length",
4241
+ "type": "2",
4242
+ "required": true
4243
+ },
4244
+ {
4245
+ "name": "toString",
4246
+ "type": "() => string",
4247
+ "required": true,
4248
+ "description": "Returns a string representation of an array."
4249
+ },
4250
+ {
4251
+ "name": "toLocaleString",
4252
+ "type": "{ (): string; (locales: string | string[], options?: (NumberFormatOptions & DateTimeFormatOptions) | undefined): string; }",
4253
+ "required": true,
4254
+ "description": "Returns a string representation of an array. The elements are converted to string using their toLocaleString methods."
4255
+ },
4256
+ {
4257
+ "name": "pop",
4258
+ "type": "() => number",
4259
+ "required": true,
4260
+ "description": "Removes the last element from an array and returns it. If the array is empty, undefined is returned and the array is not modified."
4261
+ },
4262
+ {
4263
+ "name": "push",
4264
+ "type": "(...items: number[]) => number",
4265
+ "required": true,
4266
+ "description": "Appends new elements to the end of an array, and returns the new length of the array."
4267
+ },
4268
+ {
4269
+ "name": "concat",
4270
+ "type": "{ (...items: ConcatArray<number>[]): number[]; (...items: (number | ConcatArray<number>)[]): number[]; }",
4271
+ "required": true,
4272
+ "description": "Combines two or more arrays. This method returns a new array without modifying any existing arrays."
4273
+ },
4274
+ {
4275
+ "name": "join",
4276
+ "type": "(separator?: string | undefined) => string",
4277
+ "required": true,
4278
+ "description": "Adds all the elements of an array into a string, separated by the specified separator string."
4279
+ },
4280
+ {
4281
+ "name": "reverse",
4282
+ "type": "() => number[]",
4283
+ "required": true,
4284
+ "description": "Reverses the elements in an array in place. This method mutates the array and returns a reference to the same array."
4285
+ },
4286
+ {
4287
+ "name": "shift",
4288
+ "type": "() => number",
4289
+ "required": true,
4290
+ "description": "Removes the first element from an array and returns it. If the array is empty, undefined is returned and the array is not modified."
4291
+ },
4292
+ {
4293
+ "name": "slice",
4294
+ "type": "(start?: number | undefined, end?: number | undefined) => number[]",
4295
+ "required": true,
4296
+ "description": "Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array."
4297
+ },
4298
+ {
4299
+ "name": "sort",
4300
+ "type": "(compareFn?: ((a: number, b: number) => number) | undefined) => LatLng",
4301
+ "required": true,
4302
+ "description": "Sorts an array in place. This method mutates the array and returns a reference to the same array."
4303
+ },
4304
+ {
4305
+ "name": "splice",
4306
+ "type": "{ (start: number, deleteCount?: number | undefined): number[]; (start: number, deleteCount: number, ...items: number[]): number[]; }",
4307
+ "required": true,
4308
+ "description": "Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements."
4309
+ },
4310
+ {
4311
+ "name": "unshift",
4312
+ "type": "(...items: number[]) => number",
4313
+ "required": true,
4314
+ "description": "Inserts new elements at the start of an array, and returns the new length of the array."
4315
+ },
4316
+ {
4317
+ "name": "indexOf",
4318
+ "type": "(searchElement: number, fromIndex?: number | undefined) => number",
4319
+ "required": true,
4320
+ "description": "Returns the index of the first occurrence of a value in an array, or -1 if it is not present."
4321
+ },
4322
+ {
4323
+ "name": "lastIndexOf",
4324
+ "type": "(searchElement: number, fromIndex?: number | undefined) => number",
4325
+ "required": true,
4326
+ "description": "Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present."
4327
+ },
4328
+ {
4329
+ "name": "every",
4330
+ "type": "{ <S extends number>(predicate: (value: number, index: number, array: number[]) => value is S, thisArg?: any): this is S[]; (predicate: (value: number, index: number, array: number[]) => unknown, thisArg?: any): boolean; }",
4331
+ "required": true,
4332
+ "description": "Determines whether all the members of an array satisfy the specified test."
4333
+ },
4334
+ {
4335
+ "name": "some",
4336
+ "type": "(predicate: (value: number, index: number, array: number[]) => unknown, thisArg?: any) => boolean",
4337
+ "required": true,
4338
+ "description": "Determines whether the specified callback function returns true for any element of an array."
4339
+ },
4340
+ {
4341
+ "name": "forEach",
4342
+ "type": "(callbackfn: (value: number, index: number, array: number[]) => void, thisArg?: any) => void",
4343
+ "required": true,
4344
+ "description": "Performs the specified action for each element in an array."
4345
+ },
4346
+ {
4347
+ "name": "map",
4348
+ "type": "<U>(callbackfn: (value: number, index: number, array: number[]) => U, thisArg?: any) => U[]",
4349
+ "required": true,
4350
+ "description": "Calls a defined callback function on each element of an array, and returns an array that contains the results."
4351
+ },
4352
+ {
4353
+ "name": "filter",
4354
+ "type": "{ <S extends number>(predicate: (value: number, index: number, array: number[]) => value is S, thisArg?: any): S[]; (predicate: (value: number, index: number, array: number[]) => unknown, thisArg?: any): number[]; }",
4355
+ "required": true,
4356
+ "description": "Returns the elements of an array that meet the condition specified in a callback function."
4357
+ },
4358
+ {
4359
+ "name": "reduce",
4360
+ "type": "{ (callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: number[]) => number): number; (callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: number[]) => number, initialValue: number): number; <U>(callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: number[]) => U, initialValue: U): U; }",
4361
+ "required": true,
4362
+ "description": "Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function."
4363
+ },
4364
+ {
4365
+ "name": "reduceRight",
4366
+ "type": "{ (callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: number[]) => number): number; (callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: number[]) => number, initialValue: number): number; <U>(callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: number[]) => U, initialValue: U): U; }",
4367
+ "required": true,
4368
+ "description": "Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function."
4369
+ },
4370
+ {
4371
+ "name": "find",
4372
+ "type": "{ <S extends number>(predicate: (value: number, index: number, obj: number[]) => value is S, thisArg?: any): S | undefined; (predicate: (value: number, index: number, obj: number[]) => unknown, thisArg?: any): number | undefined; }",
4373
+ "required": true,
4374
+ "description": "Returns the value of the first element in the array where predicate is true, and undefined otherwise."
4375
+ },
4376
+ {
4377
+ "name": "findIndex",
4378
+ "type": "(predicate: (value: number, index: number, obj: number[]) => unknown, thisArg?: any) => number",
4379
+ "required": true,
4380
+ "description": "Returns the index of the first element in the array where predicate is true, and -1 otherwise."
4381
+ },
4382
+ {
4383
+ "name": "fill",
4384
+ "type": "(value: number, start?: number | undefined, end?: number | undefined) => LatLng",
4385
+ "required": true,
4386
+ "description": "Changes all array elements from `start` to `end` index to a static `value` and returns the modified array"
4387
+ },
4388
+ {
4389
+ "name": "copyWithin",
4390
+ "type": "(target: number, start: number, end?: number | undefined) => LatLng",
4391
+ "required": true,
4392
+ "description": "Returns the this object after copying a section of the array identified by start and end to the same array starting at position target"
4393
+ },
4394
+ {
4395
+ "name": "entries",
4396
+ "type": "() => ArrayIterator<[number, number]>",
4397
+ "required": true,
4398
+ "description": "Returns an iterable of key, value pairs for every entry in the array"
4399
+ },
4400
+ {
4401
+ "name": "keys",
4402
+ "type": "() => ArrayIterator<number>",
4403
+ "required": true,
4404
+ "description": "Returns an iterable of keys in the array"
4405
+ },
4406
+ {
4407
+ "name": "values",
4408
+ "type": "() => ArrayIterator<number>",
4409
+ "required": true,
4410
+ "description": "Returns an iterable of values in the array"
4411
+ },
4412
+ {
4413
+ "name": "includes",
4414
+ "type": "(searchElement: number, fromIndex?: number | undefined) => boolean",
4415
+ "required": true,
4416
+ "description": "Determines whether an array includes a certain element, returning true or false as appropriate."
4417
+ },
4418
+ {
4419
+ "name": "flatMap",
4420
+ "type": "<U, This = undefined>(callback: (this: This, value: number, index: number, array: number[]) => U | readonly U[], thisArg?: This | undefined) => U[]",
4421
+ "required": true,
4422
+ "description": "Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1."
4423
+ },
4424
+ {
4425
+ "name": "flat",
4426
+ "type": "<A, D extends number = 1>(this: A, depth?: D | undefined) => FlatArray<A, D>[]",
4427
+ "required": true,
4428
+ "description": "Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth."
4429
+ },
4430
+ {
4431
+ "name": "at",
4432
+ "type": "(index: number) => number",
4433
+ "required": true,
4434
+ "description": "Returns the item located at the specified index."
4435
+ },
4436
+ {
4437
+ "name": "__@iterator@15310",
4438
+ "type": "() => ArrayIterator<number>",
4439
+ "required": true,
4440
+ "description": "Iterator"
4441
+ },
4442
+ {
4443
+ "name": "__@unscopables@15340",
4444
+ "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; }",
4445
+ "required": true,
4446
+ "description": "Is an object whose properties have the value 'true' when they will be absent when used in a 'with' statement."
4447
+ }
4448
+ ]
4449
+ }
4450
+ },
4451
+ {
4452
+ "name": "zoom",
4453
+ "type": "number",
4454
+ "required": false,
4455
+ "default": 12,
4456
+ "description": "Starting zoom, 0 (whole world) to maxZoom. Changing it later animates to it."
4457
+ },
4458
+ {
4459
+ "name": "minZoom",
4460
+ "type": "number",
4461
+ "required": false,
4462
+ "default": 2
4463
+ },
4464
+ {
4465
+ "name": "maxZoom",
4466
+ "type": "number",
4467
+ "required": false,
4468
+ "default": 18
4469
+ },
4470
+ {
4471
+ "name": "onViewChange",
4472
+ "type": "((view: MapView) => void)",
4473
+ "required": false,
4474
+ "description": "Called whenever the user pans or zooms."
4475
+ },
4476
+ {
4477
+ "name": "tileUrl",
4478
+ "type": "string",
4479
+ "required": false,
4480
+ "default": "https://tile.openstreetmap.org/{z}/{x}/{y}.png",
4481
+ "description": "Tile URL template with {z}, {x} and {y}. Defaults to OpenStreetMap."
4482
+ },
4483
+ {
4484
+ "name": "tileUrlDark",
4485
+ "type": "string",
4486
+ "required": false,
4487
+ "description": "Tiles to use in dark mode, from a provider that has a dark style. Without it the same tiles are darkened with `--map-tile-filter` (flat dark land, blue water, roads darker than the land)."
4488
+ },
4489
+ {
4490
+ "name": "theme",
4491
+ "type": "\"auto\" | \"dark\"",
4492
+ "required": false,
4493
+ "values": [
4494
+ "auto",
4495
+ "dark"
4496
+ ],
4497
+ "default": "auto",
4498
+ "description": "\"auto\" follows the surrounding theme (a `.dark` class on <html> or any ancestor)."
4499
+ },
4500
+ {
4501
+ "name": "attribution",
4502
+ "type": "ReactNode",
4503
+ "required": false,
4504
+ "description": "Attribution text required by the tile provider. Pass null to hide it (only if your provider allows)."
4505
+ },
4506
+ {
4507
+ "name": "controls",
4508
+ "type": "boolean",
4509
+ "required": false,
4510
+ "default": true,
4511
+ "description": "Show the zoom controls. Defaults to true."
4512
+ },
4513
+ {
4514
+ "name": "locate",
4515
+ "type": "boolean",
4516
+ "required": false,
4517
+ "default": false,
4518
+ "description": "Show the locate button (uses the browser's geolocation). Defaults to false."
4519
+ },
4520
+ {
4521
+ "name": "onLocate",
4522
+ "type": "((position: LatLng) => void)",
4523
+ "required": false,
4524
+ "description": "Called with the user's position after the locate button finds it."
4525
+ },
4526
+ {
4527
+ "name": "onLocateError",
4528
+ "type": "((error: GeolocationPositionError | Error) => void)",
4529
+ "required": false,
4530
+ "description": "Called when the locate button cannot find the user (permission denied, no signal, no support)."
4531
+ },
4532
+ {
4533
+ "name": "height",
4534
+ "type": "string | number",
4535
+ "required": false,
4536
+ "default": 400,
4537
+ "description": "Height in px or any CSS length. Defaults to 400."
4538
+ },
4539
+ {
4540
+ "name": "aria-label",
4541
+ "type": "string",
4542
+ "required": false,
4543
+ "default": "Map",
4544
+ "description": "Accessible name for the map region. Defaults to \"Map\"."
4545
+ },
4546
+ {
4547
+ "name": "className",
4548
+ "type": "string",
4549
+ "required": false
4550
+ },
4551
+ {
4552
+ "name": "children",
4553
+ "type": "ReactNode",
4554
+ "required": false,
4555
+ "description": "MapMarker and MapPopup elements."
4556
+ }
4557
+ ],
4558
+ "contract": {
4559
+ "requiredProps": [],
4560
+ "requiresAccessibleName": false
4561
+ },
4562
+ "since": "0.11.0",
4563
+ "example": "import { Map } from '@sakaniui/react';\n\n<Map />",
4564
+ "recipes": [
4565
+ {
4566
+ "title": "A live feed: markers that slide to each new position",
4567
+ "description": "Keep the positions in state, update them when the feed (WebSocket, server-sent events, polling) delivers, and give each MapMarker `glide` of about the interval between updates so it slides instead of jumping. A MapPopup that points at a moving marker needs the same `glide`.",
4568
+ "code": "import React from 'react';\nimport { Map, MapMarker, type LatLng } from '@sakaniui/react';\n\nexport const Example = () => {\n const [vehicles, setVehicles] = React.useState<{ id: string; position: LatLng }[]>([{ id: 'v1', position: [51.5, -0.09] }]);\n React.useEffect(() => {\n const socket = new WebSocket('wss://example.com/vehicles');\n socket.onmessage = (e) => setVehicles(JSON.parse(e.data));\n return () => socket.close();\n }, []);\n return (\n <Map center={[51.5, -0.09]} zoom={13} height={420}>\n {vehicles.map((v) => (\n <MapMarker key={v.id} variant=\"dot\" position={v.position} glide={1900} label={v.id} />\n ))}\n </Map>\n );\n};"
4569
+ },
4570
+ {
4571
+ "title": "Thousands of places: cluster them",
4572
+ "description": "Put the places in a MapClusterLayer instead of mapping them to MapMarkers yourself. Nearby places become a counted cluster that zooms in on click, and only what is in view is rendered. Key each marker returned from `renderPoint` by the point id.",
4573
+ "code": "import { Map, MapMarker, MapClusterLayer, type LatLng } from '@sakaniui/react';\n\nconst points: { id: number; position: LatLng }[] = [\n { id: 1, position: [51.5, -0.12] },\n { id: 2, position: [53.48, -2.24] },\n];\n\nexport const Example = () => (\n <Map center={[53, -1.8]} zoom={6} height={420}>\n <MapClusterLayer\n points={points}\n renderPoint={(p) => <MapMarker key={p.id} variant=\"dot\" position={p.position} label={`Place ${p.id}`} />}\n />\n </Map>\n);"
4574
+ }
4575
+ ],
4576
+ "aliases": [
4577
+ "map view",
4578
+ "interactive map",
4579
+ "street map",
4580
+ "location map",
4581
+ "leaflet",
4582
+ "mapbox",
4583
+ "google map",
4584
+ "google maps",
4585
+ "slippy map",
4586
+ "tile map"
4587
+ ]
4588
+ },
4589
+ {
4590
+ "name": "MapClusterLayer",
4591
+ "kind": "component",
4592
+ "category": "Composite",
4593
+ "import": "@sakaniui/react",
4594
+ "summary": "Draws thousands of places on a Map by grouping nearby ones into counted cluster markers (click to zoom in) and rendering only what is in view. `renderPoint` draws each single place.",
4595
+ "props": [
4596
+ {
4597
+ "name": "points",
4598
+ "type": "T[]",
4599
+ "required": true,
4600
+ "shape": {
4601
+ "type": "MapClusterPoint",
4602
+ "collection": "array",
4603
+ "fields": [
4604
+ {
4605
+ "name": "id",
4606
+ "type": "string | number",
4607
+ "required": true
4608
+ },
4609
+ {
4610
+ "name": "position",
4611
+ "type": "LatLng",
4612
+ "required": true
4613
+ }
4614
+ ]
4615
+ }
4616
+ },
4617
+ {
4618
+ "name": "renderPoint",
4619
+ "type": "(point: T) => ReactNode",
4620
+ "required": true,
4621
+ "description": "Draws one place that is not clustered, usually a <MapMarker>. Give it the point's `id` as its key."
4622
+ },
4623
+ {
4624
+ "name": "radius",
4625
+ "type": "number",
4626
+ "required": false,
4627
+ "default": 56,
4628
+ "description": "Grid size in px: larger groups more places together. Defaults to 56."
4629
+ },
4630
+ {
4631
+ "name": "clusterMaxZoom",
4632
+ "type": "number",
4633
+ "required": false,
4634
+ "default": 16,
4635
+ "description": "From this zoom up, nothing clusters. Defaults to 16."
4636
+ },
4637
+ {
4638
+ "name": "onClusterClick",
4639
+ "type": "((points: T[]) => void)",
4640
+ "required": false,
4641
+ "description": "Called after a cluster is clicked, with the places in it. The map zooms to them first."
4642
+ }
4643
+ ],
4644
+ "contract": {
4645
+ "requiredProps": [
4646
+ "points",
4647
+ "renderPoint"
4648
+ ],
4649
+ "requiresAccessibleName": false
4650
+ },
4651
+ "since": "0.11.0",
4652
+ "example": "import { MapClusterLayer } from '@sakaniui/react';\n\n<MapClusterLayer points={[{ id: \"item-1\", position: [1, 1] }]} renderPoint={() => {}} />",
4653
+ "aliases": [
4654
+ "marker clustering",
4655
+ "cluster markers",
4656
+ "supercluster",
4657
+ "many markers",
4658
+ "point clustering",
4659
+ "heatmap markers"
4660
+ ]
4661
+ },
4662
+ {
4663
+ "name": "MapControlButton",
4664
+ "kind": "component",
4665
+ "category": "Composite",
4666
+ "import": "@sakaniui/react",
4667
+ "summary": "A 32px icon button for a map overlay (the zoom and locate buttons Map shows). Needs an icon and an aria-label; has hover and disabled states.",
4668
+ "props": [
4669
+ {
4670
+ "name": "icon",
4671
+ "type": "IconComponent",
4672
+ "required": true,
4673
+ "description": "The icon, drawn at 16px."
4674
+ },
4675
+ {
4676
+ "name": "aria-label",
4677
+ "type": "string",
4678
+ "required": true,
4679
+ "description": "Accessible name; the button has no visible text."
4680
+ },
4681
+ {
4682
+ "name": "disabled",
4683
+ "type": "boolean",
4684
+ "required": false
4685
+ },
4686
+ {
4687
+ "name": "hovered",
4688
+ "type": "boolean",
4689
+ "required": false,
4690
+ "description": "Shows the hover appearance without a pointer (documentation and visual tests)."
4691
+ },
4692
+ {
4693
+ "name": "onClick",
4694
+ "type": "(() => void)",
4695
+ "required": false
4696
+ },
4697
+ {
4698
+ "name": "className",
4699
+ "type": "string",
4700
+ "required": false
4701
+ }
4702
+ ],
4703
+ "contract": {
4704
+ "requiredProps": [
4705
+ "icon",
4706
+ "aria-label"
4707
+ ],
4708
+ "requiresAccessibleName": true
4709
+ },
4710
+ "since": "0.11.0",
4711
+ "example": "import { MapControlButton } from '@sakaniui/react';\nimport { IconStar } from '@sakaniui/react/icons';\n\n<MapControlButton icon={IconStar} aria-label=\"Describe the action\" />",
4712
+ "aliases": [
4713
+ "map button",
4714
+ "zoom button",
4715
+ "map control"
4716
+ ]
4717
+ },
4718
+ {
4719
+ "name": "MapControls",
4720
+ "kind": "component",
4721
+ "category": "Composite",
4722
+ "import": "@sakaniui/react",
4723
+ "summary": "The zoom group and optional locate button a Map shows top-right. Map renders it itself; use it to build a custom overlay.",
4724
+ "props": [
4725
+ {
4726
+ "name": "onZoomIn",
4727
+ "type": "(() => void)",
4728
+ "required": false
4729
+ },
4730
+ {
4731
+ "name": "onZoomOut",
4732
+ "type": "(() => void)",
4733
+ "required": false
4734
+ },
4735
+ {
4736
+ "name": "zoomInDisabled",
4737
+ "type": "boolean",
4738
+ "required": false,
4739
+ "description": "Disables the zoom-in button, e.g. at the map's maximum zoom."
4740
+ },
4741
+ {
4742
+ "name": "zoomOutDisabled",
4743
+ "type": "boolean",
4744
+ "required": false
4745
+ },
4746
+ {
4747
+ "name": "zoom",
4748
+ "type": "boolean",
4749
+ "required": false,
4750
+ "default": true,
4751
+ "description": "Show the zoom group. Defaults to true."
4752
+ },
4753
+ {
4754
+ "name": "locate",
4755
+ "type": "boolean",
4756
+ "required": false,
4757
+ "default": false
4758
+ },
4759
+ {
4760
+ "name": "onLocate",
4761
+ "type": "(() => void)",
4762
+ "required": false
4763
+ },
4764
+ {
4765
+ "name": "className",
4766
+ "type": "string",
4767
+ "required": false
4768
+ }
4769
+ ],
4770
+ "contract": {
4771
+ "requiredProps": [],
4772
+ "requiresAccessibleName": false
4773
+ },
4774
+ "since": "0.11.0",
4775
+ "example": "import { MapControls } from '@sakaniui/react';\n\n<MapControls />",
4776
+ "aliases": [
4777
+ "zoom controls",
4778
+ "map zoom",
4779
+ "zoom in out",
4780
+ "locate button"
4781
+ ]
4782
+ },
4783
+ {
4784
+ "name": "MapGlobe",
4785
+ "kind": "component",
4786
+ "category": "Composite",
4787
+ "import": "@sakaniui/react",
4788
+ "summary": "A 3D dotted globe that spins and can be dragged. `variant` \"land\" dots the continents, \"ocean\" dots the sea; pass `markers` and `arcs` to show places and routes. Follows light and dark.",
4789
+ "props": [
4790
+ {
4791
+ "name": "variant",
4792
+ "type": "\"land\" | \"ocean\"",
4793
+ "required": false,
4794
+ "values": [
4795
+ "land",
4796
+ "ocean"
4797
+ ],
4798
+ "default": "land",
4799
+ "description": "Which part gets the bright dots. Defaults to \"land\"."
4800
+ },
4801
+ {
4802
+ "name": "center",
4803
+ "type": "LatLng",
4804
+ "required": false,
4805
+ "default": "[15, 90]",
4806
+ "description": "The place facing the viewer at first, as [latitude, longitude].",
4807
+ "shape": {
4808
+ "type": "LatLng",
4809
+ "collection": "object",
4810
+ "fields": [
4811
+ {
4812
+ "name": "0",
4813
+ "type": "number",
4814
+ "required": true
4815
+ },
4816
+ {
4817
+ "name": "1",
4818
+ "type": "number",
4819
+ "required": true
4820
+ },
4821
+ {
4822
+ "name": "length",
4823
+ "type": "2",
4824
+ "required": true
4825
+ },
4826
+ {
4827
+ "name": "toString",
4828
+ "type": "() => string",
4829
+ "required": true,
4830
+ "description": "Returns a string representation of an array."
4831
+ },
4832
+ {
4833
+ "name": "toLocaleString",
4834
+ "type": "{ (): string; (locales: string | string[], options?: (NumberFormatOptions & DateTimeFormatOptions) | undefined): string; }",
4835
+ "required": true,
4836
+ "description": "Returns a string representation of an array. The elements are converted to string using their toLocaleString methods."
4837
+ },
4838
+ {
4839
+ "name": "pop",
4840
+ "type": "() => number",
4841
+ "required": true,
4842
+ "description": "Removes the last element from an array and returns it. If the array is empty, undefined is returned and the array is not modified."
4843
+ },
4844
+ {
4845
+ "name": "push",
4846
+ "type": "(...items: number[]) => number",
4847
+ "required": true,
4848
+ "description": "Appends new elements to the end of an array, and returns the new length of the array."
4849
+ },
4850
+ {
4851
+ "name": "concat",
4852
+ "type": "{ (...items: ConcatArray<number>[]): number[]; (...items: (number | ConcatArray<number>)[]): number[]; }",
4853
+ "required": true,
4854
+ "description": "Combines two or more arrays. This method returns a new array without modifying any existing arrays."
4855
+ },
4856
+ {
4857
+ "name": "join",
4858
+ "type": "(separator?: string | undefined) => string",
4859
+ "required": true,
4860
+ "description": "Adds all the elements of an array into a string, separated by the specified separator string."
4861
+ },
4862
+ {
4863
+ "name": "reverse",
4864
+ "type": "() => number[]",
4865
+ "required": true,
4866
+ "description": "Reverses the elements in an array in place. This method mutates the array and returns a reference to the same array."
4867
+ },
4868
+ {
4869
+ "name": "shift",
4870
+ "type": "() => number",
4871
+ "required": true,
4872
+ "description": "Removes the first element from an array and returns it. If the array is empty, undefined is returned and the array is not modified."
4873
+ },
4874
+ {
4875
+ "name": "slice",
4876
+ "type": "(start?: number | undefined, end?: number | undefined) => number[]",
4877
+ "required": true,
4878
+ "description": "Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array."
4879
+ },
4880
+ {
4881
+ "name": "sort",
4882
+ "type": "(compareFn?: ((a: number, b: number) => number) | undefined) => LatLng",
4883
+ "required": true,
4884
+ "description": "Sorts an array in place. This method mutates the array and returns a reference to the same array."
4885
+ },
4886
+ {
4887
+ "name": "splice",
4888
+ "type": "{ (start: number, deleteCount?: number | undefined): number[]; (start: number, deleteCount: number, ...items: number[]): number[]; }",
4889
+ "required": true,
4890
+ "description": "Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements."
4891
+ },
4892
+ {
4893
+ "name": "unshift",
4894
+ "type": "(...items: number[]) => number",
4895
+ "required": true,
4896
+ "description": "Inserts new elements at the start of an array, and returns the new length of the array."
4897
+ },
4898
+ {
4899
+ "name": "indexOf",
4900
+ "type": "(searchElement: number, fromIndex?: number | undefined) => number",
4901
+ "required": true,
4902
+ "description": "Returns the index of the first occurrence of a value in an array, or -1 if it is not present."
4903
+ },
4904
+ {
4905
+ "name": "lastIndexOf",
4906
+ "type": "(searchElement: number, fromIndex?: number | undefined) => number",
4907
+ "required": true,
4908
+ "description": "Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present."
4909
+ },
4910
+ {
4911
+ "name": "every",
4912
+ "type": "{ <S extends number>(predicate: (value: number, index: number, array: number[]) => value is S, thisArg?: any): this is S[]; (predicate: (value: number, index: number, array: number[]) => unknown, thisArg?: any): boolean; }",
4913
+ "required": true,
4914
+ "description": "Determines whether all the members of an array satisfy the specified test."
4915
+ },
4916
+ {
4917
+ "name": "some",
4918
+ "type": "(predicate: (value: number, index: number, array: number[]) => unknown, thisArg?: any) => boolean",
4919
+ "required": true,
4920
+ "description": "Determines whether the specified callback function returns true for any element of an array."
4921
+ },
4922
+ {
4923
+ "name": "forEach",
4924
+ "type": "(callbackfn: (value: number, index: number, array: number[]) => void, thisArg?: any) => void",
4925
+ "required": true,
4926
+ "description": "Performs the specified action for each element in an array."
4927
+ },
4928
+ {
4929
+ "name": "map",
4930
+ "type": "<U>(callbackfn: (value: number, index: number, array: number[]) => U, thisArg?: any) => U[]",
4931
+ "required": true,
4932
+ "description": "Calls a defined callback function on each element of an array, and returns an array that contains the results."
4933
+ },
4934
+ {
4935
+ "name": "filter",
4936
+ "type": "{ <S extends number>(predicate: (value: number, index: number, array: number[]) => value is S, thisArg?: any): S[]; (predicate: (value: number, index: number, array: number[]) => unknown, thisArg?: any): number[]; }",
4937
+ "required": true,
4938
+ "description": "Returns the elements of an array that meet the condition specified in a callback function."
4939
+ },
4940
+ {
4941
+ "name": "reduce",
4942
+ "type": "{ (callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: number[]) => number): number; (callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: number[]) => number, initialValue: number): number; <U>(callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: number[]) => U, initialValue: U): U; }",
4943
+ "required": true,
4944
+ "description": "Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function."
4945
+ },
4946
+ {
4947
+ "name": "reduceRight",
4948
+ "type": "{ (callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: number[]) => number): number; (callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: number[]) => number, initialValue: number): number; <U>(callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: number[]) => U, initialValue: U): U; }",
4949
+ "required": true,
4950
+ "description": "Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function."
4951
+ },
4952
+ {
4953
+ "name": "find",
4954
+ "type": "{ <S extends number>(predicate: (value: number, index: number, obj: number[]) => value is S, thisArg?: any): S | undefined; (predicate: (value: number, index: number, obj: number[]) => unknown, thisArg?: any): number | undefined; }",
4955
+ "required": true,
4956
+ "description": "Returns the value of the first element in the array where predicate is true, and undefined otherwise."
4957
+ },
4958
+ {
4959
+ "name": "findIndex",
4960
+ "type": "(predicate: (value: number, index: number, obj: number[]) => unknown, thisArg?: any) => number",
4961
+ "required": true,
4962
+ "description": "Returns the index of the first element in the array where predicate is true, and -1 otherwise."
4963
+ },
4964
+ {
4965
+ "name": "fill",
4966
+ "type": "(value: number, start?: number | undefined, end?: number | undefined) => LatLng",
4967
+ "required": true,
4968
+ "description": "Changes all array elements from `start` to `end` index to a static `value` and returns the modified array"
4969
+ },
4970
+ {
4971
+ "name": "copyWithin",
4972
+ "type": "(target: number, start: number, end?: number | undefined) => LatLng",
4973
+ "required": true,
4974
+ "description": "Returns the this object after copying a section of the array identified by start and end to the same array starting at position target"
4975
+ },
4976
+ {
4977
+ "name": "entries",
4978
+ "type": "() => ArrayIterator<[number, number]>",
4979
+ "required": true,
4980
+ "description": "Returns an iterable of key, value pairs for every entry in the array"
4981
+ },
4982
+ {
4983
+ "name": "keys",
4984
+ "type": "() => ArrayIterator<number>",
4985
+ "required": true,
4986
+ "description": "Returns an iterable of keys in the array"
4987
+ },
4988
+ {
4989
+ "name": "values",
4990
+ "type": "() => ArrayIterator<number>",
4991
+ "required": true,
4992
+ "description": "Returns an iterable of values in the array"
4993
+ },
4994
+ {
4995
+ "name": "includes",
4996
+ "type": "(searchElement: number, fromIndex?: number | undefined) => boolean",
4997
+ "required": true,
4998
+ "description": "Determines whether an array includes a certain element, returning true or false as appropriate."
4999
+ },
5000
+ {
5001
+ "name": "flatMap",
5002
+ "type": "<U, This = undefined>(callback: (this: This, value: number, index: number, array: number[]) => U | readonly U[], thisArg?: This | undefined) => U[]",
5003
+ "required": true,
5004
+ "description": "Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1."
5005
+ },
5006
+ {
5007
+ "name": "flat",
5008
+ "type": "<A, D extends number = 1>(this: A, depth?: D | undefined) => FlatArray<A, D>[]",
5009
+ "required": true,
5010
+ "description": "Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth."
5011
+ },
5012
+ {
5013
+ "name": "at",
5014
+ "type": "(index: number) => number",
5015
+ "required": true,
5016
+ "description": "Returns the item located at the specified index."
5017
+ },
5018
+ {
5019
+ "name": "__@iterator@15310",
5020
+ "type": "() => ArrayIterator<number>",
5021
+ "required": true,
5022
+ "description": "Iterator"
5023
+ },
5024
+ {
5025
+ "name": "__@unscopables@15340",
5026
+ "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; }",
5027
+ "required": true,
5028
+ "description": "Is an object whose properties have the value 'true' when they will be absent when used in a 'with' statement."
5029
+ }
5030
+ ]
5031
+ }
5032
+ },
5033
+ {
5034
+ "name": "markers",
5035
+ "type": "MapGlobeMarker[]",
5036
+ "required": false,
5037
+ "default": "[]",
5038
+ "shape": {
5039
+ "type": "MapGlobeMarker",
5040
+ "collection": "array",
5041
+ "fields": [
5042
+ {
5043
+ "name": "position",
5044
+ "type": "LatLng",
5045
+ "required": true,
5046
+ "description": "[latitude, longitude]"
5047
+ },
5048
+ {
5049
+ "name": "active",
5050
+ "type": "boolean",
5051
+ "required": false,
5052
+ "description": "Draws a pulsing ring around it."
5053
+ },
5054
+ {
5055
+ "name": "selected",
5056
+ "type": "boolean",
5057
+ "required": false,
5058
+ "description": "The larger halo, for the marker the user picked."
5059
+ },
5060
+ {
5061
+ "name": "hovered",
5062
+ "type": "boolean",
5063
+ "required": false,
5064
+ "description": "Shows the hover appearance without a pointer (documentation and visual tests). Real hover works on its own."
5065
+ },
5066
+ {
5067
+ "name": "label",
5068
+ "type": "string",
5069
+ "required": false,
5070
+ "description": "Name shown in a small card above the marker while it is hovered or selected; also its accessible name."
5071
+ }
5072
+ ]
5073
+ }
5074
+ },
5075
+ {
5076
+ "name": "arcs",
5077
+ "type": "MapGlobeArc[]",
5078
+ "required": false,
5079
+ "default": "[]",
5080
+ "shape": {
5081
+ "type": "MapGlobeArc",
5082
+ "collection": "array",
5083
+ "fields": [
5084
+ {
5085
+ "name": "from",
5086
+ "type": "LatLng",
5087
+ "required": true
5088
+ },
5089
+ {
5090
+ "name": "to",
5091
+ "type": "LatLng",
5092
+ "required": true
5093
+ }
5094
+ ]
5095
+ }
5096
+ },
5097
+ {
5098
+ "name": "autoRotate",
5099
+ "type": "boolean",
5100
+ "required": false,
5101
+ "default": true,
5102
+ "description": "Spin on its own. Defaults to true (off under reduced motion)."
5103
+ },
5104
+ {
5105
+ "name": "rotationSpeed",
5106
+ "type": "number",
5107
+ "required": false,
5108
+ "default": 6,
5109
+ "description": "Degrees per second. Defaults to 6."
5110
+ },
5111
+ {
5112
+ "name": "draggable",
5113
+ "type": "boolean",
5114
+ "required": false,
5115
+ "default": true,
5116
+ "description": "Let people drag to spin it. Defaults to true."
5117
+ },
5118
+ {
5119
+ "name": "atmosphere",
5120
+ "type": "boolean",
5121
+ "required": false,
5122
+ "default": true,
5123
+ "description": "The soft halo past the edge. Defaults to true."
5124
+ },
5125
+ {
5126
+ "name": "dotSpacing",
5127
+ "type": "number",
5128
+ "required": false,
5129
+ "default": 1.3,
5130
+ "description": "Degrees between dots; smaller is denser. Defaults to 1.3."
5131
+ },
5132
+ {
5133
+ "name": "theme",
5134
+ "type": "\"auto\" | \"dark\"",
5135
+ "required": false,
5136
+ "values": [
5137
+ "auto",
5138
+ "dark"
5139
+ ],
5140
+ "default": "auto",
5141
+ "description": "\"auto\" follows the surrounding theme. \"dark\" draws light dots wherever the globe sits, for a globe on a dark surface inside a light page. (The globe has no background of its own; it takes the colour behind it.)"
5142
+ },
5143
+ {
5144
+ "name": "onMarkerClick",
5145
+ "type": "((index: number, marker: MapGlobeMarker) => void)",
5146
+ "required": false,
5147
+ "description": "Called when a marker is clicked or activated from the keyboard (markers with a `label` get a hidden button)."
5148
+ },
5149
+ {
5150
+ "name": "onMarkerHover",
5151
+ "type": "((index: number | null) => void)",
5152
+ "required": false,
5153
+ "description": "Called when the pointer or keyboard focus moves onto a marker, and with null when it leaves."
5154
+ },
5155
+ {
5156
+ "name": "aria-label",
5157
+ "type": "string",
5158
+ "required": false,
5159
+ "default": "Globe",
5160
+ "description": "Accessible description. Defaults to \"Globe\"."
5161
+ },
5162
+ {
5163
+ "name": "className",
5164
+ "type": "string",
5165
+ "required": false
5166
+ }
5167
+ ],
5168
+ "contract": {
5169
+ "requiredProps": [],
5170
+ "requiresAccessibleName": false
5171
+ },
5172
+ "since": "0.11.0",
5173
+ "example": "import { MapGlobe } from '@sakaniui/react';\n\n<MapGlobe />",
5174
+ "aliases": [
5175
+ "globe",
5176
+ "3d globe",
5177
+ "world globe",
5178
+ "earth",
5179
+ "dotted globe",
5180
+ "spinning globe",
5181
+ "world map",
5182
+ "dot globe"
5183
+ ]
5184
+ },
5185
+ {
5186
+ "name": "MapMarker",
5187
+ "kind": "component",
5188
+ "category": "Composite",
5189
+ "import": "@sakaniui/react",
5190
+ "summary": "A place on a Map.",
5191
+ "props": [
5192
+ {
5193
+ "name": "position",
5194
+ "type": "LatLng",
5195
+ "required": true,
5196
+ "description": "[latitude, longitude]",
5197
+ "shape": {
5198
+ "type": "LatLng",
5199
+ "collection": "object",
5200
+ "fields": [
5201
+ {
5202
+ "name": "0",
5203
+ "type": "number",
5204
+ "required": true
5205
+ },
5206
+ {
5207
+ "name": "1",
5208
+ "type": "number",
5209
+ "required": true
5210
+ },
5211
+ {
5212
+ "name": "length",
5213
+ "type": "2",
5214
+ "required": true
5215
+ },
5216
+ {
5217
+ "name": "toString",
5218
+ "type": "() => string",
5219
+ "required": true,
5220
+ "description": "Returns a string representation of an array."
5221
+ },
5222
+ {
5223
+ "name": "toLocaleString",
5224
+ "type": "{ (): string; (locales: string | string[], options?: (NumberFormatOptions & DateTimeFormatOptions) | undefined): string; }",
5225
+ "required": true,
5226
+ "description": "Returns a string representation of an array. The elements are converted to string using their toLocaleString methods."
5227
+ },
5228
+ {
5229
+ "name": "pop",
5230
+ "type": "() => number",
5231
+ "required": true,
5232
+ "description": "Removes the last element from an array and returns it. If the array is empty, undefined is returned and the array is not modified."
5233
+ },
5234
+ {
5235
+ "name": "push",
5236
+ "type": "(...items: number[]) => number",
5237
+ "required": true,
5238
+ "description": "Appends new elements to the end of an array, and returns the new length of the array."
5239
+ },
5240
+ {
5241
+ "name": "concat",
5242
+ "type": "{ (...items: ConcatArray<number>[]): number[]; (...items: (number | ConcatArray<number>)[]): number[]; }",
5243
+ "required": true,
5244
+ "description": "Combines two or more arrays. This method returns a new array without modifying any existing arrays."
5245
+ },
5246
+ {
5247
+ "name": "join",
5248
+ "type": "(separator?: string | undefined) => string",
5249
+ "required": true,
5250
+ "description": "Adds all the elements of an array into a string, separated by the specified separator string."
5251
+ },
5252
+ {
5253
+ "name": "reverse",
5254
+ "type": "() => number[]",
5255
+ "required": true,
5256
+ "description": "Reverses the elements in an array in place. This method mutates the array and returns a reference to the same array."
5257
+ },
5258
+ {
5259
+ "name": "shift",
5260
+ "type": "() => number",
5261
+ "required": true,
5262
+ "description": "Removes the first element from an array and returns it. If the array is empty, undefined is returned and the array is not modified."
5263
+ },
5264
+ {
5265
+ "name": "slice",
5266
+ "type": "(start?: number | undefined, end?: number | undefined) => number[]",
5267
+ "required": true,
5268
+ "description": "Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array."
5269
+ },
5270
+ {
5271
+ "name": "sort",
5272
+ "type": "(compareFn?: ((a: number, b: number) => number) | undefined) => LatLng",
5273
+ "required": true,
5274
+ "description": "Sorts an array in place. This method mutates the array and returns a reference to the same array."
5275
+ },
5276
+ {
5277
+ "name": "splice",
5278
+ "type": "{ (start: number, deleteCount?: number | undefined): number[]; (start: number, deleteCount: number, ...items: number[]): number[]; }",
5279
+ "required": true,
5280
+ "description": "Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements."
5281
+ },
5282
+ {
5283
+ "name": "unshift",
5284
+ "type": "(...items: number[]) => number",
5285
+ "required": true,
5286
+ "description": "Inserts new elements at the start of an array, and returns the new length of the array."
5287
+ },
5288
+ {
5289
+ "name": "indexOf",
5290
+ "type": "(searchElement: number, fromIndex?: number | undefined) => number",
5291
+ "required": true,
5292
+ "description": "Returns the index of the first occurrence of a value in an array, or -1 if it is not present."
5293
+ },
5294
+ {
5295
+ "name": "lastIndexOf",
5296
+ "type": "(searchElement: number, fromIndex?: number | undefined) => number",
5297
+ "required": true,
5298
+ "description": "Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present."
5299
+ },
5300
+ {
5301
+ "name": "every",
5302
+ "type": "{ <S extends number>(predicate: (value: number, index: number, array: number[]) => value is S, thisArg?: any): this is S[]; (predicate: (value: number, index: number, array: number[]) => unknown, thisArg?: any): boolean; }",
5303
+ "required": true,
5304
+ "description": "Determines whether all the members of an array satisfy the specified test."
5305
+ },
5306
+ {
5307
+ "name": "some",
5308
+ "type": "(predicate: (value: number, index: number, array: number[]) => unknown, thisArg?: any) => boolean",
5309
+ "required": true,
5310
+ "description": "Determines whether the specified callback function returns true for any element of an array."
5311
+ },
5312
+ {
5313
+ "name": "forEach",
5314
+ "type": "(callbackfn: (value: number, index: number, array: number[]) => void, thisArg?: any) => void",
5315
+ "required": true,
5316
+ "description": "Performs the specified action for each element in an array."
5317
+ },
5318
+ {
5319
+ "name": "map",
5320
+ "type": "<U>(callbackfn: (value: number, index: number, array: number[]) => U, thisArg?: any) => U[]",
5321
+ "required": true,
5322
+ "description": "Calls a defined callback function on each element of an array, and returns an array that contains the results."
5323
+ },
5324
+ {
5325
+ "name": "filter",
5326
+ "type": "{ <S extends number>(predicate: (value: number, index: number, array: number[]) => value is S, thisArg?: any): S[]; (predicate: (value: number, index: number, array: number[]) => unknown, thisArg?: any): number[]; }",
5327
+ "required": true,
5328
+ "description": "Returns the elements of an array that meet the condition specified in a callback function."
5329
+ },
5330
+ {
5331
+ "name": "reduce",
5332
+ "type": "{ (callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: number[]) => number): number; (callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: number[]) => number, initialValue: number): number; <U>(callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: number[]) => U, initialValue: U): U; }",
5333
+ "required": true,
5334
+ "description": "Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function."
5335
+ },
5336
+ {
5337
+ "name": "reduceRight",
5338
+ "type": "{ (callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: number[]) => number): number; (callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: number[]) => number, initialValue: number): number; <U>(callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: number[]) => U, initialValue: U): U; }",
5339
+ "required": true,
5340
+ "description": "Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function."
5341
+ },
5342
+ {
5343
+ "name": "find",
5344
+ "type": "{ <S extends number>(predicate: (value: number, index: number, obj: number[]) => value is S, thisArg?: any): S | undefined; (predicate: (value: number, index: number, obj: number[]) => unknown, thisArg?: any): number | undefined; }",
5345
+ "required": true,
5346
+ "description": "Returns the value of the first element in the array where predicate is true, and undefined otherwise."
5347
+ },
5348
+ {
5349
+ "name": "findIndex",
5350
+ "type": "(predicate: (value: number, index: number, obj: number[]) => unknown, thisArg?: any) => number",
5351
+ "required": true,
5352
+ "description": "Returns the index of the first element in the array where predicate is true, and -1 otherwise."
5353
+ },
5354
+ {
5355
+ "name": "fill",
5356
+ "type": "(value: number, start?: number | undefined, end?: number | undefined) => LatLng",
5357
+ "required": true,
5358
+ "description": "Changes all array elements from `start` to `end` index to a static `value` and returns the modified array"
5359
+ },
5360
+ {
5361
+ "name": "copyWithin",
5362
+ "type": "(target: number, start: number, end?: number | undefined) => LatLng",
5363
+ "required": true,
5364
+ "description": "Returns the this object after copying a section of the array identified by start and end to the same array starting at position target"
5365
+ },
5366
+ {
5367
+ "name": "entries",
5368
+ "type": "() => ArrayIterator<[number, number]>",
5369
+ "required": true,
5370
+ "description": "Returns an iterable of key, value pairs for every entry in the array"
5371
+ },
5372
+ {
5373
+ "name": "keys",
5374
+ "type": "() => ArrayIterator<number>",
5375
+ "required": true,
5376
+ "description": "Returns an iterable of keys in the array"
5377
+ },
5378
+ {
5379
+ "name": "values",
5380
+ "type": "() => ArrayIterator<number>",
5381
+ "required": true,
5382
+ "description": "Returns an iterable of values in the array"
5383
+ },
5384
+ {
5385
+ "name": "includes",
5386
+ "type": "(searchElement: number, fromIndex?: number | undefined) => boolean",
5387
+ "required": true,
5388
+ "description": "Determines whether an array includes a certain element, returning true or false as appropriate."
5389
+ },
5390
+ {
5391
+ "name": "flatMap",
5392
+ "type": "<U, This = undefined>(callback: (this: This, value: number, index: number, array: number[]) => U | readonly U[], thisArg?: This | undefined) => U[]",
5393
+ "required": true,
5394
+ "description": "Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1."
5395
+ },
5396
+ {
5397
+ "name": "flat",
5398
+ "type": "<A, D extends number = 1>(this: A, depth?: D | undefined) => FlatArray<A, D>[]",
5399
+ "required": true,
5400
+ "description": "Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth."
5401
+ },
5402
+ {
5403
+ "name": "at",
5404
+ "type": "(index: number) => number",
5405
+ "required": true,
5406
+ "description": "Returns the item located at the specified index."
5407
+ },
5408
+ {
5409
+ "name": "__@iterator@15310",
5410
+ "type": "() => ArrayIterator<number>",
5411
+ "required": true,
5412
+ "description": "Iterator"
5413
+ },
5414
+ {
5415
+ "name": "__@unscopables@15340",
5416
+ "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; }",
5417
+ "required": true,
5418
+ "description": "Is an object whose properties have the value 'true' when they will be absent when used in a 'with' statement."
5419
+ }
5420
+ ]
5421
+ }
5422
+ },
5423
+ {
5424
+ "name": "variant",
5425
+ "type": "\"pin\" | \"dot\" | \"cluster\"",
5426
+ "required": false,
5427
+ "values": [
5428
+ "pin",
5429
+ "dot",
5430
+ "cluster"
5431
+ ],
5432
+ "default": "pin"
5433
+ },
5434
+ {
5435
+ "name": "count",
5436
+ "type": "number",
5437
+ "required": false,
5438
+ "description": "Number shown on a cluster."
5439
+ },
5440
+ {
5441
+ "name": "selected",
5442
+ "type": "boolean",
5443
+ "required": false
5444
+ },
5445
+ {
5446
+ "name": "hovered",
5447
+ "type": "boolean",
5448
+ "required": false,
5449
+ "description": "Shows the hover appearance without a pointer (documentation and visual tests). Real hover works on its own."
5450
+ },
5451
+ {
5452
+ "name": "glide",
5453
+ "type": "number",
5454
+ "required": false,
5455
+ "description": "Milliseconds to slide to a new `position` instead of jumping, for markers fed by a live source (about the interval between updates reads as continuous). Off by default; reduced motion turns it off."
5456
+ },
5457
+ {
5458
+ "name": "label",
5459
+ "type": "string",
5460
+ "required": false,
5461
+ "description": "Accessible name, e.g. the place's name."
5462
+ },
5463
+ {
5464
+ "name": "onClick",
5465
+ "type": "((e: MouseEvent<HTMLButtonElement, MouseEvent>) => void)",
5466
+ "required": false
5467
+ },
5468
+ {
5469
+ "name": "className",
5470
+ "type": "string",
5471
+ "required": false
5472
+ }
5473
+ ],
5474
+ "contract": {
5475
+ "requiredProps": [
5476
+ "position"
5477
+ ],
5478
+ "requiresAccessibleName": false
5479
+ },
5480
+ "since": "0.11.0",
5481
+ "example": "import { MapMarker } from '@sakaniui/react';\n\n<MapMarker position={[1, 1]} />",
5482
+ "aliases": [
5483
+ "map pin",
5484
+ "pin",
5485
+ "location pin",
5486
+ "map marker pin",
5487
+ "live marker",
5488
+ "moving marker",
5489
+ "vehicle marker"
5490
+ ]
5491
+ },
5492
+ {
5493
+ "name": "MapPopup",
5494
+ "kind": "component",
5495
+ "category": "Composite",
5496
+ "import": "@sakaniui/react",
5497
+ "summary": "Card that opens above a place on a Map.",
5498
+ "props": [
5499
+ {
5500
+ "name": "position",
5501
+ "type": "LatLng",
5502
+ "required": true,
5503
+ "description": "[latitude, longitude] the pointer points at.",
5504
+ "shape": {
5505
+ "type": "LatLng",
5506
+ "collection": "object",
5507
+ "fields": [
5508
+ {
5509
+ "name": "0",
5510
+ "type": "number",
5511
+ "required": true
5512
+ },
5513
+ {
5514
+ "name": "1",
5515
+ "type": "number",
5516
+ "required": true
5517
+ },
5518
+ {
5519
+ "name": "length",
5520
+ "type": "2",
5521
+ "required": true
5522
+ },
5523
+ {
5524
+ "name": "toString",
5525
+ "type": "() => string",
5526
+ "required": true,
5527
+ "description": "Returns a string representation of an array."
5528
+ },
5529
+ {
5530
+ "name": "toLocaleString",
5531
+ "type": "{ (): string; (locales: string | string[], options?: (NumberFormatOptions & DateTimeFormatOptions) | undefined): string; }",
5532
+ "required": true,
5533
+ "description": "Returns a string representation of an array. The elements are converted to string using their toLocaleString methods."
5534
+ },
5535
+ {
5536
+ "name": "pop",
5537
+ "type": "() => number",
5538
+ "required": true,
5539
+ "description": "Removes the last element from an array and returns it. If the array is empty, undefined is returned and the array is not modified."
5540
+ },
5541
+ {
5542
+ "name": "push",
5543
+ "type": "(...items: number[]) => number",
5544
+ "required": true,
5545
+ "description": "Appends new elements to the end of an array, and returns the new length of the array."
5546
+ },
5547
+ {
5548
+ "name": "concat",
5549
+ "type": "{ (...items: ConcatArray<number>[]): number[]; (...items: (number | ConcatArray<number>)[]): number[]; }",
5550
+ "required": true,
5551
+ "description": "Combines two or more arrays. This method returns a new array without modifying any existing arrays."
5552
+ },
5553
+ {
5554
+ "name": "join",
5555
+ "type": "(separator?: string | undefined) => string",
5556
+ "required": true,
5557
+ "description": "Adds all the elements of an array into a string, separated by the specified separator string."
5558
+ },
5559
+ {
5560
+ "name": "reverse",
5561
+ "type": "() => number[]",
5562
+ "required": true,
5563
+ "description": "Reverses the elements in an array in place. This method mutates the array and returns a reference to the same array."
5564
+ },
5565
+ {
5566
+ "name": "shift",
5567
+ "type": "() => number",
5568
+ "required": true,
5569
+ "description": "Removes the first element from an array and returns it. If the array is empty, undefined is returned and the array is not modified."
5570
+ },
5571
+ {
5572
+ "name": "slice",
5573
+ "type": "(start?: number | undefined, end?: number | undefined) => number[]",
5574
+ "required": true,
5575
+ "description": "Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array."
5576
+ },
5577
+ {
5578
+ "name": "sort",
5579
+ "type": "(compareFn?: ((a: number, b: number) => number) | undefined) => LatLng",
5580
+ "required": true,
5581
+ "description": "Sorts an array in place. This method mutates the array and returns a reference to the same array."
5582
+ },
5583
+ {
5584
+ "name": "splice",
5585
+ "type": "{ (start: number, deleteCount?: number | undefined): number[]; (start: number, deleteCount: number, ...items: number[]): number[]; }",
5586
+ "required": true,
5587
+ "description": "Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements."
5588
+ },
5589
+ {
5590
+ "name": "unshift",
5591
+ "type": "(...items: number[]) => number",
5592
+ "required": true,
5593
+ "description": "Inserts new elements at the start of an array, and returns the new length of the array."
5594
+ },
5595
+ {
5596
+ "name": "indexOf",
5597
+ "type": "(searchElement: number, fromIndex?: number | undefined) => number",
5598
+ "required": true,
5599
+ "description": "Returns the index of the first occurrence of a value in an array, or -1 if it is not present."
5600
+ },
5601
+ {
5602
+ "name": "lastIndexOf",
5603
+ "type": "(searchElement: number, fromIndex?: number | undefined) => number",
5604
+ "required": true,
5605
+ "description": "Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present."
5606
+ },
5607
+ {
5608
+ "name": "every",
5609
+ "type": "{ <S extends number>(predicate: (value: number, index: number, array: number[]) => value is S, thisArg?: any): this is S[]; (predicate: (value: number, index: number, array: number[]) => unknown, thisArg?: any): boolean; }",
5610
+ "required": true,
5611
+ "description": "Determines whether all the members of an array satisfy the specified test."
5612
+ },
5613
+ {
5614
+ "name": "some",
5615
+ "type": "(predicate: (value: number, index: number, array: number[]) => unknown, thisArg?: any) => boolean",
5616
+ "required": true,
5617
+ "description": "Determines whether the specified callback function returns true for any element of an array."
5618
+ },
5619
+ {
5620
+ "name": "forEach",
5621
+ "type": "(callbackfn: (value: number, index: number, array: number[]) => void, thisArg?: any) => void",
5622
+ "required": true,
5623
+ "description": "Performs the specified action for each element in an array."
5624
+ },
5625
+ {
5626
+ "name": "map",
5627
+ "type": "<U>(callbackfn: (value: number, index: number, array: number[]) => U, thisArg?: any) => U[]",
5628
+ "required": true,
5629
+ "description": "Calls a defined callback function on each element of an array, and returns an array that contains the results."
5630
+ },
5631
+ {
5632
+ "name": "filter",
5633
+ "type": "{ <S extends number>(predicate: (value: number, index: number, array: number[]) => value is S, thisArg?: any): S[]; (predicate: (value: number, index: number, array: number[]) => unknown, thisArg?: any): number[]; }",
5634
+ "required": true,
5635
+ "description": "Returns the elements of an array that meet the condition specified in a callback function."
5636
+ },
5637
+ {
5638
+ "name": "reduce",
5639
+ "type": "{ (callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: number[]) => number): number; (callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: number[]) => number, initialValue: number): number; <U>(callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: number[]) => U, initialValue: U): U; }",
5640
+ "required": true,
5641
+ "description": "Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function."
5642
+ },
5643
+ {
5644
+ "name": "reduceRight",
5645
+ "type": "{ (callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: number[]) => number): number; (callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: number[]) => number, initialValue: number): number; <U>(callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: number[]) => U, initialValue: U): U; }",
5646
+ "required": true,
5647
+ "description": "Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function."
5648
+ },
5649
+ {
5650
+ "name": "find",
5651
+ "type": "{ <S extends number>(predicate: (value: number, index: number, obj: number[]) => value is S, thisArg?: any): S | undefined; (predicate: (value: number, index: number, obj: number[]) => unknown, thisArg?: any): number | undefined; }",
5652
+ "required": true,
5653
+ "description": "Returns the value of the first element in the array where predicate is true, and undefined otherwise."
5654
+ },
5655
+ {
5656
+ "name": "findIndex",
5657
+ "type": "(predicate: (value: number, index: number, obj: number[]) => unknown, thisArg?: any) => number",
5658
+ "required": true,
5659
+ "description": "Returns the index of the first element in the array where predicate is true, and -1 otherwise."
5660
+ },
5661
+ {
5662
+ "name": "fill",
5663
+ "type": "(value: number, start?: number | undefined, end?: number | undefined) => LatLng",
5664
+ "required": true,
5665
+ "description": "Changes all array elements from `start` to `end` index to a static `value` and returns the modified array"
5666
+ },
5667
+ {
5668
+ "name": "copyWithin",
5669
+ "type": "(target: number, start: number, end?: number | undefined) => LatLng",
5670
+ "required": true,
5671
+ "description": "Returns the this object after copying a section of the array identified by start and end to the same array starting at position target"
5672
+ },
5673
+ {
5674
+ "name": "entries",
5675
+ "type": "() => ArrayIterator<[number, number]>",
5676
+ "required": true,
5677
+ "description": "Returns an iterable of key, value pairs for every entry in the array"
5678
+ },
5679
+ {
5680
+ "name": "keys",
5681
+ "type": "() => ArrayIterator<number>",
5682
+ "required": true,
5683
+ "description": "Returns an iterable of keys in the array"
5684
+ },
5685
+ {
5686
+ "name": "values",
5687
+ "type": "() => ArrayIterator<number>",
5688
+ "required": true,
5689
+ "description": "Returns an iterable of values in the array"
5690
+ },
5691
+ {
5692
+ "name": "includes",
5693
+ "type": "(searchElement: number, fromIndex?: number | undefined) => boolean",
5694
+ "required": true,
5695
+ "description": "Determines whether an array includes a certain element, returning true or false as appropriate."
5696
+ },
5697
+ {
5698
+ "name": "flatMap",
5699
+ "type": "<U, This = undefined>(callback: (this: This, value: number, index: number, array: number[]) => U | readonly U[], thisArg?: This | undefined) => U[]",
5700
+ "required": true,
5701
+ "description": "Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1."
5702
+ },
5703
+ {
5704
+ "name": "flat",
5705
+ "type": "<A, D extends number = 1>(this: A, depth?: D | undefined) => FlatArray<A, D>[]",
5706
+ "required": true,
5707
+ "description": "Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth."
5708
+ },
5709
+ {
5710
+ "name": "at",
5711
+ "type": "(index: number) => number",
5712
+ "required": true,
5713
+ "description": "Returns the item located at the specified index."
5714
+ },
5715
+ {
5716
+ "name": "__@iterator@15310",
5717
+ "type": "() => ArrayIterator<number>",
5718
+ "required": true,
5719
+ "description": "Iterator"
5720
+ },
5721
+ {
5722
+ "name": "__@unscopables@15340",
5723
+ "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; }",
5724
+ "required": true,
5725
+ "description": "Is an object whose properties have the value 'true' when they will be absent when used in a 'with' statement."
5726
+ }
5727
+ ]
5728
+ }
5729
+ },
3931
5730
  {
3932
5731
  "name": "title",
3933
- "type": "string",
3934
- "required": true
3935
- },
3936
- {
3937
- "name": "description",
3938
- "type": "string",
3939
- "required": false
3940
- },
3941
- {
3942
- "name": "leading",
3943
5732
  "type": "ReactNode",
3944
5733
  "required": false
3945
5734
  },
3946
5735
  {
3947
- "name": "trailing",
5736
+ "name": "description",
3948
5737
  "type": "ReactNode",
3949
5738
  "required": false
3950
5739
  },
3951
5740
  {
3952
- "name": "selected",
3953
- "type": "boolean",
3954
- "required": false
5741
+ "name": "onClose",
5742
+ "type": "(() => void)",
5743
+ "required": false,
5744
+ "description": "Shows a close button when given."
3955
5745
  },
3956
5746
  {
3957
- "name": "disabled",
3958
- "type": "boolean",
3959
- "required": false
5747
+ "name": "offset",
5748
+ "type": "number",
5749
+ "required": false,
5750
+ "default": 48,
5751
+ "description": "Gap between the place and the pointer tip, in px. Defaults to 48 (above a pin); use 14 for a dot."
3960
5752
  },
3961
5753
  {
3962
- "name": "onClick",
3963
- "type": "(() => void)",
3964
- "required": false
5754
+ "name": "pointer",
5755
+ "type": "boolean",
5756
+ "required": false,
5757
+ "default": true
3965
5758
  },
3966
5759
  {
3967
- "name": "className",
3968
- "type": "string",
3969
- "required": false
3970
- }
3971
- ],
3972
- "contract": {
3973
- "requiredProps": [
3974
- "title"
3975
- ],
3976
- "requiresAccessibleName": false
3977
- },
3978
- "since": "0.1.0",
3979
- "example": "import { ListItem } from '@sakaniui/react';\n\n<ListItem title=\"Title\" />"
3980
- },
3981
- {
3982
- "name": "LocationDot",
3983
- "kind": "component",
3984
- "category": "Marketing",
3985
- "import": "@sakaniui/react",
3986
- "summary": "A status dot and location label; `status` \"active\" is green (a real office), \"remote\" is gray.",
3987
- "props": [
3988
- {
3989
- "name": "location",
3990
- "type": "string",
3991
- "required": true
5760
+ "name": "glide",
5761
+ "type": "number",
5762
+ "required": false,
5763
+ "description": "Milliseconds to follow a moving `position`; use the same value as the marker it points at."
3992
5764
  },
3993
5765
  {
3994
- "name": "status",
3995
- "type": "\"active\" | \"remote\"",
5766
+ "name": "children",
5767
+ "type": "ReactNode",
3996
5768
  "required": false,
3997
- "values": [
3998
- "active",
3999
- "remote"
4000
- ],
4001
- "default": "active"
5769
+ "description": "Extra content under the description (actions, a thumbnail...)."
4002
5770
  },
4003
5771
  {
4004
5772
  "name": "className",
@@ -4008,12 +5776,17 @@
4008
5776
  ],
4009
5777
  "contract": {
4010
5778
  "requiredProps": [
4011
- "location"
5779
+ "position"
4012
5780
  ],
4013
5781
  "requiresAccessibleName": false
4014
5782
  },
4015
- "since": "0.3.0",
4016
- "example": "import { LocationDot } from '@sakaniui/react';\n\n<LocationDot location=\"Location\" />"
5783
+ "since": "0.11.0",
5784
+ "example": "import { MapPopup } from '@sakaniui/react';\n\n<MapPopup position={[1, 1]} />",
5785
+ "aliases": [
5786
+ "map tooltip",
5787
+ "info window",
5788
+ "marker popup"
5789
+ ]
4017
5790
  },
4018
5791
  {
4019
5792
  "name": "Marquee",
@@ -6468,6 +8241,123 @@
6468
8241
  "range input"
6469
8242
  ]
6470
8243
  },
8244
+ {
8245
+ "name": "SourceLogo",
8246
+ "kind": "component",
8247
+ "category": "Composite",
8248
+ "import": "@sakaniui/react",
8249
+ "summary": "The real logo of a site an agent searched or read, in its brand colour: `<SourceLogo name=\"reddit\" />`, or `sourceLogo('reddit')` for any `icon` prop (a step's, a SourceStack chip's). Black brands draw in the text colour so they stay visible in dark mode.",
8250
+ "props": [
8251
+ {
8252
+ "name": "name",
8253
+ "type": "\"x\" | \"google\" | \"reddit\" | \"github\" | \"linkedin\" | \"youtube\" | \"hackernews\" | \"wikipedia\" | \"stackoverflow\" | \"producthunt\" | \"medium\" | \"notion\" | \"substack\" | \"arxiv\" | \"bluesky\" | \"perplexity\" | \"duckduckgo\"",
8254
+ "required": true,
8255
+ "values": [
8256
+ "x",
8257
+ "google",
8258
+ "reddit",
8259
+ "github",
8260
+ "linkedin",
8261
+ "youtube",
8262
+ "hackernews",
8263
+ "wikipedia",
8264
+ "stackoverflow",
8265
+ "producthunt",
8266
+ "medium",
8267
+ "notion",
8268
+ "substack",
8269
+ "arxiv",
8270
+ "bluesky",
8271
+ "perplexity",
8272
+ "duckduckgo"
8273
+ ],
8274
+ "description": "Which site: \"google\", \"x\", \"reddit\", \"github\", \"linkedin\", \"youtube\", \"hackernews\", \"wikipedia\", \"stackoverflow\", \"producthunt\", \"medium\", \"notion\", \"substack\", \"arxiv\", \"bluesky\", \"perplexity\" or \"duckduckgo\"."
8275
+ },
8276
+ {
8277
+ "name": "size",
8278
+ "type": "string | number",
8279
+ "required": false,
8280
+ "default": 16,
8281
+ "description": "Rendered size: px, or any CSS length. Default 16."
8282
+ },
8283
+ {
8284
+ "name": "title",
8285
+ "type": "string",
8286
+ "required": false,
8287
+ "description": "Accessible name. Without it the logo is decorative (aria-hidden), which is right next to a text label."
8288
+ }
8289
+ ],
8290
+ "contract": {
8291
+ "requiredProps": [
8292
+ "name"
8293
+ ],
8294
+ "requiresAccessibleName": false
8295
+ },
8296
+ "since": "0.12.0",
8297
+ "example": "import { SourceLogo } from '@sakaniui/react';\n\n<SourceLogo name=\"x\" />",
8298
+ "aliases": [
8299
+ "brand logo",
8300
+ "site logo",
8301
+ "favicon",
8302
+ "website logo",
8303
+ "social logo",
8304
+ "colour logo"
8305
+ ]
8306
+ },
8307
+ {
8308
+ "name": "SourceStack",
8309
+ "kind": "component",
8310
+ "category": "Composite",
8311
+ "import": "@sakaniui/react",
8312
+ "summary": "Overlapping site-icon chips for a step's sources: pass `sources` as { label, icon } (three to five read best).",
8313
+ "props": [
8314
+ {
8315
+ "name": "sources",
8316
+ "type": "SourceStackSource[]",
8317
+ "required": true,
8318
+ "description": "The sources, in order. Three to five read best.",
8319
+ "shape": {
8320
+ "type": "SourceStackSource",
8321
+ "collection": "array",
8322
+ "fields": [
8323
+ {
8324
+ "name": "label",
8325
+ "type": "string",
8326
+ "required": true,
8327
+ "description": "The site's name, e.g. \"Reddit\". Read out and shown as a tooltip."
8328
+ },
8329
+ {
8330
+ "name": "icon",
8331
+ "type": "IconComponent",
8332
+ "required": false,
8333
+ "description": "A brand or generic icon, drawn at 10px. Defaults to a globe."
8334
+ }
8335
+ ]
8336
+ }
8337
+ },
8338
+ {
8339
+ "name": "className",
8340
+ "type": "string",
8341
+ "required": false
8342
+ }
8343
+ ],
8344
+ "contract": {
8345
+ "requiredProps": [
8346
+ "sources"
8347
+ ],
8348
+ "requiresAccessibleName": false
8349
+ },
8350
+ "since": "0.12.0",
8351
+ "example": "import { SourceStack } from '@sakaniui/react';\n\n<SourceStack sources={[{ label: \"Label\" }]} />",
8352
+ "aliases": [
8353
+ "sources",
8354
+ "favicon stack",
8355
+ "source chips",
8356
+ "citations",
8357
+ "citation chips",
8358
+ "site icons"
8359
+ ]
8360
+ },
6471
8361
  {
6472
8362
  "name": "SpendingBalance",
6473
8363
  "kind": "component",
@@ -8129,6 +10019,63 @@
8129
10019
  "since": "0.3.0",
8130
10020
  "example": "import { WishlistButton } from '@sakaniui/react';\n\n<WishlistButton />"
8131
10021
  },
10022
+ {
10023
+ "name": "WorkingIndicator",
10024
+ "kind": "component",
10025
+ "category": "Composite",
10026
+ "import": "@sakaniui/react",
10027
+ "summary": "The live status line under an agent's steps: a sparkle, \"Working\" and the elapsed time (`startedAt` ticks on its own), or a check and \"Worked for 11s\" when done.",
10028
+ "props": [
10029
+ {
10030
+ "name": "status",
10031
+ "type": "\"done\" | \"working\"",
10032
+ "required": false,
10033
+ "values": [
10034
+ "done",
10035
+ "working"
10036
+ ],
10037
+ "default": "done",
10038
+ "description": "\"working\" shows a sparkle and a shimmering label; \"done\" shows a check. Defaults to \"working\"."
10039
+ },
10040
+ {
10041
+ "name": "label",
10042
+ "type": "string",
10043
+ "required": false,
10044
+ "description": "Replaces the default label (\"Working\" / \"Worked for\")."
10045
+ },
10046
+ {
10047
+ "name": "elapsed",
10048
+ "type": "number",
10049
+ "required": false,
10050
+ "description": "Elapsed seconds. Takes precedence over startedAt."
10051
+ },
10052
+ {
10053
+ "name": "startedAt",
10054
+ "type": "number",
10055
+ "required": false,
10056
+ "description": "Epoch ms when the work started; while \"working\" the time ticks on its own."
10057
+ },
10058
+ {
10059
+ "name": "className",
10060
+ "type": "string",
10061
+ "required": false
10062
+ }
10063
+ ],
10064
+ "contract": {
10065
+ "requiredProps": [],
10066
+ "requiresAccessibleName": false
10067
+ },
10068
+ "since": "0.12.0",
10069
+ "example": "import { WorkingIndicator } from '@sakaniui/react';\n\n<WorkingIndicator />",
10070
+ "aliases": [
10071
+ "thinking indicator",
10072
+ "working status",
10073
+ "agent status",
10074
+ "typing status",
10075
+ "elapsed timer",
10076
+ "shimmer label"
10077
+ ]
10078
+ },
8132
10079
  {
8133
10080
  "name": "XIcon",
8134
10081
  "kind": "component",
@@ -11206,6 +13153,16 @@
11206
13153
  "import": "@sakaniui/react",
11207
13154
  "since": "0.3.0"
11208
13155
  },
13156
+ {
13157
+ "name": "sourceLogo",
13158
+ "kind": "helper",
13159
+ "import": "@sakaniui/react"
13160
+ },
13161
+ {
13162
+ "name": "sourceLogoNames",
13163
+ "kind": "helper",
13164
+ "import": "@sakaniui/react"
13165
+ },
11209
13166
  {
11210
13167
  "name": "syncLiquidBackdrop",
11211
13168
  "kind": "helper",
@@ -11229,6 +13186,12 @@
11229
13186
  "kind": "hook",
11230
13187
  "import": "@sakaniui/react",
11231
13188
  "since": "0.4.0"
13189
+ },
13190
+ {
13191
+ "name": "useMapContext",
13192
+ "kind": "hook",
13193
+ "import": "@sakaniui/react",
13194
+ "since": "0.11.0"
11232
13195
  }
11233
13196
  ]
11234
13197
  }