@ionic/docs 8.6.3-dev.11751478001.1cb7436f → 8.6.3-nightly.20250620

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/core.json +72 -138
  2. package/package.json +1 -1
package/core.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
- "timestamp": "2025-07-02T17:41:38",
2
+ "timestamp": "2025-06-20T06:09:47",
3
3
  "compiler": {
4
4
  "name": "@stencil/core",
5
5
  "version": "4.33.1",
@@ -933,7 +933,7 @@
933
933
  {
934
934
  "name": "role",
935
935
  "type": "string | undefined",
936
- "docs": "The role of the element that is dismissing the action sheet.\nThis can be useful in a button handler for determining which button was\nclicked to dismiss the action sheet. Some examples include:\n`\"cancel\"`, `\"destructive\"`, `\"selected\"`, and `\"backdrop\"`."
936
+ "docs": "The role of the element that is dismissing the action sheet.\nThis can be useful in a button handler for determining which button was\nclicked to dismiss the action sheet.\nSome examples include: ``\"cancel\"`, `\"destructive\"`, \"selected\"`, and `\"backdrop\"`.\n\nThis is a no-op if the overlay has not been presented yet. If you want\nto remove an overlay from the DOM that was never presented, use the\n[remove](https://developer.mozilla.org/en-US/docs/Web/API/Element/remove) method."
937
937
  }
938
938
  ],
939
939
  "references": {
@@ -954,10 +954,10 @@
954
954
  {
955
955
  "name": "role",
956
956
  "type": "string | undefined",
957
- "docs": "The role of the element that is dismissing the action sheet.\nThis can be useful in a button handler for determining which button was\nclicked to dismiss the action sheet. Some examples include:\n`\"cancel\"`, `\"destructive\"`, `\"selected\"`, and `\"backdrop\"`."
957
+ "docs": "The role of the element that is dismissing the action sheet.\nThis can be useful in a button handler for determining which button was\nclicked to dismiss the action sheet.\nSome examples include: ``\"cancel\"`, `\"destructive\"`, \"selected\"`, and `\"backdrop\"`.\n\nThis is a no-op if the overlay has not been presented yet. If you want\nto remove an overlay from the DOM that was never presented, use the\n[remove](https://developer.mozilla.org/en-US/docs/Web/API/Element/remove) method."
958
958
  }
959
959
  ],
960
- "docs": "Dismiss the action sheet overlay after it has been presented.\nThis is a no-op if the overlay has not been presented yet. If you want\nto remove an overlay from the DOM that was never presented, use the\n[remove](https://developer.mozilla.org/en-US/docs/Web/API/Element/remove) method.",
960
+ "docs": "Dismiss the action sheet overlay after it has been presented.",
961
961
  "docsTags": [
962
962
  {
963
963
  "name": "param",
@@ -965,7 +965,7 @@
965
965
  },
966
966
  {
967
967
  "name": "param",
968
- "text": "role The role of the element that is dismissing the action sheet.\nThis can be useful in a button handler for determining which button was\nclicked to dismiss the action sheet. Some examples include:\n`\"cancel\"`, `\"destructive\"`, `\"selected\"`, and `\"backdrop\"`."
968
+ "text": "role The role of the element that is dismissing the action sheet.\nThis can be useful in a button handler for determining which button was\nclicked to dismiss the action sheet.\nSome examples include: ``\"cancel\"`, `\"destructive\"`, \"selected\"`, and `\"backdrop\"`.\n\nThis is a no-op if the overlay has not been presented yet. If you want\nto remove an overlay from the DOM that was never presented, use the\n[remove](https://developer.mozilla.org/en-US/docs/Web/API/Element/remove) method."
969
969
  }
970
970
  ]
971
971
  },
@@ -2007,7 +2007,7 @@
2007
2007
  {
2008
2008
  "name": "role",
2009
2009
  "type": "string | undefined",
2010
- "docs": "The role of the element that is dismissing the alert.\nThis can be useful in a button handler for determining which button was\nclicked to dismiss the alert. Some examples include:\n`\"cancel\"`, `\"destructive\"`, `\"selected\"`, and `\"backdrop\"`."
2010
+ "docs": "The role of the element that is dismissing the alert.\nThis can be useful in a button handler for determining which button was\nclicked to dismiss the alert.\nSome examples include: ``\"cancel\"`, `\"destructive\"`, \"selected\"`, and `\"backdrop\"`.\n\nThis is a no-op if the overlay has not been presented yet. If you want\nto remove an overlay from the DOM that was never presented, use the\n[remove](https://developer.mozilla.org/en-US/docs/Web/API/Element/remove) method."
2011
2011
  }
2012
2012
  ],
2013
2013
  "references": {
@@ -2028,10 +2028,10 @@
2028
2028
  {
2029
2029
  "name": "role",
2030
2030
  "type": "string | undefined",
2031
- "docs": "The role of the element that is dismissing the alert.\nThis can be useful in a button handler for determining which button was\nclicked to dismiss the alert. Some examples include:\n`\"cancel\"`, `\"destructive\"`, `\"selected\"`, and `\"backdrop\"`."
2031
+ "docs": "The role of the element that is dismissing the alert.\nThis can be useful in a button handler for determining which button was\nclicked to dismiss the alert.\nSome examples include: ``\"cancel\"`, `\"destructive\"`, \"selected\"`, and `\"backdrop\"`.\n\nThis is a no-op if the overlay has not been presented yet. If you want\nto remove an overlay from the DOM that was never presented, use the\n[remove](https://developer.mozilla.org/en-US/docs/Web/API/Element/remove) method."
2032
2032
  }
2033
2033
  ],
2034
- "docs": "Dismiss the alert overlay after it has been presented.\nThis is a no-op if the overlay has not been presented yet. If you want\nto remove an overlay from the DOM that was never presented, use the\n[remove](https://developer.mozilla.org/en-US/docs/Web/API/Element/remove) method.",
2034
+ "docs": "Dismiss the alert overlay after it has been presented.",
2035
2035
  "docsTags": [
2036
2036
  {
2037
2037
  "name": "param",
@@ -2039,7 +2039,7 @@
2039
2039
  },
2040
2040
  {
2041
2041
  "name": "param",
2042
- "text": "role The role of the element that is dismissing the alert.\nThis can be useful in a button handler for determining which button was\nclicked to dismiss the alert. Some examples include:\n`\"cancel\"`, `\"destructive\"`, `\"selected\"`, and `\"backdrop\"`."
2042
+ "text": "role The role of the element that is dismissing the alert.\nThis can be useful in a button handler for determining which button was\nclicked to dismiss the alert.\nSome examples include: ``\"cancel\"`, `\"destructive\"`, \"selected\"`, and `\"backdrop\"`.\n\nThis is a no-op if the overlay has not been presented yet. If you want\nto remove an overlay from the DOM that was never presented, use the\n[remove](https://developer.mozilla.org/en-US/docs/Web/API/Element/remove) method."
2043
2043
  }
2044
2044
  ]
2045
2045
  },
@@ -2416,7 +2416,7 @@
2416
2416
  {
2417
2417
  "name": "elements",
2418
2418
  "type": "HTMLElement[]",
2419
- "docs": "An array of HTML elements to set focus on."
2419
+ "docs": ""
2420
2420
  }
2421
2421
  ],
2422
2422
  "references": {
@@ -2436,16 +2436,11 @@
2436
2436
  {
2437
2437
  "name": "elements",
2438
2438
  "type": "HTMLElement[]",
2439
- "docs": "An array of HTML elements to set focus on."
2439
+ "docs": ""
2440
2440
  }
2441
2441
  ],
2442
2442
  "docs": "Used to set focus on an element that uses `ion-focusable`.\nDo not use this if focusing the element as a result of a keyboard\nevent as the focus utility should handle this for us. This method\nshould be used when we want to programmatically focus an element as\na result of another user action. (Ex: We focus the first element\ninside of a popover when the user presents it, but the popover is not always\npresented as a result of keyboard action.)",
2443
- "docsTags": [
2444
- {
2445
- "name": "param",
2446
- "text": "elements An array of HTML elements to set focus on."
2447
- }
2448
- ]
2443
+ "docsTags": []
2449
2444
  }
2450
2445
  ],
2451
2446
  "events": [],
@@ -9516,7 +9511,7 @@
9516
9511
  {
9517
9512
  "name": "closeOverlay",
9518
9513
  "type": "boolean",
9519
- "docs": "If `true`, closes the parent overlay. Defaults to `false`."
9514
+ "docs": ""
9520
9515
  }
9521
9516
  ],
9522
9517
  "references": {
@@ -9532,16 +9527,11 @@
9532
9527
  {
9533
9528
  "name": "closeOverlay",
9534
9529
  "type": "boolean",
9535
- "docs": "If `true`, closes the parent overlay. Defaults to `false`."
9530
+ "docs": ""
9536
9531
  }
9537
9532
  ],
9538
9533
  "docs": "Emits the ionCancel event and\noptionally closes the popover\nor modal that the datetime was\npresented in.",
9539
- "docsTags": [
9540
- {
9541
- "name": "param",
9542
- "text": "closeOverlay If `true`, closes the parent overlay. Defaults to `false`."
9543
- }
9544
- ]
9534
+ "docsTags": []
9545
9535
  },
9546
9536
  {
9547
9537
  "name": "confirm",
@@ -9555,7 +9545,7 @@
9555
9545
  {
9556
9546
  "name": "closeOverlay",
9557
9547
  "type": "boolean",
9558
- "docs": "If `true`, closes the parent overlay. Defaults to `false`."
9548
+ "docs": ""
9559
9549
  }
9560
9550
  ],
9561
9551
  "references": {
@@ -9571,16 +9561,11 @@
9571
9561
  {
9572
9562
  "name": "closeOverlay",
9573
9563
  "type": "boolean",
9574
- "docs": "If `true`, closes the parent overlay. Defaults to `false`."
9564
+ "docs": ""
9575
9565
  }
9576
9566
  ],
9577
9567
  "docs": "Confirms the selected datetime value, updates the\n`value` property, and optionally closes the popover\nor modal that the datetime was presented in.",
9578
- "docsTags": [
9579
- {
9580
- "name": "param",
9581
- "text": "closeOverlay If `true`, closes the parent overlay. Defaults to `false`."
9582
- }
9583
- ]
9568
+ "docsTags": []
9584
9569
  },
9585
9570
  {
9586
9571
  "name": "reset",
@@ -9594,7 +9579,7 @@
9594
9579
  {
9595
9580
  "name": "startDate",
9596
9581
  "type": "string | undefined",
9597
- "docs": "A valid [ISO-8601 string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date#date_time_string_format) to reset the datetime state to."
9582
+ "docs": ""
9598
9583
  }
9599
9584
  ],
9600
9585
  "references": {
@@ -9610,16 +9595,11 @@
9610
9595
  {
9611
9596
  "name": "startDate",
9612
9597
  "type": "string | undefined",
9613
- "docs": "A valid [ISO-8601 string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date#date_time_string_format) to reset the datetime state to."
9598
+ "docs": ""
9614
9599
  }
9615
9600
  ],
9616
9601
  "docs": "Resets the internal state of the datetime but does not update the value.\nPassing a valid ISO-8601 string will reset the state of the component to the provided date.\nIf no value is provided, the internal state will be reset to the clamped value of the min, max and today.",
9617
- "docsTags": [
9618
- {
9619
- "name": "param",
9620
- "text": "startDate A valid [ISO-8601 string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date#date_time_string_format) to reset the datetime state to."
9621
- }
9622
- ]
9602
+ "docsTags": []
9623
9603
  }
9624
9604
  ],
9625
9605
  "events": [
@@ -17657,7 +17637,7 @@
17657
17637
  {
17658
17638
  "name": "role",
17659
17639
  "type": "string | undefined",
17660
- "docs": "The role of the element that is dismissing the loading.\nThis can be useful in a button handler for determining which button was\nclicked to dismiss the loading. Some examples include:\n`\"cancel\"`, `\"destructive\"`, `\"selected\"`, and `\"backdrop\"`."
17640
+ "docs": "The role of the element that is dismissing the loading.\nThis can be useful in a button handler for determining which button was\nclicked to dismiss the loading.\nSome examples include: ``\"cancel\"`, `\"destructive\"`, \"selected\"`, and `\"backdrop\"`.\n\nThis is a no-op if the overlay has not been presented yet. If you want\nto remove an overlay from the DOM that was never presented, use the\n[remove](https://developer.mozilla.org/en-US/docs/Web/API/Element/remove) method."
17661
17641
  }
17662
17642
  ],
17663
17643
  "references": {
@@ -17678,10 +17658,10 @@
17678
17658
  {
17679
17659
  "name": "role",
17680
17660
  "type": "string | undefined",
17681
- "docs": "The role of the element that is dismissing the loading.\nThis can be useful in a button handler for determining which button was\nclicked to dismiss the loading. Some examples include:\n`\"cancel\"`, `\"destructive\"`, `\"selected\"`, and `\"backdrop\"`."
17661
+ "docs": "The role of the element that is dismissing the loading.\nThis can be useful in a button handler for determining which button was\nclicked to dismiss the loading.\nSome examples include: ``\"cancel\"`, `\"destructive\"`, \"selected\"`, and `\"backdrop\"`.\n\nThis is a no-op if the overlay has not been presented yet. If you want\nto remove an overlay from the DOM that was never presented, use the\n[remove](https://developer.mozilla.org/en-US/docs/Web/API/Element/remove) method."
17682
17662
  }
17683
17663
  ],
17684
- "docs": "Dismiss the loading overlay after it has been presented.\nThis is a no-op if the overlay has not been presented yet. If you want\nto remove an overlay from the DOM that was never presented, use the\n[remove](https://developer.mozilla.org/en-US/docs/Web/API/Element/remove) method.",
17664
+ "docs": "Dismiss the loading overlay after it has been presented.",
17685
17665
  "docsTags": [
17686
17666
  {
17687
17667
  "name": "param",
@@ -17689,7 +17669,7 @@
17689
17669
  },
17690
17670
  {
17691
17671
  "name": "param",
17692
- "text": "role The role of the element that is dismissing the loading.\nThis can be useful in a button handler for determining which button was\nclicked to dismiss the loading. Some examples include:\n`\"cancel\"`, `\"destructive\"`, `\"selected\"`, and `\"backdrop\"`."
17672
+ "text": "role The role of the element that is dismissing the loading.\nThis can be useful in a button handler for determining which button was\nclicked to dismiss the loading.\nSome examples include: ``\"cancel\"`, `\"destructive\"`, \"selected\"`, and `\"backdrop\"`.\n\nThis is a no-op if the overlay has not been presented yet. If you want\nto remove an overlay from the DOM that was never presented, use the\n[remove](https://developer.mozilla.org/en-US/docs/Web/API/Element/remove) method."
17693
17673
  }
17694
17674
  ]
17695
17675
  },
@@ -18292,12 +18272,12 @@
18292
18272
  {
18293
18273
  "name": "animated",
18294
18274
  "type": "boolean",
18295
- "docs": "If `true`, the menu will animate when closing. If `false`,\nthe menu will close instantly without animation. Defaults to `true`."
18275
+ "docs": ""
18296
18276
  },
18297
18277
  {
18298
18278
  "name": "role",
18299
18279
  "type": "string | undefined",
18300
- "docs": "The role of the element that is closing the menu.\nThis can be useful in a button handler for determining which button was\nclicked to close the menu. Some examples include:\n`\"cancel\"`, `\"destructive\"`, `\"selected\"`, and `\"backdrop\"`."
18280
+ "docs": ""
18301
18281
  }
18302
18282
  ],
18303
18283
  "references": {
@@ -18313,25 +18293,16 @@
18313
18293
  {
18314
18294
  "name": "animated",
18315
18295
  "type": "boolean",
18316
- "docs": "If `true`, the menu will animate when closing. If `false`,\nthe menu will close instantly without animation. Defaults to `true`."
18296
+ "docs": ""
18317
18297
  },
18318
18298
  {
18319
18299
  "name": "role",
18320
18300
  "type": "string | undefined",
18321
- "docs": "The role of the element that is closing the menu.\nThis can be useful in a button handler for determining which button was\nclicked to close the menu. Some examples include:\n`\"cancel\"`, `\"destructive\"`, `\"selected\"`, and `\"backdrop\"`."
18301
+ "docs": ""
18322
18302
  }
18323
18303
  ],
18324
18304
  "docs": "Closes the menu. If the menu is already closed or it can't be closed,\nit returns `false`.",
18325
- "docsTags": [
18326
- {
18327
- "name": "param",
18328
- "text": "animated If `true`, the menu will animate when closing. If `false`,\nthe menu will close instantly without animation. Defaults to `true`."
18329
- },
18330
- {
18331
- "name": "param",
18332
- "text": "role The role of the element that is closing the menu.\nThis can be useful in a button handler for determining which button was\nclicked to close the menu. Some examples include:\n`\"cancel\"`, `\"destructive\"`, `\"selected\"`, and `\"backdrop\"`."
18333
- }
18334
- ]
18305
+ "docsTags": []
18335
18306
  },
18336
18307
  {
18337
18308
  "name": "isActive",
@@ -18352,7 +18323,7 @@
18352
18323
  },
18353
18324
  "signature": "isActive() => Promise<boolean>",
18354
18325
  "parameters": [],
18355
- "docs": "Returns `true` if the menu is active.\n\nA menu is active when it can be opened or closed, meaning it's enabled\nand it's not part of a `ion-split-pane`.",
18326
+ "docs": "Returns `true` is the menu is active.\n\nA menu is active when it can be opened or closed, meaning it's enabled\nand it's not part of a `ion-split-pane`.",
18356
18327
  "docsTags": []
18357
18328
  },
18358
18329
  {
@@ -18389,7 +18360,7 @@
18389
18360
  {
18390
18361
  "name": "animated",
18391
18362
  "type": "boolean",
18392
- "docs": "If `true`, the menu will animate when opening.\nIf `false`, the menu will open instantly without animation.\nDefaults to `true`."
18363
+ "docs": ""
18393
18364
  }
18394
18365
  ],
18395
18366
  "references": {
@@ -18405,16 +18376,11 @@
18405
18376
  {
18406
18377
  "name": "animated",
18407
18378
  "type": "boolean",
18408
- "docs": "If `true`, the menu will animate when opening.\nIf `false`, the menu will open instantly without animation.\nDefaults to `true`."
18379
+ "docs": ""
18409
18380
  }
18410
18381
  ],
18411
18382
  "docs": "Opens the menu. If the menu is already open or it can't be opened,\nit returns `false`.",
18412
- "docsTags": [
18413
- {
18414
- "name": "param",
18415
- "text": "animated If `true`, the menu will animate when opening.\nIf `false`, the menu will open instantly without animation.\nDefaults to `true`."
18416
- }
18417
- ]
18383
+ "docsTags": []
18418
18384
  },
18419
18385
  {
18420
18386
  "name": "setOpen",
@@ -18428,17 +18394,17 @@
18428
18394
  {
18429
18395
  "name": "shouldOpen",
18430
18396
  "type": "boolean",
18431
- "docs": "If `true`, the menu will open. If `false`, the menu\nwill close."
18397
+ "docs": ""
18432
18398
  },
18433
18399
  {
18434
18400
  "name": "animated",
18435
18401
  "type": "boolean",
18436
- "docs": "If `true`, the menu will animate when opening/closing.\nIf `false`, the menu will open/close instantly without animation."
18402
+ "docs": ""
18437
18403
  },
18438
18404
  {
18439
18405
  "name": "role",
18440
18406
  "type": "string | undefined",
18441
- "docs": "The role of the element that is closing the menu."
18407
+ "docs": ""
18442
18408
  }
18443
18409
  ],
18444
18410
  "references": {
@@ -18454,34 +18420,21 @@
18454
18420
  {
18455
18421
  "name": "shouldOpen",
18456
18422
  "type": "boolean",
18457
- "docs": "If `true`, the menu will open. If `false`, the menu\nwill close."
18423
+ "docs": ""
18458
18424
  },
18459
18425
  {
18460
18426
  "name": "animated",
18461
18427
  "type": "boolean",
18462
- "docs": "If `true`, the menu will animate when opening/closing.\nIf `false`, the menu will open/close instantly without animation."
18428
+ "docs": ""
18463
18429
  },
18464
18430
  {
18465
18431
  "name": "role",
18466
18432
  "type": "string | undefined",
18467
- "docs": "The role of the element that is closing the menu."
18433
+ "docs": ""
18468
18434
  }
18469
18435
  ],
18470
- "docs": "Opens or closes the menu.\nIf the operation can't be completed successfully, it returns `false`.",
18471
- "docsTags": [
18472
- {
18473
- "name": "param",
18474
- "text": "shouldOpen If `true`, the menu will open. If `false`, the menu\nwill close."
18475
- },
18476
- {
18477
- "name": "param",
18478
- "text": "animated If `true`, the menu will animate when opening/closing.\nIf `false`, the menu will open/close instantly without animation."
18479
- },
18480
- {
18481
- "name": "param",
18482
- "text": "role The role of the element that is closing the menu."
18483
- }
18484
- ]
18436
+ "docs": "Opens or closes the button.\nIf the operation can't be completed successfully, it returns `false`.",
18437
+ "docsTags": []
18485
18438
  },
18486
18439
  {
18487
18440
  "name": "toggle",
@@ -18495,7 +18448,7 @@
18495
18448
  {
18496
18449
  "name": "animated",
18497
18450
  "type": "boolean",
18498
- "docs": "If `true`, the menu will animate when opening/closing.\nIf `false`, the menu will open/close instantly without animation.\nDefaults to `true`."
18451
+ "docs": ""
18499
18452
  }
18500
18453
  ],
18501
18454
  "references": {
@@ -18511,16 +18464,11 @@
18511
18464
  {
18512
18465
  "name": "animated",
18513
18466
  "type": "boolean",
18514
- "docs": "If `true`, the menu will animate when opening/closing.\nIf `false`, the menu will open/close instantly without animation.\nDefaults to `true`."
18467
+ "docs": ""
18515
18468
  }
18516
18469
  ],
18517
- "docs": "Toggles the menu. If the menu is already open, it will try to close,\notherwise it will try to open it.\nIf the operation can't be completed successfully, it returns `false`.",
18518
- "docsTags": [
18519
- {
18520
- "name": "param",
18521
- "text": "animated If `true`, the menu will animate when opening/closing.\nIf `false`, the menu will open/close instantly without animation.\nDefaults to `true`."
18522
- }
18523
- ]
18470
+ "docs": "Toggles the menu. If the menu is already open, it will try to close, otherwise it will try to open it.\nIf the operation can't be completed successfully, it returns `false`.",
18471
+ "docsTags": []
18524
18472
  }
18525
18473
  ],
18526
18474
  "events": [
@@ -19878,7 +19826,7 @@
19878
19826
  {
19879
19827
  "name": "role",
19880
19828
  "type": "string | undefined",
19881
- "docs": "The role of the element that is dismissing the modal.\nFor example, `cancel` or `backdrop`."
19829
+ "docs": "The role of the element that is dismissing the modal. For example, 'cancel' or 'backdrop'.\n\nThis is a no-op if the overlay has not been presented yet. If you want\nto remove an overlay from the DOM that was never presented, use the\n[remove](https://developer.mozilla.org/en-US/docs/Web/API/Element/remove) method."
19882
19830
  }
19883
19831
  ],
19884
19832
  "references": {
@@ -19903,10 +19851,10 @@
19903
19851
  {
19904
19852
  "name": "role",
19905
19853
  "type": "string | undefined",
19906
- "docs": "The role of the element that is dismissing the modal.\nFor example, `cancel` or `backdrop`."
19854
+ "docs": "The role of the element that is dismissing the modal. For example, 'cancel' or 'backdrop'.\n\nThis is a no-op if the overlay has not been presented yet. If you want\nto remove an overlay from the DOM that was never presented, use the\n[remove](https://developer.mozilla.org/en-US/docs/Web/API/Element/remove) method."
19907
19855
  }
19908
19856
  ],
19909
- "docs": "Dismiss the modal overlay after it has been presented.\nThis is a no-op if the overlay has not been presented yet. If you want\nto remove an overlay from the DOM that was never presented, use the\n[remove](https://developer.mozilla.org/en-US/docs/Web/API/Element/remove) method.",
19857
+ "docs": "Dismiss the modal overlay after it has been presented.",
19910
19858
  "docsTags": [
19911
19859
  {
19912
19860
  "name": "param",
@@ -19914,7 +19862,7 @@
19914
19862
  },
19915
19863
  {
19916
19864
  "name": "param",
19917
- "text": "role The role of the element that is dismissing the modal.\nFor example, `cancel` or `backdrop`."
19865
+ "text": "role The role of the element that is dismissing the modal. For example, 'cancel' or 'backdrop'.\n\nThis is a no-op if the overlay has not been presented yet. If you want\nto remove an overlay from the DOM that was never presented, use the\n[remove](https://developer.mozilla.org/en-US/docs/Web/API/Element/remove) method."
19918
19866
  }
19919
19867
  ]
19920
19868
  },
@@ -20040,7 +19988,7 @@
20040
19988
  {
20041
19989
  "name": "breakpoint",
20042
19990
  "type": "number",
20043
- "docs": "The breakpoint value to move the sheet modal to.\nMust be a value defined in your `breakpoints` array."
19991
+ "docs": ""
20044
19992
  }
20045
19993
  ],
20046
19994
  "references": {
@@ -20056,16 +20004,11 @@
20056
20004
  {
20057
20005
  "name": "breakpoint",
20058
20006
  "type": "number",
20059
- "docs": "The breakpoint value to move the sheet modal to.\nMust be a value defined in your `breakpoints` array."
20007
+ "docs": ""
20060
20008
  }
20061
20009
  ],
20062
- "docs": "Move a sheet style modal to a specific breakpoint.",
20063
- "docsTags": [
20064
- {
20065
- "name": "param",
20066
- "text": "breakpoint The breakpoint value to move the sheet modal to.\nMust be a value defined in your `breakpoints` array."
20067
- }
20068
- ]
20010
+ "docs": "Move a sheet style modal to a specific breakpoint. The breakpoint value must\nbe a value defined in your `breakpoints` array.",
20011
+ "docsTags": []
20069
20012
  }
20070
20013
  ],
20071
20014
  "events": [
@@ -24118,12 +24061,12 @@
24118
24061
  {
24119
24062
  "name": "role",
24120
24063
  "type": "string | undefined",
24121
- "docs": "The role of the element that is dismissing the popover. For example, `cancel` or `backdrop`."
24064
+ "docs": "The role of the element that is dismissing the popover. For example, 'cancel' or 'backdrop'."
24122
24065
  },
24123
24066
  {
24124
24067
  "name": "dismissParentPopover",
24125
24068
  "type": "boolean",
24126
- "docs": "If `true`, dismissing this popover will also dismiss\na parent popover if this popover is nested. Defaults to `true`."
24069
+ "docs": "If `true`, dismissing this popover will also dismiss\na parent popover if this popover is nested. Defaults to `true`.\n\nThis is a no-op if the overlay has not been presented yet. If you want\nto remove an overlay from the DOM that was never presented, use the\n[remove](https://developer.mozilla.org/en-US/docs/Web/API/Element/remove) method."
24127
24070
  }
24128
24071
  ],
24129
24072
  "references": {
@@ -24148,15 +24091,15 @@
24148
24091
  {
24149
24092
  "name": "role",
24150
24093
  "type": "string | undefined",
24151
- "docs": "The role of the element that is dismissing the popover. For example, `cancel` or `backdrop`."
24094
+ "docs": "The role of the element that is dismissing the popover. For example, 'cancel' or 'backdrop'."
24152
24095
  },
24153
24096
  {
24154
24097
  "name": "dismissParentPopover",
24155
24098
  "type": "boolean",
24156
- "docs": "If `true`, dismissing this popover will also dismiss\na parent popover if this popover is nested. Defaults to `true`."
24099
+ "docs": "If `true`, dismissing this popover will also dismiss\na parent popover if this popover is nested. Defaults to `true`.\n\nThis is a no-op if the overlay has not been presented yet. If you want\nto remove an overlay from the DOM that was never presented, use the\n[remove](https://developer.mozilla.org/en-US/docs/Web/API/Element/remove) method."
24157
24100
  }
24158
24101
  ],
24159
- "docs": "Dismiss the popover overlay after it has been presented.\nThis is a no-op if the overlay has not been presented yet. If you want\nto remove an overlay from the DOM that was never presented, use the\n[remove](https://developer.mozilla.org/en-US/docs/Web/API/Element/remove) method.",
24102
+ "docs": "Dismiss the popover overlay after it has been presented.",
24160
24103
  "docsTags": [
24161
24104
  {
24162
24105
  "name": "param",
@@ -24164,11 +24107,11 @@
24164
24107
  },
24165
24108
  {
24166
24109
  "name": "param",
24167
- "text": "role The role of the element that is dismissing the popover. For example, `cancel` or `backdrop`."
24110
+ "text": "role The role of the element that is dismissing the popover. For example, 'cancel' or 'backdrop'."
24168
24111
  },
24169
24112
  {
24170
24113
  "name": "param",
24171
- "text": "dismissParentPopover If `true`, dismissing this popover will also dismiss\na parent popover if this popover is nested. Defaults to `true`."
24114
+ "text": "dismissParentPopover If `true`, dismissing this popover will also dismiss\na parent popover if this popover is nested. Defaults to `true`.\n\nThis is a no-op if the overlay has not been presented yet. If you want\nto remove an overlay from the DOM that was never presented, use the\n[remove](https://developer.mozilla.org/en-US/docs/Web/API/Element/remove) method."
24172
24115
  }
24173
24116
  ]
24174
24117
  },
@@ -24246,7 +24189,7 @@
24246
24189
  {
24247
24190
  "name": "event",
24248
24191
  "type": "MouseEvent | PointerEvent | TouchEvent | CustomEvent<any> | undefined",
24249
- "docs": "The event to position the popover relative to."
24192
+ "docs": ""
24250
24193
  }
24251
24194
  ],
24252
24195
  "references": {
@@ -24282,16 +24225,11 @@
24282
24225
  {
24283
24226
  "name": "event",
24284
24227
  "type": "MouseEvent | PointerEvent | TouchEvent | CustomEvent<any> | undefined",
24285
- "docs": "The event to position the popover relative to."
24228
+ "docs": ""
24286
24229
  }
24287
24230
  ],
24288
24231
  "docs": "Present the popover overlay after it has been created.\nDevelopers can pass a mouse, touch, or pointer event\nto position the popover relative to where that event\nwas dispatched.",
24289
- "docsTags": [
24290
- {
24291
- "name": "param",
24292
- "text": "event The event to position the popover relative to."
24293
- }
24294
- ]
24232
+ "docsTags": []
24295
24233
  }
24296
24234
  ],
24297
24235
  "events": [
@@ -27081,7 +27019,7 @@
27081
27019
  "docs": "A list of items to be sorted and returned in the new order or a\nboolean of whether or not the reorder should reposition the item."
27082
27020
  }
27083
27021
  ],
27084
- "docs": "Completes the reorder operation. Must be called by the `ionItemReorder` event.\nIf a list of items is passed, the list will be reordered and returned in the\nproper order.\n\nIf no parameters are passed or if `true` is passed in, the reorder will complete\nand the item will remain in the position it was dragged to. If `false` is passed,\nthe reorder will complete and the item will bounce back to its original position.",
27022
+ "docs": "Completes the reorder operation. Must be called by the `ionItemReorder` event.\n\nIf a list of items is passed, the list will be reordered and returned in the\nproper order.\n\nIf no parameters are passed or if `true` is passed in, the reorder will complete\nand the item will remain in the position it was dragged to. If `false` is passed,\nthe reorder will complete and the item will bounce back to its original position.",
27085
27023
  "docsTags": [
27086
27024
  {
27087
27025
  "name": "param",
@@ -27669,7 +27607,7 @@
27669
27607
  {
27670
27608
  "name": "animation",
27671
27609
  "type": "AnimationBuilder | undefined",
27672
- "docs": "A custom animation to use for the transition."
27610
+ "docs": ""
27673
27611
  }
27674
27612
  ],
27675
27613
  "references": {
@@ -27705,7 +27643,7 @@
27705
27643
  {
27706
27644
  "name": "animation",
27707
27645
  "type": "AnimationBuilder | undefined",
27708
- "docs": "A custom animation to use for the transition."
27646
+ "docs": ""
27709
27647
  }
27710
27648
  ],
27711
27649
  "docs": "Navigate to the specified path.",
@@ -27717,10 +27655,6 @@
27717
27655
  {
27718
27656
  "name": "param",
27719
27657
  "text": "direction The direction of the animation. Defaults to `\"forward\"`."
27720
- },
27721
- {
27722
- "name": "param",
27723
- "text": "animation A custom animation to use for the transition."
27724
27658
  }
27725
27659
  ]
27726
27660
  }
@@ -29241,7 +29175,7 @@
29241
29175
  },
29242
29176
  "signature": "setFocus() => Promise<void>",
29243
29177
  "parameters": [],
29244
- "docs": "Sets focus on the native `input` in `ion-searchbar`. Use this method instead of the global\n`input.focus()`.\nDevelopers who wish to focus an input when a page enters\nshould call `setFocus()` in the `ionViewDidEnter()` lifecycle method.\nDevelopers who wish to focus an input when an overlay is presented\nshould call `setFocus` after `didPresent` has resolved.\n\nSee [managing focus](/docs/developing/managing-focus) for more information.",
29178
+ "docs": "Sets focus on the native `input` in `ion-searchbar`. Use this method instead of the global\n`input.focus()`.\n\nDevelopers who wish to focus an input when a page enters\nshould call `setFocus()` in the `ionViewDidEnter()` lifecycle method.\n\nDevelopers who wish to focus an input when an overlay is presented\nshould call `setFocus` after `didPresent` has resolved.\n\nSee [managing focus](/docs/developing/managing-focus) for more information.",
29245
29179
  "docsTags": []
29246
29180
  }
29247
29181
  ],
@@ -35652,7 +35586,7 @@
35652
35586
  {
35653
35587
  "name": "role",
35654
35588
  "type": "string | undefined",
35655
- "docs": "The role of the element that is dismissing the toast.\nThis can be useful in a button handler for determining which button was\nclicked to dismiss the toast.\nSome examples include: `\"cancel\"`, `\"destructive\"`, `\"selected\"`, and `\"backdrop\"`."
35589
+ "docs": "The role of the element that is dismissing the toast.\nThis can be useful in a button handler for determining which button was\nclicked to dismiss the toast.\nSome examples include: ``\"cancel\"`, `\"destructive\"`, \"selected\"`, and `\"backdrop\"`.\n\nThis is a no-op if the overlay has not been presented yet. If you want\nto remove an overlay from the DOM that was never presented, use the\n[remove](https://developer.mozilla.org/en-US/docs/Web/API/Element/remove) method."
35656
35590
  }
35657
35591
  ],
35658
35592
  "references": {
@@ -35678,10 +35612,10 @@
35678
35612
  {
35679
35613
  "name": "role",
35680
35614
  "type": "string | undefined",
35681
- "docs": "The role of the element that is dismissing the toast.\nThis can be useful in a button handler for determining which button was\nclicked to dismiss the toast.\nSome examples include: `\"cancel\"`, `\"destructive\"`, `\"selected\"`, and `\"backdrop\"`."
35615
+ "docs": "The role of the element that is dismissing the toast.\nThis can be useful in a button handler for determining which button was\nclicked to dismiss the toast.\nSome examples include: ``\"cancel\"`, `\"destructive\"`, \"selected\"`, and `\"backdrop\"`.\n\nThis is a no-op if the overlay has not been presented yet. If you want\nto remove an overlay from the DOM that was never presented, use the\n[remove](https://developer.mozilla.org/en-US/docs/Web/API/Element/remove) method."
35682
35616
  }
35683
35617
  ],
35684
- "docs": "Dismiss the toast overlay after it has been presented.\nThis is a no-op if the overlay has not been presented yet. If you want\nto remove an overlay from the DOM that was never presented, use the\n[remove](https://developer.mozilla.org/en-US/docs/Web/API/Element/remove) method.",
35618
+ "docs": "Dismiss the toast overlay after it has been presented.",
35685
35619
  "docsTags": [
35686
35620
  {
35687
35621
  "name": "param",
@@ -35689,7 +35623,7 @@
35689
35623
  },
35690
35624
  {
35691
35625
  "name": "param",
35692
- "text": "role The role of the element that is dismissing the toast.\nThis can be useful in a button handler for determining which button was\nclicked to dismiss the toast.\nSome examples include: `\"cancel\"`, `\"destructive\"`, `\"selected\"`, and `\"backdrop\"`."
35626
+ "text": "role The role of the element that is dismissing the toast.\nThis can be useful in a button handler for determining which button was\nclicked to dismiss the toast.\nSome examples include: ``\"cancel\"`, `\"destructive\"`, \"selected\"`, and `\"backdrop\"`.\n\nThis is a no-op if the overlay has not been presented yet. If you want\nto remove an overlay from the DOM that was never presented, use the\n[remove](https://developer.mozilla.org/en-US/docs/Web/API/Element/remove) method."
35693
35627
  }
35694
35628
  ]
35695
35629
  },
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ionic/docs",
3
- "version": "8.6.3-dev.11751478001.1cb7436f",
3
+ "version": "8.6.3-nightly.20250620",
4
4
  "description": "Pre-packaged API documentation for the Ionic docs.",
5
5
  "main": "core.json",
6
6
  "types": "core.d.ts",