UNPKG

180 kBJSONView Raw
1{
2 "version": 1.1,
3 "tags": [
4 {
5 "name": "ion-action-sheet",
6 "description": {
7 "kind": "markdown",
8 "value": "An Action Sheet is a dialog that displays a set of options. It appears on top of the app's content, and must be manually dismissed by the user before they can resume interaction with the app. Destructive options are made obvious in `ios` mode. There are multiple ways to dismiss the action sheet, including tapping the backdrop or hitting the escape key on desktop."
9 },
10 "attributes": [
11 {
12 "name": "animated",
13 "description": "If `true`, the action sheet will animate."
14 },
15 {
16 "name": "backdrop-dismiss",
17 "description": "If `true`, the action sheet will be dismissed when the backdrop is clicked."
18 },
19 {
20 "name": "css-class",
21 "description": "Additional classes to apply for custom CSS. If multiple classes are\nprovided they should be separated by spaces."
22 },
23 {
24 "name": "header",
25 "description": "Title for the action sheet."
26 },
27 {
28 "name": "keyboard-close",
29 "description": "If `true`, the keyboard will be automatically dismissed when the overlay is presented."
30 },
31 {
32 "name": "mode",
33 "description": "The mode determines which platform styles to use.",
34 "values": [
35 {
36 "name": "ios"
37 },
38 {
39 "name": "md"
40 }
41 ]
42 },
43 {
44 "name": "sub-header",
45 "description": "Subtitle for the action sheet."
46 },
47 {
48 "name": "translucent",
49 "description": "If `true`, the action sheet will be translucent.\nOnly applies when the mode is `\"ios\"` and the device supports\n[`backdrop-filter`](https://developer.mozilla.org/en-US/docs/Web/CSS/backdrop-filter#Browser_compatibility)."
50 }
51 ],
52 "references": [
53 {
54 "name": "Source code",
55 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/action-sheet/action-sheet.tsx"
56 }
57 ]
58 },
59 {
60 "name": "ion-alert",
61 "description": {
62 "kind": "markdown",
63 "value": "An Alert is a dialog that presents users with information or collects information from the user using inputs. An alert appears on top of the app's content, and must be manually dismissed by the user before they can resume interaction with the app. It can also optionally have a `header`, `subHeader` and `message`."
64 },
65 "attributes": [
66 {
67 "name": "animated",
68 "description": "If `true`, the alert will animate."
69 },
70 {
71 "name": "backdrop-dismiss",
72 "description": "If `true`, the alert will be dismissed when the backdrop is clicked."
73 },
74 {
75 "name": "css-class",
76 "description": "Additional classes to apply for custom CSS. If multiple classes are\nprovided they should be separated by spaces."
77 },
78 {
79 "name": "header",
80 "description": "The main title in the heading of the alert."
81 },
82 {
83 "name": "keyboard-close",
84 "description": "If `true`, the keyboard will be automatically dismissed when the overlay is presented."
85 },
86 {
87 "name": "message",
88 "description": "The main message to be displayed in the alert.\n`message` can accept either plaintext or HTML as a string.\nTo display characters normally reserved for HTML, they\nmust be escaped. For example `<Ionic>` would become\n`&lt;Ionic&gt;`\n\nFor more information: [Security Documentation](https://ionicframework.com/docs/faq/security)"
89 },
90 {
91 "name": "mode",
92 "description": "The mode determines which platform styles to use.",
93 "values": [
94 {
95 "name": "ios"
96 },
97 {
98 "name": "md"
99 }
100 ]
101 },
102 {
103 "name": "sub-header",
104 "description": "The subtitle in the heading of the alert. Displayed under the title."
105 },
106 {
107 "name": "translucent",
108 "description": "If `true`, the alert will be translucent.\nOnly applies when the mode is `\"ios\"` and the device supports\n[`backdrop-filter`](https://developer.mozilla.org/en-US/docs/Web/CSS/backdrop-filter#Browser_compatibility)."
109 }
110 ],
111 "references": [
112 {
113 "name": "Source code",
114 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/alert/alert.tsx"
115 }
116 ]
117 },
118 {
119 "name": "ion-app",
120 "description": {
121 "kind": "markdown",
122 "value": "App is a container element for an Ionic application. There should only be one `<ion-app>` element per project. An app can have many Ionic components including menus, headers, content, and footers. The overlay components get appended to the `<ion-app>` when they are presented."
123 },
124 "attributes": [],
125 "references": [
126 {
127 "name": "Source code",
128 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/app/app.tsx"
129 }
130 ]
131 },
132 {
133 "name": "ion-avatar",
134 "description": {
135 "kind": "markdown",
136 "value": "Avatars are circular components that usually wrap an image or icon. They can be used to represent a person or an object.\n\nAvatars can be used by themselves or inside of any element. If placed inside of an `ion-chip` or `ion-item`, the avatar will resize to fit the parent component. To position an avatar on the left or right side of an item, set the slot to `start` or `end`, respectively."
137 },
138 "attributes": [],
139 "references": [
140 {
141 "name": "Source code",
142 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/avatar/avatar.tsx"
143 }
144 ]
145 },
146 {
147 "name": "ion-back-button",
148 "description": {
149 "kind": "markdown",
150 "value": "The back button navigates back in the app's history upon click. It is smart enough to know what to render based on the mode and when to show based on the navigation stack.\n\nTo change what is displayed in the back button, use the `text` and `icon` properties."
151 },
152 "attributes": [
153 {
154 "name": "color",
155 "description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics)."
156 },
157 {
158 "name": "default-href",
159 "description": "The url to navigate back to by default when there is no history."
160 },
161 {
162 "name": "disabled",
163 "description": "If `true`, the user cannot interact with the button."
164 },
165 {
166 "name": "icon",
167 "description": "The icon name to use for the back button."
168 },
169 {
170 "name": "mode",
171 "description": "The mode determines which platform styles to use.",
172 "values": [
173 {
174 "name": "ios"
175 },
176 {
177 "name": "md"
178 }
179 ]
180 },
181 {
182 "name": "text",
183 "description": "The text to display in the back button."
184 },
185 {
186 "name": "type",
187 "description": "The type of the button.",
188 "values": [
189 {
190 "name": "button"
191 },
192 {
193 "name": "reset"
194 },
195 {
196 "name": "submit"
197 }
198 ]
199 }
200 ],
201 "references": [
202 {
203 "name": "Source code",
204 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/back-button/back-button.tsx"
205 }
206 ]
207 },
208 {
209 "name": "ion-backdrop",
210 "description": {
211 "kind": "markdown",
212 "value": "Backdrops are full screen components that overlay other components. They are useful behind components that transition in on top of other content and can be used to dismiss that component."
213 },
214 "attributes": [
215 {
216 "name": "stop-propagation",
217 "description": "If `true`, the backdrop will stop propagation on tap."
218 },
219 {
220 "name": "tappable",
221 "description": "If `true`, the backdrop will can be clicked and will emit the `ionBackdropTap` event."
222 },
223 {
224 "name": "visible",
225 "description": "If `true`, the backdrop will be visible."
226 }
227 ],
228 "references": [
229 {
230 "name": "Source code",
231 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/backdrop/backdrop.tsx"
232 }
233 ]
234 },
235 {
236 "name": "ion-badge",
237 "description": {
238 "kind": "markdown",
239 "value": "Badges are inline block elements that usually appear near another element. Typically they contain a number or other characters. They can be used as a notification that there are additional items associated with an element and indicate how many items there are."
240 },
241 "attributes": [
242 {
243 "name": "color",
244 "description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics)."
245 },
246 {
247 "name": "mode",
248 "description": "The mode determines which platform styles to use.",
249 "values": [
250 {
251 "name": "ios"
252 },
253 {
254 "name": "md"
255 }
256 ]
257 }
258 ],
259 "references": [
260 {
261 "name": "Source code",
262 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/badge/badge.tsx"
263 }
264 ]
265 },
266 {
267 "name": "ion-button",
268 "description": {
269 "kind": "markdown",
270 "value": "Buttons provide a clickable element, which can be used in forms, or anywhere that needs simple, standard button functionality. They may display text, icons, or both. Buttons can be styled with several attributes to look a specific way."
271 },
272 "attributes": [
273 {
274 "name": "button-type",
275 "description": "The type of button."
276 },
277 {
278 "name": "color",
279 "description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics)."
280 },
281 {
282 "name": "disabled",
283 "description": "If `true`, the user cannot interact with the button."
284 },
285 {
286 "name": "download",
287 "description": "This attribute instructs browsers to download a URL instead of navigating to\nit, so the user will be prompted to save it as a local file. If the attribute\nhas a value, it is used as the pre-filled file name in the Save prompt\n(the user can still change the file name if they want)."
288 },
289 {
290 "name": "expand",
291 "description": "Set to `\"block\"` for a full-width button or to `\"full\"` for a full-width button\nwithout left and right borders.",
292 "values": [
293 {
294 "name": "block"
295 },
296 {
297 "name": "full"
298 }
299 ]
300 },
301 {
302 "name": "fill",
303 "description": "Set to `\"clear\"` for a transparent button, to `\"outline\"` for a transparent\nbutton with a border, or to `\"solid\"`. The default style is `\"solid\"` except inside of\na toolbar, where the default is `\"clear\"`.",
304 "values": [
305 {
306 "name": "clear"
307 },
308 {
309 "name": "default"
310 },
311 {
312 "name": "outline"
313 },
314 {
315 "name": "solid"
316 }
317 ]
318 },
319 {
320 "name": "href",
321 "description": "Contains a URL or a URL fragment that the hyperlink points to.\nIf this property is set, an anchor tag will be rendered."
322 },
323 {
324 "name": "mode",
325 "description": "The mode determines which platform styles to use.",
326 "values": [
327 {
328 "name": "ios"
329 },
330 {
331 "name": "md"
332 }
333 ]
334 },
335 {
336 "name": "rel",
337 "description": "Specifies the relationship of the target object to the link object.\nThe value is a space-separated list of [link types](https://developer.mozilla.org/en-US/docs/Web/HTML/Link_types)."
338 },
339 {
340 "name": "router-direction",
341 "description": "When using a router, it specifies the transition direction when navigating to\nanother page using `href`.",
342 "values": [
343 {
344 "name": "back"
345 },
346 {
347 "name": "forward"
348 },
349 {
350 "name": "root"
351 }
352 ]
353 },
354 {
355 "name": "shape",
356 "description": "The button shape.",
357 "values": [
358 {
359 "name": "round"
360 }
361 ]
362 },
363 {
364 "name": "size",
365 "description": "The button size.",
366 "values": [
367 {
368 "name": "default"
369 },
370 {
371 "name": "large"
372 },
373 {
374 "name": "small"
375 }
376 ]
377 },
378 {
379 "name": "strong",
380 "description": "If `true`, activates a button with a heavier font weight."
381 },
382 {
383 "name": "target",
384 "description": "Specifies where to display the linked URL.\nOnly applies when an `href` is provided.\nSpecial keywords: `\"_blank\"`, `\"_self\"`, `\"_parent\"`, `\"_top\"`."
385 },
386 {
387 "name": "type",
388 "description": "The type of the button.",
389 "values": [
390 {
391 "name": "button"
392 },
393 {
394 "name": "reset"
395 },
396 {
397 "name": "submit"
398 }
399 ]
400 }
401 ],
402 "references": [
403 {
404 "name": "Source code",
405 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/button/button.tsx"
406 }
407 ]
408 },
409 {
410 "name": "ion-buttons",
411 "description": {
412 "kind": "markdown",
413 "value": "The Buttons component is a container element. Buttons placed in a toolbar should be placed inside of the `<ion-buttons>` element.\n\nThe `<ion-buttons>` element can be positioned inside of the toolbar using a named slot. The below chart has a description of each slot.\n\n| Slot | Description |\n|--------------|----------------------------------------------------------------------------------------------------------|\n| `secondary` | Positions element to the `left` of the content in `ios` mode, and directly to the `right` in `md` mode. |\n| `primary` | Positions element to the `right` of the content in `ios` mode, and to the far `right` in `md` mode. |\n| `start` | Positions to the `left` of the content in LTR, and to the `right` in RTL. |\n| `end` | Positions to the `right` of the content in LTR, and to the `left` in RTL. |"
414 },
415 "attributes": [
416 {
417 "name": "collapse",
418 "description": "If true, buttons will disappear when its\nparent toolbar has fully collapsed if the toolbar\nis not the first toolbar. If the toolbar is the\nfirst toolbar, the buttons will be hidden and will\nonly be shown once all toolbars have fully collapsed.\n\nOnly applies in `ios` mode with `collapse` set to\n`true` on `ion-header`.\n\nTypically used for [Collapsible Large Titles](https://ionicframework.com/docs/api/title#collapsible-large-titles)"
419 }
420 ],
421 "references": [
422 {
423 "name": "Source code",
424 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/buttons/buttons.tsx"
425 }
426 ]
427 },
428 {
429 "name": "ion-card",
430 "description": {
431 "kind": "markdown",
432 "value": "Cards are a standard piece of UI that serves as an entry point to more detailed\ninformation. A card can be a single component, but is often made up of some\nheader, title, subtitle, and content. `ion-card` is broken up into several\nsub-components to reflect this. Please see `ion-card-content`,\n`ion-card-header`, `ion-card-title`, `ion-card-subtitle`."
433 },
434 "attributes": [
435 {
436 "name": "button",
437 "description": "If `true`, a button tag will be rendered and the card will be tappable."
438 },
439 {
440 "name": "color",
441 "description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics)."
442 },
443 {
444 "name": "disabled",
445 "description": "If `true`, the user cannot interact with the card."
446 },
447 {
448 "name": "download",
449 "description": "This attribute instructs browsers to download a URL instead of navigating to\nit, so the user will be prompted to save it as a local file. If the attribute\nhas a value, it is used as the pre-filled file name in the Save prompt\n(the user can still change the file name if they want)."
450 },
451 {
452 "name": "href",
453 "description": "Contains a URL or a URL fragment that the hyperlink points to.\nIf this property is set, an anchor tag will be rendered."
454 },
455 {
456 "name": "mode",
457 "description": "The mode determines which platform styles to use.",
458 "values": [
459 {
460 "name": "ios"
461 },
462 {
463 "name": "md"
464 }
465 ]
466 },
467 {
468 "name": "rel",
469 "description": "Specifies the relationship of the target object to the link object.\nThe value is a space-separated list of [link types](https://developer.mozilla.org/en-US/docs/Web/HTML/Link_types)."
470 },
471 {
472 "name": "router-direction",
473 "description": "When using a router, it specifies the transition direction when navigating to\nanother page using `href`.",
474 "values": [
475 {
476 "name": "back"
477 },
478 {
479 "name": "forward"
480 },
481 {
482 "name": "root"
483 }
484 ]
485 },
486 {
487 "name": "target",
488 "description": "Specifies where to display the linked URL.\nOnly applies when an `href` is provided.\nSpecial keywords: `\"_blank\"`, `\"_self\"`, `\"_parent\"`, `\"_top\"`."
489 },
490 {
491 "name": "type",
492 "description": "The type of the button. Only used when an `onclick` or `button` property is present.",
493 "values": [
494 {
495 "name": "button"
496 },
497 {
498 "name": "reset"
499 },
500 {
501 "name": "submit"
502 }
503 ]
504 }
505 ],
506 "references": [
507 {
508 "name": "Source code",
509 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/card/card.tsx"
510 }
511 ]
512 },
513 {
514 "name": "ion-card-content",
515 "description": {
516 "kind": "markdown",
517 "value": "`ion-card-content` is child component of `ion-card` that adds some content padding.\nIt is recommended that any text content for a card should be placed in an `ion-card-content`."
518 },
519 "attributes": [
520 {
521 "name": "mode",
522 "description": "The mode determines which platform styles to use.",
523 "values": [
524 {
525 "name": "ios"
526 },
527 {
528 "name": "md"
529 }
530 ]
531 }
532 ],
533 "references": [
534 {
535 "name": "Source code",
536 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/card-content/card-content.tsx"
537 }
538 ]
539 },
540 {
541 "name": "ion-card-header",
542 "description": {
543 "kind": "markdown",
544 "value": "`ion-card-header` is a header component for `ion-card`."
545 },
546 "attributes": [
547 {
548 "name": "color",
549 "description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics)."
550 },
551 {
552 "name": "mode",
553 "description": "The mode determines which platform styles to use.",
554 "values": [
555 {
556 "name": "ios"
557 },
558 {
559 "name": "md"
560 }
561 ]
562 },
563 {
564 "name": "translucent",
565 "description": "If `true`, the card header will be translucent.\nOnly applies when the mode is `\"ios\"` and the device supports\n[`backdrop-filter`](https://developer.mozilla.org/en-US/docs/Web/CSS/backdrop-filter#Browser_compatibility)."
566 }
567 ],
568 "references": [
569 {
570 "name": "Source code",
571 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/card-header/card-header.tsx"
572 }
573 ]
574 },
575 {
576 "name": "ion-card-subtitle",
577 "description": {
578 "kind": "markdown",
579 "value": "`ion-card-subtitle` is a child component of `ion-card`"
580 },
581 "attributes": [
582 {
583 "name": "color",
584 "description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics)."
585 },
586 {
587 "name": "mode",
588 "description": "The mode determines which platform styles to use.",
589 "values": [
590 {
591 "name": "ios"
592 },
593 {
594 "name": "md"
595 }
596 ]
597 }
598 ],
599 "references": [
600 {
601 "name": "Source code",
602 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/card-subtitle/card-subtitle.tsx"
603 }
604 ]
605 },
606 {
607 "name": "ion-card-title",
608 "description": {
609 "kind": "markdown",
610 "value": "`ion-card-title` is a child component of `ion-card`"
611 },
612 "attributes": [
613 {
614 "name": "color",
615 "description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics)."
616 },
617 {
618 "name": "mode",
619 "description": "The mode determines which platform styles to use.",
620 "values": [
621 {
622 "name": "ios"
623 },
624 {
625 "name": "md"
626 }
627 ]
628 }
629 ],
630 "references": [
631 {
632 "name": "Source code",
633 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/card-title/card-title.tsx"
634 }
635 ]
636 },
637 {
638 "name": "ion-checkbox",
639 "description": {
640 "kind": "markdown",
641 "value": "Checkboxes allow the selection of multiple options from a set of options. They appear as checked (ticked) when activated. Clicking on a checkbox will toggle the `checked` property. They can also be checked programmatically by setting the `checked` property."
642 },
643 "attributes": [
644 {
645 "name": "checked",
646 "description": "If `true`, the checkbox is selected."
647 },
648 {
649 "name": "color",
650 "description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics)."
651 },
652 {
653 "name": "disabled",
654 "description": "If `true`, the user cannot interact with the checkbox."
655 },
656 {
657 "name": "indeterminate",
658 "description": "If `true`, the checkbox will visually appear as indeterminate."
659 },
660 {
661 "name": "mode",
662 "description": "The mode determines which platform styles to use.",
663 "values": [
664 {
665 "name": "ios"
666 },
667 {
668 "name": "md"
669 }
670 ]
671 },
672 {
673 "name": "name",
674 "description": "The name of the control, which is submitted with the form data."
675 },
676 {
677 "name": "value",
678 "description": "The value of the checkbox does not mean if it's checked or not, use the `checked`\nproperty for that.\n\nThe value of a checkbox is analogous to the value of an `<input type=\"checkbox\">`,\nit's only used when the checkbox participates in a native `<form>`."
679 }
680 ],
681 "references": [
682 {
683 "name": "Source code",
684 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/checkbox/checkbox.tsx"
685 }
686 ]
687 },
688 {
689 "name": "ion-chip",
690 "description": {
691 "kind": "markdown",
692 "value": "Chips represent complex entities in small blocks, such as a contact. A chip can contain several different elements such as avatars, text, and icons."
693 },
694 "attributes": [
695 {
696 "name": "color",
697 "description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics)."
698 },
699 {
700 "name": "disabled",
701 "description": "If `true`, the user cannot interact with the chip."
702 },
703 {
704 "name": "mode",
705 "description": "The mode determines which platform styles to use.",
706 "values": [
707 {
708 "name": "ios"
709 },
710 {
711 "name": "md"
712 }
713 ]
714 },
715 {
716 "name": "outline",
717 "description": "Display an outline style button."
718 }
719 ],
720 "references": [
721 {
722 "name": "Source code",
723 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/chip/chip.tsx"
724 }
725 ]
726 },
727 {
728 "name": "ion-col",
729 "description": {
730 "kind": "markdown",
731 "value": "Columns are cellular components of the [grid](../grid) system and go inside of a [row](../row).\nThey will expand to fill their row. All content within a grid should go inside of a column.\n\nSee [Grid Layout](/docs/layout/grid) for more information."
732 },
733 "attributes": [
734 {
735 "name": "offset",
736 "description": "The amount to offset the column, in terms of how many columns it should shift to the end\nof the total available."
737 },
738 {
739 "name": "offset-lg",
740 "description": "The amount to offset the column for lg screens, in terms of how many columns it should shift\nto the end of the total available."
741 },
742 {
743 "name": "offset-md",
744 "description": "The amount to offset the column for md screens, in terms of how many columns it should shift\nto the end of the total available."
745 },
746 {
747 "name": "offset-sm",
748 "description": "The amount to offset the column for sm screens, in terms of how many columns it should shift\nto the end of the total available."
749 },
750 {
751 "name": "offset-xl",
752 "description": "The amount to offset the column for xl screens, in terms of how many columns it should shift\nto the end of the total available."
753 },
754 {
755 "name": "offset-xs",
756 "description": "The amount to offset the column for xs screens, in terms of how many columns it should shift\nto the end of the total available."
757 },
758 {
759 "name": "pull",
760 "description": "The amount to pull the column, in terms of how many columns it should shift to the start of\nthe total available."
761 },
762 {
763 "name": "pull-lg",
764 "description": "The amount to pull the column for lg screens, in terms of how many columns it should shift\nto the start of the total available."
765 },
766 {
767 "name": "pull-md",
768 "description": "The amount to pull the column for md screens, in terms of how many columns it should shift\nto the start of the total available."
769 },
770 {
771 "name": "pull-sm",
772 "description": "The amount to pull the column for sm screens, in terms of how many columns it should shift\nto the start of the total available."
773 },
774 {
775 "name": "pull-xl",
776 "description": "The amount to pull the column for xl screens, in terms of how many columns it should shift\nto the start of the total available."
777 },
778 {
779 "name": "pull-xs",
780 "description": "The amount to pull the column for xs screens, in terms of how many columns it should shift\nto the start of the total available."
781 },
782 {
783 "name": "push",
784 "description": "The amount to push the column, in terms of how many columns it should shift to the end\nof the total available."
785 },
786 {
787 "name": "push-lg",
788 "description": "The amount to push the column for lg screens, in terms of how many columns it should shift\nto the end of the total available."
789 },
790 {
791 "name": "push-md",
792 "description": "The amount to push the column for md screens, in terms of how many columns it should shift\nto the end of the total available."
793 },
794 {
795 "name": "push-sm",
796 "description": "The amount to push the column for sm screens, in terms of how many columns it should shift\nto the end of the total available."
797 },
798 {
799 "name": "push-xl",
800 "description": "The amount to push the column for xl screens, in terms of how many columns it should shift\nto the end of the total available."
801 },
802 {
803 "name": "push-xs",
804 "description": "The amount to push the column for xs screens, in terms of how many columns it should shift\nto the end of the total available."
805 },
806 {
807 "name": "size",
808 "description": "The size of the column, in terms of how many columns it should take up out of the total\navailable. If `\"auto\"` is passed, the column will be the size of its content."
809 },
810 {
811 "name": "size-lg",
812 "description": "The size of the column for lg screens, in terms of how many columns it should take up out\nof the total available. If `\"auto\"` is passed, the column will be the size of its content."
813 },
814 {
815 "name": "size-md",
816 "description": "The size of the column for md screens, in terms of how many columns it should take up out\nof the total available. If `\"auto\"` is passed, the column will be the size of its content."
817 },
818 {
819 "name": "size-sm",
820 "description": "The size of the column for sm screens, in terms of how many columns it should take up out\nof the total available. If `\"auto\"` is passed, the column will be the size of its content."
821 },
822 {
823 "name": "size-xl",
824 "description": "The size of the column for xl screens, in terms of how many columns it should take up out\nof the total available. If `\"auto\"` is passed, the column will be the size of its content."
825 },
826 {
827 "name": "size-xs",
828 "description": "The size of the column for xs screens, in terms of how many columns it should take up out\nof the total available. If `\"auto\"` is passed, the column will be the size of its content."
829 }
830 ],
831 "references": [
832 {
833 "name": "Source code",
834 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/col/col.tsx"
835 }
836 ]
837 },
838 {
839 "name": "ion-content",
840 "description": {
841 "kind": "markdown",
842 "value": "The content component provides an easy to use content area with some useful methods\nto control the scrollable area. There should only be one content in a single\nview.\n\nContent, along with many other Ionic components, can be customized to modify its padding, margin, and more using the global styles provided in the [CSS Utilities](/docs/layout/css-utilities) or by individually styling it using CSS and the available [CSS Custom Properties](#css-custom-properties)."
843 },
844 "attributes": [
845 {
846 "name": "color",
847 "description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics)."
848 },
849 {
850 "name": "force-overscroll",
851 "description": "If `true` and the content does not cause an overflow scroll, the scroll interaction will cause a bounce.\nIf the content exceeds the bounds of ionContent, nothing will change.\nNote, the does not disable the system bounce on iOS. That is an OS level setting."
852 },
853 {
854 "name": "fullscreen",
855 "description": "If `true`, the content will scroll behind the headers\nand footers. This effect can easily be seen by setting the toolbar\nto transparent."
856 },
857 {
858 "name": "scroll-events",
859 "description": "Because of performance reasons, ionScroll events are disabled by default, in order to enable them\nand start listening from (ionScroll), set this property to `true`."
860 },
861 {
862 "name": "scroll-x",
863 "description": "If you want to enable the content scrolling in the X axis, set this property to `true`."
864 },
865 {
866 "name": "scroll-y",
867 "description": "If you want to disable the content scrolling in the Y axis, set this property to `false`."
868 }
869 ],
870 "references": [
871 {
872 "name": "Source code",
873 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/content/content.tsx"
874 }
875 ]
876 },
877 {
878 "name": "ion-datetime",
879 "description": {
880 "kind": "markdown",
881 "value": "Datetimes present a picker interface from the bottom of a page, making it easy for\nusers to select dates and times. The picker displays scrollable columns that can be\nused to individually select years, months, days, hours and minute values. Datetimes\nare similar to the native `input` elements of type `datetime-local`, however, Ionic's\nDatetime component makes it easy to display the date and time in a preferred format,\nand manage the datetime values."
882 },
883 "attributes": [
884 {
885 "name": "cancel-text",
886 "description": "The text to display on the picker's cancel button."
887 },
888 {
889 "name": "day-names",
890 "description": "Full day of the week names. This can be used to provide\nlocale names for each day in the week. Defaults to English."
891 },
892 {
893 "name": "day-short-names",
894 "description": "Short abbreviated day of the week names. This can be used to provide\nlocale names for each day in the week. Defaults to English.\nDefaults to: `['Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat']`"
895 },
896 {
897 "name": "day-values",
898 "description": "Values used to create the list of selectable days. By default\nevery day is shown for the given month. However, to control exactly which days of\nthe month to display, the `dayValues` input can take a number, an array of numbers, or\na string of comma separated numbers. Note that even if the array days have an invalid\nnumber for the selected month, like `31` in February, it will correctly not show\ndays which are not valid for the selected month."
899 },
900 {
901 "name": "disabled",
902 "description": "If `true`, the user cannot interact with the datetime."
903 },
904 {
905 "name": "display-format",
906 "description": "The display format of the date and time as text that shows\nwithin the item. When the `pickerFormat` input is not used, then the\n`displayFormat` is used for both display the formatted text, and determining\nthe datetime picker's columns. See the `pickerFormat` input description for\nmore info. Defaults to `MMM D, YYYY`."
907 },
908 {
909 "name": "display-timezone",
910 "description": "The timezone to use for display purposes only. See\n[Date.prototype.toLocaleString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toLocaleString)\nfor a list of supported timezones. If no value is provided, the\ncomponent will default to displaying times in the user's local timezone."
911 },
912 {
913 "name": "done-text",
914 "description": "The text to display on the picker's \"Done\" button."
915 },
916 {
917 "name": "hour-values",
918 "description": "Values used to create the list of selectable hours. By default\nthe hour values range from `0` to `23` for 24-hour, or `1` to `12` for 12-hour. However,\nto control exactly which hours to display, the `hourValues` input can take a number, an\narray of numbers, or a string of comma separated numbers."
919 },
920 {
921 "name": "max",
922 "description": "The maximum datetime allowed. Value must be a date string\nfollowing the\n[ISO 8601 datetime format standard](https://www.w3.org/TR/NOTE-datetime),\n`1996-12-19`. The format does not have to be specific to an exact\ndatetime. For example, the maximum could just be the year, such as `1994`.\nDefaults to the end of this year."
923 },
924 {
925 "name": "min",
926 "description": "The minimum datetime allowed. Value must be a date string\nfollowing the\n[ISO 8601 datetime format standard](https://www.w3.org/TR/NOTE-datetime),\nsuch as `1996-12-19`. The format does not have to be specific to an exact\ndatetime. For example, the minimum could just be the year, such as `1994`.\nDefaults to the beginning of the year, 100 years ago from today."
927 },
928 {
929 "name": "minute-values",
930 "description": "Values used to create the list of selectable minutes. By default\nthe minutes range from `0` to `59`. However, to control exactly which minutes to display,\nthe `minuteValues` input can take a number, an array of numbers, or a string of comma\nseparated numbers. For example, if the minute selections should only be every 15 minutes,\nthen this input value would be `minuteValues=\"0,15,30,45\"`."
931 },
932 {
933 "name": "mode",
934 "description": "The mode determines which platform styles to use.",
935 "values": [
936 {
937 "name": "ios"
938 },
939 {
940 "name": "md"
941 }
942 ]
943 },
944 {
945 "name": "month-names",
946 "description": "Full names for each month name. This can be used to provide\nlocale month names. Defaults to English."
947 },
948 {
949 "name": "month-short-names",
950 "description": "Short abbreviated names for each month name. This can be used to provide\nlocale month names. Defaults to English."
951 },
952 {
953 "name": "month-values",
954 "description": "Values used to create the list of selectable months. By default\nthe month values range from `1` to `12`. However, to control exactly which months to\ndisplay, the `monthValues` input can take a number, an array of numbers, or a string of\ncomma separated numbers. For example, if only summer months should be shown, then this\ninput value would be `monthValues=\"6,7,8\"`. Note that month numbers do *not* have a\nzero-based index, meaning January's value is `1`, and December's is `12`."
955 },
956 {
957 "name": "name",
958 "description": "The name of the control, which is submitted with the form data."
959 },
960 {
961 "name": "picker-format",
962 "description": "The format of the date and time picker columns the user selects.\nA datetime input can have one or many datetime parts, each getting their\nown column which allow individual selection of that particular datetime part. For\nexample, year and month columns are two individually selectable columns which help\nchoose an exact date from the datetime picker. Each column follows the string\nparse format. Defaults to use `displayFormat`."
963 },
964 {
965 "name": "placeholder",
966 "description": "The text to display when there's no date selected yet.\nUsing lowercase to match the input attribute"
967 },
968 {
969 "name": "readonly",
970 "description": "If `true`, the datetime appears normal but is not interactive."
971 },
972 {
973 "name": "value",
974 "description": "The value of the datetime as a valid ISO 8601 datetime string."
975 },
976 {
977 "name": "year-values",
978 "description": "Values used to create the list of selectable years. By default\nthe year values range between the `min` and `max` datetime inputs. However, to\ncontrol exactly which years to display, the `yearValues` input can take a number, an array\nof numbers, or string of comma separated numbers. For example, to show upcoming and\nrecent leap years, then this input's value would be `yearValues=\"2024,2020,2016,2012,2008\"`."
979 }
980 ],
981 "references": [
982 {
983 "name": "Source code",
984 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/datetime/datetime.tsx"
985 }
986 ]
987 },
988 {
989 "name": "ion-fab",
990 "description": {
991 "kind": "markdown",
992 "value": "Fabs are container elements that contain one or more fab buttons. They should be placed in a fixed position that does not scroll with the content. Fab should have one main fab-button. Fabs can also contain fab-lists which contain related buttons that show when the main fab button is clicked. The same fab container can contain several [fab-list](../fab-list) elements with different side values."
993 },
994 "attributes": [
995 {
996 "name": "activated",
997 "description": "If `true`, both the `ion-fab-button` and all `ion-fab-list` inside `ion-fab` will become active.\nThat means `ion-fab-button` will become a `close` icon and `ion-fab-list` will become visible."
998 },
999 {
1000 "name": "edge",
1001 "description": "If `true`, the fab will display on the edge of the header if\n`vertical` is `\"top\"`, and on the edge of the footer if\nit is `\"bottom\"`. Should be used with a `fixed` slot."
1002 },
1003 {
1004 "name": "horizontal",
1005 "description": "Where to align the fab horizontally in the viewport.",
1006 "values": [
1007 {
1008 "name": "center"
1009 },
1010 {
1011 "name": "end"
1012 },
1013 {
1014 "name": "start"
1015 }
1016 ]
1017 },
1018 {
1019 "name": "vertical",
1020 "description": "Where to align the fab vertically in the viewport.",
1021 "values": [
1022 {
1023 "name": "bottom"
1024 },
1025 {
1026 "name": "center"
1027 },
1028 {
1029 "name": "top"
1030 }
1031 ]
1032 }
1033 ],
1034 "references": [
1035 {
1036 "name": "Source code",
1037 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/fab/fab.tsx"
1038 }
1039 ]
1040 },
1041 {
1042 "name": "ion-fab-button",
1043 "description": {
1044 "kind": "markdown",
1045 "value": "Floating Action Buttons (FABs) represent the primary action in an application. By default, they have a circular shape. When pressed, the button may open more related actions. As the name suggests, FABs generally float over the content in a fixed position. This is not achieved exclusively by using an `<ion-fab-button>FAB</ion-fab-button>`. They need to be wrapped with an `<ion-fab>` component in order to be fixed over the content.\n\nIf the FAB button is not wrapped with `<ion-fab>`, it will scroll with the content. FAB buttons have a default size, a mini size and can accept different colors:"
1046 },
1047 "attributes": [
1048 {
1049 "name": "activated",
1050 "description": "If `true`, the fab button will be show a close icon."
1051 },
1052 {
1053 "name": "close-icon",
1054 "description": "The icon name to use for the close icon. This will appear when the fab button\nis pressed. Only applies if it is the main button inside of a fab containing a\nfab list."
1055 },
1056 {
1057 "name": "color",
1058 "description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics)."
1059 },
1060 {
1061 "name": "disabled",
1062 "description": "If `true`, the user cannot interact with the fab button."
1063 },
1064 {
1065 "name": "download",
1066 "description": "This attribute instructs browsers to download a URL instead of navigating to\nit, so the user will be prompted to save it as a local file. If the attribute\nhas a value, it is used as the pre-filled file name in the Save prompt\n(the user can still change the file name if they want)."
1067 },
1068 {
1069 "name": "href",
1070 "description": "Contains a URL or a URL fragment that the hyperlink points to.\nIf this property is set, an anchor tag will be rendered."
1071 },
1072 {
1073 "name": "mode",
1074 "description": "The mode determines which platform styles to use.",
1075 "values": [
1076 {
1077 "name": "ios"
1078 },
1079 {
1080 "name": "md"
1081 }
1082 ]
1083 },
1084 {
1085 "name": "rel",
1086 "description": "Specifies the relationship of the target object to the link object.\nThe value is a space-separated list of [link types](https://developer.mozilla.org/en-US/docs/Web/HTML/Link_types)."
1087 },
1088 {
1089 "name": "router-direction",
1090 "description": "When using a router, it specifies the transition direction when navigating to\nanother page using `href`.",
1091 "values": [
1092 {
1093 "name": "back"
1094 },
1095 {
1096 "name": "forward"
1097 },
1098 {
1099 "name": "root"
1100 }
1101 ]
1102 },
1103 {
1104 "name": "show",
1105 "description": "If `true`, the fab button will show when in a fab-list."
1106 },
1107 {
1108 "name": "size",
1109 "description": "The size of the button. Set this to `small` in order to have a mini fab button.",
1110 "values": [
1111 {
1112 "name": "small"
1113 }
1114 ]
1115 },
1116 {
1117 "name": "target",
1118 "description": "Specifies where to display the linked URL.\nOnly applies when an `href` is provided.\nSpecial keywords: `\"_blank\"`, `\"_self\"`, `\"_parent\"`, `\"_top\"`."
1119 },
1120 {
1121 "name": "translucent",
1122 "description": "If `true`, the fab button will be translucent.\nOnly applies when the mode is `\"ios\"` and the device supports\n[`backdrop-filter`](https://developer.mozilla.org/en-US/docs/Web/CSS/backdrop-filter#Browser_compatibility)."
1123 },
1124 {
1125 "name": "type",
1126 "description": "The type of the button.",
1127 "values": [
1128 {
1129 "name": "button"
1130 },
1131 {
1132 "name": "reset"
1133 },
1134 {
1135 "name": "submit"
1136 }
1137 ]
1138 }
1139 ],
1140 "references": [
1141 {
1142 "name": "Source code",
1143 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/fab-button/fab-button.tsx"
1144 }
1145 ]
1146 },
1147 {
1148 "name": "ion-fab-list",
1149 "description": {
1150 "kind": "markdown",
1151 "value": "The `ion-fab-list` element is a container for multiple fab buttons. This collection of fab buttons contains actions related to the main fab button and is flung out on click. To specify what side the buttons should appear on, set the `side` property to 'start', 'end', 'top', 'bottom'"
1152 },
1153 "attributes": [
1154 {
1155 "name": "activated",
1156 "description": "If `true`, the fab list will show all fab buttons in the list."
1157 },
1158 {
1159 "name": "side",
1160 "description": "The side the fab list will show on relative to the main fab button.",
1161 "values": [
1162 {
1163 "name": "bottom"
1164 },
1165 {
1166 "name": "end"
1167 },
1168 {
1169 "name": "start"
1170 },
1171 {
1172 "name": "top"
1173 }
1174 ]
1175 }
1176 ],
1177 "references": [
1178 {
1179 "name": "Source code",
1180 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/fab-list/fab-list.tsx"
1181 }
1182 ]
1183 },
1184 {
1185 "name": "ion-footer",
1186 "description": {
1187 "kind": "markdown",
1188 "value": "Footer is a root component of a page that sits at the bottom of the page.\nFooter can be a wrapper for ion-toolbar to make sure the content area is sized correctly."
1189 },
1190 "attributes": [
1191 {
1192 "name": "mode",
1193 "description": "The mode determines which platform styles to use.",
1194 "values": [
1195 {
1196 "name": "ios"
1197 },
1198 {
1199 "name": "md"
1200 }
1201 ]
1202 },
1203 {
1204 "name": "translucent",
1205 "description": "If `true`, the footer will be translucent.\nOnly applies when the mode is `\"ios\"` and the device supports\n[`backdrop-filter`](https://developer.mozilla.org/en-US/docs/Web/CSS/backdrop-filter#Browser_compatibility).\n\nNote: In order to scroll content behind the footer, the `fullscreen`\nattribute needs to be set on the content."
1206 }
1207 ],
1208 "references": [
1209 {
1210 "name": "Source code",
1211 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/footer/footer.tsx"
1212 }
1213 ]
1214 },
1215 {
1216 "name": "ion-grid",
1217 "description": {
1218 "kind": "markdown",
1219 "value": "The grid is a powerful mobile-first flexbox system for building custom layouts.\n\nIt is composed of three units — a grid, [row(s)](../row) and [column(s)](../col). Columns will expand to fill the row, and will resize to fit additional columns. It is based on a 12 column layout with different breakpoints based on the screen size. The number of columns can be customized using CSS.\n\nSee the [Responsive Grid documentation](/docs/layout/grid) for more information."
1220 },
1221 "attributes": [
1222 {
1223 "name": "fixed",
1224 "description": "If `true`, the grid will have a fixed width based on the screen size."
1225 }
1226 ],
1227 "references": [
1228 {
1229 "name": "Source code",
1230 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/grid/grid.tsx"
1231 }
1232 ]
1233 },
1234 {
1235 "name": "ion-header",
1236 "description": {
1237 "kind": "markdown",
1238 "value": "Header is a parent component that holds the toolbar component.\nIt's important to note that ion-header needs to be the one of the three root elements of a page"
1239 },
1240 "attributes": [
1241 {
1242 "name": "collapse",
1243 "description": "Describes the scroll effect that will be applied to the header\n`condense` only applies in iOS mode.\n\nTypically used for [Collapsible Large Titles](https://ionicframework.com/docs/api/title#collapsible-large-titles)",
1244 "values": [
1245 {
1246 "name": "condense"
1247 }
1248 ]
1249 },
1250 {
1251 "name": "mode",
1252 "description": "The mode determines which platform styles to use.",
1253 "values": [
1254 {
1255 "name": "ios"
1256 },
1257 {
1258 "name": "md"
1259 }
1260 ]
1261 },
1262 {
1263 "name": "translucent",
1264 "description": "If `true`, the header will be translucent.\nOnly applies when the mode is `\"ios\"` and the device supports\n[`backdrop-filter`](https://developer.mozilla.org/en-US/docs/Web/CSS/backdrop-filter#Browser_compatibility).\n\nNote: In order to scroll content behind the header, the `fullscreen`\nattribute needs to be set on the content."
1265 }
1266 ],
1267 "references": [
1268 {
1269 "name": "Source code",
1270 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/header/header.tsx"
1271 }
1272 ]
1273 },
1274 {
1275 "name": "ion-img",
1276 "description": {
1277 "kind": "markdown",
1278 "value": "Img is a tag that will lazily load an image when ever the tag is in the viewport. This is extremely useful when generating a large list as images are only loaded when they're visible. The component uses [Intersection Observer](https://caniuse.com/#feat=intersectionobserver) internally, which is supported in most modern browser, but falls back to a `setTimeout` when it is not supported."
1279 },
1280 "attributes": [
1281 {
1282 "name": "alt",
1283 "description": "This attribute defines the alternative text describing the image.\nUsers will see this text displayed if the image URL is wrong,\nthe image is not in one of the supported formats, or if the image is not yet downloaded."
1284 },
1285 {
1286 "name": "src",
1287 "description": "The image URL. This attribute is mandatory for the `<img>` element."
1288 }
1289 ],
1290 "references": [
1291 {
1292 "name": "Source code",
1293 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/img/img.tsx"
1294 }
1295 ]
1296 },
1297 {
1298 "name": "ion-infinite-scroll",
1299 "description": {
1300 "kind": "markdown",
1301 "value": "The Infinite Scroll component calls an action to be performed when the user scrolls a specified distance from the bottom or top of the page.\n\nThe expression assigned to the `ionInfinite` event is called when the user reaches that defined distance. When this expression has finished any and all tasks, it should call the `complete()` method on the infinite scroll instance."
1302 },
1303 "attributes": [
1304 {
1305 "name": "disabled",
1306 "description": "If `true`, the infinite scroll will be hidden and scroll event listeners\nwill be removed.\n\nSet this to true to disable the infinite scroll from actively\ntrying to receive new data while scrolling. This is useful\nwhen it is known that there is no more data that can be added, and\nthe infinite scroll is no longer needed."
1307 },
1308 {
1309 "name": "position",
1310 "description": "The position of the infinite scroll element.\nThe value can be either `top` or `bottom`.",
1311 "values": [
1312 {
1313 "name": "bottom"
1314 },
1315 {
1316 "name": "top"
1317 }
1318 ]
1319 },
1320 {
1321 "name": "threshold",
1322 "description": "The threshold distance from the bottom\nof the content to call the `infinite` output event when scrolled.\nThe threshold value can be either a percent, or\nin pixels. For example, use the value of `10%` for the `infinite`\noutput event to get called when the user has scrolled 10%\nfrom the bottom of the page. Use the value `100px` when the\nscroll is within 100 pixels from the bottom of the page."
1323 }
1324 ],
1325 "references": [
1326 {
1327 "name": "Source code",
1328 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/infinite-scroll/infinite-scroll.tsx"
1329 }
1330 ]
1331 },
1332 {
1333 "name": "ion-infinite-scroll-content",
1334 "description": {
1335 "kind": "markdown",
1336 "value": "The `ion-infinite-scroll-content` component is the default child used by the `ion-infinite-scroll`. It displays an infinite scroll spinner that looks best based on the platform and changes the look depending on the infinite scroll's state. The default spinner can be changed and text can be added by setting the `loadingSpinner` and `loadingText` properties."
1337 },
1338 "attributes": [
1339 {
1340 "name": "loading-spinner",
1341 "description": "An animated SVG spinner that shows while loading.",
1342 "values": [
1343 {
1344 "name": "bubbles"
1345 },
1346 {
1347 "name": "circles"
1348 },
1349 {
1350 "name": "circular"
1351 },
1352 {
1353 "name": "crescent"
1354 },
1355 {
1356 "name": "dots"
1357 },
1358 {
1359 "name": "lines"
1360 },
1361 {
1362 "name": "lines-small"
1363 }
1364 ]
1365 },
1366 {
1367 "name": "loading-text",
1368 "description": "Optional text to display while loading.\n`loadingText` can accept either plaintext or HTML as a string.\nTo display characters normally reserved for HTML, they\nmust be escaped. For example `<Ionic>` would become\n`&lt;Ionic&gt;`\n\nFor more information: [Security Documentation](https://ionicframework.com/docs/faq/security)"
1369 }
1370 ],
1371 "references": [
1372 {
1373 "name": "Source code",
1374 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/infinite-scroll-content/infinite-scroll-content.tsx"
1375 }
1376 ]
1377 },
1378 {
1379 "name": "ion-input",
1380 "description": {
1381 "kind": "markdown",
1382 "value": "The input component is a wrapper to the HTML input element with custom styling and additional functionality. It accepts most of the same properties as the HTML input, but works great on desktop devices and integrates with the keyboard on mobile devices.\n\nIt is meant for text `type` inputs only, such as `\"text\"`, `\"password\"`, `\"email\"`, `\"number\"`, `\"search\"`, `\"tel\"`, and `\"url\"`. It supports all standard text input events including keyup, keydown, keypress, and more."
1383 },
1384 "attributes": [
1385 {
1386 "name": "accept",
1387 "description": "If the value of the type attribute is `\"file\"`, then this attribute will indicate the types of files that the server accepts, otherwise it will be ignored. The value must be a comma-separated list of unique content type specifiers."
1388 },
1389 {
1390 "name": "autocapitalize",
1391 "description": "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\"`."
1392 },
1393 {
1394 "name": "autocomplete",
1395 "description": "Indicates whether the value of the control can be automatically completed by the browser.",
1396 "values": [
1397 {
1398 "name": "on"
1399 },
1400 {
1401 "name": "off"
1402 },
1403 {
1404 "name": "name"
1405 },
1406 {
1407 "name": "honorific-prefix"
1408 },
1409 {
1410 "name": "given-name"
1411 },
1412 {
1413 "name": "additional-name"
1414 },
1415 {
1416 "name": "family-name"
1417 },
1418 {
1419 "name": "honorific-suffix"
1420 },
1421 {
1422 "name": "nickname"
1423 },
1424 {
1425 "name": "email"
1426 },
1427 {
1428 "name": "username"
1429 },
1430 {
1431 "name": "new-password"
1432 },
1433 {
1434 "name": "current-password"
1435 },
1436 {
1437 "name": "one-time-code"
1438 },
1439 {
1440 "name": "organization-title"
1441 },
1442 {
1443 "name": "organization"
1444 },
1445 {
1446 "name": "street-address"
1447 },
1448 {
1449 "name": "address-line1"
1450 },
1451 {
1452 "name": "address-line2"
1453 },
1454 {
1455 "name": "address-line3"
1456 },
1457 {
1458 "name": "address-level4"
1459 },
1460 {
1461 "name": "address-level3"
1462 },
1463 {
1464 "name": "address-level2"
1465 },
1466 {
1467 "name": "address-level1"
1468 },
1469 {
1470 "name": "country"
1471 },
1472 {
1473 "name": "country-name"
1474 },
1475 {
1476 "name": "postal-code"
1477 },
1478 {
1479 "name": "cc-name"
1480 },
1481 {
1482 "name": "cc-given-name"
1483 },
1484 {
1485 "name": "cc-additional-name"
1486 },
1487 {
1488 "name": "cc-family-name"
1489 },
1490 {
1491 "name": "cc-number"
1492 },
1493 {
1494 "name": "cc-exp"
1495 },
1496 {
1497 "name": "cc-exp-month"
1498 },
1499 {
1500 "name": "cc-exp-year"
1501 },
1502 {
1503 "name": "cc-csc"
1504 },
1505 {
1506 "name": "cc-type"
1507 },
1508 {
1509 "name": "transaction-currency"
1510 },
1511 {
1512 "name": "transaction-amount"
1513 },
1514 {
1515 "name": "language"
1516 },
1517 {
1518 "name": "bday"
1519 },
1520 {
1521 "name": "bday-day"
1522 },
1523 {
1524 "name": "bday-month"
1525 },
1526 {
1527 "name": "bday-year"
1528 },
1529 {
1530 "name": "sex"
1531 },
1532 {
1533 "name": "tel"
1534 },
1535 {
1536 "name": "tel-country-code"
1537 },
1538 {
1539 "name": "tel-national"
1540 },
1541 {
1542 "name": "tel-area-code"
1543 },
1544 {
1545 "name": "tel-local"
1546 },
1547 {
1548 "name": "tel-extension"
1549 },
1550 {
1551 "name": "impp"
1552 },
1553 {
1554 "name": "url"
1555 },
1556 {
1557 "name": "photo"
1558 }
1559 ]
1560 },
1561 {
1562 "name": "autocorrect",
1563 "description": "Whether auto correction should be enabled when the user is entering/editing the text value.",
1564 "values": [
1565 {
1566 "name": "off"
1567 },
1568 {
1569 "name": "on"
1570 }
1571 ]
1572 },
1573 {
1574 "name": "autofocus",
1575 "description": "This Boolean attribute lets you specify that a form control should have input focus when the page loads."
1576 },
1577 {
1578 "name": "clear-input",
1579 "description": "If `true`, a clear icon will appear in the input when there is a value. Clicking it clears the input."
1580 },
1581 {
1582 "name": "clear-on-edit",
1583 "description": "If `true`, the value will be cleared after focus upon edit. Defaults to `true` when `type` is `\"password\"`, `false` for all other types."
1584 },
1585 {
1586 "name": "color",
1587 "description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics)."
1588 },
1589 {
1590 "name": "debounce",
1591 "description": "Set the amount of time, in milliseconds, to wait to trigger the `ionChange` event after each keystroke. This also impacts form bindings such as `ngModel` or `v-model`."
1592 },
1593 {
1594 "name": "disabled",
1595 "description": "If `true`, the user cannot interact with the input."
1596 },
1597 {
1598 "name": "enterkeyhint",
1599 "description": "A hint to the browser for which enter key to display.\nPossible values: `\"enter\"`, `\"done\"`, `\"go\"`, `\"next\"`,\n`\"previous\"`, `\"search\"`, and `\"send\"`.",
1600 "values": [
1601 {
1602 "name": "done"
1603 },
1604 {
1605 "name": "enter"
1606 },
1607 {
1608 "name": "go"
1609 },
1610 {
1611 "name": "next"
1612 },
1613 {
1614 "name": "previous"
1615 },
1616 {
1617 "name": "search"
1618 },
1619 {
1620 "name": "send"
1621 }
1622 ]
1623 },
1624 {
1625 "name": "inputmode",
1626 "description": "A hint to the browser for which keyboard to display.\nPossible values: `\"none\"`, `\"text\"`, `\"tel\"`, `\"url\"`,\n`\"email\"`, `\"numeric\"`, `\"decimal\"`, and `\"search\"`.",
1627 "values": [
1628 {
1629 "name": "decimal"
1630 },
1631 {
1632 "name": "email"
1633 },
1634 {
1635 "name": "none"
1636 },
1637 {
1638 "name": "numeric"
1639 },
1640 {
1641 "name": "search"
1642 },
1643 {
1644 "name": "tel"
1645 },
1646 {
1647 "name": "text"
1648 },
1649 {
1650 "name": "url"
1651 }
1652 ]
1653 },
1654 {
1655 "name": "max",
1656 "description": "The maximum value, which must not be less than its minimum (min attribute) value."
1657 },
1658 {
1659 "name": "maxlength",
1660 "description": "If the value of the type attribute is `text`, `email`, `search`, `password`, `tel`, or `url`, this attribute specifies the maximum number of characters that the user can enter."
1661 },
1662 {
1663 "name": "min",
1664 "description": "The minimum value, which must not be greater than its maximum (max attribute) value."
1665 },
1666 {
1667 "name": "minlength",
1668 "description": "If the value of the type attribute is `text`, `email`, `search`, `password`, `tel`, or `url`, this attribute specifies the minimum number of characters that the user can enter."
1669 },
1670 {
1671 "name": "mode",
1672 "description": "The mode determines which platform styles to use.",
1673 "values": [
1674 {
1675 "name": "ios"
1676 },
1677 {
1678 "name": "md"
1679 }
1680 ]
1681 },
1682 {
1683 "name": "multiple",
1684 "description": "If `true`, the user can enter more than one value. This attribute applies when the type attribute is set to `\"email\"` or `\"file\"`, otherwise it is ignored."
1685 },
1686 {
1687 "name": "name",
1688 "description": "The name of the control, which is submitted with the form data."
1689 },
1690 {
1691 "name": "pattern",
1692 "description": "A regular expression that the value is checked against. The pattern must match the entire value, not just some subset. Use the title attribute to describe the pattern to help the user. This attribute applies when the value of the type attribute is `\"text\"`, `\"search\"`, `\"tel\"`, `\"url\"`, `\"email\"`, `\"date\"`, or `\"password\"`, otherwise it is ignored. When the type attribute is `\"date\"`, `pattern` will only be used in browsers that do not support the `\"date\"` input type natively. See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/date for more information."
1693 },
1694 {
1695 "name": "placeholder",
1696 "description": "Instructional text that shows before the input has a value."
1697 },
1698 {
1699 "name": "readonly",
1700 "description": "If `true`, the user cannot modify the value."
1701 },
1702 {
1703 "name": "required",
1704 "description": "If `true`, the user must fill in a value before submitting a form."
1705 },
1706 {
1707 "name": "size",
1708 "description": "The initial size of the control. This value is in pixels unless the value of the type attribute is `\"text\"` or `\"password\"`, in which case it is an integer number of characters. This attribute applies only when the `type` attribute is set to `\"text\"`, `\"search\"`, `\"tel\"`, `\"url\"`, `\"email\"`, or `\"password\"`, otherwise it is ignored."
1709 },
1710 {
1711 "name": "spellcheck",
1712 "description": "If `true`, the element will have its spelling and grammar checked."
1713 },
1714 {
1715 "name": "step",
1716 "description": "Works with the min and max attributes to limit the increments at which a value can be set.\nPossible values are: `\"any\"` or a positive floating point number."
1717 },
1718 {
1719 "name": "type",
1720 "description": "The type of control to display. The default type is text.",
1721 "values": [
1722 {
1723 "name": "date"
1724 },
1725 {
1726 "name": "datetime-local"
1727 },
1728 {
1729 "name": "email"
1730 },
1731 {
1732 "name": "month"
1733 },
1734 {
1735 "name": "number"
1736 },
1737 {
1738 "name": "password"
1739 },
1740 {
1741 "name": "search"
1742 },
1743 {
1744 "name": "tel"
1745 },
1746 {
1747 "name": "text"
1748 },
1749 {
1750 "name": "time"
1751 },
1752 {
1753 "name": "url"
1754 },
1755 {
1756 "name": "week"
1757 }
1758 ]
1759 },
1760 {
1761 "name": "value",
1762 "description": "The value of the input."
1763 }
1764 ],
1765 "references": [
1766 {
1767 "name": "Source code",
1768 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/input/input.tsx"
1769 }
1770 ]
1771 },
1772 {
1773 "name": "ion-item",
1774 "description": {
1775 "kind": "markdown",
1776 "value": "Items are elements that can contain text, icons, avatars, images, inputs, and any other native or custom elements. Generally they are placed in a list with other items. Items can be swiped, deleted, reordered, edited, and more."
1777 },
1778 "attributes": [
1779 {
1780 "name": "button",
1781 "description": "If `true`, a button tag will be rendered and the item will be tappable."
1782 },
1783 {
1784 "name": "color",
1785 "description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics)."
1786 },
1787 {
1788 "name": "detail",
1789 "description": "If `true`, a detail arrow will appear on the item. Defaults to `false` unless the `mode`\nis `ios` and an `href` or `button` property is present."
1790 },
1791 {
1792 "name": "detail-icon",
1793 "description": "The icon to use when `detail` is set to `true`."
1794 },
1795 {
1796 "name": "disabled",
1797 "description": "If `true`, the user cannot interact with the item."
1798 },
1799 {
1800 "name": "download",
1801 "description": "This attribute instructs browsers to download a URL instead of navigating to\nit, so the user will be prompted to save it as a local file. If the attribute\nhas a value, it is used as the pre-filled file name in the Save prompt\n(the user can still change the file name if they want)."
1802 },
1803 {
1804 "name": "href",
1805 "description": "Contains a URL or a URL fragment that the hyperlink points to.\nIf this property is set, an anchor tag will be rendered."
1806 },
1807 {
1808 "name": "lines",
1809 "description": "How the bottom border should be displayed on the item.",
1810 "values": [
1811 {
1812 "name": "full"
1813 },
1814 {
1815 "name": "inset"
1816 },
1817 {
1818 "name": "none"
1819 }
1820 ]
1821 },
1822 {
1823 "name": "mode",
1824 "description": "The mode determines which platform styles to use.",
1825 "values": [
1826 {
1827 "name": "ios"
1828 },
1829 {
1830 "name": "md"
1831 }
1832 ]
1833 },
1834 {
1835 "name": "rel",
1836 "description": "Specifies the relationship of the target object to the link object.\nThe value is a space-separated list of [link types](https://developer.mozilla.org/en-US/docs/Web/HTML/Link_types)."
1837 },
1838 {
1839 "name": "router-direction",
1840 "description": "When using a router, it specifies the transition direction when navigating to\nanother page using `href`.",
1841 "values": [
1842 {
1843 "name": "back"
1844 },
1845 {
1846 "name": "forward"
1847 },
1848 {
1849 "name": "root"
1850 }
1851 ]
1852 },
1853 {
1854 "name": "target",
1855 "description": "Specifies where to display the linked URL.\nOnly applies when an `href` is provided.\nSpecial keywords: `\"_blank\"`, `\"_self\"`, `\"_parent\"`, `\"_top\"`."
1856 },
1857 {
1858 "name": "type",
1859 "description": "The type of the button. Only used when an `onclick` or `button` property is present.",
1860 "values": [
1861 {
1862 "name": "button"
1863 },
1864 {
1865 "name": "reset"
1866 },
1867 {
1868 "name": "submit"
1869 }
1870 ]
1871 }
1872 ],
1873 "references": [
1874 {
1875 "name": "Source code",
1876 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/item/item.tsx"
1877 }
1878 ]
1879 },
1880 {
1881 "name": "ion-item-divider",
1882 "description": {
1883 "kind": "markdown",
1884 "value": "Item Dividers are block elements that can be used to separate items in a list. They are similar to list headers, but instead of being placed at the top of a list, they should go in between groups of items."
1885 },
1886 "attributes": [
1887 {
1888 "name": "color",
1889 "description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics)."
1890 },
1891 {
1892 "name": "mode",
1893 "description": "The mode determines which platform styles to use.",
1894 "values": [
1895 {
1896 "name": "ios"
1897 },
1898 {
1899 "name": "md"
1900 }
1901 ]
1902 },
1903 {
1904 "name": "sticky",
1905 "description": "When it's set to `true`, the item-divider will stay visible when it reaches the top\nof the viewport until the next `ion-item-divider` replaces it.\n\nThis feature relies in `position:sticky`:\nhttps://caniuse.com/#feat=css-sticky"
1906 }
1907 ],
1908 "references": [
1909 {
1910 "name": "Source code",
1911 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/item-divider/item-divider.tsx"
1912 }
1913 ]
1914 },
1915 {
1916 "name": "ion-item-group",
1917 "description": {
1918 "kind": "markdown",
1919 "value": "Item groups are containers that organize similar items together. They can contain item dividers to divide the items into multiple sections. They can also be used to group sliding items."
1920 },
1921 "attributes": [],
1922 "references": [
1923 {
1924 "name": "Source code",
1925 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/item-group/item-group.tsx"
1926 }
1927 ]
1928 },
1929 {
1930 "name": "ion-item-option",
1931 "description": {
1932 "kind": "markdown",
1933 "value": "The option button for an `ion-item-sliding`. Must be placed inside of an `<ion-item-options>`.\nYou can combine the `ionSwipe` event and the `expandable` directive to create a full swipe\naction for the item."
1934 },
1935 "attributes": [
1936 {
1937 "name": "color",
1938 "description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics)."
1939 },
1940 {
1941 "name": "disabled",
1942 "description": "If `true`, the user cannot interact with the item option."
1943 },
1944 {
1945 "name": "download",
1946 "description": "This attribute instructs browsers to download a URL instead of navigating to\nit, so the user will be prompted to save it as a local file. If the attribute\nhas a value, it is used as the pre-filled file name in the Save prompt\n(the user can still change the file name if they want)."
1947 },
1948 {
1949 "name": "expandable",
1950 "description": "If `true`, the option will expand to take up the available width and cover any other options."
1951 },
1952 {
1953 "name": "href",
1954 "description": "Contains a URL or a URL fragment that the hyperlink points to.\nIf this property is set, an anchor tag will be rendered."
1955 },
1956 {
1957 "name": "mode",
1958 "description": "The mode determines which platform styles to use.",
1959 "values": [
1960 {
1961 "name": "ios"
1962 },
1963 {
1964 "name": "md"
1965 }
1966 ]
1967 },
1968 {
1969 "name": "rel",
1970 "description": "Specifies the relationship of the target object to the link object.\nThe value is a space-separated list of [link types](https://developer.mozilla.org/en-US/docs/Web/HTML/Link_types)."
1971 },
1972 {
1973 "name": "target",
1974 "description": "Specifies where to display the linked URL.\nOnly applies when an `href` is provided.\nSpecial keywords: `\"_blank\"`, `\"_self\"`, `\"_parent\"`, `\"_top\"`."
1975 },
1976 {
1977 "name": "type",
1978 "description": "The type of the button.",
1979 "values": [
1980 {
1981 "name": "button"
1982 },
1983 {
1984 "name": "reset"
1985 },
1986 {
1987 "name": "submit"
1988 }
1989 ]
1990 }
1991 ],
1992 "references": [
1993 {
1994 "name": "Source code",
1995 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/item-option/item-option.tsx"
1996 }
1997 ]
1998 },
1999 {
2000 "name": "ion-item-options",
2001 "description": {
2002 "kind": "markdown",
2003 "value": "The option buttons for an `ion-item-sliding`. These buttons can be placed either on the [start or end side](#side-description).\nYou can combine the `ionSwipe` event plus the `expandable` directive to create a full swipe action for the item."
2004 },
2005 "attributes": [
2006 {
2007 "name": "side",
2008 "description": "The side the option button should be on. Possible values: `\"start\"` and `\"end\"`. If you have multiple `ion-item-options`, a side must be provided for each.",
2009 "values": [
2010 {
2011 "name": "end"
2012 },
2013 {
2014 "name": "start"
2015 }
2016 ]
2017 }
2018 ],
2019 "references": [
2020 {
2021 "name": "Source code",
2022 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/item-options/item-options.tsx"
2023 }
2024 ]
2025 },
2026 {
2027 "name": "ion-item-sliding",
2028 "description": {
2029 "kind": "markdown",
2030 "value": "A sliding item contains an item that can be dragged to reveal buttons. It requires an [item](../item) component as a child. All options to reveal should be placed in the [item options](../item-options) element."
2031 },
2032 "attributes": [
2033 {
2034 "name": "disabled",
2035 "description": "If `true`, the user cannot interact with the sliding item."
2036 }
2037 ],
2038 "references": [
2039 {
2040 "name": "Source code",
2041 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/item-sliding/item-sliding.tsx"
2042 }
2043 ]
2044 },
2045 {
2046 "name": "ion-label",
2047 "description": {
2048 "kind": "markdown",
2049 "value": "Label is a wrapper element that can be used in combination with `ion-item`, `ion-input`, `ion-toggle`, and more. The position of the label inside of an item can be inline, fixed, stacked, or floating."
2050 },
2051 "attributes": [
2052 {
2053 "name": "color",
2054 "description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics)."
2055 },
2056 {
2057 "name": "mode",
2058 "description": "The mode determines which platform styles to use.",
2059 "values": [
2060 {
2061 "name": "ios"
2062 },
2063 {
2064 "name": "md"
2065 }
2066 ]
2067 },
2068 {
2069 "name": "position",
2070 "description": "The position determines where and how the label behaves inside an item.",
2071 "values": [
2072 {
2073 "name": "fixed"
2074 },
2075 {
2076 "name": "floating"
2077 },
2078 {
2079 "name": "stacked"
2080 }
2081 ]
2082 }
2083 ],
2084 "references": [
2085 {
2086 "name": "Source code",
2087 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/label/label.tsx"
2088 }
2089 ]
2090 },
2091 {
2092 "name": "ion-list",
2093 "description": {
2094 "kind": "markdown",
2095 "value": "Lists are made up of multiple rows of items which can contain text, buttons, toggles,\nicons, thumbnails, and much more. Lists generally contain items with similar data content, such as images and text.\n\nLists support several interactions including swiping items to reveal options, dragging to reorder items within the list, and deleting items."
2096 },
2097 "attributes": [
2098 {
2099 "name": "inset",
2100 "description": "If `true`, the list will have margin around it and rounded corners."
2101 },
2102 {
2103 "name": "lines",
2104 "description": "How the bottom border should be displayed on all items.",
2105 "values": [
2106 {
2107 "name": "full"
2108 },
2109 {
2110 "name": "inset"
2111 },
2112 {
2113 "name": "none"
2114 }
2115 ]
2116 },
2117 {
2118 "name": "mode",
2119 "description": "The mode determines which platform styles to use.",
2120 "values": [
2121 {
2122 "name": "ios"
2123 },
2124 {
2125 "name": "md"
2126 }
2127 ]
2128 }
2129 ],
2130 "references": [
2131 {
2132 "name": "Source code",
2133 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/list/list.tsx"
2134 }
2135 ]
2136 },
2137 {
2138 "name": "ion-list-header",
2139 "description": {
2140 "kind": "markdown",
2141 "value": "ListHeader a header component for a list.\nUnlike ItemDivider, ListHeaders are styled to be stand-out from the rest of the list items."
2142 },
2143 "attributes": [
2144 {
2145 "name": "color",
2146 "description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics)."
2147 },
2148 {
2149 "name": "lines",
2150 "description": "How the bottom border should be displayed on the list header.",
2151 "values": [
2152 {
2153 "name": "full"
2154 },
2155 {
2156 "name": "inset"
2157 },
2158 {
2159 "name": "none"
2160 }
2161 ]
2162 },
2163 {
2164 "name": "mode",
2165 "description": "The mode determines which platform styles to use.",
2166 "values": [
2167 {
2168 "name": "ios"
2169 },
2170 {
2171 "name": "md"
2172 }
2173 ]
2174 }
2175 ],
2176 "references": [
2177 {
2178 "name": "Source code",
2179 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/list-header/list-header.tsx"
2180 }
2181 ]
2182 },
2183 {
2184 "name": "ion-loading",
2185 "description": {
2186 "kind": "markdown",
2187 "value": "An overlay that can be used to indicate activity while blocking user interaction. The loading indicator appears on top of the app's content, and can be dismissed by the app to resume user interaction with the app. It includes an optional backdrop, which can be disabled by setting `showBackdrop: false` upon creation."
2188 },
2189 "attributes": [
2190 {
2191 "name": "animated",
2192 "description": "If `true`, the loading indicator will animate."
2193 },
2194 {
2195 "name": "backdrop-dismiss",
2196 "description": "If `true`, the loading indicator will be dismissed when the backdrop is clicked."
2197 },
2198 {
2199 "name": "css-class",
2200 "description": "Additional classes to apply for custom CSS. If multiple classes are\nprovided they should be separated by spaces."
2201 },
2202 {
2203 "name": "duration",
2204 "description": "Number of milliseconds to wait before dismissing the loading indicator."
2205 },
2206 {
2207 "name": "keyboard-close",
2208 "description": "If `true`, the keyboard will be automatically dismissed when the overlay is presented."
2209 },
2210 {
2211 "name": "message",
2212 "description": "Optional text content to display in the loading indicator."
2213 },
2214 {
2215 "name": "mode",
2216 "description": "The mode determines which platform styles to use.",
2217 "values": [
2218 {
2219 "name": "ios"
2220 },
2221 {
2222 "name": "md"
2223 }
2224 ]
2225 },
2226 {
2227 "name": "show-backdrop",
2228 "description": "If `true`, a backdrop will be displayed behind the loading indicator."
2229 },
2230 {
2231 "name": "spinner",
2232 "description": "The name of the spinner to display.",
2233 "values": [
2234 {
2235 "name": "bubbles"
2236 },
2237 {
2238 "name": "circles"
2239 },
2240 {
2241 "name": "circular"
2242 },
2243 {
2244 "name": "crescent"
2245 },
2246 {
2247 "name": "dots"
2248 },
2249 {
2250 "name": "lines"
2251 },
2252 {
2253 "name": "lines-small"
2254 }
2255 ]
2256 },
2257 {
2258 "name": "translucent",
2259 "description": "If `true`, the loading indicator will be translucent.\nOnly applies when the mode is `\"ios\"` and the device supports\n[`backdrop-filter`](https://developer.mozilla.org/en-US/docs/Web/CSS/backdrop-filter#Browser_compatibility)."
2260 }
2261 ],
2262 "references": [
2263 {
2264 "name": "Source code",
2265 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/loading/loading.tsx"
2266 }
2267 ]
2268 },
2269 {
2270 "name": "ion-menu",
2271 "description": {
2272 "kind": "markdown",
2273 "value": "The Menu component is a navigation drawer that slides in from the side of the current view.\nBy default, it slides in from the left, but the side can be overridden.\nThe menu will be displayed differently based on the mode, however the display type can be changed to any of the available menu types.\nThe menu element should be a sibling to the root content element.\nThere can be any number of menus attached to the content.\nThese can be controlled from the templates, or programmatically using the MenuController."
2274 },
2275 "attributes": [
2276 {
2277 "name": "content-id",
2278 "description": "The `id` of the main content. When using\na router this is typically `ion-router-outlet`.\nWhen not using a router, this is typically\nyour main view's `ion-content`. This is not the\nid of the `ion-content` inside of your `ion-menu`."
2279 },
2280 {
2281 "name": "disabled",
2282 "description": "If `true`, the menu is disabled."
2283 },
2284 {
2285 "name": "max-edge-start",
2286 "description": "The edge threshold for dragging the menu open.\nIf a drag/swipe happens over this value, the menu is not triggered."
2287 },
2288 {
2289 "name": "menu-id",
2290 "description": "An id for the menu."
2291 },
2292 {
2293 "name": "side",
2294 "description": "Which side of the view the menu should be placed.",
2295 "values": [
2296 {
2297 "name": "end"
2298 },
2299 {
2300 "name": "start"
2301 }
2302 ]
2303 },
2304 {
2305 "name": "swipe-gesture",
2306 "description": "If `true`, swiping the menu is enabled."
2307 },
2308 {
2309 "name": "type",
2310 "description": "The display type of the menu.\nAvailable options: `\"overlay\"`, `\"reveal\"`, `\"push\"`."
2311 }
2312 ],
2313 "references": [
2314 {
2315 "name": "Source code",
2316 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/menu/menu.tsx"
2317 }
2318 ]
2319 },
2320 {
2321 "name": "ion-menu-button",
2322 "description": {
2323 "kind": "markdown",
2324 "value": "Menu Button is component that automatically creates the icon and functionality to open a menu on a page."
2325 },
2326 "attributes": [
2327 {
2328 "name": "auto-hide",
2329 "description": "Automatically hides the menu button when the corresponding menu is not active"
2330 },
2331 {
2332 "name": "color",
2333 "description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics)."
2334 },
2335 {
2336 "name": "disabled",
2337 "description": "If `true`, the user cannot interact with the menu button."
2338 },
2339 {
2340 "name": "menu",
2341 "description": "Optional property that maps to a Menu's `menuId` prop. Can also be `start` or `end` for the menu side. This is used to find the correct menu to toggle"
2342 },
2343 {
2344 "name": "mode",
2345 "description": "The mode determines which platform styles to use.",
2346 "values": [
2347 {
2348 "name": "ios"
2349 },
2350 {
2351 "name": "md"
2352 }
2353 ]
2354 },
2355 {
2356 "name": "type",
2357 "description": "The type of the button.",
2358 "values": [
2359 {
2360 "name": "button"
2361 },
2362 {
2363 "name": "reset"
2364 },
2365 {
2366 "name": "submit"
2367 }
2368 ]
2369 }
2370 ],
2371 "references": [
2372 {
2373 "name": "Source code",
2374 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/menu-button/menu-button.tsx"
2375 }
2376 ]
2377 },
2378 {
2379 "name": "ion-menu-toggle",
2380 "description": {
2381 "kind": "markdown",
2382 "value": "The MenuToggle component can be used to toggle a menu open or closed.\n\nBy default, it's only visible when the selected menu is active. A menu is active when it can be opened/closed. If the menu is disabled or it's being presented as a split-pane, the menu is marked as non-active and ion-menu-toggle hides itself.\n\nIn case it's desired to keep `ion-menu-toggle` always visible, the `autoHide` property can be set to `false`."
2383 },
2384 "attributes": [
2385 {
2386 "name": "auto-hide",
2387 "description": "Automatically hides the content when the corresponding menu is not active.\n\nBy default, it's `true`. Change it to `false` in order to\nkeep `ion-menu-toggle` always visible regardless the state of the menu."
2388 },
2389 {
2390 "name": "menu",
2391 "description": "Optional property that maps to a Menu's `menuId` prop.\nCan also be `start` or `end` for the menu side.\nThis is used to find the correct menu to toggle.\n\nIf this property is not used, `ion-menu-toggle` will toggle the\nfirst menu that is active."
2392 }
2393 ],
2394 "references": [
2395 {
2396 "name": "Source code",
2397 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/menu-toggle/menu-toggle.tsx"
2398 }
2399 ]
2400 },
2401 {
2402 "name": "ion-modal",
2403 "description": {
2404 "kind": "markdown",
2405 "value": "A Modal is a dialog that appears on top of the app's content, and must be dismissed by the app before interaction can resume. It is useful as a select component when there are a lot of options to choose from, or when filtering items in a list, as well as many other use cases."
2406 },
2407 "attributes": [
2408 {
2409 "name": "animated",
2410 "description": "If `true`, the modal will animate."
2411 },
2412 {
2413 "name": "backdrop-dismiss",
2414 "description": "If `true`, the modal will be dismissed when the backdrop is clicked."
2415 },
2416 {
2417 "name": "component",
2418 "description": "The component to display inside of the modal."
2419 },
2420 {
2421 "name": "css-class",
2422 "description": "Additional classes to apply for custom CSS. If multiple classes are\nprovided they should be separated by spaces."
2423 },
2424 {
2425 "name": "keyboard-close",
2426 "description": "If `true`, the keyboard will be automatically dismissed when the overlay is presented."
2427 },
2428 {
2429 "name": "mode",
2430 "description": "The mode determines which platform styles to use.",
2431 "values": [
2432 {
2433 "name": "ios"
2434 },
2435 {
2436 "name": "md"
2437 }
2438 ]
2439 },
2440 {
2441 "name": "show-backdrop",
2442 "description": "If `true`, a backdrop will be displayed behind the modal."
2443 },
2444 {
2445 "name": "swipe-to-close",
2446 "description": "If `true`, the modal can be swiped to dismiss. Only applies in iOS mode."
2447 }
2448 ],
2449 "references": [
2450 {
2451 "name": "Source code",
2452 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/modal/modal.tsx"
2453 }
2454 ]
2455 },
2456 {
2457 "name": "ion-nav",
2458 "description": {
2459 "kind": "markdown",
2460 "value": "Nav is a standalone component for loading arbitrary components and pushing new components on to the stack.\n\nUnlike Router Outlet, Nav is not tied to a particular router. This means that if we load a Nav component, and push other components to the stack, they will not affect the app's overall router. This fits use cases where you could have a modal, which needs its own sub-navigation, without making it tied to the apps URL."
2461 },
2462 "attributes": [
2463 {
2464 "name": "animated",
2465 "description": "If `true`, the nav should animate the transition of components."
2466 },
2467 {
2468 "name": "root",
2469 "description": "Root NavComponent to load"
2470 },
2471 {
2472 "name": "swipe-gesture",
2473 "description": "If the nav component should allow for swipe-to-go-back."
2474 }
2475 ],
2476 "references": [
2477 {
2478 "name": "Source code",
2479 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/nav/nav.tsx"
2480 }
2481 ]
2482 },
2483 {
2484 "name": "ion-nav-link",
2485 "description": {
2486 "kind": "markdown",
2487 "value": "A navigation link is used to navigate to a specified component. The component can be navigated to by going `forward`, `back` or as a `root` component.\n\nIt is the element form of calling the `push()`, `pop()`, and `setRoot()` methods on the navigation controller."
2488 },
2489 "attributes": [
2490 {
2491 "name": "component",
2492 "description": "Component to navigate to. Only used if the `routerDirection` is `\"forward\"` or `\"root\"`."
2493 },
2494 {
2495 "name": "router-direction",
2496 "description": "The transition direction when navigating to another page.",
2497 "values": [
2498 {
2499 "name": "back"
2500 },
2501 {
2502 "name": "forward"
2503 },
2504 {
2505 "name": "root"
2506 }
2507 ]
2508 }
2509 ],
2510 "references": [
2511 {
2512 "name": "Source code",
2513 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/nav-link/nav-link.tsx"
2514 }
2515 ]
2516 },
2517 {
2518 "name": "ion-note",
2519 "description": {
2520 "kind": "markdown",
2521 "value": "Notes are text elements generally used as subtitles that provide more information. Notes are styled to appear grey by default. Notes can be used in an item as metadata text."
2522 },
2523 "attributes": [
2524 {
2525 "name": "color",
2526 "description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics)."
2527 },
2528 {
2529 "name": "mode",
2530 "description": "The mode determines which platform styles to use.",
2531 "values": [
2532 {
2533 "name": "ios"
2534 },
2535 {
2536 "name": "md"
2537 }
2538 ]
2539 }
2540 ],
2541 "references": [
2542 {
2543 "name": "Source code",
2544 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/note/note.tsx"
2545 }
2546 ]
2547 },
2548 {
2549 "name": "ion-picker",
2550 "description": {
2551 "kind": "markdown",
2552 "value": "A Picker is a dialog that displays a row of buttons and columns underneath. It appears on top of the app's content, and at the bottom of the viewport."
2553 },
2554 "attributes": [
2555 {
2556 "name": "animated",
2557 "description": "If `true`, the picker will animate."
2558 },
2559 {
2560 "name": "backdrop-dismiss",
2561 "description": "If `true`, the picker will be dismissed when the backdrop is clicked."
2562 },
2563 {
2564 "name": "css-class",
2565 "description": "Additional classes to apply for custom CSS. If multiple classes are\nprovided they should be separated by spaces."
2566 },
2567 {
2568 "name": "duration",
2569 "description": "Number of milliseconds to wait before dismissing the picker."
2570 },
2571 {
2572 "name": "keyboard-close",
2573 "description": "If `true`, the keyboard will be automatically dismissed when the overlay is presented."
2574 },
2575 {
2576 "name": "mode",
2577 "description": "The mode determines which platform styles to use.",
2578 "values": [
2579 {
2580 "name": "ios"
2581 },
2582 {
2583 "name": "md"
2584 }
2585 ]
2586 },
2587 {
2588 "name": "show-backdrop",
2589 "description": "If `true`, a backdrop will be displayed behind the picker."
2590 }
2591 ],
2592 "references": [
2593 {
2594 "name": "Source code",
2595 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/picker/picker.tsx"
2596 }
2597 ]
2598 },
2599 {
2600 "name": "ion-popover",
2601 "description": {
2602 "kind": "markdown",
2603 "value": "A Popover is a dialog that appears on top of the current page. It can be used for anything, but generally it is used for overflow actions that don't fit in the navigation bar."
2604 },
2605 "attributes": [
2606 {
2607 "name": "animated",
2608 "description": "If `true`, the popover will animate."
2609 },
2610 {
2611 "name": "backdrop-dismiss",
2612 "description": "If `true`, the popover will be dismissed when the backdrop is clicked."
2613 },
2614 {
2615 "name": "component",
2616 "description": "The component to display inside of the popover."
2617 },
2618 {
2619 "name": "css-class",
2620 "description": "Additional classes to apply for custom CSS. If multiple classes are\nprovided they should be separated by spaces."
2621 },
2622 {
2623 "name": "event",
2624 "description": "The event to pass to the popover animation."
2625 },
2626 {
2627 "name": "keyboard-close",
2628 "description": "If `true`, the keyboard will be automatically dismissed when the overlay is presented."
2629 },
2630 {
2631 "name": "mode",
2632 "description": "The mode determines which platform styles to use.",
2633 "values": [
2634 {
2635 "name": "ios"
2636 },
2637 {
2638 "name": "md"
2639 }
2640 ]
2641 },
2642 {
2643 "name": "show-backdrop",
2644 "description": "If `true`, a backdrop will be displayed behind the popover."
2645 },
2646 {
2647 "name": "translucent",
2648 "description": "If `true`, the popover will be translucent.\nOnly applies when the mode is `\"ios\"` and the device supports\n[`backdrop-filter`](https://developer.mozilla.org/en-US/docs/Web/CSS/backdrop-filter#Browser_compatibility)."
2649 }
2650 ],
2651 "references": [
2652 {
2653 "name": "Source code",
2654 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/popover/popover.tsx"
2655 }
2656 ]
2657 },
2658 {
2659 "name": "ion-progress-bar",
2660 "description": {
2661 "kind": "markdown",
2662 "value": "Progress bars inform users about the status of ongoing processes, such as loading an app, submitting a form, or saving updates. There are two types of progress bars: `determinate` and `indeterminate`."
2663 },
2664 "attributes": [
2665 {
2666 "name": "buffer",
2667 "description": "If the buffer and value are smaller than 1, the buffer circles will show.\nThe buffer should be between [0, 1]."
2668 },
2669 {
2670 "name": "color",
2671 "description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics)."
2672 },
2673 {
2674 "name": "mode",
2675 "description": "The mode determines which platform styles to use.",
2676 "values": [
2677 {
2678 "name": "ios"
2679 },
2680 {
2681 "name": "md"
2682 }
2683 ]
2684 },
2685 {
2686 "name": "reversed",
2687 "description": "If true, reverse the progress bar direction."
2688 },
2689 {
2690 "name": "type",
2691 "description": "The state of the progress bar, based on if the time the process takes is known or not.\nDefault options are: `\"determinate\"` (no animation), `\"indeterminate\"` (animate from left to right).",
2692 "values": [
2693 {
2694 "name": "determinate"
2695 },
2696 {
2697 "name": "indeterminate"
2698 }
2699 ]
2700 },
2701 {
2702 "name": "value",
2703 "description": "The value determines how much of the active bar should display when the\n`type` is `\"determinate\"`.\nThe value should be between [0, 1]."
2704 }
2705 ],
2706 "references": [
2707 {
2708 "name": "Source code",
2709 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/progress-bar/progress-bar.tsx"
2710 }
2711 ]
2712 },
2713 {
2714 "name": "ion-radio",
2715 "description": {
2716 "kind": "markdown",
2717 "value": "Radios should be used inside of an [`ion-radio-group`](../radio-group). Pressing on a radio will check it. They can also be checked programmatically by setting the value property of the parent `ion-radio-group` to the value of the radio.\n\nWhen radios are inside of a radio group, only one radio in the group will be checked at any time. Pressing a radio will check it and uncheck the previously selected radio, if there is one. If a radio is not in a group with another radio, then both radios will have the ability to be checked at the same time."
2718 },
2719 "attributes": [
2720 {
2721 "name": "color",
2722 "description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics)."
2723 },
2724 {
2725 "name": "disabled",
2726 "description": "If `true`, the user cannot interact with the radio."
2727 },
2728 {
2729 "name": "mode",
2730 "description": "The mode determines which platform styles to use.",
2731 "values": [
2732 {
2733 "name": "ios"
2734 },
2735 {
2736 "name": "md"
2737 }
2738 ]
2739 },
2740 {
2741 "name": "name",
2742 "description": "The name of the control, which is submitted with the form data."
2743 },
2744 {
2745 "name": "value",
2746 "description": "the value of the radio."
2747 }
2748 ],
2749 "references": [
2750 {
2751 "name": "Source code",
2752 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/radio/radio.tsx"
2753 }
2754 ]
2755 },
2756 {
2757 "name": "ion-radio-group",
2758 "description": {
2759 "kind": "markdown",
2760 "value": "A radio group is a group of [radio buttons](../radio). It allows\na user to select at most one radio button from a set. Checking one radio\nbutton that belongs to a radio group unchecks any previous checked\nradio button within the same group."
2761 },
2762 "attributes": [
2763 {
2764 "name": "allow-empty-selection",
2765 "description": "If `true`, the radios can be deselected."
2766 },
2767 {
2768 "name": "name",
2769 "description": "The name of the control, which is submitted with the form data."
2770 },
2771 {
2772 "name": "value",
2773 "description": "the value of the radio group."
2774 }
2775 ],
2776 "references": [
2777 {
2778 "name": "Source code",
2779 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/radio-group/radio-group.tsx"
2780 }
2781 ]
2782 },
2783 {
2784 "name": "ion-range",
2785 "description": {
2786 "kind": "markdown",
2787 "value": "The Range slider lets users select from a range of values by moving\nthe slider knob. It can accept dual knobs, but by default one knob\ncontrols the value of the range."
2788 },
2789 "attributes": [
2790 {
2791 "name": "color",
2792 "description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics)."
2793 },
2794 {
2795 "name": "debounce",
2796 "description": "How long, in milliseconds, to wait to trigger the\n`ionChange` event after each change in the range value.\nThis also impacts form bindings such as `ngModel` or `v-model`."
2797 },
2798 {
2799 "name": "disabled",
2800 "description": "If `true`, the user cannot interact with the range."
2801 },
2802 {
2803 "name": "dual-knobs",
2804 "description": "Show two knobs."
2805 },
2806 {
2807 "name": "max",
2808 "description": "Maximum integer value of the range."
2809 },
2810 {
2811 "name": "min",
2812 "description": "Minimum integer value of the range."
2813 },
2814 {
2815 "name": "mode",
2816 "description": "The mode determines which platform styles to use.",
2817 "values": [
2818 {
2819 "name": "ios"
2820 },
2821 {
2822 "name": "md"
2823 }
2824 ]
2825 },
2826 {
2827 "name": "name",
2828 "description": "The name of the control, which is submitted with the form data."
2829 },
2830 {
2831 "name": "pin",
2832 "description": "If `true`, a pin with integer value is shown when the knob\nis pressed."
2833 },
2834 {
2835 "name": "snaps",
2836 "description": "If `true`, the knob snaps to tick marks evenly spaced based\non the step property value."
2837 },
2838 {
2839 "name": "step",
2840 "description": "Specifies the value granularity."
2841 },
2842 {
2843 "name": "ticks",
2844 "description": "If `true`, tick marks are displayed based on the step value.\nOnly applies when `snaps` is `true`."
2845 },
2846 {
2847 "name": "value",
2848 "description": "the value of the range."
2849 }
2850 ],
2851 "references": [
2852 {
2853 "name": "Source code",
2854 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/range/range.tsx"
2855 }
2856 ]
2857 },
2858 {
2859 "name": "ion-refresher",
2860 "description": {
2861 "kind": "markdown",
2862 "value": "The refresher provides pull-to-refresh functionality on a content component.\nThe pull-to-refresh pattern lets a user pull down on a list of data using touch\nin order to retrieve more data.\n\nData should be modified during the refresher's output events. Once the async\noperation has completed and the refreshing should end, call `complete()` on the\nrefresher."
2863 },
2864 "attributes": [
2865 {
2866 "name": "close-duration",
2867 "description": "Time it takes to close the refresher.\nDoes not apply when the refresher content uses a spinner,\nenabling the native refresher."
2868 },
2869 {
2870 "name": "disabled",
2871 "description": "If `true`, the refresher will be hidden."
2872 },
2873 {
2874 "name": "pull-factor",
2875 "description": "How much to multiply the pull speed by. To slow the pull animation down,\npass a number less than `1`. To speed up the pull, pass a number greater\nthan `1`. The default value is `1` which is equal to the speed of the cursor.\nIf a negative value is passed in, the factor will be `1` instead.\n\nFor example: If the value passed is `1.2` and the content is dragged by\n`10` pixels, instead of `10` pixels the content will be pulled by `12` pixels\n(an increase of 20 percent). If the value passed is `0.8`, the dragged amount\nwill be `8` pixels, less than the amount the cursor has moved.\n\nDoes not apply when the refresher content uses a spinner,\nenabling the native refresher."
2876 },
2877 {
2878 "name": "pull-max",
2879 "description": "The maximum distance of the pull until the refresher\nwill automatically go into the `refreshing` state.\nDefaults to the result of `pullMin + 60`.\nDoes not apply when the refresher content uses a spinner,\nenabling the native refresher."
2880 },
2881 {
2882 "name": "pull-min",
2883 "description": "The minimum distance the user must pull down until the\nrefresher will go into the `refreshing` state.\nDoes not apply when the refresher content uses a spinner,\nenabling the native refresher."
2884 },
2885 {
2886 "name": "snapback-duration",
2887 "description": "Time it takes the refresher to to snap back to the `refreshing` state.\nDoes not apply when the refresher content uses a spinner,\nenabling the native refresher."
2888 }
2889 ],
2890 "references": [
2891 {
2892 "name": "Source code",
2893 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/refresher/refresher.tsx"
2894 }
2895 ]
2896 },
2897 {
2898 "name": "ion-refresher-content",
2899 "description": {
2900 "kind": "markdown",
2901 "value": "The refresher content contains the text, icon and spinner to display during a pull-to-refresh. Ionic provides the pulling icon and refreshing spinner based on the platform. However, the default icon, spinner, and text can be customized based on the state of the refresher."
2902 },
2903 "attributes": [
2904 {
2905 "name": "pulling-icon",
2906 "description": "A static icon or a spinner to display when you begin to pull down.\nA spinner name can be provided to gradually show tick marks\nwhen pulling down on iOS devices."
2907 },
2908 {
2909 "name": "pulling-text",
2910 "description": "The text you want to display when you begin to pull down.\n`pullingText` can accept either plaintext or HTML as a string.\nTo display characters normally reserved for HTML, they\nmust be escaped. For example `<Ionic>` would become\n`&lt;Ionic&gt;`\n\nFor more information: [Security Documentation](https://ionicframework.com/docs/faq/security)"
2911 },
2912 {
2913 "name": "refreshing-spinner",
2914 "description": "An animated SVG spinner that shows when refreshing begins",
2915 "values": [
2916 {
2917 "name": "bubbles"
2918 },
2919 {
2920 "name": "circles"
2921 },
2922 {
2923 "name": "circular"
2924 },
2925 {
2926 "name": "crescent"
2927 },
2928 {
2929 "name": "dots"
2930 },
2931 {
2932 "name": "lines"
2933 },
2934 {
2935 "name": "lines-small"
2936 }
2937 ]
2938 },
2939 {
2940 "name": "refreshing-text",
2941 "description": "The text you want to display when performing a refresh.\n`refreshingText` can accept either plaintext or HTML as a string.\nTo display characters normally reserved for HTML, they\nmust be escaped. For example `<Ionic>` would become\n`&lt;Ionic&gt;`\n\nFor more information: [Security Documentation](https://ionicframework.com/docs/faq/security)"
2942 }
2943 ],
2944 "references": [
2945 {
2946 "name": "Source code",
2947 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/refresher-content/refresher-content.tsx"
2948 }
2949 ]
2950 },
2951 {
2952 "name": "ion-reorder",
2953 "description": {
2954 "kind": "markdown",
2955 "value": "Reorder is a component that allows an item in a group of items to be dragged to change its order within that group. It must be used within an `ion-reorder-group` to provide a visual drag and drop interface.\n\n`ion-reorder` is the anchor used to drag and drop the items inside of the `ion-reorder-group`. See the [Reorder Group](../reorder-group) for more information on how to complete the reorder operation."
2956 },
2957 "attributes": [],
2958 "references": [
2959 {
2960 "name": "Source code",
2961 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/reorder/reorder.tsx"
2962 }
2963 ]
2964 },
2965 {
2966 "name": "ion-reorder-group",
2967 "description": {
2968 "kind": "markdown",
2969 "value": "The reorder group is a wrapper component for items using the `ion-reorder` component. See the [Reorder documentation](../reorder/) for further information about the anchor component that is used to drag items within the `ion-reorder-group`.\n\nOnce the user drags an item and drops it in a new position, the `ionItemReorder` event is dispatched. A handler for it should be implemented that calls the `complete()` method.\n\nThe `detail` property of the `ionItemReorder` event includes all of the relevant information about the reorder operation, including the `from` and `to` indexes. In the context of reordering, an item moves `from` an index `to` a new index."
2970 },
2971 "attributes": [
2972 {
2973 "name": "disabled",
2974 "description": "If `true`, the reorder will be hidden."
2975 }
2976 ],
2977 "references": [
2978 {
2979 "name": "Source code",
2980 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/reorder-group/reorder-group.tsx"
2981 }
2982 ]
2983 },
2984 {
2985 "name": "ion-ripple-effect",
2986 "description": {
2987 "kind": "markdown",
2988 "value": "The ripple effect component adds the [Material Design ink ripple interaction effect](https://material.io/develop/web/components/ripples/). This component can only be used inside of an `<ion-app>` and can be added to any component.\n\nIt's important to note that the parent should have [relative positioning](https://developer.mozilla.org/en-US/docs/Web/CSS/position) because the ripple effect is absolutely positioned and will cover the closest parent with relative positioning. The parent element should also be given the `ion-activatable` class, which tells the ripple effect that the element is clickable.\n\nThe default type, `\"bounded\"`, will expand the ripple effect from the click position outwards. To add a ripple effect that always starts in the center of the element and expands in a circle, add an `\"unbounded\"` type. It's recommended to add `overflow: hidden` to the parent element to avoid the ripple overflowing its container, especially with an unbounded ripple."
2989 },
2990 "attributes": [
2991 {
2992 "name": "type",
2993 "description": "Sets the type of ripple-effect:\n\n- `bounded`: the ripple effect expands from the user's click position\n- `unbounded`: the ripple effect expands from the center of the button and overflows the container.\n\nNOTE: Surfaces for bounded ripples should have the overflow property set to hidden,\nwhile surfaces for unbounded ripples should have it set to visible.",
2994 "values": [
2995 {
2996 "name": "bounded"
2997 },
2998 {
2999 "name": "unbounded"
3000 }
3001 ]
3002 }
3003 ],
3004 "references": [
3005 {
3006 "name": "Source code",
3007 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/ripple-effect/ripple-effect.tsx"
3008 }
3009 ]
3010 },
3011 {
3012 "name": "ion-route",
3013 "description": {
3014 "kind": "markdown",
3015 "value": "The route component takes a component and renders it when the Browser URL matches the url property.\n\n> Note: this component should only be used with vanilla and Stencil JavaScript projects. For Angular projects, use [`ion-router-outlet`](../router-outlet) and the Angular router."
3016 },
3017 "attributes": [
3018 {
3019 "name": "component",
3020 "description": "Name of the component to load/select in the navigation outlet (`ion-tabs`, `ion-nav`)\nwhen the route matches.\n\nThe value of this property is not always the tagname of the component to load,\nin `ion-tabs` it actually refers to the name of the `ion-tab` to select."
3021 },
3022 {
3023 "name": "url",
3024 "description": "Relative path that needs to match in order for this route to apply.\n\nAccepts paths similar to expressjs so that you can define parameters\nin the url /foo/:bar where bar would be available in incoming props."
3025 }
3026 ],
3027 "references": [
3028 {
3029 "name": "Source code",
3030 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/route/route.tsx"
3031 }
3032 ]
3033 },
3034 {
3035 "name": "ion-route-redirect",
3036 "description": {
3037 "kind": "markdown",
3038 "value": "A route redirect can only be used with an `ion-router` as a direct child of it.\n\n> Note: this component should only be used with vanilla and Stencil JavaScript projects. For Angular projects, use [`ion-router-outlet`](../router-outlet) and the Angular router.\n\nThe route redirect has two configurable properties:\n - `from`\n - `to`\n\nIt redirects \"from\" a URL \"to\" another URL. When the defined `ion-route-redirect` rule matches, the router will redirect from the path specified in the `from` property to the path in the `to` property. In order for a redirect to occur the `from` path needs to be an exact match to the navigated URL."
3039 },
3040 "attributes": [
3041 {
3042 "name": "from",
3043 "description": "A redirect route, redirects \"from\" a URL \"to\" another URL. This property is that \"from\" URL.\nIt needs to be an exact match of the navigated URL in order to apply.\n\nThe path specified in this value is always an absolute path, even if the initial `/` slash\nis not specified."
3044 },
3045 {
3046 "name": "to",
3047 "description": "A redirect route, redirects \"from\" a URL \"to\" another URL. This property is that \"to\" URL.\nWhen the defined `ion-route-redirect` rule matches, the router will redirect to the path\nspecified in this property.\n\nThe value of this property is always an absolute path inside the scope of routes defined in\n`ion-router` it can't be used with another router or to perform a redirection to a different domain.\n\nNote that this is a virtual redirect, it will not cause a real browser refresh, again, it's\na redirect inside the context of ion-router.\n\nWhen this property is not specified or his value is `undefined` the whole redirect route is noop,\neven if the \"from\" value matches."
3048 }
3049 ],
3050 "references": [
3051 {
3052 "name": "Source code",
3053 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/route-redirect/route-redirect.tsx"
3054 }
3055 ]
3056 },
3057 {
3058 "name": "ion-router",
3059 "description": {
3060 "kind": "markdown",
3061 "value": "The router is a component for handling routing inside vanilla and Stencil JavaScript projects.\n\n> Note: this component should only be used with vanilla and Stencil JavaScript projects. For Angular projects, use [`ion-router-outlet`](../router-outlet) and the Angular router.\n\nApps should have a single `ion-router` component in the codebase.\nThis component controls all interactions with the browser history and it aggregates updates through an event system.\n\n`ion-router` is just a URL coordinator for the navigation outlets of ionic: `ion-nav` and `ion-tabs`.\n\nThat means the `ion-router` never touches the DOM, it does NOT show the components or emit any kind of lifecycle events, it just tells `ion-nav` and `ion-tabs` what and when to \"show\" based on the browser's URL.\n\nIn order to configure this relationship between components (to load/select) and URLs, `ion-router` uses a declarative syntax using JSX/HTML to define a tree of routes."
3062 },
3063 "attributes": [
3064 {
3065 "name": "root",
3066 "description": "By default `ion-router` will match the routes at the root path (\"/\").\nThat can be changed when"
3067 },
3068 {
3069 "name": "use-hash",
3070 "description": "The router can work in two \"modes\":\n- With hash: `/index.html#/path/to/page`\n- Without hash: `/path/to/page`\n\nUsing one or another might depend in the requirements of your app and/or where it's deployed.\n\nUsually \"hash-less\" navigation works better for SEO and it's more user friendly too, but it might\nrequires additional server-side configuration in order to properly work.\n\nOn the other side hash-navigation is much easier to deploy, it even works over the file protocol.\n\nBy default, this property is `true`, change to `false` to allow hash-less URLs."
3071 }
3072 ],
3073 "references": [
3074 {
3075 "name": "Source code",
3076 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/router/router.tsx"
3077 }
3078 ]
3079 },
3080 {
3081 "name": "ion-router-link",
3082 "description": {
3083 "kind": "markdown",
3084 "value": "The router link component is used for navigating to a specified link. Similar to the browser's anchor tag, it can accept a href for the location, and a direction for the transition animation.\n\n> Note: this component should only be used with vanilla and Stencil JavaScript projects. For Angular projects, use an `<a>` and `routerLink` with the Angular router."
3085 },
3086 "attributes": [
3087 {
3088 "name": "color",
3089 "description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics)."
3090 },
3091 {
3092 "name": "href",
3093 "description": "Contains a URL or a URL fragment that the hyperlink points to.\nIf this property is set, an anchor tag will be rendered."
3094 },
3095 {
3096 "name": "rel",
3097 "description": "Specifies the relationship of the target object to the link object.\nThe value is a space-separated list of [link types](https://developer.mozilla.org/en-US/docs/Web/HTML/Link_types)."
3098 },
3099 {
3100 "name": "router-direction",
3101 "description": "When using a router, it specifies the transition direction when navigating to\nanother page using `href`.",
3102 "values": [
3103 {
3104 "name": "back"
3105 },
3106 {
3107 "name": "forward"
3108 },
3109 {
3110 "name": "root"
3111 }
3112 ]
3113 },
3114 {
3115 "name": "target",
3116 "description": "Specifies where to display the linked URL.\nOnly applies when an `href` is provided.\nSpecial keywords: `\"_blank\"`, `\"_self\"`, `\"_parent\"`, `\"_top\"`."
3117 }
3118 ],
3119 "references": [
3120 {
3121 "name": "Source code",
3122 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/router-link/router-link.tsx"
3123 }
3124 ]
3125 },
3126 {
3127 "name": "ion-router-outlet",
3128 "description": {
3129 "kind": "markdown",
3130 "value": "Router outlet is a component used in routing within an Angular, React, or Vue app. It behaves in a similar way to Angular's built-in router outlet component and Vue's router view component, but contains the logic for providing a stacked navigation, and animating views in and out.\n\n> Note: this component should only be used with Angular, React, and Vue projects. For vanilla or Stencil JavaScript projects, use [`ion-router`](../router) and [`ion-route`](../route).\n\nAlthough router outlet has methods for navigating around, it's recommended to use the navigation methods in your framework's router."
3131 },
3132 "attributes": [
3133 {
3134 "name": "animated",
3135 "description": "If `true`, the router-outlet should animate the transition of components."
3136 },
3137 {
3138 "name": "mode",
3139 "description": "The mode determines which platform styles to use.",
3140 "values": [
3141 {
3142 "name": "ios"
3143 },
3144 {
3145 "name": "md"
3146 }
3147 ]
3148 }
3149 ],
3150 "references": [
3151 {
3152 "name": "Source code",
3153 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/router-outlet/route-outlet.tsx"
3154 }
3155 ]
3156 },
3157 {
3158 "name": "ion-row",
3159 "description": {
3160 "kind": "markdown",
3161 "value": "Rows are horizontal components of the [grid](../grid) system and contain varying numbers of\n[columns](../col). They ensure the columns are positioned properly.\n\nSee [Grid Layout](/docs/layout/grid) for more information."
3162 },
3163 "attributes": [],
3164 "references": [
3165 {
3166 "name": "Source code",
3167 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/row/row.tsx"
3168 }
3169 ]
3170 },
3171 {
3172 "name": "ion-searchbar",
3173 "description": {
3174 "kind": "markdown",
3175 "value": "Searchbars represent a text field that can be used to search through a collection. They can be displayed inside of a toolbar or the main content.\n\nA Searchbar should be used instead of an input to search lists. A clear button is displayed upon entering input in the searchbar's text field. Clicking on the clear button will erase the text field and the input will remain focused. A cancel button can be enabled which will clear the input and lose the focus upon click."
3176 },
3177 "attributes": [
3178 {
3179 "name": "animated",
3180 "description": "If `true`, enable searchbar animation."
3181 },
3182 {
3183 "name": "autocomplete",
3184 "description": "Set the input's autocomplete property.",
3185 "values": [
3186 {
3187 "name": "on"
3188 },
3189 {
3190 "name": "off"
3191 },
3192 {
3193 "name": "name"
3194 },
3195 {
3196 "name": "honorific-prefix"
3197 },
3198 {
3199 "name": "given-name"
3200 },
3201 {
3202 "name": "additional-name"
3203 },
3204 {
3205 "name": "family-name"
3206 },
3207 {
3208 "name": "honorific-suffix"
3209 },
3210 {
3211 "name": "nickname"
3212 },
3213 {
3214 "name": "email"
3215 },
3216 {
3217 "name": "username"
3218 },
3219 {
3220 "name": "new-password"
3221 },
3222 {
3223 "name": "current-password"
3224 },
3225 {
3226 "name": "one-time-code"
3227 },
3228 {
3229 "name": "organization-title"
3230 },
3231 {
3232 "name": "organization"
3233 },
3234 {
3235 "name": "street-address"
3236 },
3237 {
3238 "name": "address-line1"
3239 },
3240 {
3241 "name": "address-line2"
3242 },
3243 {
3244 "name": "address-line3"
3245 },
3246 {
3247 "name": "address-level4"
3248 },
3249 {
3250 "name": "address-level3"
3251 },
3252 {
3253 "name": "address-level2"
3254 },
3255 {
3256 "name": "address-level1"
3257 },
3258 {
3259 "name": "country"
3260 },
3261 {
3262 "name": "country-name"
3263 },
3264 {
3265 "name": "postal-code"
3266 },
3267 {
3268 "name": "cc-name"
3269 },
3270 {
3271 "name": "cc-given-name"
3272 },
3273 {
3274 "name": "cc-additional-name"
3275 },
3276 {
3277 "name": "cc-family-name"
3278 },
3279 {
3280 "name": "cc-number"
3281 },
3282 {
3283 "name": "cc-exp"
3284 },
3285 {
3286 "name": "cc-exp-month"
3287 },
3288 {
3289 "name": "cc-exp-year"
3290 },
3291 {
3292 "name": "cc-csc"
3293 },
3294 {
3295 "name": "cc-type"
3296 },
3297 {
3298 "name": "transaction-currency"
3299 },
3300 {
3301 "name": "transaction-amount"
3302 },
3303 {
3304 "name": "language"
3305 },
3306 {
3307 "name": "bday"
3308 },
3309 {
3310 "name": "bday-day"
3311 },
3312 {
3313 "name": "bday-month"
3314 },
3315 {
3316 "name": "bday-year"
3317 },
3318 {
3319 "name": "sex"
3320 },
3321 {
3322 "name": "tel"
3323 },
3324 {
3325 "name": "tel-country-code"
3326 },
3327 {
3328 "name": "tel-national"
3329 },
3330 {
3331 "name": "tel-area-code"
3332 },
3333 {
3334 "name": "tel-local"
3335 },
3336 {
3337 "name": "tel-extension"
3338 },
3339 {
3340 "name": "impp"
3341 },
3342 {
3343 "name": "url"
3344 },
3345 {
3346 "name": "photo"
3347 }
3348 ]
3349 },
3350 {
3351 "name": "autocorrect",
3352 "description": "Set the input's autocorrect property.",
3353 "values": [
3354 {
3355 "name": "off"
3356 },
3357 {
3358 "name": "on"
3359 }
3360 ]
3361 },
3362 {
3363 "name": "cancel-button-icon",
3364 "description": "Set the cancel button icon. Only applies to `md` mode.\nDefaults to `\"arrow-back-sharp\"`."
3365 },
3366 {
3367 "name": "cancel-button-text",
3368 "description": "Set the the cancel button text. Only applies to `ios` mode."
3369 },
3370 {
3371 "name": "clear-icon",
3372 "description": "Set the clear icon. Defaults to `\"close-circle\"` for `ios` and `\"close-sharp\"` for `md`."
3373 },
3374 {
3375 "name": "color",
3376 "description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics)."
3377 },
3378 {
3379 "name": "debounce",
3380 "description": "Set the amount of time, in milliseconds, to wait to trigger the `ionChange` event after each keystroke. This also impacts form bindings such as `ngModel` or `v-model`."
3381 },
3382 {
3383 "name": "disabled",
3384 "description": "If `true`, the user cannot interact with the input."
3385 },
3386 {
3387 "name": "enterkeyhint",
3388 "description": "A hint to the browser for which enter key to display.\nPossible values: `\"enter\"`, `\"done\"`, `\"go\"`, `\"next\"`,\n`\"previous\"`, `\"search\"`, and `\"send\"`.",
3389 "values": [
3390 {
3391 "name": "done"
3392 },
3393 {
3394 "name": "enter"
3395 },
3396 {
3397 "name": "go"
3398 },
3399 {
3400 "name": "next"
3401 },
3402 {
3403 "name": "previous"
3404 },
3405 {
3406 "name": "search"
3407 },
3408 {
3409 "name": "send"
3410 }
3411 ]
3412 },
3413 {
3414 "name": "inputmode",
3415 "description": "A hint to the browser for which keyboard to display.\nPossible values: `\"none\"`, `\"text\"`, `\"tel\"`, `\"url\"`,\n`\"email\"`, `\"numeric\"`, `\"decimal\"`, and `\"search\"`.",
3416 "values": [
3417 {
3418 "name": "decimal"
3419 },
3420 {
3421 "name": "email"
3422 },
3423 {
3424 "name": "none"
3425 },
3426 {
3427 "name": "numeric"
3428 },
3429 {
3430 "name": "search"
3431 },
3432 {
3433 "name": "tel"
3434 },
3435 {
3436 "name": "text"
3437 },
3438 {
3439 "name": "url"
3440 }
3441 ]
3442 },
3443 {
3444 "name": "mode",
3445 "description": "The mode determines which platform styles to use.",
3446 "values": [
3447 {
3448 "name": "ios"
3449 },
3450 {
3451 "name": "md"
3452 }
3453 ]
3454 },
3455 {
3456 "name": "placeholder",
3457 "description": "Set the input's placeholder.\n`placeholder` can accept either plaintext or HTML as a string.\nTo display characters normally reserved for HTML, they\nmust be escaped. For example `<Ionic>` would become\n`&lt;Ionic&gt;`\n\nFor more information: [Security Documentation](https://ionicframework.com/docs/faq/security)"
3458 },
3459 {
3460 "name": "search-icon",
3461 "description": "The icon to use as the search icon. Defaults to `\"search-outline\"` in\n`ios` mode and `\"search-sharp\"` in `md` mode."
3462 },
3463 {
3464 "name": "show-cancel-button",
3465 "description": "Sets the behavior for the cancel button. Defaults to `\"never\"`.\nSetting to `\"focus\"` shows the cancel button on focus.\nSetting to `\"never\"` hides the cancel button.\nSetting to `\"always\"` shows the cancel button regardless\nof focus state.",
3466 "values": [
3467 {
3468 "name": "always"
3469 },
3470 {
3471 "name": "focus"
3472 },
3473 {
3474 "name": "never"
3475 }
3476 ]
3477 },
3478 {
3479 "name": "show-clear-button",
3480 "description": "Sets the behavior for the clear button. Defaults to `\"focus\"`.\nSetting to `\"focus\"` shows the clear button on focus if the\ninput is not empty.\nSetting to `\"never\"` hides the clear button.\nSetting to `\"always\"` shows the clear button regardless\nof focus state, but only if the input is not empty.",
3481 "values": [
3482 {
3483 "name": "always"
3484 },
3485 {
3486 "name": "focus"
3487 },
3488 {
3489 "name": "never"
3490 }
3491 ]
3492 },
3493 {
3494 "name": "spellcheck",
3495 "description": "If `true`, enable spellcheck on the input."
3496 },
3497 {
3498 "name": "type",
3499 "description": "Set the type of the input.",
3500 "values": [
3501 {
3502 "name": "email"
3503 },
3504 {
3505 "name": "number"
3506 },
3507 {
3508 "name": "password"
3509 },
3510 {
3511 "name": "search"
3512 },
3513 {
3514 "name": "tel"
3515 },
3516 {
3517 "name": "text"
3518 },
3519 {
3520 "name": "url"
3521 }
3522 ]
3523 },
3524 {
3525 "name": "value",
3526 "description": "the value of the searchbar."
3527 }
3528 ],
3529 "references": [
3530 {
3531 "name": "Source code",
3532 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/searchbar/searchbar.tsx"
3533 }
3534 ]
3535 },
3536 {
3537 "name": "ion-segment",
3538 "description": {
3539 "kind": "markdown",
3540 "value": "Segments display a group of related buttons, sometimes known as segmented controls, in a horizontal row. They can be displayed inside of a toolbar or the main content.\n\nTheir functionality is similar to tabs, where selecting one will deselect all others. Segments are useful for toggling between different views inside of the content. Tabs should be used instead of a segment when clicking on a control should navigate between pages."
3541 },
3542 "attributes": [
3543 {
3544 "name": "color",
3545 "description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics)."
3546 },
3547 {
3548 "name": "disabled",
3549 "description": "If `true`, the user cannot interact with the segment."
3550 },
3551 {
3552 "name": "mode",
3553 "description": "The mode determines which platform styles to use.",
3554 "values": [
3555 {
3556 "name": "ios"
3557 },
3558 {
3559 "name": "md"
3560 }
3561 ]
3562 },
3563 {
3564 "name": "scrollable",
3565 "description": "If `true`, the segment buttons will overflow and the user can swipe to see them.\nIn addition, this will disable the gesture to drag the indicator between the buttons\nin order to swipe to see hidden buttons."
3566 },
3567 {
3568 "name": "swipe-gesture",
3569 "description": "If `true`, users will be able to swipe between segment buttons to activate them."
3570 },
3571 {
3572 "name": "value",
3573 "description": "the value of the segment."
3574 }
3575 ],
3576 "references": [
3577 {
3578 "name": "Source code",
3579 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/segment/segment.tsx"
3580 }
3581 ]
3582 },
3583 {
3584 "name": "ion-segment-button",
3585 "description": {
3586 "kind": "markdown",
3587 "value": "Segment buttons are groups of related buttons inside of a [Segment](../segment). They are displayed in a horizontal row. A segment button can be checked by default by setting the `value` of the segment to the `value` of the segment button. Only one segment button can be selected at a time."
3588 },
3589 "attributes": [
3590 {
3591 "name": "disabled",
3592 "description": "If `true`, the user cannot interact with the segment button."
3593 },
3594 {
3595 "name": "layout",
3596 "description": "Set the layout of the text and icon in the segment.",
3597 "values": [
3598 {
3599 "name": "icon-bottom"
3600 },
3601 {
3602 "name": "icon-end"
3603 },
3604 {
3605 "name": "icon-hide"
3606 },
3607 {
3608 "name": "icon-start"
3609 },
3610 {
3611 "name": "icon-top"
3612 },
3613 {
3614 "name": "label-hide"
3615 }
3616 ]
3617 },
3618 {
3619 "name": "mode",
3620 "description": "The mode determines which platform styles to use.",
3621 "values": [
3622 {
3623 "name": "ios"
3624 },
3625 {
3626 "name": "md"
3627 }
3628 ]
3629 },
3630 {
3631 "name": "type",
3632 "description": "The type of the button.",
3633 "values": [
3634 {
3635 "name": "button"
3636 },
3637 {
3638 "name": "reset"
3639 },
3640 {
3641 "name": "submit"
3642 }
3643 ]
3644 },
3645 {
3646 "name": "value",
3647 "description": "The value of the segment button."
3648 }
3649 ],
3650 "references": [
3651 {
3652 "name": "Source code",
3653 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/segment-button/segment-button.tsx"
3654 }
3655 ]
3656 },
3657 {
3658 "name": "ion-select",
3659 "description": {
3660 "kind": "markdown",
3661 "value": "Selects are form controls to select an option, or options, from a set of options, similar to a native `<select>` element. When a user taps the select, a dialog appears with all of the options in a large, easy to select list.\n\nA select should be used with child `<ion-select-option>` elements. If the child option is not given a `value` attribute then its text will be used as the value.\n\nIf `value` is set on the `<ion-select>`, the selected option will be chosen based on that value."
3662 },
3663 "attributes": [
3664 {
3665 "name": "cancel-text",
3666 "description": "The text to display on the cancel button."
3667 },
3668 {
3669 "name": "compare-with",
3670 "description": "A property name or function used to compare object values"
3671 },
3672 {
3673 "name": "disabled",
3674 "description": "If `true`, the user cannot interact with the select."
3675 },
3676 {
3677 "name": "interface",
3678 "description": "The interface the select should use: `action-sheet`, `popover` or `alert`.",
3679 "values": [
3680 {
3681 "name": "action-sheet"
3682 },
3683 {
3684 "name": "alert"
3685 },
3686 {
3687 "name": "popover"
3688 }
3689 ]
3690 },
3691 {
3692 "name": "interface-options",
3693 "description": "Any additional options that the `alert`, `action-sheet` or `popover` interface\ncan take. See the [ion-alert docs](../alert), the\n[ion-action-sheet docs](../action-sheet) and the\n[ion-popover docs](../popover) for the\ncreate options for each interface.\n\nNote: `interfaceOptions` will not override `inputs` or `buttons` with the `alert` interface."
3694 },
3695 {
3696 "name": "mode",
3697 "description": "The mode determines which platform styles to use.",
3698 "values": [
3699 {
3700 "name": "ios"
3701 },
3702 {
3703 "name": "md"
3704 }
3705 ]
3706 },
3707 {
3708 "name": "multiple",
3709 "description": "If `true`, the select can accept multiple values."
3710 },
3711 {
3712 "name": "name",
3713 "description": "The name of the control, which is submitted with the form data."
3714 },
3715 {
3716 "name": "ok-text",
3717 "description": "The text to display on the ok button."
3718 },
3719 {
3720 "name": "placeholder",
3721 "description": "The text to display when the select is empty."
3722 },
3723 {
3724 "name": "selected-text",
3725 "description": "The text to display instead of the selected option's value."
3726 },
3727 {
3728 "name": "value",
3729 "description": "the value of the select."
3730 }
3731 ],
3732 "references": [
3733 {
3734 "name": "Source code",
3735 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/select/select.tsx"
3736 }
3737 ]
3738 },
3739 {
3740 "name": "ion-select-option",
3741 "description": {
3742 "kind": "markdown",
3743 "value": "Select Options are components that are child elements of a Select. Each option defined is passed and displayed in the Select dialog. For more information, see the [Select docs](../select)."
3744 },
3745 "attributes": [
3746 {
3747 "name": "disabled",
3748 "description": "If `true`, the user cannot interact with the select option. This property does not apply when `interface=\"action-sheet\"` as `ion-action-sheet` does not allow for disabled buttons."
3749 },
3750 {
3751 "name": "value",
3752 "description": "The text value of the option."
3753 }
3754 ],
3755 "references": [
3756 {
3757 "name": "Source code",
3758 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/select-option/select-option.tsx"
3759 }
3760 ]
3761 },
3762 {
3763 "name": "ion-skeleton-text",
3764 "description": {
3765 "kind": "markdown",
3766 "value": "Skeleton Text is a component for rendering placeholder content. The element will render a gray block at the specified width."
3767 },
3768 "attributes": [
3769 {
3770 "name": "animated",
3771 "description": "If `true`, the skeleton text will animate."
3772 }
3773 ],
3774 "references": [
3775 {
3776 "name": "Source code",
3777 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/skeleton-text/skeleton-text.tsx"
3778 }
3779 ]
3780 },
3781 {
3782 "name": "ion-slide",
3783 "description": {
3784 "kind": "markdown",
3785 "value": "The Slide component is a child component of [Slides](../slides). The template\nshould be written as `ion-slide`. Any slide content should be written\nin this component and it should be used in conjunction with [Slides](../slides).\n\nSee the [Slides API Docs](../slides) for more usage information."
3786 },
3787 "attributes": [],
3788 "references": [
3789 {
3790 "name": "Source code",
3791 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/slide/slide.tsx"
3792 }
3793 ]
3794 },
3795 {
3796 "name": "ion-slides",
3797 "description": {
3798 "kind": "markdown",
3799 "value": "The Slides component is a multi-section container. Each section can be swiped\nor dragged between. It contains any number of [Slide](../slide) components.\n\nThis guide will cover migration from the deprecated `ion-slides` component to the framework-specific solutions that Swiper.js provides as well as the existing `ion-slides` API for developers who are still using that component.\n\nAdopted from Swiper.js:\nThe most modern mobile touch slider and framework with hardware accelerated transitions.\n\nhttp://www.idangero.us/swiper/\n\nCopyright 2016, Vladimir Kharlampidi\nThe iDangero.us\nhttp://www.idangero.us/\n\nLicensed under MIT"
3800 },
3801 "attributes": [
3802 {
3803 "name": "mode",
3804 "description": "The mode determines which platform styles to use.",
3805 "values": [
3806 {
3807 "name": "ios"
3808 },
3809 {
3810 "name": "md"
3811 }
3812 ]
3813 },
3814 {
3815 "name": "options",
3816 "description": "Options to pass to the swiper instance.\nSee http://idangero.us/swiper/api/ for valid options"
3817 },
3818 {
3819 "name": "pager",
3820 "description": "If `true`, show the pagination."
3821 },
3822 {
3823 "name": "scrollbar",
3824 "description": "If `true`, show the scrollbar."
3825 }
3826 ],
3827 "references": [
3828 {
3829 "name": "Source code",
3830 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/slides/slides.tsx"
3831 }
3832 ]
3833 },
3834 {
3835 "name": "ion-spinner",
3836 "description": {
3837 "kind": "markdown",
3838 "value": "The Spinner component provides a variety of animated SVG spinners. Spinners are visual indicators that the app is loading content or performing another process that the user needs to wait on.\n\nThe default spinner to use is based on the platform. The default spinner for `ios` is `\"lines\"`, and the default for `android` is `\"crescent\"`. If the platform is not `ios` or `android`, the spinner will default to `crescent`. If the `name` property is set, then that spinner will be used instead of the platform specific spinner."
3839 },
3840 "attributes": [
3841 {
3842 "name": "color",
3843 "description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics)."
3844 },
3845 {
3846 "name": "duration",
3847 "description": "Duration of the spinner animation in milliseconds. The default varies based on the spinner."
3848 },
3849 {
3850 "name": "name",
3851 "description": "The name of the SVG spinner to use. If a name is not provided, the platform's default\nspinner will be used.",
3852 "values": [
3853 {
3854 "name": "bubbles"
3855 },
3856 {
3857 "name": "circles"
3858 },
3859 {
3860 "name": "circular"
3861 },
3862 {
3863 "name": "crescent"
3864 },
3865 {
3866 "name": "dots"
3867 },
3868 {
3869 "name": "lines"
3870 },
3871 {
3872 "name": "lines-small"
3873 }
3874 ]
3875 },
3876 {
3877 "name": "paused",
3878 "description": "If `true`, the spinner's animation will be paused."
3879 }
3880 ],
3881 "references": [
3882 {
3883 "name": "Source code",
3884 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/spinner/spinner.tsx"
3885 }
3886 ]
3887 },
3888 {
3889 "name": "ion-split-pane",
3890 "description": {
3891 "kind": "markdown",
3892 "value": "A split pane is useful when creating multi-view layouts. It allows UI elements, like menus, to be\ndisplayed as the viewport width increases.\n\nIf the device's screen width is below a certain size, the split pane will collapse and the menu will be hidden. This is ideal for creating an app that will be served in a browser and deployed through the app store to phones and tablets."
3893 },
3894 "attributes": [
3895 {
3896 "name": "content-id",
3897 "description": "The `id` of the main content. When using\na router this is typically `ion-router-outlet`.\nWhen not using a router, this is typically\nyour main view's `ion-content`. This is not the\nid of the `ion-content` inside of your `ion-menu`."
3898 },
3899 {
3900 "name": "disabled",
3901 "description": "If `true`, the split pane will be hidden."
3902 },
3903 {
3904 "name": "when",
3905 "description": "When the split-pane should be shown.\nCan be a CSS media query expression, or a shortcut expression.\nCan also be a boolean expression."
3906 }
3907 ],
3908 "references": [
3909 {
3910 "name": "Source code",
3911 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/split-pane/split-pane.tsx"
3912 }
3913 ]
3914 },
3915 {
3916 "name": "ion-tab",
3917 "description": {
3918 "kind": "markdown",
3919 "value": "The tab component is a child component of [tabs](../tabs). Each tab can contain a top level navigation stack for an app or a single view. An app can have many tabs, all with their own independent navigation.\n\n> Note: This component should only be used with vanilla or Stencil JavaScript projects. For Angular, React, and Vue apps you do not need to use `ion-tab` to declare your tab components.\n\nSee the [tabs documentation](../tabs/) for more details on configuring tabs."
3920 },
3921 "attributes": [
3922 {
3923 "name": "component",
3924 "description": "The component to display inside of the tab."
3925 },
3926 {
3927 "name": "tab",
3928 "description": "A tab id must be provided for each `ion-tab`. It's used internally to reference\nthe selected tab or by the router to switch between them."
3929 }
3930 ],
3931 "references": [
3932 {
3933 "name": "Source code",
3934 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/tab/tab.tsx"
3935 }
3936 ]
3937 },
3938 {
3939 "name": "ion-tab-bar",
3940 "description": {
3941 "kind": "markdown",
3942 "value": "The tab bar is a UI component that contains a set of [tab buttons](../tab-button). A tab bar must be provided inside of [tabs](../tabs) to communicate with each [tab](../tab)."
3943 },
3944 "attributes": [
3945 {
3946 "name": "color",
3947 "description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics)."
3948 },
3949 {
3950 "name": "mode",
3951 "description": "The mode determines which platform styles to use.",
3952 "values": [
3953 {
3954 "name": "ios"
3955 },
3956 {
3957 "name": "md"
3958 }
3959 ]
3960 },
3961 {
3962 "name": "selected-tab",
3963 "description": "The selected tab component"
3964 },
3965 {
3966 "name": "translucent",
3967 "description": "If `true`, the tab bar will be translucent.\nOnly applies when the mode is `\"ios\"` and the device supports\n[`backdrop-filter`](https://developer.mozilla.org/en-US/docs/Web/CSS/backdrop-filter#Browser_compatibility)."
3968 }
3969 ],
3970 "references": [
3971 {
3972 "name": "Source code",
3973 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/tab-bar/tab-bar.tsx"
3974 }
3975 ]
3976 },
3977 {
3978 "name": "ion-tab-button",
3979 "description": {
3980 "kind": "markdown",
3981 "value": "A tab button is a UI component that is placed inside of a [tab bar](../tab-bar). The tab button can specify the layout of the icon and label and connect to a [tab view](../tab).\n\nSee the [tabs documentation](../tabs) for more details on configuring tabs."
3982 },
3983 "attributes": [
3984 {
3985 "name": "disabled",
3986 "description": "If `true`, the user cannot interact with the tab button."
3987 },
3988 {
3989 "name": "download",
3990 "description": "This attribute instructs browsers to download a URL instead of navigating to\nit, so the user will be prompted to save it as a local file. If the attribute\nhas a value, it is used as the pre-filled file name in the Save prompt\n(the user can still change the file name if they want)."
3991 },
3992 {
3993 "name": "href",
3994 "description": "Contains a URL or a URL fragment that the hyperlink points to.\nIf this property is set, an anchor tag will be rendered."
3995 },
3996 {
3997 "name": "layout",
3998 "description": "Set the layout of the text and icon in the tab bar.\nIt defaults to `'icon-top'`.",
3999 "values": [
4000 {
4001 "name": "icon-bottom"
4002 },
4003 {
4004 "name": "icon-end"
4005 },
4006 {
4007 "name": "icon-hide"
4008 },
4009 {
4010 "name": "icon-start"
4011 },
4012 {
4013 "name": "icon-top"
4014 },
4015 {
4016 "name": "label-hide"
4017 }
4018 ]
4019 },
4020 {
4021 "name": "mode",
4022 "description": "The mode determines which platform styles to use.",
4023 "values": [
4024 {
4025 "name": "ios"
4026 },
4027 {
4028 "name": "md"
4029 }
4030 ]
4031 },
4032 {
4033 "name": "rel",
4034 "description": "Specifies the relationship of the target object to the link object.\nThe value is a space-separated list of [link types](https://developer.mozilla.org/en-US/docs/Web/HTML/Link_types)."
4035 },
4036 {
4037 "name": "selected",
4038 "description": "The selected tab component"
4039 },
4040 {
4041 "name": "tab",
4042 "description": "A tab id must be provided for each `ion-tab`. It's used internally to reference\nthe selected tab or by the router to switch between them."
4043 },
4044 {
4045 "name": "target",
4046 "description": "Specifies where to display the linked URL.\nOnly applies when an `href` is provided.\nSpecial keywords: `\"_blank\"`, `\"_self\"`, `\"_parent\"`, `\"_top\"`."
4047 }
4048 ],
4049 "references": [
4050 {
4051 "name": "Source code",
4052 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/tab-button/tab-button.tsx"
4053 }
4054 ]
4055 },
4056 {
4057 "name": "ion-tabs",
4058 "description": {
4059 "kind": "markdown",
4060 "value": "Tabs are a top level navigation component to implement a tab-based navigation.\nThe component is a container of individual [Tab](../tab/) components.\n\nThe `ion-tabs` component does not have any styling and works as a router outlet in order to handle navigation. It does not provide any UI feedback or mechanism to switch between tabs. In order to do so, an `ion-tab-bar` should be provided as a direct child of `ion-tabs`.\n\nBoth `ion-tabs` and `ion-tab-bar` can be used as standalone elements. They don’t depend on each other to work, but they are usually used together in order to implement a tab-based navigation that behaves like a native app.\n\nThe `ion-tab-bar` needs a slot defined in order to be projected to the right place in an `ion-tabs` component."
4061 },
4062 "attributes": [],
4063 "references": [
4064 {
4065 "name": "Source code",
4066 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/tabs/tabs.tsx"
4067 }
4068 ]
4069 },
4070 {
4071 "name": "ion-text",
4072 "description": {
4073 "kind": "markdown",
4074 "value": "The text component is a simple component that can be used to style the text color of any element. The `ion-text` element should wrap the element in order to change the text color of that element."
4075 },
4076 "attributes": [
4077 {
4078 "name": "color",
4079 "description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics)."
4080 },
4081 {
4082 "name": "mode",
4083 "description": "The mode determines which platform styles to use.",
4084 "values": [
4085 {
4086 "name": "ios"
4087 },
4088 {
4089 "name": "md"
4090 }
4091 ]
4092 }
4093 ],
4094 "references": [
4095 {
4096 "name": "Source code",
4097 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/text/text.tsx"
4098 }
4099 ]
4100 },
4101 {
4102 "name": "ion-textarea",
4103 "description": {
4104 "kind": "markdown",
4105 "value": "The textarea component is used for multi-line text input. A native textarea element is rendered inside of the component. The user experience and interactivity of the textarea component is improved by having control over the native textarea.\n\nUnlike the native textarea element, the Ionic textarea does not support loading its value from the inner content. The textarea value should be set in the `value` attribute.\n\nThe textarea component accepts the [native textarea attributes](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/textarea) in addition to the Ionic properties."
4106 },
4107 "attributes": [
4108 {
4109 "name": "auto-grow",
4110 "description": "If `true`, the element height will increase based on the value."
4111 },
4112 {
4113 "name": "autocapitalize",
4114 "description": "Indicates whether and how the text value should be automatically capitalized as it is entered/edited by the user."
4115 },
4116 {
4117 "name": "autofocus",
4118 "description": "This Boolean attribute lets you specify that a form control should have input focus when the page loads."
4119 },
4120 {
4121 "name": "clear-on-edit",
4122 "description": "If `true`, the value will be cleared after focus upon edit. Defaults to `true` when `type` is `\"password\"`, `false` for all other types."
4123 },
4124 {
4125 "name": "color",
4126 "description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics)."
4127 },
4128 {
4129 "name": "cols",
4130 "description": "The visible width of the text control, in average character widths. If it is specified, it must be a positive integer."
4131 },
4132 {
4133 "name": "debounce",
4134 "description": "Set the amount of time, in milliseconds, to wait to trigger the `ionChange` event after each keystroke. This also impacts form bindings such as `ngModel` or `v-model`."
4135 },
4136 {
4137 "name": "disabled",
4138 "description": "If `true`, the user cannot interact with the textarea."
4139 },
4140 {
4141 "name": "enterkeyhint",
4142 "description": "A hint to the browser for which enter key to display.\nPossible values: `\"enter\"`, `\"done\"`, `\"go\"`, `\"next\"`,\n`\"previous\"`, `\"search\"`, and `\"send\"`.",
4143 "values": [
4144 {
4145 "name": "done"
4146 },
4147 {
4148 "name": "enter"
4149 },
4150 {
4151 "name": "go"
4152 },
4153 {
4154 "name": "next"
4155 },
4156 {
4157 "name": "previous"
4158 },
4159 {
4160 "name": "search"
4161 },
4162 {
4163 "name": "send"
4164 }
4165 ]
4166 },
4167 {
4168 "name": "inputmode",
4169 "description": "A hint to the browser for which keyboard to display.\nPossible values: `\"none\"`, `\"text\"`, `\"tel\"`, `\"url\"`,\n`\"email\"`, `\"numeric\"`, `\"decimal\"`, and `\"search\"`.",
4170 "values": [
4171 {
4172 "name": "decimal"
4173 },
4174 {
4175 "name": "email"
4176 },
4177 {
4178 "name": "none"
4179 },
4180 {
4181 "name": "numeric"
4182 },
4183 {
4184 "name": "search"
4185 },
4186 {
4187 "name": "tel"
4188 },
4189 {
4190 "name": "text"
4191 },
4192 {
4193 "name": "url"
4194 }
4195 ]
4196 },
4197 {
4198 "name": "maxlength",
4199 "description": "If the value of the type attribute is `text`, `email`, `search`, `password`, `tel`, or `url`, this attribute specifies the maximum number of characters that the user can enter."
4200 },
4201 {
4202 "name": "minlength",
4203 "description": "If the value of the type attribute is `text`, `email`, `search`, `password`, `tel`, or `url`, this attribute specifies the minimum number of characters that the user can enter."
4204 },
4205 {
4206 "name": "mode",
4207 "description": "The mode determines which platform styles to use.",
4208 "values": [
4209 {
4210 "name": "ios"
4211 },
4212 {
4213 "name": "md"
4214 }
4215 ]
4216 },
4217 {
4218 "name": "name",
4219 "description": "The name of the control, which is submitted with the form data."
4220 },
4221 {
4222 "name": "placeholder",
4223 "description": "Instructional text that shows before the input has a value."
4224 },
4225 {
4226 "name": "readonly",
4227 "description": "If `true`, the user cannot modify the value."
4228 },
4229 {
4230 "name": "required",
4231 "description": "If `true`, the user must fill in a value before submitting a form."
4232 },
4233 {
4234 "name": "rows",
4235 "description": "The number of visible text lines for the control."
4236 },
4237 {
4238 "name": "spellcheck",
4239 "description": "If `true`, the element will have its spelling and grammar checked."
4240 },
4241 {
4242 "name": "value",
4243 "description": "The value of the textarea."
4244 },
4245 {
4246 "name": "wrap",
4247 "description": "Indicates how the control wraps text.",
4248 "values": [
4249 {
4250 "name": "hard"
4251 },
4252 {
4253 "name": "off"
4254 },
4255 {
4256 "name": "soft"
4257 }
4258 ]
4259 }
4260 ],
4261 "references": [
4262 {
4263 "name": "Source code",
4264 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/textarea/textarea.tsx"
4265 }
4266 ]
4267 },
4268 {
4269 "name": "ion-thumbnail",
4270 "description": {
4271 "kind": "markdown",
4272 "value": "Thumbnails are square components that usually wrap an image or icon. They can be used to make it easier to display a group of larger images or provide a preview of the full-size image.\n\nThumbnails can be used by themselves or inside of any element. If placed inside of an `ion-item`, the thumbnail will resize to fit the parent component. To position a thumbnail on the left or right side of an item, set the slot to `start` or `end`, respectively."
4273 },
4274 "attributes": [],
4275 "references": [
4276 {
4277 "name": "Source code",
4278 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/thumbnail/thumbnail.tsx"
4279 }
4280 ]
4281 },
4282 {
4283 "name": "ion-title",
4284 "description": {
4285 "kind": "markdown",
4286 "value": "`ion-title` is a component that sets the title of the `Toolbar`."
4287 },
4288 "attributes": [
4289 {
4290 "name": "color",
4291 "description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics)."
4292 },
4293 {
4294 "name": "size",
4295 "description": "The size of the toolbar title.",
4296 "values": [
4297 {
4298 "name": "large"
4299 },
4300 {
4301 "name": "small"
4302 }
4303 ]
4304 }
4305 ],
4306 "references": [
4307 {
4308 "name": "Source code",
4309 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/title/title.tsx"
4310 }
4311 ]
4312 },
4313 {
4314 "name": "ion-toast",
4315 "description": {
4316 "kind": "markdown",
4317 "value": "A Toast is a subtle notification commonly used in modern applications. It can be used to provide feedback about an operation or to display a system message. The toast appears on top of the app's content, and can be dismissed by the app to resume user interaction with the app."
4318 },
4319 "attributes": [
4320 {
4321 "name": "animated",
4322 "description": "If `true`, the toast will animate."
4323 },
4324 {
4325 "name": "color",
4326 "description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics)."
4327 },
4328 {
4329 "name": "css-class",
4330 "description": "Additional classes to apply for custom CSS. If multiple classes are\nprovided they should be separated by spaces."
4331 },
4332 {
4333 "name": "duration",
4334 "description": "How many milliseconds to wait before hiding the toast. By default, it will show\nuntil `dismiss()` is called."
4335 },
4336 {
4337 "name": "header",
4338 "description": "Header to be shown in the toast."
4339 },
4340 {
4341 "name": "keyboard-close",
4342 "description": "If `true`, the keyboard will be automatically dismissed when the overlay is presented."
4343 },
4344 {
4345 "name": "message",
4346 "description": "Message to be shown in the toast."
4347 },
4348 {
4349 "name": "mode",
4350 "description": "The mode determines which platform styles to use.",
4351 "values": [
4352 {
4353 "name": "ios"
4354 },
4355 {
4356 "name": "md"
4357 }
4358 ]
4359 },
4360 {
4361 "name": "position",
4362 "description": "The position of the toast on the screen.",
4363 "values": [
4364 {
4365 "name": "bottom"
4366 },
4367 {
4368 "name": "middle"
4369 },
4370 {
4371 "name": "top"
4372 }
4373 ]
4374 },
4375 {
4376 "name": "translucent",
4377 "description": "If `true`, the toast will be translucent.\nOnly applies when the mode is `\"ios\"` and the device supports\n[`backdrop-filter`](https://developer.mozilla.org/en-US/docs/Web/CSS/backdrop-filter#Browser_compatibility)."
4378 }
4379 ],
4380 "references": [
4381 {
4382 "name": "Source code",
4383 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/toast/toast.tsx"
4384 }
4385 ]
4386 },
4387 {
4388 "name": "ion-toggle",
4389 "description": {
4390 "kind": "markdown",
4391 "value": "Toggles change the state of a single option. Toggles can be switched on or off by pressing or swiping them. They can also be checked programmatically by setting the `checked` property."
4392 },
4393 "attributes": [
4394 {
4395 "name": "checked",
4396 "description": "If `true`, the toggle is selected."
4397 },
4398 {
4399 "name": "color",
4400 "description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics)."
4401 },
4402 {
4403 "name": "disabled",
4404 "description": "If `true`, the user cannot interact with the toggle."
4405 },
4406 {
4407 "name": "mode",
4408 "description": "The mode determines which platform styles to use.",
4409 "values": [
4410 {
4411 "name": "ios"
4412 },
4413 {
4414 "name": "md"
4415 }
4416 ]
4417 },
4418 {
4419 "name": "name",
4420 "description": "The name of the control, which is submitted with the form data."
4421 },
4422 {
4423 "name": "value",
4424 "description": "The value of the toggle does not mean if it's checked or not, use the `checked`\nproperty for that.\n\nThe value of a toggle is analogous to the value of a `<input type=\"checkbox\">`,\nit's only used when the toggle participates in a native `<form>`."
4425 }
4426 ],
4427 "references": [
4428 {
4429 "name": "Source code",
4430 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/toggle/toggle.tsx"
4431 }
4432 ]
4433 },
4434 {
4435 "name": "ion-toolbar",
4436 "description": {
4437 "kind": "markdown",
4438 "value": "Toolbars are positioned above or below content. When a toolbar is placed in an `<ion-header>` it will appear fixed at the top of the content, and when it is in an `<ion-footer>` it will appear fixed at the bottom. Fullscreen content will scroll behind a toolbar in a header or footer. When placed within an `<ion-content>`, toolbars will scroll with the content."
4439 },
4440 "attributes": [
4441 {
4442 "name": "color",
4443 "description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics)."
4444 },
4445 {
4446 "name": "mode",
4447 "description": "The mode determines which platform styles to use.",
4448 "values": [
4449 {
4450 "name": "ios"
4451 },
4452 {
4453 "name": "md"
4454 }
4455 ]
4456 }
4457 ],
4458 "references": [
4459 {
4460 "name": "Source code",
4461 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/toolbar/toolbar.tsx"
4462 }
4463 ]
4464 },
4465 {
4466 "name": "ion-virtual-scroll",
4467 "description": {
4468 "kind": "markdown",
4469 "value": "Virtual Scroll displays a virtual, \"infinite\" list. An array of records\nis passed to the virtual scroll containing the data to create templates\nfor. The template created for each record, referred to as a cell, can\nconsist of items, headers, and footers. For performance reasons, not every record\nin the list is rendered at once; instead a small subset of records (enough to fill the viewport)\nare rendered and reused as the user scrolls.\n\nThis guide will go over the recommended virtual scrolling packages for each framework integration as well as documentation for the deprecated `ion-virtual-scroll` component for Ionic Angular. We recommend using the framework-specific solutions listed below, but the `ion-virtual-scroll` documentation is available below for developers who are still using that component."
4470 },
4471 "attributes": [
4472 {
4473 "name": "approx-footer-height",
4474 "description": "The approximate width of each footer template's cell.\nThis dimension is used to help determine how many cells should\nbe created when initialized, and to help calculate the height of\nthe scrollable area. This height value can only use `px` units.\nNote that the actual rendered size of each cell comes from the\napp's CSS, whereas this approximation is used to help calculate\ninitial dimensions before the item has been rendered."
4475 },
4476 {
4477 "name": "approx-header-height",
4478 "description": "The approximate height of each header template's cell.\nThis dimension is used to help determine how many cells should\nbe created when initialized, and to help calculate the height of\nthe scrollable area. This height value can only use `px` units.\nNote that the actual rendered size of each cell comes from the\napp's CSS, whereas this approximation is used to help calculate\ninitial dimensions before the item has been rendered."
4479 },
4480 {
4481 "name": "approx-item-height",
4482 "description": "It is important to provide this\nif virtual item height will be significantly larger than the default\nThe approximate height of each virtual item template's cell.\nThis dimension is used to help determine how many cells should\nbe created when initialized, and to help calculate the height of\nthe scrollable area. This height value can only use `px` units.\nNote that the actual rendered size of each cell comes from the\napp's CSS, whereas this approximation is used to help calculate\ninitial dimensions before the item has been rendered."
4483 }
4484 ],
4485 "references": [
4486 {
4487 "name": "Source code",
4488 "url": "./https:/github.com/ionic-team/ionic/tree/master/core/src/components/virtual-scroll/virtual-scroll.tsx"
4489 }
4490 ]
4491 }
4492 ]
4493}
\No newline at end of file