@ionic/docs 8.0.0-beta.1 → 8.0.0-beta.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/core.json +158 -189
  2. package/package.json +1 -1
package/core.json CHANGED
@@ -1,8 +1,8 @@
1
1
  {
2
- "timestamp": "2024-03-06T21:21:47",
2
+ "timestamp": "2024-03-13T14:34:12",
3
3
  "compiler": {
4
4
  "name": "@stencil/core",
5
- "version": "4.12.4",
5
+ "version": "4.12.5",
6
6
  "typescriptVersion": "5.3.3"
7
7
  },
8
8
  "components": [
@@ -7067,6 +7067,44 @@
7067
7067
  "optional": false,
7068
7068
  "required": false
7069
7069
  },
7070
+ {
7071
+ "name": "formatOptions",
7072
+ "type": "undefined | { date: DateTimeFormatOptions; time?: DateTimeFormatOptions | undefined; } | { date?: DateTimeFormatOptions | undefined; time: DateTimeFormatOptions; }",
7073
+ "complexType": {
7074
+ "original": "FormatOptions",
7075
+ "resolved": "undefined | { date: DateTimeFormatOptions; time?: DateTimeFormatOptions | undefined; } | { date?: DateTimeFormatOptions | undefined; time: DateTimeFormatOptions; }",
7076
+ "references": {
7077
+ "FormatOptions": {
7078
+ "location": "import",
7079
+ "path": "./datetime-interface",
7080
+ "id": "src/components/datetime/datetime-interface.ts::FormatOptions"
7081
+ }
7082
+ }
7083
+ },
7084
+ "mutable": false,
7085
+ "reflectToAttr": false,
7086
+ "docs": "Formatting options for dates and times.\nShould include a 'date' and/or 'time' object, each of which is of type [Intl.DateTimeFormatOptions](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/DateTimeFormat#options).",
7087
+ "docsTags": [],
7088
+ "values": [
7089
+ {
7090
+ "type": "undefined"
7091
+ },
7092
+ {
7093
+ "type": "{ date: DateTimeFormatOptions; time?: DateTimeFormatOptions"
7094
+ },
7095
+ {
7096
+ "type": "undefined; }"
7097
+ },
7098
+ {
7099
+ "type": "{ date?: DateTimeFormatOptions"
7100
+ },
7101
+ {
7102
+ "type": "undefined; time: DateTimeFormatOptions; }"
7103
+ }
7104
+ ],
7105
+ "optional": true,
7106
+ "required": false
7107
+ },
7070
7108
  {
7071
7109
  "name": "highlightedDates",
7072
7110
  "type": "((dateIsoString: string) => DatetimeHighlightStyle | undefined) | DatetimeHighlight[] | undefined",
@@ -11068,6 +11106,11 @@
11068
11106
  "annotation": "prop",
11069
11107
  "docs": "The color of the highlight on the input when valid"
11070
11108
  },
11109
+ {
11110
+ "name": "--highlight-height",
11111
+ "annotation": "prop",
11112
+ "docs": "The height of the highlight on the input. Only applies to md mode."
11113
+ },
11071
11114
  {
11072
11115
  "name": "--padding-bottom",
11073
11116
  "annotation": "prop",
@@ -11156,14 +11199,6 @@
11156
11199
  "name": "slot",
11157
11200
  "text": "end - Content is placed to the right of the item text in LTR, and to the left in RTL."
11158
11201
  },
11159
- {
11160
- "name": "slot",
11161
- "text": "helper - Content is placed under the item and displayed when no error is detected. **DEPRECATED** Use the \"helperText\" property on ion-input or ion-textarea instead."
11162
- },
11163
- {
11164
- "name": "slot",
11165
- "text": "error - Content is placed under the item and displayed when an error is detected. **DEPRECATED** Use the \"errorText\" property on ion-input or ion-textarea instead."
11166
- },
11167
11202
  {
11168
11203
  "name": "part",
11169
11204
  "text": "native - The native HTML button, anchor or div element that wraps all child elements."
@@ -11263,69 +11298,6 @@
11263
11298
  "optional": true,
11264
11299
  "required": false
11265
11300
  },
11266
- {
11267
- "name": "counter",
11268
- "type": "boolean",
11269
- "complexType": {
11270
- "original": "boolean",
11271
- "resolved": "boolean",
11272
- "references": {}
11273
- },
11274
- "mutable": false,
11275
- "attr": "counter",
11276
- "reflectToAttr": false,
11277
- "docs": "If `true`, a character counter will display the ratio of characters used and the total character limit. Only applies when the `maxlength` property is set on the inner `ion-input` or `ion-textarea`.",
11278
- "docsTags": [
11279
- {
11280
- "name": "deprecated",
11281
- "text": "Use the `counter` property on `ion-input` or `ion-textarea` instead."
11282
- }
11283
- ],
11284
- "default": "false",
11285
- "deprecation": "Use the `counter` property on `ion-input` or `ion-textarea` instead.",
11286
- "values": [
11287
- {
11288
- "type": "boolean"
11289
- }
11290
- ],
11291
- "optional": false,
11292
- "required": false
11293
- },
11294
- {
11295
- "name": "counterFormatter",
11296
- "type": "((inputLength: number, maxLength: number) => string) | undefined",
11297
- "complexType": {
11298
- "original": "CounterFormatter",
11299
- "resolved": "((inputLength: number, maxLength: number) => string) | undefined",
11300
- "references": {
11301
- "CounterFormatter": {
11302
- "location": "import",
11303
- "path": "./item-interface",
11304
- "id": "src/components/item/item-interface.ts::CounterFormatter"
11305
- }
11306
- }
11307
- },
11308
- "mutable": false,
11309
- "reflectToAttr": false,
11310
- "docs": "A callback used to format the counter text.\nBy default the counter text is set to \"itemLength / maxLength\".",
11311
- "docsTags": [
11312
- {
11313
- "name": "deprecated",
11314
- "text": "Use the `counterFormatter` property on `ion-input` or `ion-textarea` instead."
11315
- }
11316
- ],
11317
- "deprecation": "Use the `counterFormatter` property on `ion-input` or `ion-textarea` instead.",
11318
- "values": [
11319
- {
11320
- "type": "((inputLength: number, maxLength: number) => string)"
11321
- },
11322
- {
11323
- "type": "undefined"
11324
- }
11325
- ],
11326
- "optional": true,
11327
- "required": false
11328
- },
11329
11301
  {
11330
11302
  "name": "detail",
11331
11303
  "type": "boolean | undefined",
@@ -11418,41 +11390,6 @@
11418
11390
  "optional": false,
11419
11391
  "required": false
11420
11392
  },
11421
- {
11422
- "name": "fill",
11423
- "type": "\"outline\" | \"solid\" | undefined",
11424
- "complexType": {
11425
- "original": "'outline' | 'solid'",
11426
- "resolved": "\"outline\" | \"solid\" | undefined",
11427
- "references": {}
11428
- },
11429
- "mutable": false,
11430
- "attr": "fill",
11431
- "reflectToAttr": false,
11432
- "docs": "The fill for the item. If `\"solid\"` the item will have a background. If\n`\"outline\"` the item will be transparent with a border. Only available in `md` mode.",
11433
- "docsTags": [
11434
- {
11435
- "name": "deprecated",
11436
- "text": "Use the `fill` property on `ion-input` or `ion-textarea` instead."
11437
- }
11438
- ],
11439
- "deprecation": "Use the `fill` property on `ion-input` or `ion-textarea` instead.",
11440
- "values": [
11441
- {
11442
- "value": "outline",
11443
- "type": "string"
11444
- },
11445
- {
11446
- "value": "solid",
11447
- "type": "string"
11448
- },
11449
- {
11450
- "type": "undefined"
11451
- }
11452
- ],
11453
- "optional": true,
11454
- "required": false
11455
- },
11456
11393
  {
11457
11394
  "name": "href",
11458
11395
  "type": "string | undefined",
@@ -11621,31 +11558,6 @@
11621
11558
  "optional": false,
11622
11559
  "required": false
11623
11560
  },
11624
- {
11625
- "name": "shape",
11626
- "type": "\"round\" | undefined",
11627
- "complexType": {
11628
- "original": "'round'",
11629
- "resolved": "\"round\" | undefined",
11630
- "references": {}
11631
- },
11632
- "mutable": false,
11633
- "attr": "shape",
11634
- "reflectToAttr": false,
11635
- "docs": "The shape of the item. If \"round\" it will have increased\nborder radius.",
11636
- "docsTags": [],
11637
- "values": [
11638
- {
11639
- "value": "round",
11640
- "type": "string"
11641
- },
11642
- {
11643
- "type": "undefined"
11644
- }
11645
- ],
11646
- "optional": true,
11647
- "required": false
11648
- },
11649
11561
  {
11650
11562
  "name": "target",
11651
11563
  "type": "string | undefined",
@@ -11705,11 +11617,6 @@
11705
11617
  "methods": [],
11706
11618
  "events": [],
11707
11619
  "listeners": [
11708
- {
11709
- "event": "ionInput",
11710
- "capture": false,
11711
- "passive": false
11712
- },
11713
11620
  {
11714
11621
  "event": "ionColor",
11715
11622
  "capture": false,
@@ -11812,26 +11719,6 @@
11812
11719
  "annotation": "prop",
11813
11720
  "docs": "Opacity of the item detail icon"
11814
11721
  },
11815
- {
11816
- "name": "--highlight-color-focused",
11817
- "annotation": "prop",
11818
- "docs": "The color of the highlight on the item when focused. Only applies to inputs and textareas using the legacy form syntax. DEPRECATED: Highlights can be styled on `ion-input` or `ion-textarea` when using the modern form syntax."
11819
- },
11820
- {
11821
- "name": "--highlight-color-invalid",
11822
- "annotation": "prop",
11823
- "docs": "The color of the highlight on the item when invalid. Only applies to inputs and textareas using the legacy form syntax. DEPRECATED: Highlights can be styled on `ion-input` or `ion-textarea` when using the modern form syntax."
11824
- },
11825
- {
11826
- "name": "--highlight-color-valid",
11827
- "annotation": "prop",
11828
- "docs": "The color of the highlight on the item when valid. Only applies to inputs and textareas using the legacy form syntax. DEPRECATED: Highlights can be styled on `ion-input` or `ion-textarea` when using the modern form syntax."
11829
- },
11830
- {
11831
- "name": "--highlight-height",
11832
- "annotation": "prop",
11833
- "docs": "The height of the highlight on the item. Only applies to inputs and textareas using the legacy form syntax. DEPRECATED: Highlights can be styled on `ion-input` or `ion-textarea` when using the modern form syntax."
11834
- },
11835
11722
  {
11836
11723
  "name": "--inner-border-width",
11837
11724
  "annotation": "prop",
@@ -11907,14 +11794,6 @@
11907
11794
  "name": "end",
11908
11795
  "docs": "Content is placed to the right of the item text in LTR, and to the left in RTL."
11909
11796
  },
11910
- {
11911
- "name": "error",
11912
- "docs": "Content is placed under the item and displayed when an error is detected. **DEPRECATED** Use the \"errorText\" property on ion-input or ion-textarea instead."
11913
- },
11914
- {
11915
- "name": "helper",
11916
- "docs": "Content is placed under the item and displayed when no error is detected. **DEPRECATED** Use the \"helperText\" property on ion-input or ion-textarea instead."
11917
- },
11918
11797
  {
11919
11798
  "name": "start",
11920
11799
  "docs": "Content is placed to the left of the item text in LTR, and to the right in RTL."
@@ -11935,14 +11814,12 @@
11935
11814
  ],
11936
11815
  "dependencies": [
11937
11816
  "ion-icon",
11938
- "ion-ripple-effect",
11939
- "ion-note"
11817
+ "ion-ripple-effect"
11940
11818
  ],
11941
11819
  "dependencyGraph": {
11942
11820
  "ion-item": [
11943
11821
  "ion-icon",
11944
- "ion-ripple-effect",
11945
- "ion-note"
11822
+ "ion-ripple-effect"
11946
11823
  ],
11947
11824
  "ion-select-popover": [
11948
11825
  "ion-item"
@@ -14180,11 +14057,17 @@
14180
14057
  },
14181
14058
  {
14182
14059
  "name": "type",
14183
- "type": "string | undefined",
14060
+ "type": "\"overlay\" | \"push\" | \"reveal\" | undefined",
14184
14061
  "complexType": {
14185
- "original": "string",
14186
- "resolved": "string | undefined",
14187
- "references": {}
14062
+ "original": "MenuType",
14063
+ "resolved": "\"overlay\" | \"push\" | \"reveal\" | undefined",
14064
+ "references": {
14065
+ "MenuType": {
14066
+ "location": "import",
14067
+ "path": "./menu-interface",
14068
+ "id": "src/components/menu/menu-interface.ts::MenuType"
14069
+ }
14070
+ }
14188
14071
  },
14189
14072
  "mutable": true,
14190
14073
  "attr": "type",
@@ -14193,6 +14076,15 @@
14193
14076
  "docsTags": [],
14194
14077
  "values": [
14195
14078
  {
14079
+ "value": "overlay",
14080
+ "type": "string"
14081
+ },
14082
+ {
14083
+ "value": "push",
14084
+ "type": "string"
14085
+ },
14086
+ {
14087
+ "value": "reveal",
14196
14088
  "type": "string"
14197
14089
  },
14198
14090
  {
@@ -17324,15 +17216,9 @@
17324
17216
  ],
17325
17217
  "slots": [],
17326
17218
  "parts": [],
17327
- "dependents": [
17328
- "ion-item"
17329
- ],
17219
+ "dependents": [],
17330
17220
  "dependencies": [],
17331
- "dependencyGraph": {
17332
- "ion-item": [
17333
- "ion-note"
17334
- ]
17335
- }
17221
+ "dependencyGraph": {}
17336
17222
  },
17337
17223
  {
17338
17224
  "filePath": "src/components/picker/picker.tsx",
@@ -22698,6 +22584,27 @@
22698
22584
  "optional": false,
22699
22585
  "required": false
22700
22586
  },
22587
+ {
22588
+ "name": "autocapitalize",
22589
+ "type": "string",
22590
+ "complexType": {
22591
+ "original": "string",
22592
+ "resolved": "string",
22593
+ "references": {}
22594
+ },
22595
+ "mutable": false,
22596
+ "attr": "autocapitalize",
22597
+ "reflectToAttr": false,
22598
+ "docs": "Indicates whether and how the text value should be automatically capitalized as it is entered/edited by the user.\nAvailable options: `\"off\"`, `\"none\"`, `\"on\"`, `\"sentences\"`, `\"words\"`, `\"characters\"`.",
22599
+ "docsTags": [],
22600
+ "values": [
22601
+ {
22602
+ "type": "string"
22603
+ }
22604
+ ],
22605
+ "optional": false,
22606
+ "required": true
22607
+ },
22701
22608
  {
22702
22609
  "name": "autocomplete",
22703
22610
  "type": "\"name\" | \"email\" | \"tel\" | \"url\" | \"on\" | \"off\" | \"honorific-prefix\" | \"given-name\" | \"additional-name\" | \"family-name\" | \"honorific-suffix\" | \"nickname\" | \"username\" | \"new-password\" | \"current-password\" | \"one-time-code\" | \"organization-title\" | \"organization\" | \"street-address\" | \"address-line1\" | \"address-line2\" | \"address-line3\" | \"address-level4\" | \"address-level3\" | \"address-level2\" | \"address-level1\" | \"country\" | \"country-name\" | \"postal-code\" | \"cc-name\" | \"cc-given-name\" | \"cc-additional-name\" | \"cc-family-name\" | \"cc-number\" | \"cc-exp\" | \"cc-exp-month\" | \"cc-exp-year\" | \"cc-csc\" | \"cc-type\" | \"transaction-currency\" | \"transaction-amount\" | \"language\" | \"bday\" | \"bday-day\" | \"bday-month\" | \"bday-year\" | \"sex\" | \"tel-country-code\" | \"tel-national\" | \"tel-area-code\" | \"tel-local\" | \"tel-extension\" | \"impp\" | \"photo\"",
@@ -23248,6 +23155,54 @@
23248
23155
  "optional": true,
23249
23156
  "required": false
23250
23157
  },
23158
+ {
23159
+ "name": "maxlength",
23160
+ "type": "number | undefined",
23161
+ "complexType": {
23162
+ "original": "number",
23163
+ "resolved": "number | undefined",
23164
+ "references": {}
23165
+ },
23166
+ "mutable": false,
23167
+ "attr": "maxlength",
23168
+ "reflectToAttr": false,
23169
+ "docs": "This attribute specifies the maximum number of characters that the user can enter.",
23170
+ "docsTags": [],
23171
+ "values": [
23172
+ {
23173
+ "type": "number"
23174
+ },
23175
+ {
23176
+ "type": "undefined"
23177
+ }
23178
+ ],
23179
+ "optional": true,
23180
+ "required": false
23181
+ },
23182
+ {
23183
+ "name": "minlength",
23184
+ "type": "number | undefined",
23185
+ "complexType": {
23186
+ "original": "number",
23187
+ "resolved": "number | undefined",
23188
+ "references": {}
23189
+ },
23190
+ "mutable": false,
23191
+ "attr": "minlength",
23192
+ "reflectToAttr": false,
23193
+ "docs": "This attribute specifies the minimum number of characters that the user can enter.",
23194
+ "docsTags": [],
23195
+ "values": [
23196
+ {
23197
+ "type": "number"
23198
+ },
23199
+ {
23200
+ "type": "undefined"
23201
+ }
23202
+ ],
23203
+ "optional": true,
23204
+ "required": false
23205
+ },
23251
23206
  {
23252
23207
  "name": "mode",
23253
23208
  "type": "\"ios\" | \"md\"",
@@ -25111,6 +25066,11 @@
25111
25066
  "annotation": "prop",
25112
25067
  "docs": "The color of the highlight on the select when valid"
25113
25068
  },
25069
+ {
25070
+ "name": "--highlight-height",
25071
+ "annotation": "prop",
25072
+ "docs": "The height of the highlight on the select. Only applies to md mode."
25073
+ },
25114
25074
  {
25115
25075
  "name": "--padding-bottom",
25116
25076
  "annotation": "prop",
@@ -25210,8 +25170,7 @@
25210
25170
  ],
25211
25171
  "ion-item": [
25212
25172
  "ion-icon",
25213
- "ion-ripple-effect",
25214
- "ion-note"
25173
+ "ion-ripple-effect"
25215
25174
  ],
25216
25175
  "ion-popover": [
25217
25176
  "ion-backdrop"
@@ -27597,6 +27556,11 @@
27597
27556
  "annotation": "prop",
27598
27557
  "docs": "The color of the highlight on the textarea when valid"
27599
27558
  },
27559
+ {
27560
+ "name": "--highlight-height",
27561
+ "annotation": "prop",
27562
+ "docs": "The height of the highlight on the textarea. Only applies to md mode."
27563
+ },
27600
27564
  {
27601
27565
  "name": "--padding-bottom",
27602
27566
  "annotation": "prop",
@@ -29542,11 +29506,6 @@
29542
29506
  "docstring": "",
29543
29507
  "path": "src/components/router/utils/interface.ts"
29544
29508
  },
29545
- "src/components/item/item-interface.ts::CounterFormatter": {
29546
- "declaration": "(inputLength: number, maxLength: number) => string",
29547
- "docstring": "",
29548
- "path": "src/components/item/item-interface.ts"
29549
- },
29550
29509
  "src/interface.d.ts::FrameworkDelegate": {
29551
29510
  "declaration": "export interface FrameworkDelegate {\n attachViewToDom(container: any, component: any, propsOrDataObj?: any, cssClasses?: string[]): Promise<HTMLElement>;\n removeViewFromDom(container: any, component: any): Promise<void>;\n}",
29552
29511
  "docstring": "",
@@ -29597,6 +29556,11 @@
29597
29556
  "docstring": "",
29598
29557
  "path": "src/components/content/content-interface.ts"
29599
29558
  },
29559
+ "src/components/datetime/datetime-interface.ts::FormatOptions": {
29560
+ "declaration": "export type FormatOptions =\n | {\n date: Intl.DateTimeFormatOptions;\n time?: Intl.DateTimeFormatOptions;\n }\n | {\n date?: Intl.DateTimeFormatOptions;\n time: Intl.DateTimeFormatOptions;\n };",
29561
+ "docstring": "",
29562
+ "path": "src/components/datetime/datetime-interface.ts"
29563
+ },
29600
29564
  "src/components/datetime/datetime-interface.ts::DatetimePresentation": {
29601
29565
  "declaration": "export type DatetimePresentation = 'date-time' | 'time-date' | 'date' | 'time' | 'month' | 'year' | 'month-year';",
29602
29566
  "docstring": "",
@@ -29687,6 +29651,11 @@
29687
29651
  "docstring": "",
29688
29652
  "path": "src/components/menu/menu-interface.ts"
29689
29653
  },
29654
+ "src/components/menu/menu-interface.ts::MenuType": {
29655
+ "declaration": "export type MenuType = 'overlay' | 'reveal' | 'push';",
29656
+ "docstring": "",
29657
+ "path": "src/components/menu/menu-interface.ts"
29658
+ },
29690
29659
  "src/components/menu/menu-interface.ts::MenuChangeEventDetail": {
29691
29660
  "declaration": "export interface MenuChangeEventDetail {\n disabled: boolean;\n open: boolean;\n}",
29692
29661
  "docstring": "",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ionic/docs",
3
- "version": "8.0.0-beta.1",
3
+ "version": "8.0.0-beta.2",
4
4
  "description": "Pre-packaged API documentation for the Ionic docs.",
5
5
  "main": "core.json",
6
6
  "types": "core.d.ts",