@capgo/capacitor-native-navigation 8.0.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (36) hide show
  1. package/CapgoNativeNavigation.podspec +17 -0
  2. package/LICENSE +373 -0
  3. package/Package.swift +28 -0
  4. package/README.md +858 -0
  5. package/android/build.gradle +61 -0
  6. package/android/src/main/AndroidManifest.xml +2 -0
  7. package/android/src/main/java/app/capgo/nativenavigation/NativeNavigation.java +8 -0
  8. package/android/src/main/java/app/capgo/nativenavigation/NativeNavigationPlugin.java +1322 -0
  9. package/android/src/main/res/.gitkeep +0 -0
  10. package/dist/docs.json +1369 -0
  11. package/dist/esm/components.d.ts +1 -0
  12. package/dist/esm/components.js +159 -0
  13. package/dist/esm/components.js.map +1 -0
  14. package/dist/esm/definitions.d.ts +470 -0
  15. package/dist/esm/definitions.js +2 -0
  16. package/dist/esm/definitions.js.map +1 -0
  17. package/dist/esm/index.d.ts +19 -0
  18. package/dist/esm/index.js +40 -0
  19. package/dist/esm/index.js.map +1 -0
  20. package/dist/esm/plugin.d.ts +2 -0
  21. package/dist/esm/plugin.js +2 -0
  22. package/dist/esm/plugin.js.map +1 -0
  23. package/dist/esm/web.d.ts +17 -0
  24. package/dist/esm/web.js +90 -0
  25. package/dist/esm/web.js.map +1 -0
  26. package/dist/plugin.cjs.js +310 -0
  27. package/dist/plugin.cjs.js.map +1 -0
  28. package/dist/plugin.js +313 -0
  29. package/dist/plugin.js.map +1 -0
  30. package/docs/demo-navigation.webp +0 -0
  31. package/docs/demo-options.webp +0 -0
  32. package/docs/demo-svg-icons.webp +0 -0
  33. package/ios/Sources/NativeNavigationPlugin/NativeNavigation.swift +7 -0
  34. package/ios/Sources/NativeNavigationPlugin/NativeNavigationPlugin.swift +1580 -0
  35. package/ios/Tests/NativeNavigationPluginTests/NativeNavigationTests.swift +19 -0
  36. package/package.json +91 -0
package/dist/docs.json ADDED
@@ -0,0 +1,1369 @@
1
+ {
2
+ "api": {
3
+ "name": "NativeNavigationPlugin",
4
+ "slug": "nativenavigationplugin",
5
+ "docs": "Framework-agnostic native navigation chrome API.",
6
+ "tags": [],
7
+ "methods": [
8
+ {
9
+ "name": "configure",
10
+ "signature": "(options?: NativeNavigationConfigureOptions | undefined) => Promise<NativeNavigationInsetsResult>",
11
+ "parameters": [
12
+ {
13
+ "name": "options",
14
+ "docs": "",
15
+ "type": "NativeNavigationConfigureOptions | undefined"
16
+ }
17
+ ],
18
+ "returns": "Promise<NativeNavigationInsetsResult>",
19
+ "tags": [],
20
+ "docs": "Configure the native chrome host and content inset behavior.",
21
+ "complexTypes": [
22
+ "NativeNavigationInsetsResult",
23
+ "NativeNavigationConfigureOptions"
24
+ ],
25
+ "slug": "configure"
26
+ },
27
+ {
28
+ "name": "setNavbar",
29
+ "signature": "(options: NativeNavigationNavbarOptions) => Promise<NativeNavigationInsetsResult>",
30
+ "parameters": [
31
+ {
32
+ "name": "options",
33
+ "docs": "",
34
+ "type": "NativeNavigationNavbarOptions"
35
+ }
36
+ ],
37
+ "returns": "Promise<NativeNavigationInsetsResult>",
38
+ "tags": [],
39
+ "docs": "Render or update the native navbar.",
40
+ "complexTypes": [
41
+ "NativeNavigationInsetsResult",
42
+ "NativeNavigationNavbarOptions"
43
+ ],
44
+ "slug": "setnavbar"
45
+ },
46
+ {
47
+ "name": "setTabbar",
48
+ "signature": "(options: NativeNavigationTabbarOptions) => Promise<NativeNavigationInsetsResult>",
49
+ "parameters": [
50
+ {
51
+ "name": "options",
52
+ "docs": "",
53
+ "type": "NativeNavigationTabbarOptions"
54
+ }
55
+ ],
56
+ "returns": "Promise<NativeNavigationInsetsResult>",
57
+ "tags": [],
58
+ "docs": "Render or update the native tabbar.",
59
+ "complexTypes": [
60
+ "NativeNavigationInsetsResult",
61
+ "NativeNavigationTabbarOptions"
62
+ ],
63
+ "slug": "settabbar"
64
+ },
65
+ {
66
+ "name": "beginTransition",
67
+ "signature": "(options?: NativeNavigationBeginTransitionOptions | undefined) => Promise<NativeNavigationTransitionResult>",
68
+ "parameters": [
69
+ {
70
+ "name": "options",
71
+ "docs": "",
72
+ "type": "NativeNavigationBeginTransitionOptions | undefined"
73
+ }
74
+ ],
75
+ "returns": "Promise<NativeNavigationTransitionResult>",
76
+ "tags": [],
77
+ "docs": "Capture the current WebView and prepare a native transition.",
78
+ "complexTypes": [
79
+ "NativeNavigationTransitionResult",
80
+ "NativeNavigationBeginTransitionOptions"
81
+ ],
82
+ "slug": "begintransition"
83
+ },
84
+ {
85
+ "name": "finishTransition",
86
+ "signature": "(options?: NativeNavigationFinishTransitionOptions | undefined) => Promise<NativeNavigationTransitionResult>",
87
+ "parameters": [
88
+ {
89
+ "name": "options",
90
+ "docs": "",
91
+ "type": "NativeNavigationFinishTransitionOptions | undefined"
92
+ }
93
+ ],
94
+ "returns": "Promise<NativeNavigationTransitionResult>",
95
+ "tags": [],
96
+ "docs": "Animate from the captured WebView snapshot to the current live WebView.",
97
+ "complexTypes": [
98
+ "NativeNavigationTransitionResult",
99
+ "NativeNavigationFinishTransitionOptions"
100
+ ],
101
+ "slug": "finishtransition"
102
+ },
103
+ {
104
+ "name": "getPluginVersion",
105
+ "signature": "() => Promise<PluginVersionResult>",
106
+ "parameters": [],
107
+ "returns": "Promise<PluginVersionResult>",
108
+ "tags": [],
109
+ "docs": "Returns the platform implementation version marker.",
110
+ "complexTypes": [
111
+ "PluginVersionResult"
112
+ ],
113
+ "slug": "getpluginversion"
114
+ },
115
+ {
116
+ "name": "addListener",
117
+ "signature": "(eventName: 'navbarBack', listenerFunc: (event: NativeNavigationBackEvent) => void) => Promise<PluginListenerHandle>",
118
+ "parameters": [
119
+ {
120
+ "name": "eventName",
121
+ "docs": "",
122
+ "type": "'navbarBack'"
123
+ },
124
+ {
125
+ "name": "listenerFunc",
126
+ "docs": "",
127
+ "type": "(event: NativeNavigationBackEvent) => void"
128
+ }
129
+ ],
130
+ "returns": "Promise<PluginListenerHandle>",
131
+ "tags": [],
132
+ "docs": "",
133
+ "complexTypes": [
134
+ "PluginListenerHandle",
135
+ "NativeNavigationBackEvent"
136
+ ],
137
+ "slug": "addlistenernavbarback-"
138
+ },
139
+ {
140
+ "name": "addListener",
141
+ "signature": "(eventName: 'navbarItemTap', listenerFunc: (event: NativeNavigationBarItemTapEvent) => void) => Promise<PluginListenerHandle>",
142
+ "parameters": [
143
+ {
144
+ "name": "eventName",
145
+ "docs": "",
146
+ "type": "'navbarItemTap'"
147
+ },
148
+ {
149
+ "name": "listenerFunc",
150
+ "docs": "",
151
+ "type": "(event: NativeNavigationBarItemTapEvent) => void"
152
+ }
153
+ ],
154
+ "returns": "Promise<PluginListenerHandle>",
155
+ "tags": [],
156
+ "docs": "",
157
+ "complexTypes": [
158
+ "PluginListenerHandle",
159
+ "NativeNavigationBarItemTapEvent"
160
+ ],
161
+ "slug": "addlistenernavbaritemtap-"
162
+ },
163
+ {
164
+ "name": "addListener",
165
+ "signature": "(eventName: 'tabSelect', listenerFunc: (event: NativeNavigationTabSelectEvent) => void) => Promise<PluginListenerHandle>",
166
+ "parameters": [
167
+ {
168
+ "name": "eventName",
169
+ "docs": "",
170
+ "type": "'tabSelect'"
171
+ },
172
+ {
173
+ "name": "listenerFunc",
174
+ "docs": "",
175
+ "type": "(event: NativeNavigationTabSelectEvent) => void"
176
+ }
177
+ ],
178
+ "returns": "Promise<PluginListenerHandle>",
179
+ "tags": [],
180
+ "docs": "",
181
+ "complexTypes": [
182
+ "PluginListenerHandle",
183
+ "NativeNavigationTabSelectEvent"
184
+ ],
185
+ "slug": "addlistenertabselect-"
186
+ },
187
+ {
188
+ "name": "addListener",
189
+ "signature": "(eventName: 'safeAreaChanged', listenerFunc: (event: NativeNavigationSafeAreaChangedEvent) => void) => Promise<PluginListenerHandle>",
190
+ "parameters": [
191
+ {
192
+ "name": "eventName",
193
+ "docs": "",
194
+ "type": "'safeAreaChanged'"
195
+ },
196
+ {
197
+ "name": "listenerFunc",
198
+ "docs": "",
199
+ "type": "(event: NativeNavigationSafeAreaChangedEvent) => void"
200
+ }
201
+ ],
202
+ "returns": "Promise<PluginListenerHandle>",
203
+ "tags": [],
204
+ "docs": "",
205
+ "complexTypes": [
206
+ "PluginListenerHandle",
207
+ "NativeNavigationSafeAreaChangedEvent"
208
+ ],
209
+ "slug": "addlistenersafeareachanged-"
210
+ },
211
+ {
212
+ "name": "addListener",
213
+ "signature": "(eventName: 'transitionStart', listenerFunc: (event: NativeNavigationTransitionEvent) => void) => Promise<PluginListenerHandle>",
214
+ "parameters": [
215
+ {
216
+ "name": "eventName",
217
+ "docs": "",
218
+ "type": "'transitionStart'"
219
+ },
220
+ {
221
+ "name": "listenerFunc",
222
+ "docs": "",
223
+ "type": "(event: NativeNavigationTransitionEvent) => void"
224
+ }
225
+ ],
226
+ "returns": "Promise<PluginListenerHandle>",
227
+ "tags": [],
228
+ "docs": "",
229
+ "complexTypes": [
230
+ "PluginListenerHandle",
231
+ "NativeNavigationTransitionEvent"
232
+ ],
233
+ "slug": "addlistenertransitionstart-"
234
+ },
235
+ {
236
+ "name": "addListener",
237
+ "signature": "(eventName: 'transitionEnd', listenerFunc: (event: NativeNavigationTransitionEvent) => void) => Promise<PluginListenerHandle>",
238
+ "parameters": [
239
+ {
240
+ "name": "eventName",
241
+ "docs": "",
242
+ "type": "'transitionEnd'"
243
+ },
244
+ {
245
+ "name": "listenerFunc",
246
+ "docs": "",
247
+ "type": "(event: NativeNavigationTransitionEvent) => void"
248
+ }
249
+ ],
250
+ "returns": "Promise<PluginListenerHandle>",
251
+ "tags": [],
252
+ "docs": "",
253
+ "complexTypes": [
254
+ "PluginListenerHandle",
255
+ "NativeNavigationTransitionEvent"
256
+ ],
257
+ "slug": "addlistenertransitionend-"
258
+ }
259
+ ],
260
+ "properties": []
261
+ },
262
+ "interfaces": [
263
+ {
264
+ "name": "NativeNavigationInsetsResult",
265
+ "slug": "nativenavigationinsetsresult",
266
+ "docs": "Returned by methods that may change safe content bounds.",
267
+ "tags": [],
268
+ "methods": [],
269
+ "properties": [
270
+ {
271
+ "name": "insets",
272
+ "tags": [],
273
+ "docs": "",
274
+ "complexTypes": [
275
+ "NativeNavigationInsets"
276
+ ],
277
+ "type": "NativeNavigationInsets"
278
+ }
279
+ ]
280
+ },
281
+ {
282
+ "name": "NativeNavigationInsets",
283
+ "slug": "nativenavigationinsets",
284
+ "docs": "Insets exposed to web content.",
285
+ "tags": [],
286
+ "methods": [],
287
+ "properties": [
288
+ {
289
+ "name": "top",
290
+ "tags": [],
291
+ "docs": "",
292
+ "complexTypes": [],
293
+ "type": "number"
294
+ },
295
+ {
296
+ "name": "right",
297
+ "tags": [],
298
+ "docs": "",
299
+ "complexTypes": [],
300
+ "type": "number"
301
+ },
302
+ {
303
+ "name": "bottom",
304
+ "tags": [],
305
+ "docs": "",
306
+ "complexTypes": [],
307
+ "type": "number"
308
+ },
309
+ {
310
+ "name": "left",
311
+ "tags": [],
312
+ "docs": "",
313
+ "complexTypes": [],
314
+ "type": "number"
315
+ },
316
+ {
317
+ "name": "navbarHeight",
318
+ "tags": [],
319
+ "docs": "",
320
+ "complexTypes": [],
321
+ "type": "number"
322
+ },
323
+ {
324
+ "name": "tabbarHeight",
325
+ "tags": [],
326
+ "docs": "",
327
+ "complexTypes": [],
328
+ "type": "number"
329
+ }
330
+ ]
331
+ },
332
+ {
333
+ "name": "NativeNavigationConfigureOptions",
334
+ "slug": "nativenavigationconfigureoptions",
335
+ "docs": "Global plugin configuration.",
336
+ "tags": [],
337
+ "methods": [],
338
+ "properties": [
339
+ {
340
+ "name": "enabled",
341
+ "tags": [],
342
+ "docs": "Enables or disables the native chrome host.",
343
+ "complexTypes": [],
344
+ "type": "boolean | undefined"
345
+ },
346
+ {
347
+ "name": "platformStyle",
348
+ "tags": [],
349
+ "docs": "Native style preference. `auto` uses the current platform.",
350
+ "complexTypes": [
351
+ "NativeNavigationPlatformStyle"
352
+ ],
353
+ "type": "NativeNavigationPlatformStyle"
354
+ },
355
+ {
356
+ "name": "contentInsetMode",
357
+ "tags": [],
358
+ "docs": "When `css`, the plugin writes CSS variables on `document.documentElement`.",
359
+ "complexTypes": [
360
+ "NativeNavigationContentInsetMode"
361
+ ],
362
+ "type": "NativeNavigationContentInsetMode"
363
+ },
364
+ {
365
+ "name": "animationDuration",
366
+ "tags": [],
367
+ "docs": "Default native transition duration in milliseconds.",
368
+ "complexTypes": [],
369
+ "type": "number | undefined"
370
+ },
371
+ {
372
+ "name": "colors",
373
+ "tags": [],
374
+ "docs": "Shared color hints for native bars.",
375
+ "complexTypes": [
376
+ "NativeNavigationColors"
377
+ ],
378
+ "type": "NativeNavigationColors"
379
+ }
380
+ ]
381
+ },
382
+ {
383
+ "name": "NativeNavigationColors",
384
+ "slug": "nativenavigationcolors",
385
+ "docs": "Native bar colors. Use CSS-style hex strings (`#RRGGBB` or `#AARRGGBB`).",
386
+ "tags": [],
387
+ "methods": [],
388
+ "properties": [
389
+ {
390
+ "name": "dynamic",
391
+ "tags": [],
392
+ "docs": "When `true`, Android 12+ derives unspecified bar colors from Material You\nsystem palettes. Explicit color fields still win.",
393
+ "complexTypes": [],
394
+ "type": "boolean | undefined"
395
+ },
396
+ {
397
+ "name": "tint",
398
+ "tags": [],
399
+ "docs": "Tint color for active buttons/items.",
400
+ "complexTypes": [],
401
+ "type": "string | undefined"
402
+ },
403
+ {
404
+ "name": "inactiveTint",
405
+ "tags": [],
406
+ "docs": "Color for inactive tab items.",
407
+ "complexTypes": [],
408
+ "type": "string | undefined"
409
+ },
410
+ {
411
+ "name": "background",
412
+ "tags": [],
413
+ "docs": "Optional background tint. Ignored on iOS 26+ so UIKit can preserve the\nsystem Liquid Glass navigation appearance.",
414
+ "complexTypes": [],
415
+ "type": "string | undefined"
416
+ },
417
+ {
418
+ "name": "foreground",
419
+ "tags": [],
420
+ "docs": "Title and label text color where the native platform supports it.",
421
+ "complexTypes": [],
422
+ "type": "string | undefined"
423
+ },
424
+ {
425
+ "name": "badgeBackground",
426
+ "tags": [],
427
+ "docs": "Badge background color for native tab badges.",
428
+ "complexTypes": [],
429
+ "type": "string | undefined"
430
+ },
431
+ {
432
+ "name": "badgeText",
433
+ "tags": [],
434
+ "docs": "Badge text color for native tab badges.",
435
+ "complexTypes": [],
436
+ "type": "string | undefined"
437
+ },
438
+ {
439
+ "name": "indicator",
440
+ "tags": [],
441
+ "docs": "Active tab indicator color on Android.",
442
+ "complexTypes": [],
443
+ "type": "string | undefined"
444
+ },
445
+ {
446
+ "name": "ripple",
447
+ "tags": [],
448
+ "docs": "Tab press ripple color on Android.",
449
+ "complexTypes": [],
450
+ "type": "string | undefined"
451
+ }
452
+ ]
453
+ },
454
+ {
455
+ "name": "NativeNavigationNavbarOptions",
456
+ "slug": "nativenavigationnavbaroptions",
457
+ "docs": "Native navbar state.",
458
+ "tags": [],
459
+ "methods": [],
460
+ "properties": [
461
+ {
462
+ "name": "hidden",
463
+ "tags": [],
464
+ "docs": "Hide the native navbar.",
465
+ "complexTypes": [],
466
+ "type": "boolean | undefined"
467
+ },
468
+ {
469
+ "name": "title",
470
+ "tags": [],
471
+ "docs": "Main title.",
472
+ "complexTypes": [],
473
+ "type": "string | undefined"
474
+ },
475
+ {
476
+ "name": "subtitle",
477
+ "tags": [],
478
+ "docs": "Secondary title where supported by the platform.",
479
+ "complexTypes": [],
480
+ "type": "string | undefined"
481
+ },
482
+ {
483
+ "name": "large",
484
+ "tags": [],
485
+ "docs": "Prefer a large iOS title style.",
486
+ "complexTypes": [],
487
+ "type": "boolean | undefined"
488
+ },
489
+ {
490
+ "name": "transparent",
491
+ "tags": [],
492
+ "docs": "Prefer transparent/scroll-edge style.",
493
+ "complexTypes": [],
494
+ "type": "boolean | undefined"
495
+ },
496
+ {
497
+ "name": "blurEffect",
498
+ "tags": [],
499
+ "docs": "iOS blur/material effect for the navbar background when glass is not\navailable. Defaults to `systemChromeMaterial` for transparent bars.",
500
+ "complexTypes": [
501
+ "NativeNavigationBlurEffect"
502
+ ],
503
+ "type": "NativeNavigationBlurEffect"
504
+ },
505
+ {
506
+ "name": "backButton",
507
+ "tags": [],
508
+ "docs": "Back button state.",
509
+ "complexTypes": [
510
+ "NativeNavigationBackButton"
511
+ ],
512
+ "type": "NativeNavigationBackButton"
513
+ },
514
+ {
515
+ "name": "leftItems",
516
+ "tags": [],
517
+ "docs": "Left-side action buttons.",
518
+ "complexTypes": [
519
+ "NativeNavigationBarButton"
520
+ ],
521
+ "type": "NativeNavigationBarButton[] | undefined"
522
+ },
523
+ {
524
+ "name": "rightItems",
525
+ "tags": [],
526
+ "docs": "Right-side action buttons.",
527
+ "complexTypes": [
528
+ "NativeNavigationBarButton"
529
+ ],
530
+ "type": "NativeNavigationBarButton[] | undefined"
531
+ },
532
+ {
533
+ "name": "colors",
534
+ "tags": [],
535
+ "docs": "Navbar color hints.",
536
+ "complexTypes": [
537
+ "NativeNavigationColors"
538
+ ],
539
+ "type": "NativeNavigationColors"
540
+ },
541
+ {
542
+ "name": "animated",
543
+ "tags": [],
544
+ "docs": "Animate native navbar changes.",
545
+ "complexTypes": [],
546
+ "type": "boolean | undefined"
547
+ }
548
+ ]
549
+ },
550
+ {
551
+ "name": "NativeNavigationBackButton",
552
+ "slug": "nativenavigationbackbutton",
553
+ "docs": "Native back button configuration.",
554
+ "tags": [],
555
+ "methods": [],
556
+ "properties": [
557
+ {
558
+ "name": "visible",
559
+ "tags": [],
560
+ "docs": "Show the native back affordance.",
561
+ "complexTypes": [],
562
+ "type": "boolean | undefined"
563
+ },
564
+ {
565
+ "name": "title",
566
+ "tags": [],
567
+ "docs": "Optional back title.",
568
+ "complexTypes": [],
569
+ "type": "string | undefined"
570
+ }
571
+ ]
572
+ },
573
+ {
574
+ "name": "NativeNavigationBarButton",
575
+ "slug": "nativenavigationbarbutton",
576
+ "docs": "A button shown in the native navbar.",
577
+ "tags": [],
578
+ "methods": [],
579
+ "properties": [
580
+ {
581
+ "name": "id",
582
+ "tags": [],
583
+ "docs": "Stable id returned in `navbarItemTap`.",
584
+ "complexTypes": [],
585
+ "type": "string"
586
+ },
587
+ {
588
+ "name": "title",
589
+ "tags": [],
590
+ "docs": "Visible text label.",
591
+ "complexTypes": [],
592
+ "type": "string | undefined"
593
+ },
594
+ {
595
+ "name": "icon",
596
+ "tags": [],
597
+ "docs": "Native icon descriptor.",
598
+ "complexTypes": [
599
+ "NativeNavigationIcon"
600
+ ],
601
+ "type": "NativeNavigationIcon"
602
+ },
603
+ {
604
+ "name": "enabled",
605
+ "tags": [],
606
+ "docs": "Whether the action is enabled. Defaults to `true`.",
607
+ "complexTypes": [],
608
+ "type": "boolean | undefined"
609
+ }
610
+ ]
611
+ },
612
+ {
613
+ "name": "NativeNavigationIcon",
614
+ "slug": "nativenavigationicon",
615
+ "docs": "A serializable icon descriptor. Framework nodes are intentionally not accepted\nbecause icons are rendered by native UI.",
616
+ "tags": [],
617
+ "methods": [],
618
+ "properties": [
619
+ {
620
+ "name": "src",
621
+ "tags": [],
622
+ "docs": "Cross-platform asset path or URL fallback.",
623
+ "complexTypes": [],
624
+ "type": "string | undefined"
625
+ },
626
+ {
627
+ "name": "svg",
628
+ "tags": [],
629
+ "docs": "Cross-platform inline SVG markup. The native renderers support common icon\nshapes such as path, line, polyline, polygon, circle, and rect. SVG icons\nare rendered as template images by default so native tint colors still\napply.",
630
+ "complexTypes": [],
631
+ "type": "string | undefined"
632
+ },
633
+ {
634
+ "name": "width",
635
+ "tags": [],
636
+ "docs": "Preferred rendered icon width in native points/dp. Defaults to `24`.",
637
+ "complexTypes": [],
638
+ "type": "number | undefined"
639
+ },
640
+ {
641
+ "name": "height",
642
+ "tags": [],
643
+ "docs": "Preferred rendered icon height in native points/dp. Defaults to `24`.",
644
+ "complexTypes": [],
645
+ "type": "number | undefined"
646
+ },
647
+ {
648
+ "name": "template",
649
+ "tags": [],
650
+ "docs": "When `true`, native tint colors are applied to the rendered SVG/image.\nDefaults to `true`.",
651
+ "complexTypes": [],
652
+ "type": "boolean | undefined"
653
+ },
654
+ {
655
+ "name": "ios",
656
+ "tags": [],
657
+ "docs": "iOS-specific SF Symbol, bundled image name, or inline SVG.",
658
+ "complexTypes": [],
659
+ "type": "{ sfSymbol?: string | undefined; image?: string | undefined; svg?: string | undefined; } | undefined"
660
+ },
661
+ {
662
+ "name": "android",
663
+ "tags": [],
664
+ "docs": "Android-specific drawable resource, asset name, or inline SVG.",
665
+ "complexTypes": [],
666
+ "type": "{ resource?: string | undefined; image?: string | undefined; svg?: string | undefined; } | undefined"
667
+ }
668
+ ]
669
+ },
670
+ {
671
+ "name": "NativeNavigationTabbarOptions",
672
+ "slug": "nativenavigationtabbaroptions",
673
+ "docs": "Native tabbar state.",
674
+ "tags": [],
675
+ "methods": [],
676
+ "properties": [
677
+ {
678
+ "name": "hidden",
679
+ "tags": [],
680
+ "docs": "Hide the native tabbar.",
681
+ "complexTypes": [],
682
+ "type": "boolean | undefined"
683
+ },
684
+ {
685
+ "name": "tabs",
686
+ "tags": [],
687
+ "docs": "Tab definitions.",
688
+ "complexTypes": [
689
+ "NativeNavigationTab"
690
+ ],
691
+ "type": "NativeNavigationTab[] | undefined"
692
+ },
693
+ {
694
+ "name": "selectedId",
695
+ "tags": [],
696
+ "docs": "Currently selected tab id.",
697
+ "complexTypes": [],
698
+ "type": "string | undefined"
699
+ },
700
+ {
701
+ "name": "labels",
702
+ "tags": [],
703
+ "docs": "Show text labels. Defaults to `true`.",
704
+ "complexTypes": [],
705
+ "type": "boolean | undefined"
706
+ },
707
+ {
708
+ "name": "labelVisibilityMode",
709
+ "tags": [],
710
+ "docs": "Native label visibility mode. Overrides `labels` when provided.",
711
+ "complexTypes": [
712
+ "NativeNavigationTabLabelVisibilityMode"
713
+ ],
714
+ "type": "NativeNavigationTabLabelVisibilityMode"
715
+ },
716
+ {
717
+ "name": "icons",
718
+ "tags": [],
719
+ "docs": "Show icons. Defaults to `true`.",
720
+ "complexTypes": [],
721
+ "type": "boolean | undefined"
722
+ },
723
+ {
724
+ "name": "colors",
725
+ "tags": [],
726
+ "docs": "Tabbar color hints.",
727
+ "complexTypes": [
728
+ "NativeNavigationColors"
729
+ ],
730
+ "type": "NativeNavigationColors"
731
+ },
732
+ {
733
+ "name": "blurEffect",
734
+ "tags": [],
735
+ "docs": "iOS blur/material effect for the tabbar background when glass is not\navailable.",
736
+ "complexTypes": [
737
+ "NativeNavigationBlurEffect"
738
+ ],
739
+ "type": "NativeNavigationBlurEffect"
740
+ },
741
+ {
742
+ "name": "disableIndicator",
743
+ "tags": [],
744
+ "docs": "Disable the Android active tab indicator.",
745
+ "complexTypes": [],
746
+ "type": "boolean | undefined"
747
+ },
748
+ {
749
+ "name": "indicatorColor",
750
+ "tags": [],
751
+ "docs": "Active tab indicator color on Android. `colors.indicator` is also\nsupported.",
752
+ "complexTypes": [],
753
+ "type": "string | undefined"
754
+ },
755
+ {
756
+ "name": "rippleColor",
757
+ "tags": [],
758
+ "docs": "Tab press ripple color on Android. `colors.ripple` is also supported.",
759
+ "complexTypes": [],
760
+ "type": "string | undefined"
761
+ },
762
+ {
763
+ "name": "badgeBackgroundColor",
764
+ "tags": [],
765
+ "docs": "Badge background color. `colors.badgeBackground` is also supported.",
766
+ "complexTypes": [],
767
+ "type": "string | undefined"
768
+ },
769
+ {
770
+ "name": "badgeTextColor",
771
+ "tags": [],
772
+ "docs": "Badge text color. `colors.badgeText` is also supported.",
773
+ "complexTypes": [],
774
+ "type": "string | undefined"
775
+ },
776
+ {
777
+ "name": "animated",
778
+ "tags": [],
779
+ "docs": "Animate native tabbar changes.",
780
+ "complexTypes": [],
781
+ "type": "boolean | undefined"
782
+ }
783
+ ]
784
+ },
785
+ {
786
+ "name": "NativeNavigationTab",
787
+ "slug": "nativenavigationtab",
788
+ "docs": "A native tab item.",
789
+ "tags": [],
790
+ "methods": [],
791
+ "properties": [
792
+ {
793
+ "name": "id",
794
+ "tags": [],
795
+ "docs": "Stable tab id returned in `tabSelect`.",
796
+ "complexTypes": [],
797
+ "type": "string"
798
+ },
799
+ {
800
+ "name": "title",
801
+ "tags": [],
802
+ "docs": "Visible tab label.",
803
+ "complexTypes": [],
804
+ "type": "string | undefined"
805
+ },
806
+ {
807
+ "name": "icon",
808
+ "tags": [],
809
+ "docs": "Native icon descriptor.",
810
+ "complexTypes": [
811
+ "NativeNavigationIcon"
812
+ ],
813
+ "type": "NativeNavigationIcon"
814
+ },
815
+ {
816
+ "name": "selectedIcon",
817
+ "tags": [],
818
+ "docs": "Optional selected-state icon.",
819
+ "complexTypes": [
820
+ "NativeNavigationIcon"
821
+ ],
822
+ "type": "NativeNavigationIcon"
823
+ },
824
+ {
825
+ "name": "badge",
826
+ "tags": [],
827
+ "docs": "Optional badge. Numeric badges are supported on both platforms; text badge\nsupport depends on platform capabilities.",
828
+ "complexTypes": [],
829
+ "type": "string | number | undefined"
830
+ },
831
+ {
832
+ "name": "enabled",
833
+ "tags": [],
834
+ "docs": "Whether the tab is enabled. Defaults to `true`.",
835
+ "complexTypes": [],
836
+ "type": "boolean | undefined"
837
+ }
838
+ ]
839
+ },
840
+ {
841
+ "name": "NativeNavigationTransitionResult",
842
+ "slug": "nativenavigationtransitionresult",
843
+ "docs": "Native transition result.",
844
+ "tags": [],
845
+ "methods": [],
846
+ "properties": [
847
+ {
848
+ "name": "id",
849
+ "tags": [],
850
+ "docs": "",
851
+ "complexTypes": [],
852
+ "type": "string"
853
+ },
854
+ {
855
+ "name": "direction",
856
+ "tags": [],
857
+ "docs": "",
858
+ "complexTypes": [
859
+ "NativeNavigationTransitionDirection"
860
+ ],
861
+ "type": "NativeNavigationTransitionDirection"
862
+ },
863
+ {
864
+ "name": "duration",
865
+ "tags": [],
866
+ "docs": "",
867
+ "complexTypes": [],
868
+ "type": "number"
869
+ }
870
+ ]
871
+ },
872
+ {
873
+ "name": "NativeNavigationBeginTransitionOptions",
874
+ "slug": "nativenavigationbegintransitionoptions",
875
+ "docs": "Begin a native transition transaction before JS changes route content.",
876
+ "tags": [],
877
+ "methods": [],
878
+ "properties": [
879
+ {
880
+ "name": "id",
881
+ "tags": [],
882
+ "docs": "",
883
+ "complexTypes": [],
884
+ "type": "string | undefined"
885
+ },
886
+ {
887
+ "name": "direction",
888
+ "tags": [],
889
+ "docs": "",
890
+ "complexTypes": [
891
+ "NativeNavigationTransitionDirection"
892
+ ],
893
+ "type": "NativeNavigationTransitionDirection"
894
+ },
895
+ {
896
+ "name": "duration",
897
+ "tags": [],
898
+ "docs": "",
899
+ "complexTypes": [],
900
+ "type": "number | undefined"
901
+ },
902
+ {
903
+ "name": "sourceRect",
904
+ "tags": [],
905
+ "docs": "Source rectangle for `zoom` transitions. Use viewport coordinates such as\nthose returned by `Element.getBoundingClientRect()`.",
906
+ "complexTypes": [
907
+ "NativeNavigationRect"
908
+ ],
909
+ "type": "NativeNavigationRect"
910
+ },
911
+ {
912
+ "name": "targetRect",
913
+ "tags": [],
914
+ "docs": "Destination rectangle for shared-element-style `zoom` transitions.",
915
+ "complexTypes": [
916
+ "NativeNavigationRect"
917
+ ],
918
+ "type": "NativeNavigationRect"
919
+ },
920
+ {
921
+ "name": "cornerRadius",
922
+ "tags": [],
923
+ "docs": "Corner radius used while animating a `zoom` transition.",
924
+ "complexTypes": [],
925
+ "type": "number | undefined"
926
+ }
927
+ ]
928
+ },
929
+ {
930
+ "name": "NativeNavigationRect",
931
+ "slug": "nativenavigationrect",
932
+ "docs": "A rectangle in WebView viewport coordinates, expressed in native points/dp.",
933
+ "tags": [],
934
+ "methods": [],
935
+ "properties": [
936
+ {
937
+ "name": "x",
938
+ "tags": [],
939
+ "docs": "",
940
+ "complexTypes": [],
941
+ "type": "number"
942
+ },
943
+ {
944
+ "name": "y",
945
+ "tags": [],
946
+ "docs": "",
947
+ "complexTypes": [],
948
+ "type": "number"
949
+ },
950
+ {
951
+ "name": "width",
952
+ "tags": [],
953
+ "docs": "",
954
+ "complexTypes": [],
955
+ "type": "number"
956
+ },
957
+ {
958
+ "name": "height",
959
+ "tags": [],
960
+ "docs": "",
961
+ "complexTypes": [],
962
+ "type": "number"
963
+ }
964
+ ]
965
+ },
966
+ {
967
+ "name": "NativeNavigationFinishTransitionOptions",
968
+ "slug": "nativenavigationfinishtransitionoptions",
969
+ "docs": "Finish a native transition transaction after JS has changed route content.",
970
+ "tags": [],
971
+ "methods": [],
972
+ "properties": [
973
+ {
974
+ "name": "id",
975
+ "tags": [],
976
+ "docs": "",
977
+ "complexTypes": [],
978
+ "type": "string | undefined"
979
+ },
980
+ {
981
+ "name": "direction",
982
+ "tags": [],
983
+ "docs": "",
984
+ "complexTypes": [
985
+ "NativeNavigationTransitionDirection"
986
+ ],
987
+ "type": "NativeNavigationTransitionDirection"
988
+ },
989
+ {
990
+ "name": "duration",
991
+ "tags": [],
992
+ "docs": "",
993
+ "complexTypes": [],
994
+ "type": "number | undefined"
995
+ },
996
+ {
997
+ "name": "sourceRect",
998
+ "tags": [],
999
+ "docs": "Source rectangle for `zoom` transitions when no active source was recorded.",
1000
+ "complexTypes": [
1001
+ "NativeNavigationRect"
1002
+ ],
1003
+ "type": "NativeNavigationRect"
1004
+ },
1005
+ {
1006
+ "name": "targetRect",
1007
+ "tags": [],
1008
+ "docs": "Destination rectangle for shared-element-style `zoom` transitions.",
1009
+ "complexTypes": [
1010
+ "NativeNavigationRect"
1011
+ ],
1012
+ "type": "NativeNavigationRect"
1013
+ },
1014
+ {
1015
+ "name": "cornerRadius",
1016
+ "tags": [],
1017
+ "docs": "Corner radius used while animating a `zoom` transition.",
1018
+ "complexTypes": [],
1019
+ "type": "number | undefined"
1020
+ }
1021
+ ]
1022
+ },
1023
+ {
1024
+ "name": "PluginVersionResult",
1025
+ "slug": "pluginversionresult",
1026
+ "docs": "Plugin version payload.",
1027
+ "tags": [],
1028
+ "methods": [],
1029
+ "properties": [
1030
+ {
1031
+ "name": "version",
1032
+ "tags": [],
1033
+ "docs": "Version identifier returned by the platform implementation.",
1034
+ "complexTypes": [],
1035
+ "type": "string"
1036
+ }
1037
+ ]
1038
+ },
1039
+ {
1040
+ "name": "PluginListenerHandle",
1041
+ "slug": "pluginlistenerhandle",
1042
+ "docs": "",
1043
+ "tags": [],
1044
+ "methods": [],
1045
+ "properties": [
1046
+ {
1047
+ "name": "remove",
1048
+ "tags": [],
1049
+ "docs": "",
1050
+ "complexTypes": [],
1051
+ "type": "() => Promise<void>"
1052
+ }
1053
+ ]
1054
+ },
1055
+ {
1056
+ "name": "NativeNavigationBackEvent",
1057
+ "slug": "nativenavigationbackevent",
1058
+ "docs": "",
1059
+ "tags": [],
1060
+ "methods": [],
1061
+ "properties": [
1062
+ {
1063
+ "name": "source",
1064
+ "tags": [],
1065
+ "docs": "",
1066
+ "complexTypes": [],
1067
+ "type": "'navbar'"
1068
+ }
1069
+ ]
1070
+ },
1071
+ {
1072
+ "name": "NativeNavigationBarItemTapEvent",
1073
+ "slug": "nativenavigationbaritemtapevent",
1074
+ "docs": "",
1075
+ "tags": [],
1076
+ "methods": [],
1077
+ "properties": [
1078
+ {
1079
+ "name": "id",
1080
+ "tags": [],
1081
+ "docs": "",
1082
+ "complexTypes": [],
1083
+ "type": "string"
1084
+ },
1085
+ {
1086
+ "name": "title",
1087
+ "tags": [],
1088
+ "docs": "",
1089
+ "complexTypes": [],
1090
+ "type": "string | undefined"
1091
+ },
1092
+ {
1093
+ "name": "placement",
1094
+ "tags": [],
1095
+ "docs": "",
1096
+ "complexTypes": [],
1097
+ "type": "'left' | 'right'"
1098
+ }
1099
+ ]
1100
+ },
1101
+ {
1102
+ "name": "NativeNavigationTabSelectEvent",
1103
+ "slug": "nativenavigationtabselectevent",
1104
+ "docs": "",
1105
+ "tags": [],
1106
+ "methods": [],
1107
+ "properties": [
1108
+ {
1109
+ "name": "id",
1110
+ "tags": [],
1111
+ "docs": "",
1112
+ "complexTypes": [],
1113
+ "type": "string"
1114
+ },
1115
+ {
1116
+ "name": "index",
1117
+ "tags": [],
1118
+ "docs": "",
1119
+ "complexTypes": [],
1120
+ "type": "number"
1121
+ },
1122
+ {
1123
+ "name": "title",
1124
+ "tags": [],
1125
+ "docs": "",
1126
+ "complexTypes": [],
1127
+ "type": "string | undefined"
1128
+ }
1129
+ ]
1130
+ },
1131
+ {
1132
+ "name": "NativeNavigationSafeAreaChangedEvent",
1133
+ "slug": "nativenavigationsafeareachangedevent",
1134
+ "docs": "",
1135
+ "tags": [],
1136
+ "methods": [],
1137
+ "properties": [
1138
+ {
1139
+ "name": "insets",
1140
+ "tags": [],
1141
+ "docs": "",
1142
+ "complexTypes": [
1143
+ "NativeNavigationInsets"
1144
+ ],
1145
+ "type": "NativeNavigationInsets"
1146
+ }
1147
+ ]
1148
+ },
1149
+ {
1150
+ "name": "NativeNavigationTransitionEvent",
1151
+ "slug": "nativenavigationtransitionevent",
1152
+ "docs": "",
1153
+ "tags": [],
1154
+ "methods": [],
1155
+ "properties": [
1156
+ {
1157
+ "name": "id",
1158
+ "tags": [],
1159
+ "docs": "",
1160
+ "complexTypes": [],
1161
+ "type": "string"
1162
+ },
1163
+ {
1164
+ "name": "direction",
1165
+ "tags": [],
1166
+ "docs": "",
1167
+ "complexTypes": [
1168
+ "NativeNavigationTransitionDirection"
1169
+ ],
1170
+ "type": "NativeNavigationTransitionDirection"
1171
+ },
1172
+ {
1173
+ "name": "duration",
1174
+ "tags": [],
1175
+ "docs": "",
1176
+ "complexTypes": [],
1177
+ "type": "number"
1178
+ }
1179
+ ]
1180
+ }
1181
+ ],
1182
+ "enums": [],
1183
+ "typeAliases": [
1184
+ {
1185
+ "name": "NativeNavigationPlatformStyle",
1186
+ "slug": "nativenavigationplatformstyle",
1187
+ "docs": "Platform rendering preference for the native bars.",
1188
+ "types": [
1189
+ {
1190
+ "text": "'auto'",
1191
+ "complexTypes": []
1192
+ },
1193
+ {
1194
+ "text": "'ios'",
1195
+ "complexTypes": []
1196
+ },
1197
+ {
1198
+ "text": "'android'",
1199
+ "complexTypes": []
1200
+ }
1201
+ ]
1202
+ },
1203
+ {
1204
+ "name": "NativeNavigationContentInsetMode",
1205
+ "slug": "nativenavigationcontentinsetmode",
1206
+ "docs": "How the plugin exposes native bar sizes to web content.",
1207
+ "types": [
1208
+ {
1209
+ "text": "'css'",
1210
+ "complexTypes": []
1211
+ },
1212
+ {
1213
+ "text": "'none'",
1214
+ "complexTypes": []
1215
+ }
1216
+ ]
1217
+ },
1218
+ {
1219
+ "name": "NativeNavigationBlurEffect",
1220
+ "slug": "nativenavigationblureffect",
1221
+ "docs": "Native material/blur effect preference.",
1222
+ "types": [
1223
+ {
1224
+ "text": "'none'",
1225
+ "complexTypes": []
1226
+ },
1227
+ {
1228
+ "text": "'systemDefault'",
1229
+ "complexTypes": []
1230
+ },
1231
+ {
1232
+ "text": "'extraLight'",
1233
+ "complexTypes": []
1234
+ },
1235
+ {
1236
+ "text": "'light'",
1237
+ "complexTypes": []
1238
+ },
1239
+ {
1240
+ "text": "'dark'",
1241
+ "complexTypes": []
1242
+ },
1243
+ {
1244
+ "text": "'regular'",
1245
+ "complexTypes": []
1246
+ },
1247
+ {
1248
+ "text": "'prominent'",
1249
+ "complexTypes": []
1250
+ },
1251
+ {
1252
+ "text": "'systemUltraThinMaterial'",
1253
+ "complexTypes": []
1254
+ },
1255
+ {
1256
+ "text": "'systemThinMaterial'",
1257
+ "complexTypes": []
1258
+ },
1259
+ {
1260
+ "text": "'systemMaterial'",
1261
+ "complexTypes": []
1262
+ },
1263
+ {
1264
+ "text": "'systemThickMaterial'",
1265
+ "complexTypes": []
1266
+ },
1267
+ {
1268
+ "text": "'systemChromeMaterial'",
1269
+ "complexTypes": []
1270
+ },
1271
+ {
1272
+ "text": "'systemUltraThinMaterialLight'",
1273
+ "complexTypes": []
1274
+ },
1275
+ {
1276
+ "text": "'systemThinMaterialLight'",
1277
+ "complexTypes": []
1278
+ },
1279
+ {
1280
+ "text": "'systemMaterialLight'",
1281
+ "complexTypes": []
1282
+ },
1283
+ {
1284
+ "text": "'systemThickMaterialLight'",
1285
+ "complexTypes": []
1286
+ },
1287
+ {
1288
+ "text": "'systemChromeMaterialLight'",
1289
+ "complexTypes": []
1290
+ },
1291
+ {
1292
+ "text": "'systemUltraThinMaterialDark'",
1293
+ "complexTypes": []
1294
+ },
1295
+ {
1296
+ "text": "'systemThinMaterialDark'",
1297
+ "complexTypes": []
1298
+ },
1299
+ {
1300
+ "text": "'systemMaterialDark'",
1301
+ "complexTypes": []
1302
+ },
1303
+ {
1304
+ "text": "'systemThickMaterialDark'",
1305
+ "complexTypes": []
1306
+ },
1307
+ {
1308
+ "text": "'systemChromeMaterialDark'",
1309
+ "complexTypes": []
1310
+ }
1311
+ ]
1312
+ },
1313
+ {
1314
+ "name": "NativeNavigationTabLabelVisibilityMode",
1315
+ "slug": "nativenavigationtablabelvisibilitymode",
1316
+ "docs": "Native tab label visibility behavior.",
1317
+ "types": [
1318
+ {
1319
+ "text": "'auto'",
1320
+ "complexTypes": []
1321
+ },
1322
+ {
1323
+ "text": "'selected'",
1324
+ "complexTypes": []
1325
+ },
1326
+ {
1327
+ "text": "'labeled'",
1328
+ "complexTypes": []
1329
+ },
1330
+ {
1331
+ "text": "'unlabeled'",
1332
+ "complexTypes": []
1333
+ }
1334
+ ]
1335
+ },
1336
+ {
1337
+ "name": "NativeNavigationTransitionDirection",
1338
+ "slug": "nativenavigationtransitiondirection",
1339
+ "docs": "Navigation animation direction.",
1340
+ "types": [
1341
+ {
1342
+ "text": "'forward'",
1343
+ "complexTypes": []
1344
+ },
1345
+ {
1346
+ "text": "'back'",
1347
+ "complexTypes": []
1348
+ },
1349
+ {
1350
+ "text": "'root'",
1351
+ "complexTypes": []
1352
+ },
1353
+ {
1354
+ "text": "'tab'",
1355
+ "complexTypes": []
1356
+ },
1357
+ {
1358
+ "text": "'zoom'",
1359
+ "complexTypes": []
1360
+ },
1361
+ {
1362
+ "text": "'none'",
1363
+ "complexTypes": []
1364
+ }
1365
+ ]
1366
+ }
1367
+ ],
1368
+ "pluginConfigs": []
1369
+ }