diff --git a/docs/api/accordion-group.md b/docs/api/accordion-group.md index 312f8acd762..2880703001c 100644 --- a/docs/api/accordion-group.md +++ b/docs/api/accordion-group.md @@ -1,12 +1,12 @@ --- title: "ion-accordion-group" --- -import Props from '@ionic-internal/component-api/v7/accordion-group/props.md'; -import Events from '@ionic-internal/component-api/v7/accordion-group/events.md'; -import Methods from '@ionic-internal/component-api/v7/accordion-group/methods.md'; -import Parts from '@ionic-internal/component-api/v7/accordion-group/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/accordion-group/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/accordion-group/slots.md'; +import Props from '@site/static/auto-generated/accordion-group/props.md'; +import Events from '@site/static/auto-generated/accordion-group/events.md'; +import Methods from '@site/static/auto-generated/accordion-group/methods.md'; +import Parts from '@site/static/auto-generated/accordion-group/parts.md'; +import CustomProps from '@site/static/auto-generated/accordion-group/custom-props.md'; +import Slots from '@site/static/auto-generated/accordion-group/slots.md'; import EncapsulationPill from '@components/page/api/EncapsulationPill'; diff --git a/docs/api/accordion.md b/docs/api/accordion.md index f64573d9c64..0fb249825c8 100644 --- a/docs/api/accordion.md +++ b/docs/api/accordion.md @@ -1,12 +1,12 @@ --- title: "ion-accordion" --- -import Props from '@ionic-internal/component-api/v7/accordion/props.md'; -import Events from '@ionic-internal/component-api/v7/accordion/events.md'; -import Methods from '@ionic-internal/component-api/v7/accordion/methods.md'; -import Parts from '@ionic-internal/component-api/v7/accordion/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/accordion/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/accordion/slots.md'; +import Props from '@site/static/auto-generated/accordion/props.md'; +import Events from '@site/static/auto-generated/accordion/events.md'; +import Methods from '@site/static/auto-generated/accordion/methods.md'; +import Parts from '@site/static/auto-generated/accordion/parts.md'; +import CustomProps from '@site/static/auto-generated/accordion/custom-props.md'; +import Slots from '@site/static/auto-generated/accordion/slots.md'; Ion-Accordion Components: How to Build & Examples | Ionic diff --git a/docs/api/action-sheet.md b/docs/api/action-sheet.md index a11e669c194..64943f9fcf2 100644 --- a/docs/api/action-sheet.md +++ b/docs/api/action-sheet.md @@ -1,12 +1,12 @@ --- title: "ion-action-sheet" --- -import Props from '@ionic-internal/component-api/v7/action-sheet/props.md'; -import Events from '@ionic-internal/component-api/v7/action-sheet/events.md'; -import Methods from '@ionic-internal/component-api/v7/action-sheet/methods.md'; -import Parts from '@ionic-internal/component-api/v7/action-sheet/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/action-sheet/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/action-sheet/slots.md'; +import Props from '@site/static/auto-generated/action-sheet/props.md'; +import Events from '@site/static/auto-generated/action-sheet/events.md'; +import Methods from '@site/static/auto-generated/action-sheet/methods.md'; +import Parts from '@site/static/auto-generated/action-sheet/parts.md'; +import CustomProps from '@site/static/auto-generated/action-sheet/custom-props.md'; +import Slots from '@site/static/auto-generated/action-sheet/slots.md'; ion-action-sheet | Action Sheet Dialog for iOS and Android Apps diff --git a/docs/api/alert.md b/docs/api/alert.md index f6e5d5ee581..3aa37fd64d2 100644 --- a/docs/api/alert.md +++ b/docs/api/alert.md @@ -4,12 +4,12 @@ title: "ion-alert" import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -import Props from '@ionic-internal/component-api/v7/alert/props.md'; -import Events from '@ionic-internal/component-api/v7/alert/events.md'; -import Methods from '@ionic-internal/component-api/v7/alert/methods.md'; -import Parts from '@ionic-internal/component-api/v7/alert/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/alert/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/alert/slots.md'; +import Props from '@site/static/auto-generated/alert/props.md'; +import Events from '@site/static/auto-generated/alert/events.md'; +import Methods from '@site/static/auto-generated/alert/methods.md'; +import Parts from '@site/static/auto-generated/alert/parts.md'; +import CustomProps from '@site/static/auto-generated/alert/custom-props.md'; +import Slots from '@site/static/auto-generated/alert/slots.md'; ion-alert: Ionic API Alert Buttons with Custom Message Prompts diff --git a/docs/api/app.md b/docs/api/app.md index 1ac4dc6805e..98125d4aa8e 100644 --- a/docs/api/app.md +++ b/docs/api/app.md @@ -1,12 +1,12 @@ --- title: "ion-app" --- -import Props from '@ionic-internal/component-api/v7/app/props.md'; -import Events from '@ionic-internal/component-api/v7/app/events.md'; -import Methods from '@ionic-internal/component-api/v7/app/methods.md'; -import Parts from '@ionic-internal/component-api/v7/app/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/app/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/app/slots.md'; +import Props from '@site/static/auto-generated/app/props.md'; +import Events from '@site/static/auto-generated/app/events.md'; +import Methods from '@site/static/auto-generated/app/methods.md'; +import Parts from '@site/static/auto-generated/app/parts.md'; +import CustomProps from '@site/static/auto-generated/app/custom-props.md'; +import Slots from '@site/static/auto-generated/app/slots.md'; ion-app: Container Element for an Ionic Application diff --git a/docs/api/avatar.md b/docs/api/avatar.md index 0f61597f61c..ed6cd9db893 100644 --- a/docs/api/avatar.md +++ b/docs/api/avatar.md @@ -2,12 +2,12 @@ title: "ion-avatar" --- -import Props from '@ionic-internal/component-api/v7/avatar/props.md'; -import Events from '@ionic-internal/component-api/v7/avatar/events.md'; -import Methods from '@ionic-internal/component-api/v7/avatar/methods.md'; -import Parts from '@ionic-internal/component-api/v7/avatar/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/avatar/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/avatar/slots.md'; +import Props from '@site/static/auto-generated/avatar/props.md'; +import Events from '@site/static/auto-generated/avatar/events.md'; +import Methods from '@site/static/auto-generated/avatar/methods.md'; +import Parts from '@site/static/auto-generated/avatar/parts.md'; +import CustomProps from '@site/static/auto-generated/avatar/custom-props.md'; +import Slots from '@site/static/auto-generated/avatar/slots.md'; ion-avatar: Circular Application Avatar Icon Component diff --git a/docs/api/back-button.md b/docs/api/back-button.md index ca39063c3b5..6500a8ab781 100644 --- a/docs/api/back-button.md +++ b/docs/api/back-button.md @@ -1,12 +1,12 @@ --- title: "ion-back-button" --- -import Props from '@ionic-internal/component-api/v7/back-button/props.md'; -import Events from '@ionic-internal/component-api/v7/back-button/events.md'; -import Methods from '@ionic-internal/component-api/v7/back-button/methods.md'; -import Parts from '@ionic-internal/component-api/v7/back-button/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/back-button/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/back-button/slots.md'; +import Props from '@site/static/auto-generated/back-button/props.md'; +import Events from '@site/static/auto-generated/back-button/events.md'; +import Methods from '@site/static/auto-generated/back-button/methods.md'; +import Parts from '@site/static/auto-generated/back-button/parts.md'; +import CustomProps from '@site/static/auto-generated/back-button/custom-props.md'; +import Slots from '@site/static/auto-generated/back-button/slots.md'; Back Button | ion-back-button: Custom Menu Icon for Applications diff --git a/docs/api/backdrop.md b/docs/api/backdrop.md index 4684f53e6e3..e23d11b0588 100644 --- a/docs/api/backdrop.md +++ b/docs/api/backdrop.md @@ -1,12 +1,12 @@ --- title: "ion-backdrop" --- -import Props from '@ionic-internal/component-api/v7/backdrop/props.md'; -import Events from '@ionic-internal/component-api/v7/backdrop/events.md'; -import Methods from '@ionic-internal/component-api/v7/backdrop/methods.md'; -import Parts from '@ionic-internal/component-api/v7/backdrop/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/backdrop/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/backdrop/slots.md'; +import Props from '@site/static/auto-generated/backdrop/props.md'; +import Events from '@site/static/auto-generated/backdrop/events.md'; +import Methods from '@site/static/auto-generated/backdrop/methods.md'; +import Parts from '@site/static/auto-generated/backdrop/parts.md'; +import CustomProps from '@site/static/auto-generated/backdrop/custom-props.md'; +import Slots from '@site/static/auto-generated/backdrop/slots.md'; import EncapsulationPill from '@components/page/api/EncapsulationPill'; diff --git a/docs/api/badge.md b/docs/api/badge.md index 4f956169fa7..21e2f298355 100644 --- a/docs/api/badge.md +++ b/docs/api/badge.md @@ -1,12 +1,12 @@ --- title: "ion-badge" --- -import Props from '@ionic-internal/component-api/v7/badge/props.md'; -import Events from '@ionic-internal/component-api/v7/badge/events.md'; -import Methods from '@ionic-internal/component-api/v7/badge/methods.md'; -import Parts from '@ionic-internal/component-api/v7/badge/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/badge/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/badge/slots.md'; +import Props from '@site/static/auto-generated/badge/props.md'; +import Events from '@site/static/auto-generated/badge/events.md'; +import Methods from '@site/static/auto-generated/badge/methods.md'; +import Parts from '@site/static/auto-generated/badge/parts.md'; +import CustomProps from '@site/static/auto-generated/badge/custom-props.md'; +import Slots from '@site/static/auto-generated/badge/slots.md'; Badges | ion-badge: iOS & Android App Notification Badge Icons diff --git a/docs/api/breadcrumb.md b/docs/api/breadcrumb.md index 5679d17a3c9..5be2aa6c695 100644 --- a/docs/api/breadcrumb.md +++ b/docs/api/breadcrumb.md @@ -1,12 +1,12 @@ --- title: "ion-breadcrumb" --- -import Props from '@ionic-internal/component-api/v7/breadcrumb/props.md'; -import Events from '@ionic-internal/component-api/v7/breadcrumb/events.md'; -import Methods from '@ionic-internal/component-api/v7/breadcrumb/methods.md'; -import Parts from '@ionic-internal/component-api/v7/breadcrumb/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/breadcrumb/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/breadcrumb/slots.md'; +import Props from '@site/static/auto-generated/breadcrumb/props.md'; +import Events from '@site/static/auto-generated/breadcrumb/events.md'; +import Methods from '@site/static/auto-generated/breadcrumb/methods.md'; +import Parts from '@site/static/auto-generated/breadcrumb/parts.md'; +import CustomProps from '@site/static/auto-generated/breadcrumb/custom-props.md'; +import Slots from '@site/static/auto-generated/breadcrumb/slots.md'; import EncapsulationPill from '@components/page/api/EncapsulationPill'; diff --git a/docs/api/breadcrumbs.md b/docs/api/breadcrumbs.md index cff44c2f872..d9a12c4c9a4 100644 --- a/docs/api/breadcrumbs.md +++ b/docs/api/breadcrumbs.md @@ -1,12 +1,12 @@ --- title: "ion-breadcrumbs" --- -import Props from '@ionic-internal/component-api/v7/breadcrumbs/props.md'; -import Events from '@ionic-internal/component-api/v7/breadcrumbs/events.md'; -import Methods from '@ionic-internal/component-api/v7/breadcrumbs/methods.md'; -import Parts from '@ionic-internal/component-api/v7/breadcrumbs/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/breadcrumbs/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/breadcrumbs/slots.md'; +import Props from '@site/static/auto-generated/breadcrumbs/props.md'; +import Events from '@site/static/auto-generated/breadcrumbs/events.md'; +import Methods from '@site/static/auto-generated/breadcrumbs/methods.md'; +import Parts from '@site/static/auto-generated/breadcrumbs/parts.md'; +import CustomProps from '@site/static/auto-generated/breadcrumbs/custom-props.md'; +import Slots from '@site/static/auto-generated/breadcrumbs/slots.md'; diff --git a/docs/api/button.md b/docs/api/button.md index c538075468d..b3161ccb0ec 100644 --- a/docs/api/button.md +++ b/docs/api/button.md @@ -1,12 +1,12 @@ --- title: "ion-button" --- -import Props from '@ionic-internal/component-api/v7/button/props.md'; -import Events from '@ionic-internal/component-api/v7/button/events.md'; -import Methods from '@ionic-internal/component-api/v7/button/methods.md'; -import Parts from '@ionic-internal/component-api/v7/button/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/button/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/button/slots.md'; +import Props from '@site/static/auto-generated/button/props.md'; +import Events from '@site/static/auto-generated/button/events.md'; +import Methods from '@site/static/auto-generated/button/methods.md'; +import Parts from '@site/static/auto-generated/button/parts.md'; +import CustomProps from '@site/static/auto-generated/button/custom-props.md'; +import Slots from '@site/static/auto-generated/button/slots.md'; ion-button: Design and Style Buttons with Custom CSS Properties diff --git a/docs/api/buttons.md b/docs/api/buttons.md index cc8f5cf401c..3e4db87783f 100644 --- a/docs/api/buttons.md +++ b/docs/api/buttons.md @@ -1,12 +1,12 @@ --- title: "ion-buttons" --- -import Props from '@ionic-internal/component-api/v7/buttons/props.md'; -import Events from '@ionic-internal/component-api/v7/buttons/events.md'; -import Methods from '@ionic-internal/component-api/v7/buttons/methods.md'; -import Parts from '@ionic-internal/component-api/v7/buttons/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/buttons/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/buttons/slots.md'; +import Props from '@site/static/auto-generated/buttons/props.md'; +import Events from '@site/static/auto-generated/buttons/events.md'; +import Methods from '@site/static/auto-generated/buttons/methods.md'; +import Parts from '@site/static/auto-generated/buttons/parts.md'; +import CustomProps from '@site/static/auto-generated/buttons/custom-props.md'; +import Slots from '@site/static/auto-generated/buttons/slots.md'; ion-buttons: Toolbar Element with Named Slots for Buttons diff --git a/docs/api/card-content.md b/docs/api/card-content.md index ad6e5e51be8..647cba00897 100644 --- a/docs/api/card-content.md +++ b/docs/api/card-content.md @@ -1,12 +1,12 @@ --- title: "ion-card-content" --- -import Props from '@ionic-internal/component-api/v7/card-content/props.md'; -import Events from '@ionic-internal/component-api/v7/card-content/events.md'; -import Methods from '@ionic-internal/component-api/v7/card-content/methods.md'; -import Parts from '@ionic-internal/component-api/v7/card-content/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/card-content/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/card-content/slots.md'; +import Props from '@site/static/auto-generated/card-content/props.md'; +import Events from '@site/static/auto-generated/card-content/events.md'; +import Methods from '@site/static/auto-generated/card-content/methods.md'; +import Parts from '@site/static/auto-generated/card-content/parts.md'; +import CustomProps from '@site/static/auto-generated/card-content/custom-props.md'; +import Slots from '@site/static/auto-generated/card-content/slots.md'; import EncapsulationPill from '@components/page/api/EncapsulationPill'; diff --git a/docs/api/card-header.md b/docs/api/card-header.md index c247d37e667..2e52467ed43 100644 --- a/docs/api/card-header.md +++ b/docs/api/card-header.md @@ -1,12 +1,12 @@ --- title: "ion-card-header" --- -import Props from '@ionic-internal/component-api/v7/card-header/props.md'; -import Events from '@ionic-internal/component-api/v7/card-header/events.md'; -import Methods from '@ionic-internal/component-api/v7/card-header/methods.md'; -import Parts from '@ionic-internal/component-api/v7/card-header/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/card-header/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/card-header/slots.md'; +import Props from '@site/static/auto-generated/card-header/props.md'; +import Events from '@site/static/auto-generated/card-header/events.md'; +import Methods from '@site/static/auto-generated/card-header/methods.md'; +import Parts from '@site/static/auto-generated/card-header/parts.md'; +import CustomProps from '@site/static/auto-generated/card-header/custom-props.md'; +import Slots from '@site/static/auto-generated/card-header/slots.md'; import EncapsulationPill from '@components/page/api/EncapsulationPill'; diff --git a/docs/api/card-subtitle.md b/docs/api/card-subtitle.md index 692caa70759..ec72784cd99 100644 --- a/docs/api/card-subtitle.md +++ b/docs/api/card-subtitle.md @@ -1,12 +1,12 @@ --- title: "ion-card-subtitle" --- -import Props from '@ionic-internal/component-api/v7/card-subtitle/props.md'; -import Events from '@ionic-internal/component-api/v7/card-subtitle/events.md'; -import Methods from '@ionic-internal/component-api/v7/card-subtitle/methods.md'; -import Parts from '@ionic-internal/component-api/v7/card-subtitle/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/card-subtitle/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/card-subtitle/slots.md'; +import Props from '@site/static/auto-generated/card-subtitle/props.md'; +import Events from '@site/static/auto-generated/card-subtitle/events.md'; +import Methods from '@site/static/auto-generated/card-subtitle/methods.md'; +import Parts from '@site/static/auto-generated/card-subtitle/parts.md'; +import CustomProps from '@site/static/auto-generated/card-subtitle/custom-props.md'; +import Slots from '@site/static/auto-generated/card-subtitle/slots.md'; import EncapsulationPill from '@components/page/api/EncapsulationPill'; diff --git a/docs/api/card-title.md b/docs/api/card-title.md index 9263fe91136..33b24158eb5 100644 --- a/docs/api/card-title.md +++ b/docs/api/card-title.md @@ -1,12 +1,12 @@ --- title: "ion-card-title" --- -import Props from '@ionic-internal/component-api/v7/card-title/props.md'; -import Events from '@ionic-internal/component-api/v7/card-title/events.md'; -import Methods from '@ionic-internal/component-api/v7/card-title/methods.md'; -import Parts from '@ionic-internal/component-api/v7/card-title/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/card-title/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/card-title/slots.md'; +import Props from '@site/static/auto-generated/card-title/props.md'; +import Events from '@site/static/auto-generated/card-title/events.md'; +import Methods from '@site/static/auto-generated/card-title/methods.md'; +import Parts from '@site/static/auto-generated/card-title/parts.md'; +import CustomProps from '@site/static/auto-generated/card-title/custom-props.md'; +import Slots from '@site/static/auto-generated/card-title/slots.md'; import EncapsulationPill from '@components/page/api/EncapsulationPill'; diff --git a/docs/api/card.md b/docs/api/card.md index 183166599b2..b9419281ab6 100644 --- a/docs/api/card.md +++ b/docs/api/card.md @@ -1,12 +1,12 @@ --- title: "ion-card" --- -import Props from '@ionic-internal/component-api/v7/card/props.md'; -import Events from '@ionic-internal/component-api/v7/card/events.md'; -import Methods from '@ionic-internal/component-api/v7/card/methods.md'; -import Parts from '@ionic-internal/component-api/v7/card/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/card/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/card/slots.md'; +import Props from '@site/static/auto-generated/card/props.md'; +import Events from '@site/static/auto-generated/card/events.md'; +import Methods from '@site/static/auto-generated/card/methods.md'; +import Parts from '@site/static/auto-generated/card/parts.md'; +import CustomProps from '@site/static/auto-generated/card/custom-props.md'; +import Slots from '@site/static/auto-generated/card/slots.md'; import EncapsulationPill from '@components/page/api/EncapsulationPill'; diff --git a/docs/api/checkbox.md b/docs/api/checkbox.md index 0f62607010d..c861b994ff1 100644 --- a/docs/api/checkbox.md +++ b/docs/api/checkbox.md @@ -2,12 +2,12 @@ title: "ion-checkbox" --- -import Props from '@ionic-internal/component-api/v7/checkbox/props.md'; -import Events from '@ionic-internal/component-api/v7/checkbox/events.md'; -import Methods from '@ionic-internal/component-api/v7/checkbox/methods.md'; -import Parts from '@ionic-internal/component-api/v7/checkbox/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/checkbox/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/checkbox/slots.md'; +import Props from '@site/static/auto-generated/checkbox/props.md'; +import Events from '@site/static/auto-generated/checkbox/events.md'; +import Methods from '@site/static/auto-generated/checkbox/methods.md'; +import Parts from '@site/static/auto-generated/checkbox/parts.md'; +import CustomProps from '@site/static/auto-generated/checkbox/custom-props.md'; +import Slots from '@site/static/auto-generated/checkbox/slots.md'; ion-checkboxes: Ionic App Component to Select Multiple Options diff --git a/docs/api/chip.md b/docs/api/chip.md index e05495b6493..e032f7e5e0e 100644 --- a/docs/api/chip.md +++ b/docs/api/chip.md @@ -1,12 +1,12 @@ --- title: "ion-chip" --- -import Props from '@ionic-internal/component-api/v7/chip/props.md'; -import Events from '@ionic-internal/component-api/v7/chip/events.md'; -import Methods from '@ionic-internal/component-api/v7/chip/methods.md'; -import Parts from '@ionic-internal/component-api/v7/chip/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/chip/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/chip/slots.md'; +import Props from '@site/static/auto-generated/chip/props.md'; +import Events from '@site/static/auto-generated/chip/events.md'; +import Methods from '@site/static/auto-generated/chip/methods.md'; +import Parts from '@site/static/auto-generated/chip/parts.md'; +import CustomProps from '@site/static/auto-generated/chip/custom-props.md'; +import Slots from '@site/static/auto-generated/chip/slots.md'; ion-chip: Name, Text, Icon and Avatar for Ionic Framework Apps diff --git a/docs/api/col.md b/docs/api/col.md index 2f6ac3e552f..e5872b4f6a1 100644 --- a/docs/api/col.md +++ b/docs/api/col.md @@ -1,12 +1,12 @@ --- title: "ion-col" --- -import Props from '@ionic-internal/component-api/v7/col/props.md'; -import Events from '@ionic-internal/component-api/v7/col/events.md'; -import Methods from '@ionic-internal/component-api/v7/col/methods.md'; -import Parts from '@ionic-internal/component-api/v7/col/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/col/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/col/slots.md'; +import Props from '@site/static/auto-generated/col/props.md'; +import Events from '@site/static/auto-generated/col/events.md'; +import Methods from '@site/static/auto-generated/col/methods.md'; +import Parts from '@site/static/auto-generated/col/parts.md'; +import CustomProps from '@site/static/auto-generated/col/custom-props.md'; +import Slots from '@site/static/auto-generated/col/slots.md'; ion-col: Column Component Padding, Size and Other Properties diff --git a/docs/api/content.md b/docs/api/content.md index a257b0e51ee..a0feb3f2ccd 100644 --- a/docs/api/content.md +++ b/docs/api/content.md @@ -1,12 +1,12 @@ --- title: "ion-content" --- -import Props from '@ionic-internal/component-api/v7/content/props.md'; -import Events from '@ionic-internal/component-api/v7/content/events.md'; -import Methods from '@ionic-internal/component-api/v7/content/methods.md'; -import Parts from '@ionic-internal/component-api/v7/content/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/content/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/content/slots.md'; +import Props from '@site/static/auto-generated/content/props.md'; +import Events from '@site/static/auto-generated/content/events.md'; +import Methods from '@site/static/auto-generated/content/methods.md'; +import Parts from '@site/static/auto-generated/content/parts.md'; +import CustomProps from '@site/static/auto-generated/content/custom-props.md'; +import Slots from '@site/static/auto-generated/content/slots.md'; ion-content: Scrollable CSS Component for Ionic App Content Areas diff --git a/docs/api/datetime-button.md b/docs/api/datetime-button.md index 554e74d2b01..a17b50b498f 100644 --- a/docs/api/datetime-button.md +++ b/docs/api/datetime-button.md @@ -1,12 +1,12 @@ --- title: "ion-datetime-button" --- -import Props from '@ionic-internal/component-api/v7/datetime-button/props.md'; -import Events from '@ionic-internal/component-api/v7/datetime-button/events.md'; -import Methods from '@ionic-internal/component-api/v7/datetime-button/methods.md'; -import Parts from '@ionic-internal/component-api/v7/datetime-button/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/datetime-button/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/datetime-button/slots.md'; +import Props from '@site/static/auto-generated/datetime-button/props.md'; +import Events from '@site/static/auto-generated/datetime-button/events.md'; +import Methods from '@site/static/auto-generated/datetime-button/methods.md'; +import Parts from '@site/static/auto-generated/datetime-button/parts.md'; +import CustomProps from '@site/static/auto-generated/datetime-button/custom-props.md'; +import Slots from '@site/static/auto-generated/datetime-button/slots.md'; ion-datetime-button: Ionic API Input for interacting with Datetime picker diff --git a/docs/api/datetime.md b/docs/api/datetime.md index 784c151cf0c..36f2946b919 100644 --- a/docs/api/datetime.md +++ b/docs/api/datetime.md @@ -1,12 +1,12 @@ --- title: "ion-datetime" --- -import Props from '@ionic-internal/component-api/v7/datetime/props.md'; -import Events from '@ionic-internal/component-api/v7/datetime/events.md'; -import Methods from '@ionic-internal/component-api/v7/datetime/methods.md'; -import Parts from '@ionic-internal/component-api/v7/datetime/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/datetime/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/datetime/slots.md'; +import Props from '@site/static/auto-generated/datetime/props.md'; +import Events from '@site/static/auto-generated/datetime/events.md'; +import Methods from '@site/static/auto-generated/datetime/methods.md'; +import Parts from '@site/static/auto-generated/datetime/parts.md'; +import CustomProps from '@site/static/auto-generated/datetime/custom-props.md'; +import Slots from '@site/static/auto-generated/datetime/slots.md'; import Basic from '@site/static/usage/v7/datetime/basic/index.md'; diff --git a/docs/api/fab-button.md b/docs/api/fab-button.md index d864c6c3f38..ab86a48426e 100644 --- a/docs/api/fab-button.md +++ b/docs/api/fab-button.md @@ -1,12 +1,12 @@ --- title: "ion-fab-button" --- -import Props from '@ionic-internal/component-api/v7/fab-button/props.md'; -import Events from '@ionic-internal/component-api/v7/fab-button/events.md'; -import Methods from '@ionic-internal/component-api/v7/fab-button/methods.md'; -import Parts from '@ionic-internal/component-api/v7/fab-button/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/fab-button/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/fab-button/slots.md'; +import Props from '@site/static/auto-generated/fab-button/props.md'; +import Events from '@site/static/auto-generated/fab-button/events.md'; +import Methods from '@site/static/auto-generated/fab-button/methods.md'; +import Parts from '@site/static/auto-generated/fab-button/parts.md'; +import CustomProps from '@site/static/auto-generated/fab-button/custom-props.md'; +import Slots from '@site/static/auto-generated/fab-button/slots.md'; Floating Action Button | Ionic FAB Button Icon for Primary Action diff --git a/docs/api/fab-list.md b/docs/api/fab-list.md index e97540df9d3..a0659a394d7 100644 --- a/docs/api/fab-list.md +++ b/docs/api/fab-list.md @@ -1,12 +1,12 @@ --- title: "ion-fab-list" --- -import Props from '@ionic-internal/component-api/v7/fab-list/props.md'; -import Events from '@ionic-internal/component-api/v7/fab-list/events.md'; -import Methods from '@ionic-internal/component-api/v7/fab-list/methods.md'; -import Parts from '@ionic-internal/component-api/v7/fab-list/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/fab-list/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/fab-list/slots.md'; +import Props from '@site/static/auto-generated/fab-list/props.md'; +import Events from '@site/static/auto-generated/fab-list/events.md'; +import Methods from '@site/static/auto-generated/fab-list/methods.md'; +import Parts from '@site/static/auto-generated/fab-list/parts.md'; +import CustomProps from '@site/static/auto-generated/fab-list/custom-props.md'; +import Slots from '@site/static/auto-generated/fab-list/slots.md'; import EncapsulationPill from '@components/page/api/EncapsulationPill'; diff --git a/docs/api/fab.md b/docs/api/fab.md index 06201e3bde6..55ce35332fb 100644 --- a/docs/api/fab.md +++ b/docs/api/fab.md @@ -1,12 +1,12 @@ --- title: "ion-fab" --- -import Props from '@ionic-internal/component-api/v7/fab/props.md'; -import Events from '@ionic-internal/component-api/v7/fab/events.md'; -import Methods from '@ionic-internal/component-api/v7/fab/methods.md'; -import Parts from '@ionic-internal/component-api/v7/fab/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/fab/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/fab/slots.md'; +import Props from '@site/static/auto-generated/fab/props.md'; +import Events from '@site/static/auto-generated/fab/events.md'; +import Methods from '@site/static/auto-generated/fab/methods.md'; +import Parts from '@site/static/auto-generated/fab/parts.md'; +import CustomProps from '@site/static/auto-generated/fab/custom-props.md'; +import Slots from '@site/static/auto-generated/fab/slots.md'; ion-fab: Floating Action Button for Android and iOS Ionic Apps diff --git a/docs/api/footer.md b/docs/api/footer.md index 5127287d601..b5298d7bccd 100644 --- a/docs/api/footer.md +++ b/docs/api/footer.md @@ -1,12 +1,12 @@ --- title: "ion-footer" --- -import Props from '@ionic-internal/component-api/v7/footer/props.md'; -import Events from '@ionic-internal/component-api/v7/footer/events.md'; -import Methods from '@ionic-internal/component-api/v7/footer/methods.md'; -import Parts from '@ionic-internal/component-api/v7/footer/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/footer/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/footer/slots.md'; +import Props from '@site/static/auto-generated/footer/props.md'; +import Events from '@site/static/auto-generated/footer/events.md'; +import Methods from '@site/static/auto-generated/footer/methods.md'; +import Parts from '@site/static/auto-generated/footer/parts.md'; +import CustomProps from '@site/static/auto-generated/footer/custom-props.md'; +import Slots from '@site/static/auto-generated/footer/slots.md'; Page Footer | Ionic App Footer: Wrapper Root Page Component diff --git a/docs/api/grid.md b/docs/api/grid.md index e80e3642bb7..30b504cd3cf 100644 --- a/docs/api/grid.md +++ b/docs/api/grid.md @@ -1,12 +1,12 @@ --- title: "ion-grid" --- -import Props from '@ionic-internal/component-api/v7/grid/props.md'; -import Events from '@ionic-internal/component-api/v7/grid/events.md'; -import Methods from '@ionic-internal/component-api/v7/grid/methods.md'; -import Parts from '@ionic-internal/component-api/v7/grid/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/grid/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/grid/slots.md'; +import Props from '@site/static/auto-generated/grid/props.md'; +import Events from '@site/static/auto-generated/grid/events.md'; +import Methods from '@site/static/auto-generated/grid/methods.md'; +import Parts from '@site/static/auto-generated/grid/parts.md'; +import CustomProps from '@site/static/auto-generated/grid/custom-props.md'; +import Slots from '@site/static/auto-generated/grid/slots.md'; Ion-Grid: Display Grids to Build Mobile-First Custom App Layout diff --git a/docs/api/header.md b/docs/api/header.md index 584a5207d05..7288b636abe 100644 --- a/docs/api/header.md +++ b/docs/api/header.md @@ -1,12 +1,12 @@ --- title: "ion-header" --- -import Props from '@ionic-internal/component-api/v7/header/props.md'; -import Events from '@ionic-internal/component-api/v7/header/events.md'; -import Methods from '@ionic-internal/component-api/v7/header/methods.md'; -import Parts from '@ionic-internal/component-api/v7/header/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/header/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/header/slots.md'; +import Props from '@site/static/auto-generated/header/props.md'; +import Events from '@site/static/auto-generated/header/events.md'; +import Methods from '@site/static/auto-generated/header/methods.md'; +import Parts from '@site/static/auto-generated/header/parts.md'; +import CustomProps from '@site/static/auto-generated/header/custom-props.md'; +import Slots from '@site/static/auto-generated/header/slots.md'; ion-header: Header Parent Component for Ionic Framework Apps diff --git a/docs/api/img.md b/docs/api/img.md index 441c9f4f27c..14c697c760d 100644 --- a/docs/api/img.md +++ b/docs/api/img.md @@ -2,12 +2,12 @@ title: "ion-img" --- -import Props from '@ionic-internal/component-api/v7/img/props.md'; -import Events from '@ionic-internal/component-api/v7/img/events.md'; -import Methods from '@ionic-internal/component-api/v7/img/methods.md'; -import Parts from '@ionic-internal/component-api/v7/img/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/img/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/img/slots.md'; +import Props from '@site/static/auto-generated/img/props.md'; +import Events from '@site/static/auto-generated/img/events.md'; +import Methods from '@site/static/auto-generated/img/methods.md'; +import Parts from '@site/static/auto-generated/img/parts.md'; +import CustomProps from '@site/static/auto-generated/img/custom-props.md'; +import Slots from '@site/static/auto-generated/img/slots.md'; Img Tag to Lazy Load Images in Viewport | ion-img Tag diff --git a/docs/api/infinite-scroll-content.md b/docs/api/infinite-scroll-content.md index 39da6e7165f..2647dffdb87 100644 --- a/docs/api/infinite-scroll-content.md +++ b/docs/api/infinite-scroll-content.md @@ -2,12 +2,12 @@ title: "ion-infinite-scroll-content" --- -import Props from '@ionic-internal/component-api/v7/infinite-scroll-content/props.md'; -import Events from '@ionic-internal/component-api/v7/infinite-scroll-content/events.md'; -import Methods from '@ionic-internal/component-api/v7/infinite-scroll-content/methods.md'; -import Parts from '@ionic-internal/component-api/v7/infinite-scroll-content/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/infinite-scroll-content/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/infinite-scroll-content/slots.md'; +import Props from '@site/static/auto-generated/infinite-scroll-content/props.md'; +import Events from '@site/static/auto-generated/infinite-scroll-content/events.md'; +import Methods from '@site/static/auto-generated/infinite-scroll-content/methods.md'; +import Parts from '@site/static/auto-generated/infinite-scroll-content/parts.md'; +import CustomProps from '@site/static/auto-generated/infinite-scroll-content/custom-props.md'; +import Slots from '@site/static/auto-generated/infinite-scroll-content/slots.md'; import EncapsulationPill from '@components/page/api/EncapsulationPill'; diff --git a/docs/api/infinite-scroll.md b/docs/api/infinite-scroll.md index 12f68542b8a..5675984b447 100644 --- a/docs/api/infinite-scroll.md +++ b/docs/api/infinite-scroll.md @@ -2,12 +2,12 @@ title: "ion-infinite-scroll" --- -import Props from '@ionic-internal/component-api/v7/infinite-scroll/props.md'; -import Events from '@ionic-internal/component-api/v7/infinite-scroll/events.md'; -import Methods from '@ionic-internal/component-api/v7/infinite-scroll/methods.md'; -import Parts from '@ionic-internal/component-api/v7/infinite-scroll/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/infinite-scroll/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/infinite-scroll/slots.md'; +import Props from '@site/static/auto-generated/infinite-scroll/props.md'; +import Events from '@site/static/auto-generated/infinite-scroll/events.md'; +import Methods from '@site/static/auto-generated/infinite-scroll/methods.md'; +import Parts from '@site/static/auto-generated/infinite-scroll/parts.md'; +import CustomProps from '@site/static/auto-generated/infinite-scroll/custom-props.md'; +import Slots from '@site/static/auto-generated/infinite-scroll/slots.md'; Infinite Scroller | ion-infinite-scroll Action Component diff --git a/docs/api/input.md b/docs/api/input.md index 2e263cbf3c8..4d7df8eef12 100644 --- a/docs/api/input.md +++ b/docs/api/input.md @@ -1,12 +1,12 @@ --- title: "ion-input" --- -import Props from '@ionic-internal/component-api/v7/input/props.md'; -import Events from '@ionic-internal/component-api/v7/input/events.md'; -import Methods from '@ionic-internal/component-api/v7/input/methods.md'; -import Parts from '@ionic-internal/component-api/v7/input/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/input/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/input/slots.md'; +import Props from '@site/static/auto-generated/input/props.md'; +import Events from '@site/static/auto-generated/input/events.md'; +import Methods from '@site/static/auto-generated/input/methods.md'; +import Parts from '@site/static/auto-generated/input/parts.md'; +import CustomProps from '@site/static/auto-generated/input/custom-props.md'; +import Slots from '@site/static/auto-generated/input/slots.md'; ion-input: Custom Input Value Type Styling and CSS Properties diff --git a/docs/api/item-divider.md b/docs/api/item-divider.md index 79554071252..0f4dd8c40f8 100644 --- a/docs/api/item-divider.md +++ b/docs/api/item-divider.md @@ -1,12 +1,12 @@ --- title: "ion-item-divider" --- -import Props from '@ionic-internal/component-api/v7/item-divider/props.md'; -import Events from '@ionic-internal/component-api/v7/item-divider/events.md'; -import Methods from '@ionic-internal/component-api/v7/item-divider/methods.md'; -import Parts from '@ionic-internal/component-api/v7/item-divider/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/item-divider/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/item-divider/slots.md'; +import Props from '@site/static/auto-generated/item-divider/props.md'; +import Events from '@site/static/auto-generated/item-divider/events.md'; +import Methods from '@site/static/auto-generated/item-divider/methods.md'; +import Parts from '@site/static/auto-generated/item-divider/parts.md'; +import CustomProps from '@site/static/auto-generated/item-divider/custom-props.md'; +import Slots from '@site/static/auto-generated/item-divider/slots.md'; Item Divider | List Item Divider Block Element for Ionic Apps diff --git a/docs/api/item-group.md b/docs/api/item-group.md index 5d440ed3ce8..60cf8b09383 100644 --- a/docs/api/item-group.md +++ b/docs/api/item-group.md @@ -1,12 +1,12 @@ --- title: "ion-item-group" --- -import Props from '@ionic-internal/component-api/v7/item-group/props.md'; -import Events from '@ionic-internal/component-api/v7/item-group/events.md'; -import Methods from '@ionic-internal/component-api/v7/item-group/methods.md'; -import Parts from '@ionic-internal/component-api/v7/item-group/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/item-group/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/item-group/slots.md'; +import Props from '@site/static/auto-generated/item-group/props.md'; +import Events from '@site/static/auto-generated/item-group/events.md'; +import Methods from '@site/static/auto-generated/item-group/methods.md'; +import Parts from '@site/static/auto-generated/item-group/parts.md'; +import CustomProps from '@site/static/auto-generated/item-group/custom-props.md'; +import Slots from '@site/static/auto-generated/item-group/slots.md'; ion-item-group: Group Items to Divide into Multiple Sections diff --git a/docs/api/item-option.md b/docs/api/item-option.md index 413e993de64..800d1030f50 100644 --- a/docs/api/item-option.md +++ b/docs/api/item-option.md @@ -1,12 +1,12 @@ --- title: "ion-item-option" --- -import Props from '@ionic-internal/component-api/v7/item-option/props.md'; -import Events from '@ionic-internal/component-api/v7/item-option/events.md'; -import Methods from '@ionic-internal/component-api/v7/item-option/methods.md'; -import Parts from '@ionic-internal/component-api/v7/item-option/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/item-option/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/item-option/slots.md'; +import Props from '@site/static/auto-generated/item-option/props.md'; +import Events from '@site/static/auto-generated/item-option/events.md'; +import Methods from '@site/static/auto-generated/item-option/methods.md'; +import Parts from '@site/static/auto-generated/item-option/parts.md'; +import CustomProps from '@site/static/auto-generated/item-option/custom-props.md'; +import Slots from '@site/static/auto-generated/item-option/slots.md'; ion-item-options: Option Button Components for Ionic Apps diff --git a/docs/api/item-options.md b/docs/api/item-options.md index e242c9d1012..cbee8f5289b 100644 --- a/docs/api/item-options.md +++ b/docs/api/item-options.md @@ -1,12 +1,12 @@ --- title: "ion-item-options" --- -import Props from '@ionic-internal/component-api/v7/item-options/props.md'; -import Events from '@ionic-internal/component-api/v7/item-options/events.md'; -import Methods from '@ionic-internal/component-api/v7/item-options/methods.md'; -import Parts from '@ionic-internal/component-api/v7/item-options/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/item-options/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/item-options/slots.md'; +import Props from '@site/static/auto-generated/item-options/props.md'; +import Events from '@site/static/auto-generated/item-options/events.md'; +import Methods from '@site/static/auto-generated/item-options/methods.md'; +import Parts from '@site/static/auto-generated/item-options/parts.md'; +import CustomProps from '@site/static/auto-generated/item-options/custom-props.md'; +import Slots from '@site/static/auto-generated/item-options/slots.md'; ion-item-options: Option Button Components for Ionic Apps diff --git a/docs/api/item-sliding.md b/docs/api/item-sliding.md index 61cd5f58f20..526f4d1263b 100644 --- a/docs/api/item-sliding.md +++ b/docs/api/item-sliding.md @@ -1,12 +1,12 @@ --- title: "ion-item-sliding" --- -import Props from '@ionic-internal/component-api/v7/item-sliding/props.md'; -import Events from '@ionic-internal/component-api/v7/item-sliding/events.md'; -import Methods from '@ionic-internal/component-api/v7/item-sliding/methods.md'; -import Parts from '@ionic-internal/component-api/v7/item-sliding/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/item-sliding/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/item-sliding/slots.md'; +import Props from '@site/static/auto-generated/item-sliding/props.md'; +import Events from '@site/static/auto-generated/item-sliding/events.md'; +import Methods from '@site/static/auto-generated/item-sliding/methods.md'; +import Parts from '@site/static/auto-generated/item-sliding/parts.md'; +import CustomProps from '@site/static/auto-generated/item-sliding/custom-props.md'; +import Slots from '@site/static/auto-generated/item-sliding/slots.md'; Slide Buttons | Slide Right to Left with ion-item-sliding diff --git a/docs/api/item.md b/docs/api/item.md index 6aaf0dd0609..09f89b1132b 100644 --- a/docs/api/item.md +++ b/docs/api/item.md @@ -1,12 +1,12 @@ --- title: "ion-item" --- -import Props from '@ionic-internal/component-api/v7/item/props.md'; -import Events from '@ionic-internal/component-api/v7/item/events.md'; -import Methods from '@ionic-internal/component-api/v7/item/methods.md'; -import Parts from '@ionic-internal/component-api/v7/item/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/item/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/item/slots.md'; +import Props from '@site/static/auto-generated/item/props.md'; +import Events from '@site/static/auto-generated/item/events.md'; +import Methods from '@site/static/auto-generated/item/methods.md'; +import Parts from '@site/static/auto-generated/item/parts.md'; +import CustomProps from '@site/static/auto-generated/item/custom-props.md'; +import Slots from '@site/static/auto-generated/item/slots.md'; ion-item: Input, Edit, or Delete iOS and Android Item Elements diff --git a/docs/api/label.md b/docs/api/label.md index e7ed495d15c..a7b6422775e 100644 --- a/docs/api/label.md +++ b/docs/api/label.md @@ -1,12 +1,12 @@ --- title: "ion-label" --- -import Props from '@ionic-internal/component-api/v7/label/props.md'; -import Events from '@ionic-internal/component-api/v7/label/events.md'; -import Methods from '@ionic-internal/component-api/v7/label/methods.md'; -import Parts from '@ionic-internal/component-api/v7/label/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/label/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/label/slots.md'; +import Props from '@site/static/auto-generated/label/props.md'; +import Events from '@site/static/auto-generated/label/events.md'; +import Methods from '@site/static/auto-generated/label/methods.md'; +import Parts from '@site/static/auto-generated/label/parts.md'; +import CustomProps from '@site/static/auto-generated/label/custom-props.md'; +import Slots from '@site/static/auto-generated/label/slots.md'; Item Label Color and Properties for Applications | ion-label diff --git a/docs/api/list-header.md b/docs/api/list-header.md index 4d684f1d4b8..f2ecb781627 100644 --- a/docs/api/list-header.md +++ b/docs/api/list-header.md @@ -1,12 +1,12 @@ --- title: "ion-list-header" --- -import Props from '@ionic-internal/component-api/v7/list-header/props.md'; -import Events from '@ionic-internal/component-api/v7/list-header/events.md'; -import Methods from '@ionic-internal/component-api/v7/list-header/methods.md'; -import Parts from '@ionic-internal/component-api/v7/list-header/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/list-header/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/list-header/slots.md'; +import Props from '@site/static/auto-generated/list-header/props.md'; +import Events from '@site/static/auto-generated/list-header/events.md'; +import Methods from '@site/static/auto-generated/list-header/methods.md'; +import Parts from '@site/static/auto-generated/list-header/parts.md'; +import CustomProps from '@site/static/auto-generated/list-header/custom-props.md'; +import Slots from '@site/static/auto-generated/list-header/slots.md'; import EncapsulationPill from '@components/page/api/EncapsulationPill'; diff --git a/docs/api/list.md b/docs/api/list.md index 6aee4eaa556..b5907823923 100644 --- a/docs/api/list.md +++ b/docs/api/list.md @@ -1,12 +1,12 @@ --- title: "ion-list" --- -import Props from '@ionic-internal/component-api/v7/list/props.md'; -import Events from '@ionic-internal/component-api/v7/list/events.md'; -import Methods from '@ionic-internal/component-api/v7/list/methods.md'; -import Parts from '@ionic-internal/component-api/v7/list/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/list/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/list/slots.md'; +import Props from '@site/static/auto-generated/list/props.md'; +import Events from '@site/static/auto-generated/list/events.md'; +import Methods from '@site/static/auto-generated/list/methods.md'; +import Parts from '@site/static/auto-generated/list/parts.md'; +import CustomProps from '@site/static/auto-generated/list/custom-props.md'; +import Slots from '@site/static/auto-generated/list/slots.md'; ion-list: Item List View Component for iOS and Android Apps diff --git a/docs/api/loading.md b/docs/api/loading.md index 2a9309c4ba7..f4e4f04f00c 100644 --- a/docs/api/loading.md +++ b/docs/api/loading.md @@ -1,12 +1,12 @@ --- title: "ion-loading" --- -import Props from '@ionic-internal/component-api/v7/loading/props.md'; -import Events from '@ionic-internal/component-api/v7/loading/events.md'; -import Methods from '@ionic-internal/component-api/v7/loading/methods.md'; -import Parts from '@ionic-internal/component-api/v7/loading/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/loading/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/loading/slots.md'; +import Props from '@site/static/auto-generated/loading/props.md'; +import Events from '@site/static/auto-generated/loading/events.md'; +import Methods from '@site/static/auto-generated/loading/methods.md'; +import Parts from '@site/static/auto-generated/loading/parts.md'; +import CustomProps from '@site/static/auto-generated/loading/custom-props.md'; +import Slots from '@site/static/auto-generated/loading/slots.md'; Loading | Application Loading Indicator Overlay | ion-loading diff --git a/docs/api/menu-button.md b/docs/api/menu-button.md index 7d2be77fef0..adba980b958 100644 --- a/docs/api/menu-button.md +++ b/docs/api/menu-button.md @@ -1,12 +1,12 @@ --- title: "ion-menu-button" --- -import Props from '@ionic-internal/component-api/v7/menu-button/props.md'; -import Events from '@ionic-internal/component-api/v7/menu-button/events.md'; -import Methods from '@ionic-internal/component-api/v7/menu-button/methods.md'; -import Parts from '@ionic-internal/component-api/v7/menu-button/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/menu-button/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/menu-button/slots.md'; +import Props from '@site/static/auto-generated/menu-button/props.md'; +import Events from '@site/static/auto-generated/menu-button/events.md'; +import Methods from '@site/static/auto-generated/menu-button/methods.md'; +import Parts from '@site/static/auto-generated/menu-button/parts.md'; +import CustomProps from '@site/static/auto-generated/menu-button/custom-props.md'; +import Slots from '@site/static/auto-generated/menu-button/slots.md'; Menu Button | ion-menu-button to Open an App Menu on A Page diff --git a/docs/api/menu-toggle.md b/docs/api/menu-toggle.md index 3f6cef6f6fd..e6a10201362 100644 --- a/docs/api/menu-toggle.md +++ b/docs/api/menu-toggle.md @@ -1,12 +1,12 @@ --- title: "ion-menu-toggle" --- -import Props from '@ionic-internal/component-api/v7/menu-toggle/props.md'; -import Events from '@ionic-internal/component-api/v7/menu-toggle/events.md'; -import Methods from '@ionic-internal/component-api/v7/menu-toggle/methods.md'; -import Parts from '@ionic-internal/component-api/v7/menu-toggle/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/menu-toggle/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/menu-toggle/slots.md'; +import Props from '@site/static/auto-generated/menu-toggle/props.md'; +import Events from '@site/static/auto-generated/menu-toggle/events.md'; +import Methods from '@site/static/auto-generated/menu-toggle/methods.md'; +import Parts from '@site/static/auto-generated/menu-toggle/parts.md'; +import CustomProps from '@site/static/auto-generated/menu-toggle/custom-props.md'; +import Slots from '@site/static/auto-generated/menu-toggle/slots.md'; ion-menu-toggle | MenuToggle Component to Open/Close Active Menus diff --git a/docs/api/menu.md b/docs/api/menu.md index 1918527a15a..8a12ff43350 100644 --- a/docs/api/menu.md +++ b/docs/api/menu.md @@ -1,12 +1,12 @@ --- title: "ion-menu" --- -import Props from '@ionic-internal/component-api/v7/menu/props.md'; -import Events from '@ionic-internal/component-api/v7/menu/events.md'; -import Methods from '@ionic-internal/component-api/v7/menu/methods.md'; -import Parts from '@ionic-internal/component-api/v7/menu/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/menu/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/menu/slots.md'; +import Props from '@site/static/auto-generated/menu/props.md'; +import Events from '@site/static/auto-generated/menu/events.md'; +import Methods from '@site/static/auto-generated/menu/methods.md'; +import Parts from '@site/static/auto-generated/menu/parts.md'; +import CustomProps from '@site/static/auto-generated/menu/custom-props.md'; +import Slots from '@site/static/auto-generated/menu/slots.md'; ion-menu: API Framework Docs for Types of Menu Components diff --git a/docs/api/modal.md b/docs/api/modal.md index 7271d8368f6..6e68846652e 100644 --- a/docs/api/modal.md +++ b/docs/api/modal.md @@ -1,12 +1,12 @@ --- title: "ion-modal" --- -import Props from '@ionic-internal/component-api/v7/modal/props.md'; -import Events from '@ionic-internal/component-api/v7/modal/events.md'; -import Methods from '@ionic-internal/component-api/v7/modal/methods.md'; -import Parts from '@ionic-internal/component-api/v7/modal/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/modal/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/modal/slots.md'; +import Props from '@site/static/auto-generated/modal/props.md'; +import Events from '@site/static/auto-generated/modal/events.md'; +import Methods from '@site/static/auto-generated/modal/methods.md'; +import Parts from '@site/static/auto-generated/modal/parts.md'; +import CustomProps from '@site/static/auto-generated/modal/custom-props.md'; +import Slots from '@site/static/auto-generated/modal/slots.md'; ion-modal: Ionic Mobile App Custom Modal API Component diff --git a/docs/api/nav-link.md b/docs/api/nav-link.md index 9e333a98ede..30a8f3264ed 100644 --- a/docs/api/nav-link.md +++ b/docs/api/nav-link.md @@ -1,12 +1,12 @@ --- title: "ion-nav-link" --- -import Props from '@ionic-internal/component-api/v7/nav-link/props.md'; -import Events from '@ionic-internal/component-api/v7/nav-link/events.md'; -import Methods from '@ionic-internal/component-api/v7/nav-link/methods.md'; -import Parts from '@ionic-internal/component-api/v7/nav-link/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/nav-link/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/nav-link/slots.md'; +import Props from '@site/static/auto-generated/nav-link/props.md'; +import Events from '@site/static/auto-generated/nav-link/events.md'; +import Methods from '@site/static/auto-generated/nav-link/methods.md'; +import Parts from '@site/static/auto-generated/nav-link/parts.md'; +import CustomProps from '@site/static/auto-generated/nav-link/custom-props.md'; +import Slots from '@site/static/auto-generated/nav-link/slots.md'; ion-nav-link: The Element for Navigation to a Specified Component diff --git a/docs/api/nav.md b/docs/api/nav.md index 7a5d975232f..727add0a05f 100644 --- a/docs/api/nav.md +++ b/docs/api/nav.md @@ -1,12 +1,12 @@ --- title: "ion-nav" --- -import Props from '@ionic-internal/component-api/v7/nav/props.md'; -import Events from '@ionic-internal/component-api/v7/nav/events.md'; -import Methods from '@ionic-internal/component-api/v7/nav/methods.md'; -import Parts from '@ionic-internal/component-api/v7/nav/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/nav/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/nav/slots.md'; +import Props from '@site/static/auto-generated/nav/props.md'; +import Events from '@site/static/auto-generated/nav/events.md'; +import Methods from '@site/static/auto-generated/nav/methods.md'; +import Parts from '@site/static/auto-generated/nav/parts.md'; +import CustomProps from '@site/static/auto-generated/nav/custom-props.md'; +import Slots from '@site/static/auto-generated/nav/slots.md'; ion-nav | Nav View Component for Ionic Framework Apps diff --git a/docs/api/note.md b/docs/api/note.md index d5f00591b4d..5d142dd53b8 100644 --- a/docs/api/note.md +++ b/docs/api/note.md @@ -1,12 +1,12 @@ --- title: "ion-note" --- -import Props from '@ionic-internal/component-api/v7/note/props.md'; -import Events from '@ionic-internal/component-api/v7/note/events.md'; -import Methods from '@ionic-internal/component-api/v7/note/methods.md'; -import Parts from '@ionic-internal/component-api/v7/note/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/note/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/note/slots.md'; +import Props from '@site/static/auto-generated/note/props.md'; +import Events from '@site/static/auto-generated/note/events.md'; +import Methods from '@site/static/auto-generated/note/methods.md'; +import Parts from '@site/static/auto-generated/note/parts.md'; +import CustomProps from '@site/static/auto-generated/note/custom-props.md'; +import Slots from '@site/static/auto-generated/note/slots.md'; ion-note: Note Text Elements for iOS and Android Ionic Apps diff --git a/docs/api/picker.md b/docs/api/picker.md index b2efb4c7bf2..eca018fb227 100644 --- a/docs/api/picker.md +++ b/docs/api/picker.md @@ -1,12 +1,12 @@ --- title: "ion-picker" --- -import Props from '@ionic-internal/component-api/v7/picker/props.md'; -import Events from '@ionic-internal/component-api/v7/picker/events.md'; -import Methods from '@ionic-internal/component-api/v7/picker/methods.md'; -import Parts from '@ionic-internal/component-api/v7/picker/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/picker/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/picker/slots.md'; +import Props from '@site/static/auto-generated/picker/props.md'; +import Events from '@site/static/auto-generated/picker/events.md'; +import Methods from '@site/static/auto-generated/picker/methods.md'; +import Parts from '@site/static/auto-generated/picker/parts.md'; +import CustomProps from '@site/static/auto-generated/picker/custom-props.md'; +import Slots from '@site/static/auto-generated/picker/slots.md'; Picker | Display Buttons and Columns for ion-picker on Ionic Apps diff --git a/docs/api/popover.md b/docs/api/popover.md index 2878ce602b1..33017292870 100644 --- a/docs/api/popover.md +++ b/docs/api/popover.md @@ -1,12 +1,12 @@ --- title: "ion-popover" --- -import Props from '@ionic-internal/component-api/v7/popover/props.md'; -import Events from '@ionic-internal/component-api/v7/popover/events.md'; -import Methods from '@ionic-internal/component-api/v7/popover/methods.md'; -import Parts from '@ionic-internal/component-api/v7/popover/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/popover/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/popover/slots.md'; +import Props from '@site/static/auto-generated/popover/props.md'; +import Events from '@site/static/auto-generated/popover/events.md'; +import Methods from '@site/static/auto-generated/popover/methods.md'; +import Parts from '@site/static/auto-generated/popover/parts.md'; +import CustomProps from '@site/static/auto-generated/popover/custom-props.md'; +import Slots from '@site/static/auto-generated/popover/slots.md'; ion-popover: iOS / Android Popover UI Component & CSS Properties diff --git a/docs/api/progress-bar.md b/docs/api/progress-bar.md index 73c3253f3ca..15a7c27fbca 100644 --- a/docs/api/progress-bar.md +++ b/docs/api/progress-bar.md @@ -1,12 +1,12 @@ --- title: "ion-progress-bar" --- -import Props from '@ionic-internal/component-api/v7/progress-bar/props.md'; -import Events from '@ionic-internal/component-api/v7/progress-bar/events.md'; -import Methods from '@ionic-internal/component-api/v7/progress-bar/methods.md'; -import Parts from '@ionic-internal/component-api/v7/progress-bar/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/progress-bar/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/progress-bar/slots.md'; +import Props from '@site/static/auto-generated/progress-bar/props.md'; +import Events from '@site/static/auto-generated/progress-bar/events.md'; +import Methods from '@site/static/auto-generated/progress-bar/methods.md'; +import Parts from '@site/static/auto-generated/progress-bar/parts.md'; +import CustomProps from '@site/static/auto-generated/progress-bar/custom-props.md'; +import Slots from '@site/static/auto-generated/progress-bar/slots.md'; Progress Bar | Horizontal App Progress Bar for Loading Indicator diff --git a/docs/api/radio-group.md b/docs/api/radio-group.md index 91969c1ed39..b083ee208b2 100644 --- a/docs/api/radio-group.md +++ b/docs/api/radio-group.md @@ -1,12 +1,12 @@ --- title: "ion-radio-group" --- -import Props from '@ionic-internal/component-api/v7/radio-group/props.md'; -import Events from '@ionic-internal/component-api/v7/radio-group/events.md'; -import Methods from '@ionic-internal/component-api/v7/radio-group/methods.md'; -import Parts from '@ionic-internal/component-api/v7/radio-group/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/radio-group/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/radio-group/slots.md'; +import Props from '@site/static/auto-generated/radio-group/props.md'; +import Events from '@site/static/auto-generated/radio-group/events.md'; +import Methods from '@site/static/auto-generated/radio-group/methods.md'; +import Parts from '@site/static/auto-generated/radio-group/parts.md'; +import CustomProps from '@site/static/auto-generated/radio-group/custom-props.md'; +import Slots from '@site/static/auto-generated/radio-group/slots.md'; ion-radio-group | Radio Button Group Usage for Ionic Apps diff --git a/docs/api/radio.md b/docs/api/radio.md index 66890457bef..b5f94c0b8fb 100644 --- a/docs/api/radio.md +++ b/docs/api/radio.md @@ -1,12 +1,12 @@ --- title: "ion-radio" --- -import Props from '@ionic-internal/component-api/v7/radio/props.md'; -import Events from '@ionic-internal/component-api/v7/radio/events.md'; -import Methods from '@ionic-internal/component-api/v7/radio/methods.md'; -import Parts from '@ionic-internal/component-api/v7/radio/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/radio/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/radio/slots.md'; +import Props from '@site/static/auto-generated/radio/props.md'; +import Events from '@site/static/auto-generated/radio/events.md'; +import Methods from '@site/static/auto-generated/radio/methods.md'; +import Parts from '@site/static/auto-generated/radio/parts.md'; +import CustomProps from '@site/static/auto-generated/radio/custom-props.md'; +import Slots from '@site/static/auto-generated/radio/slots.md'; ion-radio Component: Radio Property for iOS and Android diff --git a/docs/api/range.md b/docs/api/range.md index fd091246945..d102bcbc971 100644 --- a/docs/api/range.md +++ b/docs/api/range.md @@ -1,12 +1,12 @@ --- title: "ion-range" --- -import Props from '@ionic-internal/component-api/v7/range/props.md'; -import Events from '@ionic-internal/component-api/v7/range/events.md'; -import Methods from '@ionic-internal/component-api/v7/range/methods.md'; -import Parts from '@ionic-internal/component-api/v7/range/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/range/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/range/slots.md'; +import Props from '@site/static/auto-generated/range/props.md'; +import Events from '@site/static/auto-generated/range/events.md'; +import Methods from '@site/static/auto-generated/range/methods.md'; +import Parts from '@site/static/auto-generated/range/parts.md'; +import CustomProps from '@site/static/auto-generated/range/custom-props.md'; +import Slots from '@site/static/auto-generated/range/slots.md'; Range Slider | ion-range: Slider Knob Controls with Labels diff --git a/docs/api/refresher-content.md b/docs/api/refresher-content.md index 263a057ce78..1b80d4ef40c 100644 --- a/docs/api/refresher-content.md +++ b/docs/api/refresher-content.md @@ -1,12 +1,12 @@ --- title: "ion-refresher-content" --- -import Props from '@ionic-internal/component-api/v7/refresher-content/props.md'; -import Events from '@ionic-internal/component-api/v7/refresher-content/events.md'; -import Methods from '@ionic-internal/component-api/v7/refresher-content/methods.md'; -import Parts from '@ionic-internal/component-api/v7/refresher-content/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/refresher-content/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/refresher-content/slots.md'; +import Props from '@site/static/auto-generated/refresher-content/props.md'; +import Events from '@site/static/auto-generated/refresher-content/events.md'; +import Methods from '@site/static/auto-generated/refresher-content/methods.md'; +import Parts from '@site/static/auto-generated/refresher-content/parts.md'; +import CustomProps from '@site/static/auto-generated/refresher-content/custom-props.md'; +import Slots from '@site/static/auto-generated/refresher-content/slots.md'; import EncapsulationPill from '@components/page/api/EncapsulationPill'; diff --git a/docs/api/refresher.md b/docs/api/refresher.md index e6552ab795d..744200a218b 100644 --- a/docs/api/refresher.md +++ b/docs/api/refresher.md @@ -1,12 +1,12 @@ --- title: "ion-refresher" --- -import Props from '@ionic-internal/component-api/v7/refresher/props.md'; -import Events from '@ionic-internal/component-api/v7/refresher/events.md'; -import Methods from '@ionic-internal/component-api/v7/refresher/methods.md'; -import Parts from '@ionic-internal/component-api/v7/refresher/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/refresher/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/refresher/slots.md'; +import Props from '@site/static/auto-generated/refresher/props.md'; +import Events from '@site/static/auto-generated/refresher/events.md'; +import Methods from '@site/static/auto-generated/refresher/methods.md'; +import Parts from '@site/static/auto-generated/refresher/parts.md'; +import CustomProps from '@site/static/auto-generated/refresher/custom-props.md'; +import Slots from '@site/static/auto-generated/refresher/slots.md'; ion-refresher: Pull-to-Refresh Page Content on Ionic Apps diff --git a/docs/api/reorder-group.md b/docs/api/reorder-group.md index 07d1ccd5ddc..674bc2561b9 100644 --- a/docs/api/reorder-group.md +++ b/docs/api/reorder-group.md @@ -1,12 +1,12 @@ --- title: "ion-reorder-group" --- -import Props from '@ionic-internal/component-api/v7/reorder-group/props.md'; -import Events from '@ionic-internal/component-api/v7/reorder-group/events.md'; -import Methods from '@ionic-internal/component-api/v7/reorder-group/methods.md'; -import Parts from '@ionic-internal/component-api/v7/reorder-group/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/reorder-group/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/reorder-group/slots.md'; +import Props from '@site/static/auto-generated/reorder-group/props.md'; +import Events from '@site/static/auto-generated/reorder-group/events.md'; +import Methods from '@site/static/auto-generated/reorder-group/methods.md'; +import Parts from '@site/static/auto-generated/reorder-group/parts.md'; +import CustomProps from '@site/static/auto-generated/reorder-group/custom-props.md'; +import Slots from '@site/static/auto-generated/reorder-group/slots.md'; ion-reorder-group: Wrapper Component for Ionic Framework Apps diff --git a/docs/api/reorder.md b/docs/api/reorder.md index 708b9202eb0..1043f82b811 100644 --- a/docs/api/reorder.md +++ b/docs/api/reorder.md @@ -1,12 +1,12 @@ --- title: "ion-reorder" --- -import Props from '@ionic-internal/component-api/v7/reorder/props.md'; -import Events from '@ionic-internal/component-api/v7/reorder/events.md'; -import Methods from '@ionic-internal/component-api/v7/reorder/methods.md'; -import Parts from '@ionic-internal/component-api/v7/reorder/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/reorder/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/reorder/slots.md'; +import Props from '@site/static/auto-generated/reorder/props.md'; +import Events from '@site/static/auto-generated/reorder/events.md'; +import Methods from '@site/static/auto-generated/reorder/methods.md'; +import Parts from '@site/static/auto-generated/reorder/parts.md'; +import CustomProps from '@site/static/auto-generated/reorder/custom-props.md'; +import Slots from '@site/static/auto-generated/reorder/slots.md'; Reorder | ion-reorder: Drag and Drop Icon to Reorder Items diff --git a/docs/api/ripple-effect.md b/docs/api/ripple-effect.md index 5ab5bf38930..1861b13a117 100644 --- a/docs/api/ripple-effect.md +++ b/docs/api/ripple-effect.md @@ -1,12 +1,12 @@ --- title: "ion-ripple-effect" --- -import Props from '@ionic-internal/component-api/v7/ripple-effect/props.md'; -import Events from '@ionic-internal/component-api/v7/ripple-effect/events.md'; -import Methods from '@ionic-internal/component-api/v7/ripple-effect/methods.md'; -import Parts from '@ionic-internal/component-api/v7/ripple-effect/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/ripple-effect/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/ripple-effect/slots.md'; +import Props from '@site/static/auto-generated/ripple-effect/props.md'; +import Events from '@site/static/auto-generated/ripple-effect/events.md'; +import Methods from '@site/static/auto-generated/ripple-effect/methods.md'; +import Parts from '@site/static/auto-generated/ripple-effect/parts.md'; +import CustomProps from '@site/static/auto-generated/ripple-effect/custom-props.md'; +import Slots from '@site/static/auto-generated/ripple-effect/slots.md'; import EncapsulationPill from '@components/page/api/EncapsulationPill'; diff --git a/docs/api/route-redirect.md b/docs/api/route-redirect.md index 591c39c28a1..ac4febd161d 100644 --- a/docs/api/route-redirect.md +++ b/docs/api/route-redirect.md @@ -2,12 +2,12 @@ title: "ion-route-redirect" --- -import Props from '@ionic-internal/component-api/v7/route-redirect/props.md'; -import Events from '@ionic-internal/component-api/v7/route-redirect/events.md'; -import Methods from '@ionic-internal/component-api/v7/route-redirect/methods.md'; -import Parts from '@ionic-internal/component-api/v7/route-redirect/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/route-redirect/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/route-redirect/slots.md'; +import Props from '@site/static/auto-generated/route-redirect/props.md'; +import Events from '@site/static/auto-generated/route-redirect/events.md'; +import Methods from '@site/static/auto-generated/route-redirect/methods.md'; +import Parts from '@site/static/auto-generated/route-redirect/parts.md'; +import CustomProps from '@site/static/auto-generated/route-redirect/custom-props.md'; +import Slots from '@site/static/auto-generated/route-redirect/slots.md'; ion-route-redirect Plugin: Redirect 'from' a URL 'to' Another URL diff --git a/docs/api/route.md b/docs/api/route.md index b49c8766b0d..91b607971e4 100644 --- a/docs/api/route.md +++ b/docs/api/route.md @@ -4,12 +4,12 @@ title: "ion-route" import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -import Props from '@ionic-internal/component-api/v7/route/props.md'; -import Events from '@ionic-internal/component-api/v7/route/events.md'; -import Methods from '@ionic-internal/component-api/v7/route/methods.md'; -import Parts from '@ionic-internal/component-api/v7/route/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/route/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/route/slots.md'; +import Props from '@site/static/auto-generated/route/props.md'; +import Events from '@site/static/auto-generated/route/events.md'; +import Methods from '@site/static/auto-generated/route/methods.md'; +import Parts from '@site/static/auto-generated/route/parts.md'; +import CustomProps from '@site/static/auto-generated/route/custom-props.md'; +import Slots from '@site/static/auto-generated/route/slots.md'; ion-route: API Route Component for Ionic Framework Apps diff --git a/docs/api/router-link.md b/docs/api/router-link.md index 96b22e69af5..ea95869eea0 100644 --- a/docs/api/router-link.md +++ b/docs/api/router-link.md @@ -6,12 +6,12 @@ demoSourceUrl: "https://github.com/ionic-team/ionic-docs/tree/main/static/demos/ --- import TOCInline from '@theme/TOCInline'; -import Props from '@ionic-internal/component-api/v7/router-link/props.md'; -import Events from '@ionic-internal/component-api/v7/router-link/events.md'; -import Methods from '@ionic-internal/component-api/v7/router-link/methods.md'; -import Parts from '@ionic-internal/component-api/v7/router-link/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/router-link/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/router-link/slots.md'; +import Props from '@site/static/auto-generated/router-link/props.md'; +import Events from '@site/static/auto-generated/router-link/events.md'; +import Methods from '@site/static/auto-generated/router-link/methods.md'; +import Parts from '@site/static/auto-generated/router-link/parts.md'; +import CustomProps from '@site/static/auto-generated/router-link/custom-props.md'; +import Slots from '@site/static/auto-generated/router-link/slots.md'; Router Link | Navigating The ion-router-link Component diff --git a/docs/api/router-outlet.md b/docs/api/router-outlet.md index 70c153815ed..c15289ab77b 100644 --- a/docs/api/router-outlet.md +++ b/docs/api/router-outlet.md @@ -2,12 +2,12 @@ title: "ion-router-outlet" --- -import Props from '@ionic-internal/component-api/v7/router-outlet/props.md'; -import Events from '@ionic-internal/component-api/v7/router-outlet/events.md'; -import Methods from '@ionic-internal/component-api/v7/router-outlet/methods.md'; -import Parts from '@ionic-internal/component-api/v7/router-outlet/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/router-outlet/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/router-outlet/slots.md'; +import Props from '@site/static/auto-generated/router-outlet/props.md'; +import Events from '@site/static/auto-generated/router-outlet/events.md'; +import Methods from '@site/static/auto-generated/router-outlet/methods.md'; +import Parts from '@site/static/auto-generated/router-outlet/parts.md'; +import CustomProps from '@site/static/auto-generated/router-outlet/custom-props.md'; +import Slots from '@site/static/auto-generated/router-outlet/slots.md'; diff --git a/docs/api/router.md b/docs/api/router.md index dd386016be9..48b8b522e04 100644 --- a/docs/api/router.md +++ b/docs/api/router.md @@ -2,12 +2,12 @@ title: "ion-router" --- -import Props from '@ionic-internal/component-api/v7/router/props.md'; -import Events from '@ionic-internal/component-api/v7/router/events.md'; -import Methods from '@ionic-internal/component-api/v7/router/methods.md'; -import Parts from '@ionic-internal/component-api/v7/router/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/router/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/router/slots.md'; +import Props from '@site/static/auto-generated/router/props.md'; +import Events from '@site/static/auto-generated/router/events.md'; +import Methods from '@site/static/auto-generated/router/methods.md'; +import Parts from '@site/static/auto-generated/router/parts.md'; +import CustomProps from '@site/static/auto-generated/router/custom-props.md'; +import Slots from '@site/static/auto-generated/router/slots.md'; ion-router: Router Component to Coordinate URL Navigation diff --git a/docs/api/row.md b/docs/api/row.md index 3f8759fb490..48fc21c4ba0 100644 --- a/docs/api/row.md +++ b/docs/api/row.md @@ -1,12 +1,12 @@ --- title: "ion-row" --- -import Props from '@ionic-internal/component-api/v7/row/props.md'; -import Events from '@ionic-internal/component-api/v7/row/events.md'; -import Methods from '@ionic-internal/component-api/v7/row/methods.md'; -import Parts from '@ionic-internal/component-api/v7/row/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/row/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/row/slots.md'; +import Props from '@site/static/auto-generated/row/props.md'; +import Events from '@site/static/auto-generated/row/events.md'; +import Methods from '@site/static/auto-generated/row/methods.md'; +import Parts from '@site/static/auto-generated/row/parts.md'; +import CustomProps from '@site/static/auto-generated/row/custom-props.md'; +import Slots from '@site/static/auto-generated/row/slots.md'; ion-row: Horizontal Row Components and Alignment | Ionic API Docs diff --git a/docs/api/searchbar.md b/docs/api/searchbar.md index bbca192fdb6..c11c14c4c74 100644 --- a/docs/api/searchbar.md +++ b/docs/api/searchbar.md @@ -1,12 +1,12 @@ --- title: "ion-searchbar" --- -import Props from '@ionic-internal/component-api/v7/searchbar/props.md'; -import Events from '@ionic-internal/component-api/v7/searchbar/events.md'; -import Methods from '@ionic-internal/component-api/v7/searchbar/methods.md'; -import Parts from '@ionic-internal/component-api/v7/searchbar/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/searchbar/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/searchbar/slots.md'; +import Props from '@site/static/auto-generated/searchbar/props.md'; +import Events from '@site/static/auto-generated/searchbar/events.md'; +import Methods from '@site/static/auto-generated/searchbar/methods.md'; +import Parts from '@site/static/auto-generated/searchbar/parts.md'; +import CustomProps from '@site/static/auto-generated/searchbar/custom-props.md'; +import Slots from '@site/static/auto-generated/searchbar/slots.md'; Search Bar Icon for Keyboard Text Display | Ion-Search Bar diff --git a/docs/api/segment-button.md b/docs/api/segment-button.md index 04c383655b3..2567e2ecbeb 100644 --- a/docs/api/segment-button.md +++ b/docs/api/segment-button.md @@ -1,12 +1,12 @@ --- title: "ion-segment-button" --- -import Props from '@ionic-internal/component-api/v7/segment-button/props.md'; -import Events from '@ionic-internal/component-api/v7/segment-button/events.md'; -import Methods from '@ionic-internal/component-api/v7/segment-button/methods.md'; -import Parts from '@ionic-internal/component-api/v7/segment-button/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/segment-button/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/segment-button/slots.md'; +import Props from '@site/static/auto-generated/segment-button/props.md'; +import Events from '@site/static/auto-generated/segment-button/events.md'; +import Methods from '@site/static/auto-generated/segment-button/methods.md'; +import Parts from '@site/static/auto-generated/segment-button/parts.md'; +import CustomProps from '@site/static/auto-generated/segment-button/custom-props.md'; +import Slots from '@site/static/auto-generated/segment-button/slots.md'; ion-segment-button | Segment Button Icon and Segment Value diff --git a/docs/api/segment.md b/docs/api/segment.md index b4bdb45b6cb..0ff953288d5 100644 --- a/docs/api/segment.md +++ b/docs/api/segment.md @@ -1,12 +1,12 @@ --- title: "ion-segment" --- -import Props from '@ionic-internal/component-api/v7/segment/props.md'; -import Events from '@ionic-internal/component-api/v7/segment/events.md'; -import Methods from '@ionic-internal/component-api/v7/segment/methods.md'; -import Parts from '@ionic-internal/component-api/v7/segment/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/segment/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/segment/slots.md'; +import Props from '@site/static/auto-generated/segment/props.md'; +import Events from '@site/static/auto-generated/segment/events.md'; +import Methods from '@site/static/auto-generated/segment/methods.md'; +import Parts from '@site/static/auto-generated/segment/parts.md'; +import CustomProps from '@site/static/auto-generated/segment/custom-props.md'; +import Slots from '@site/static/auto-generated/segment/slots.md'; ion-segment: API Documentation for Segmented Controls diff --git a/docs/api/select-option.md b/docs/api/select-option.md index bb2d2e7e6f9..73dbf015e2b 100644 --- a/docs/api/select-option.md +++ b/docs/api/select-option.md @@ -1,12 +1,12 @@ --- title: "ion-select-option" --- -import Props from '@ionic-internal/component-api/v7/select-option/props.md'; -import Events from '@ionic-internal/component-api/v7/select-option/events.md'; -import Methods from '@ionic-internal/component-api/v7/select-option/methods.md'; -import Parts from '@ionic-internal/component-api/v7/select-option/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/select-option/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/select-option/slots.md'; +import Props from '@site/static/auto-generated/select-option/props.md'; +import Events from '@site/static/auto-generated/select-option/events.md'; +import Methods from '@site/static/auto-generated/select-option/methods.md'; +import Parts from '@site/static/auto-generated/select-option/parts.md'; +import CustomProps from '@site/static/auto-generated/select-option/custom-props.md'; +import Slots from '@site/static/auto-generated/select-option/slots.md'; Select Option | What Is An Option Select on Ionic Framework Apps diff --git a/docs/api/select.md b/docs/api/select.md index 92ab5b6e70f..d3792bfe52a 100644 --- a/docs/api/select.md +++ b/docs/api/select.md @@ -1,12 +1,12 @@ --- title: "ion-select" --- -import Props from '@ionic-internal/component-api/v7/select/props.md'; -import Events from '@ionic-internal/component-api/v7/select/events.md'; -import Methods from '@ionic-internal/component-api/v7/select/methods.md'; -import Parts from '@ionic-internal/component-api/v7/select/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/select/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/select/slots.md'; +import Props from '@site/static/auto-generated/select/props.md'; +import Events from '@site/static/auto-generated/select/events.md'; +import Methods from '@site/static/auto-generated/select/methods.md'; +import Parts from '@site/static/auto-generated/select/parts.md'; +import CustomProps from '@site/static/auto-generated/select/custom-props.md'; +import Slots from '@site/static/auto-generated/select/slots.md'; ion-select: Select One or Multiple Value Boxes or Placeholders diff --git a/docs/api/skeleton-text.md b/docs/api/skeleton-text.md index 438a5b98ef9..7b627127105 100644 --- a/docs/api/skeleton-text.md +++ b/docs/api/skeleton-text.md @@ -1,12 +1,12 @@ --- title: "ion-skeleton-text" --- -import Props from '@ionic-internal/component-api/v7/skeleton-text/props.md'; -import Events from '@ionic-internal/component-api/v7/skeleton-text/events.md'; -import Methods from '@ionic-internal/component-api/v7/skeleton-text/methods.md'; -import Parts from '@ionic-internal/component-api/v7/skeleton-text/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/skeleton-text/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/skeleton-text/slots.md'; +import Props from '@site/static/auto-generated/skeleton-text/props.md'; +import Events from '@site/static/auto-generated/skeleton-text/events.md'; +import Methods from '@site/static/auto-generated/skeleton-text/methods.md'; +import Parts from '@site/static/auto-generated/skeleton-text/parts.md'; +import CustomProps from '@site/static/auto-generated/skeleton-text/custom-props.md'; +import Slots from '@site/static/auto-generated/skeleton-text/slots.md'; Skeleton Text | Skeleton Loading Placeholder & Framework for Text diff --git a/docs/api/spinner.md b/docs/api/spinner.md index dc5b55a36c3..7d805fa697e 100644 --- a/docs/api/spinner.md +++ b/docs/api/spinner.md @@ -1,12 +1,12 @@ --- title: "ion-spinner" --- -import Props from '@ionic-internal/component-api/v7/spinner/props.md'; -import Events from '@ionic-internal/component-api/v7/spinner/events.md'; -import Methods from '@ionic-internal/component-api/v7/spinner/methods.md'; -import Parts from '@ionic-internal/component-api/v7/spinner/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/spinner/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/spinner/slots.md'; +import Props from '@site/static/auto-generated/spinner/props.md'; +import Events from '@site/static/auto-generated/spinner/events.md'; +import Methods from '@site/static/auto-generated/spinner/methods.md'; +import Parts from '@site/static/auto-generated/spinner/parts.md'; +import CustomProps from '@site/static/auto-generated/spinner/custom-props.md'; +import Slots from '@site/static/auto-generated/spinner/slots.md'; ion-spinner | Animated Spinner Icon Components and Properties diff --git a/docs/api/split-pane.md b/docs/api/split-pane.md index 00f000e10c4..87ffe6c1ae0 100644 --- a/docs/api/split-pane.md +++ b/docs/api/split-pane.md @@ -2,12 +2,12 @@ title: "ion-split-pane" --- -import Props from '@ionic-internal/component-api/v7/split-pane/props.md'; -import Events from '@ionic-internal/component-api/v7/split-pane/events.md'; -import Methods from '@ionic-internal/component-api/v7/split-pane/methods.md'; -import Parts from '@ionic-internal/component-api/v7/split-pane/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/split-pane/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/split-pane/slots.md'; +import Props from '@site/static/auto-generated/split-pane/props.md'; +import Events from '@site/static/auto-generated/split-pane/events.md'; +import Methods from '@site/static/auto-generated/split-pane/methods.md'; +import Parts from '@site/static/auto-generated/split-pane/parts.md'; +import CustomProps from '@site/static/auto-generated/split-pane/custom-props.md'; +import Slots from '@site/static/auto-generated/split-pane/slots.md'; ion-split-pane: Split Plane View for Menus and Multi-View Layouts diff --git a/docs/api/tab-bar.md b/docs/api/tab-bar.md index cb69107d111..5cd9d97fe3d 100644 --- a/docs/api/tab-bar.md +++ b/docs/api/tab-bar.md @@ -4,12 +4,12 @@ title: "ion-tab-bar" import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -import Props from '@ionic-internal/component-api/v7/tab-bar/props.md'; -import Events from '@ionic-internal/component-api/v7/tab-bar/events.md'; -import Methods from '@ionic-internal/component-api/v7/tab-bar/methods.md'; -import Parts from '@ionic-internal/component-api/v7/tab-bar/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/tab-bar/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/tab-bar/slots.md'; +import Props from '@site/static/auto-generated/tab-bar/props.md'; +import Events from '@site/static/auto-generated/tab-bar/events.md'; +import Methods from '@site/static/auto-generated/tab-bar/methods.md'; +import Parts from '@site/static/auto-generated/tab-bar/parts.md'; +import CustomProps from '@site/static/auto-generated/tab-bar/custom-props.md'; +import Slots from '@site/static/auto-generated/tab-bar/slots.md'; ion-tab-bar with CSS Custom Properties for Tab Bar Components diff --git a/docs/api/tab-button.md b/docs/api/tab-button.md index d22b0db8699..0fb186e0773 100644 --- a/docs/api/tab-button.md +++ b/docs/api/tab-button.md @@ -4,12 +4,12 @@ title: "ion-tab-button" import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -import Props from '@ionic-internal/component-api/v7/tab-button/props.md'; -import Events from '@ionic-internal/component-api/v7/tab-button/events.md'; -import Methods from '@ionic-internal/component-api/v7/tab-button/methods.md'; -import Parts from '@ionic-internal/component-api/v7/tab-button/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/tab-button/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/tab-button/slots.md'; +import Props from '@site/static/auto-generated/tab-button/props.md'; +import Events from '@site/static/auto-generated/tab-button/events.md'; +import Methods from '@site/static/auto-generated/tab-button/methods.md'; +import Parts from '@site/static/auto-generated/tab-button/parts.md'; +import CustomProps from '@site/static/auto-generated/tab-button/custom-props.md'; +import Slots from '@site/static/auto-generated/tab-button/slots.md'; diff --git a/docs/api/tab.md b/docs/api/tab.md index 3dd6576e4a8..899e3c6c484 100644 --- a/docs/api/tab.md +++ b/docs/api/tab.md @@ -2,12 +2,12 @@ title: "ion-tab" --- -import Props from '@ionic-internal/component-api/v7/tab/props.md'; -import Events from '@ionic-internal/component-api/v7/tab/events.md'; -import Methods from '@ionic-internal/component-api/v7/tab/methods.md'; -import Parts from '@ionic-internal/component-api/v7/tab/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/tab/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/tab/slots.md'; +import Props from '@site/static/auto-generated/tab/props.md'; +import Events from '@site/static/auto-generated/tab/events.md'; +import Methods from '@site/static/auto-generated/tab/methods.md'; +import Parts from '@site/static/auto-generated/tab/parts.md'; +import CustomProps from '@site/static/auto-generated/tab/custom-props.md'; +import Slots from '@site/static/auto-generated/tab/slots.md'; ion-tab - Ionic Framework Application Component diff --git a/docs/api/tabs.md b/docs/api/tabs.md index 3da90b12e70..0920727d489 100644 --- a/docs/api/tabs.md +++ b/docs/api/tabs.md @@ -1,12 +1,12 @@ --- title: "ion-tabs" --- -import Props from '@ionic-internal/component-api/v7/tabs/props.md'; -import Events from '@ionic-internal/component-api/v7/tabs/events.md'; -import Methods from '@ionic-internal/component-api/v7/tabs/methods.md'; -import Parts from '@ionic-internal/component-api/v7/tabs/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/tabs/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/tabs/slots.md'; +import Props from '@site/static/auto-generated/tabs/props.md'; +import Events from '@site/static/auto-generated/tabs/events.md'; +import Methods from '@site/static/auto-generated/tabs/methods.md'; +import Parts from '@site/static/auto-generated/tabs/parts.md'; +import CustomProps from '@site/static/auto-generated/tabs/custom-props.md'; +import Slots from '@site/static/auto-generated/tabs/slots.md'; Ion-Tabs: Tab-Based Component for App Top-Level Navigation diff --git a/docs/api/text.md b/docs/api/text.md index 30f03bd454f..ea9db032f6c 100644 --- a/docs/api/text.md +++ b/docs/api/text.md @@ -1,12 +1,12 @@ --- title: "ion-text" --- -import Props from '@ionic-internal/component-api/v7/text/props.md'; -import Events from '@ionic-internal/component-api/v7/text/events.md'; -import Methods from '@ionic-internal/component-api/v7/text/methods.md'; -import Parts from '@ionic-internal/component-api/v7/text/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/text/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/text/slots.md'; +import Props from '@site/static/auto-generated/text/props.md'; +import Events from '@site/static/auto-generated/text/events.md'; +import Methods from '@site/static/auto-generated/text/methods.md'; +import Parts from '@site/static/auto-generated/text/parts.md'; +import CustomProps from '@site/static/auto-generated/text/custom-props.md'; +import Slots from '@site/static/auto-generated/text/slots.md'; ion-text: Ionic App Component to Style or Change Text Color diff --git a/docs/api/textarea.md b/docs/api/textarea.md index bf611656010..bfd0e16d1f6 100644 --- a/docs/api/textarea.md +++ b/docs/api/textarea.md @@ -1,12 +1,12 @@ --- title: "ion-textarea" --- -import Props from '@ionic-internal/component-api/v7/textarea/props.md'; -import Events from '@ionic-internal/component-api/v7/textarea/events.md'; -import Methods from '@ionic-internal/component-api/v7/textarea/methods.md'; -import Parts from '@ionic-internal/component-api/v7/textarea/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/textarea/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/textarea/slots.md'; +import Props from '@site/static/auto-generated/textarea/props.md'; +import Events from '@site/static/auto-generated/textarea/events.md'; +import Methods from '@site/static/auto-generated/textarea/methods.md'; +import Parts from '@site/static/auto-generated/textarea/parts.md'; +import CustomProps from '@site/static/auto-generated/textarea/custom-props.md'; +import Slots from '@site/static/auto-generated/textarea/slots.md'; Ionic Textarea Component and CSS Properties for Multi-Line Input diff --git a/docs/api/thumbnail.md b/docs/api/thumbnail.md index 05d9bc86d5d..cf353200805 100644 --- a/docs/api/thumbnail.md +++ b/docs/api/thumbnail.md @@ -2,12 +2,12 @@ title: "ion-thumbnail" --- -import Props from '@ionic-internal/component-api/v7/thumbnail/props.md'; -import Events from '@ionic-internal/component-api/v7/thumbnail/events.md'; -import Methods from '@ionic-internal/component-api/v7/thumbnail/methods.md'; -import Parts from '@ionic-internal/component-api/v7/thumbnail/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/thumbnail/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/thumbnail/slots.md'; +import Props from '@site/static/auto-generated/thumbnail/props.md'; +import Events from '@site/static/auto-generated/thumbnail/events.md'; +import Methods from '@site/static/auto-generated/thumbnail/methods.md'; +import Parts from '@site/static/auto-generated/thumbnail/parts.md'; +import CustomProps from '@site/static/auto-generated/thumbnail/custom-props.md'; +import Slots from '@site/static/auto-generated/thumbnail/slots.md'; ion-thumbnail | Thumbnail App Component to Wrap Images or Icons diff --git a/docs/api/title.md b/docs/api/title.md index bde08e3b21f..4eb8eee4ac1 100644 --- a/docs/api/title.md +++ b/docs/api/title.md @@ -1,12 +1,12 @@ --- title: "ion-title" --- -import Props from '@ionic-internal/component-api/v7/title/props.md'; -import Events from '@ionic-internal/component-api/v7/title/events.md'; -import Methods from '@ionic-internal/component-api/v7/title/methods.md'; -import Parts from '@ionic-internal/component-api/v7/title/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/title/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/title/slots.md'; +import Props from '@site/static/auto-generated/title/props.md'; +import Events from '@site/static/auto-generated/title/events.md'; +import Methods from '@site/static/auto-generated/title/methods.md'; +import Parts from '@site/static/auto-generated/title/parts.md'; +import CustomProps from '@site/static/auto-generated/title/custom-props.md'; +import Slots from '@site/static/auto-generated/title/slots.md'; ion-title: Ionic Framework App Title Component for Toolbars diff --git a/docs/api/toast.md b/docs/api/toast.md index eab8f3f70e8..bf74e97cdd6 100644 --- a/docs/api/toast.md +++ b/docs/api/toast.md @@ -4,12 +4,12 @@ title: "ion-toast" import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -import Props from '@ionic-internal/component-api/v7/toast/props.md'; -import Events from '@ionic-internal/component-api/v7/toast/events.md'; -import Methods from '@ionic-internal/component-api/v7/toast/methods.md'; -import Parts from '@ionic-internal/component-api/v7/toast/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/toast/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/toast/slots.md'; +import Props from '@site/static/auto-generated/toast/props.md'; +import Events from '@site/static/auto-generated/toast/events.md'; +import Methods from '@site/static/auto-generated/toast/methods.md'; +import Parts from '@site/static/auto-generated/toast/parts.md'; +import CustomProps from '@site/static/auto-generated/toast/custom-props.md'; +import Slots from '@site/static/auto-generated/toast/slots.md'; ion-toast Component: A Dismissible App Notification Alert diff --git a/docs/api/toggle.md b/docs/api/toggle.md index bf8925e2fb6..78119d191ae 100644 --- a/docs/api/toggle.md +++ b/docs/api/toggle.md @@ -1,12 +1,12 @@ --- title: "ion-toggle" --- -import Props from '@ionic-internal/component-api/v7/toggle/props.md'; -import Events from '@ionic-internal/component-api/v7/toggle/events.md'; -import Methods from '@ionic-internal/component-api/v7/toggle/methods.md'; -import Parts from '@ionic-internal/component-api/v7/toggle/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/toggle/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/toggle/slots.md'; +import Props from '@site/static/auto-generated/toggle/props.md'; +import Events from '@site/static/auto-generated/toggle/events.md'; +import Methods from '@site/static/auto-generated/toggle/methods.md'; +import Parts from '@site/static/auto-generated/toggle/parts.md'; +import CustomProps from '@site/static/auto-generated/toggle/custom-props.md'; +import Slots from '@site/static/auto-generated/toggle/slots.md'; Toggle | ion-toggle: Custom Toggle Button for Ionic Applications diff --git a/docs/api/toolbar.md b/docs/api/toolbar.md index c6c9790ce6e..9db8ed00aa8 100644 --- a/docs/api/toolbar.md +++ b/docs/api/toolbar.md @@ -1,12 +1,12 @@ --- title: "ion-toolbar" --- -import Props from '@ionic-internal/component-api/v7/toolbar/props.md'; -import Events from '@ionic-internal/component-api/v7/toolbar/events.md'; -import Methods from '@ionic-internal/component-api/v7/toolbar/methods.md'; -import Parts from '@ionic-internal/component-api/v7/toolbar/parts.md'; -import CustomProps from '@ionic-internal/component-api/v7/toolbar/custom-props.md'; -import Slots from '@ionic-internal/component-api/v7/toolbar/slots.md'; +import Props from '@site/static/auto-generated/toolbar/props.md'; +import Events from '@site/static/auto-generated/toolbar/events.md'; +import Methods from '@site/static/auto-generated/toolbar/methods.md'; +import Parts from '@site/static/auto-generated/toolbar/parts.md'; +import CustomProps from '@site/static/auto-generated/toolbar/custom-props.md'; +import Slots from '@site/static/auto-generated/toolbar/slots.md'; Toolbar | Customize App Menu Toolbar Buttons and Icons diff --git a/docusaurus.config.js b/docusaurus.config.js index 260bea66bec..8746715cbe1 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -2,8 +2,6 @@ const path = require('path'); const prismic = require('@prismicio/client'); const fetch = require('node-fetch'); -const VERSIONS_JSON = require('./versions.json'); - const BASE_URL = '/docs'; module.exports = { @@ -316,12 +314,6 @@ module.exports = { }, }; }, - [ - path.resolve(__dirname, 'plugins', 'docusaurus-plugin-ionic-component-api'), - { - versions: VERSIONS_JSON, - }, - ], ], themes: [ [ diff --git a/package.json b/package.json index 9dfee0ace00..8121f2287bb 100644 --- a/package.json +++ b/package.json @@ -11,7 +11,7 @@ "crowdin:sync": "docusaurus write-translations && crowdin upload && crowdin download", "deploy": "docusaurus deploy", "docusaurus": "docusaurus", - "generate-markdown": "node scripts/native && concurrently \"node scripts/cli\" \"node scripts/release-notes\"", + "generate-markdown": "node scripts/native && concurrently \"node scripts/api\" \"node scripts/cli\" \"node scripts/release-notes\"", "serve": "docusaurus serve", "prestart": "npm run generate-markdown", "start": "docusaurus start", diff --git a/plugins/docusaurus-plugin-ionic-component-api/index.js b/plugins/docusaurus-plugin-ionic-component-api/index.js deleted file mode 100644 index 8e12c52ad3a..00000000000 --- a/plugins/docusaurus-plugin-ionic-component-api/index.js +++ /dev/null @@ -1,220 +0,0 @@ -const fetch = require('node-fetch'); - -module.exports = function (context, options) { - return { - name: 'docusaurus-plugin-ionic-component-api', - async loadContent() { - // Finds the plugin options for @docusaurus/plugin-content-docs - const docsPluginOptions = context.siteConfig.plugins.find( - (plugin) => Array.isArray(plugin) && plugin[0] === '@docusaurus/plugin-content-docs' - )[1]; - - const data = []; - const currentVersion = docsPluginOptions.versions.current; - - /** - * Generates the markdown files for all components in a given version. - * @param {*} version The version, e.g.: v6 - * @param {*} npmTag The npm tag, e.g.: 6 or next - * @param {*} isCurrentVersion Whether or not this is the current version of the docs - */ - const generateMarkdownForVersion = async (version, npmTag, isCurrentVersion) => { - const response = await fetch(`https://unpkg.com/@ionic/docs@${npmTag}/core.json`); - const { components } = await response.json(); - - const names = components.map((component) => component.tag.slice(4)); - // matches all relative markdown links to a component, e.g. (../button) - COMPONENT_LINK_REGEXP = new RegExp(`\\(../(${names.join('|')})/?(#[^)]+)?\\)`, 'g'); - - components.forEach((comp) => { - const compTag = comp.tag.slice(4); - const outDir = getDirectoryPath(compTag, version, isCurrentVersion); - - data.push({ - outDir, - componentTag: compTag, - version, - props: renderProperties(comp), - events: renderEvents(comp), - methods: renderMethods(comp), - parts: renderParts(comp), - customProps: renderCustomProps(comp), - slots: renderSlots(comp), - }); - }); - }; - - for (const version of options.versions) { - const npmTag = version.slice(1); - await generateMarkdownForVersion(version, npmTag, false); - } - - const npmTag = currentVersion.banner === 'unreleased' ? 'next' : currentVersion.path.slice(1); - // Latest version - await generateMarkdownForVersion(currentVersion.path, npmTag, true); - - return data; - }, - async contentLoaded({ content, actions }) { - const { createData } = actions; - const promises = []; - - for (const data of content) { - const basePath = `${data.version}/${data.componentTag}`; - /** - * createData will create a file within the generated ./docusaurus - * directory within the plugin directory. - */ - promises.push( - createData(`${basePath}/props.md`, data.props), - createData(`${basePath}/events.md`, data.events), - createData(`${basePath}/methods.md`, data.methods), - createData(`${basePath}/parts.md`, data.parts), - createData(`${basePath}/custom-props.md`, data.customProps), - createData(`${basePath}/slots.md`, data.slots) - ); - } - - await Promise.all(promises); - }, - configureWebpack(config, isServer, utils) { - /** - * Adds a custom import alias to the webpack configuration, so that the markdown files - * can import the auto-generated markdown files from: @ionic-internal/component-api/{version}/{componentTag} - */ - return { - resolve: { - alias: { - '@ionic-internal/component-api': `${context.siteDir}/.docusaurus/docusaurus-plugin-ionic-component-api/default`, - }, - }, - }; - }, - }; -}; - -/** - * Calculates the path to the directory where the auto-generated markdown files are stored. - * @param {*} componentTag The tag name of the component, e.g.: ion-button - * @param {*} version The version of Ionic that the file pertains to, e.g.: v6 - * @param {*} isCurrentVersion Whether the version is the current version of the docs - * @returns The path to the directory where the auto-generated markdown files are stored. - */ -function getDirectoryPath(componentTag, version, isCurrentVersion) { - if (isCurrentVersion) { - return `./docs/api/auto-generated/${componentTag}`; - } - return `./versioned_docs/version-${version}/api/auto-generated/${componentTag}`; -} - -/** - * Formats line breaks in a multiline string to be displayed in a table. - * @param {*} str The string to format - * @returns The formatted string - */ -function formatMultiline(str) { - return str.split('\n\n').join('

').split('\n').join(' '); -} - -function renderProperties({ props: properties }) { - if (properties.length === 0) { - return 'No properties available for this component.'; - } - - // NOTE: replaces | with U+FF5C since MDX renders \| in tables incorrectly - return ` -${properties - .map((prop) => { - const isDeprecated = prop.deprecation !== undefined; - - const docs = isDeprecated ? `${prop.docs}\n_Deprecated_ ${prop.deprecation}` : prop.docs; - - return ` -### ${prop.name} ${isDeprecated ? '(deprecated)' : ''} - -| | | -| --- | --- | -| **Description** | ${formatMultiline(docs)} | -| **Attribute** | \`${prop.attr}\` | -| **Type** | \`${prop.type.replace(/\|/g, '\uff5c')}\` | -| **Default** | \`${prop.default}\` | - -`; - }) - .join('\n')}`; -} - -function renderEvents({ events }) { - if (events.length === 0) { - return 'No events available for this component.'; - } - - return ` -| Name | Description | -| --- | --- | -${events.map((event) => `| \`${event.event}\` | ${formatMultiline(event.docs)} |`).join('\n')} - -`; -} - -function renderMethods({ methods }) { - if (methods.length === 0) { - return 'No public methods available for this component.'; - } - - // NOTE: replaces | with U+FF5C since MDX renders \| in tables incorrectly - return ` -${methods - .map( - (method) => ` -### ${method.name} - -| | | -| --- | --- | -| **Description** | ${formatMultiline(method.docs)} | -| **Signature** | \`${method.signature.replace(/\|/g, '\uff5c')}\` | -` - ) - .join('\n')} - -`; -} - -function renderParts({ parts }) { - if (parts.length === 0) { - return 'No CSS shadow parts available for this component.'; - } - - return ` -| Name | Description | -| --- | --- | -${parts.map((prop) => `| \`${prop.name}\` | ${formatMultiline(prop.docs)} |`).join('\n')} - -`; -} - -function renderCustomProps({ styles: customProps }) { - if (customProps.length === 0) { - return 'No CSS custom properties available for this component.'; - } - - return ` -| Name | Description | -| --- | --- | -${customProps.map((prop) => `| \`${prop.name}\` | ${formatMultiline(prop.docs)} |`).join('\n')} - -`; -} - -function renderSlots({ slots }) { - if (slots.length === 0) { - return 'No slots available for this component.'; - } - - return ` -| Name | Description | -| --- | --- | -${slots.map((slot) => `| \`${slot.name}\` | ${formatMultiline(slot.docs)} |`).join('\n')} - -`; -} diff --git a/scripts/api.js b/scripts/api.js new file mode 100644 index 00000000000..470aadb449f --- /dev/null +++ b/scripts/api.js @@ -0,0 +1,156 @@ +const fetch = require('node-fetch'); +const fs = require('fs'); + +/** + * + * This script will create the autogenerated MDX files for each component. + * + * Creates files for: + * - Properties + * - Events + * - Methods + * - CSS Shadow Parts + * - Custom Properties + * - Slots + * + * The auto-generated directory & files should be gitignored, since they are created from the published core.json + * and should never be edited manually. + */ + +(async function () { + const response = await fetch('https://unpkg.com/@ionic/docs/core.json'); + const { components } = await response.json(); + + const names = components.map((component) => component.tag.slice(4)); + // matches all relative markdown links to a component, e.g. (../button) + COMPONENT_LINK_REGEXP = new RegExp(`\\(../(${names.join('|')})/?(#[^)]+)?\\)`, 'g'); + + components.forEach((comp) => { + const compTag = comp.tag.slice(4); + writeAutoGeneratedPage(compTag, 'props', renderProperties(comp)); + writeAutoGeneratedPage(compTag, 'events', renderEvents(comp)); + writeAutoGeneratedPage(compTag, 'methods', renderMethods(comp)); + writeAutoGeneratedPage(compTag, 'parts', renderParts(comp)); + writeAutoGeneratedPage(compTag, 'custom-props', renderCustomProps(comp)); + writeAutoGeneratedPage(compTag, 'slots', renderSlots(comp)); + }); +})(); + +function writeAutoGeneratedPage(componentTag, fileName, data) { + const dir = `./static/auto-generated/${componentTag}`; + const path = `${dir}/${fileName}.md`; + fs.mkdirSync(dir, { recursive: true }); + fs.writeFileSync(path, data); +} + +/** + * Formats line breaks in a multiline string to be displayed in a table. + * @param {*} str The string to format + * @returns The formatted string + */ +function formatMultiline(str) { + return str.split('\n\n').join('

').split('\n').join(' '); +} + +function renderProperties({ props: properties }) { + if (properties.length === 0) { + return 'No properties available for this component.'; + } + + // NOTE: replaces | with U+FF5C since MDX renders \| in tables incorrectly + return ` +${properties + .map((prop) => { + const isDeprecated = prop.deprecation !== undefined; + + const docs = isDeprecated ? `${prop.docs}\n_Deprecated_ ${prop.deprecation}` : prop.docs; + + return ` +### ${prop.name} ${isDeprecated ? '(deprecated)' : ''} + +| | | +| --- | --- | +| **Description** | ${formatMultiline(docs)} | +| **Attribute** | \`${prop.attr}\` | +| **Type** | \`${prop.type.replace(/\|/g, '\uff5c')}\` | +| **Default** | \`${prop.default}\` | + +`; + }) + .join('\n')}`; +} + +function renderEvents({ events }) { + if (events.length === 0) { + return 'No events available for this component.'; + } + + return ` +| Name | Description | +| --- | --- | +${events.map((event) => `| \`${event.event}\` | ${formatMultiline(event.docs)} |`).join('\n')} + +`; +} + +function renderMethods({ methods }) { + if (methods.length === 0) { + return 'No public methods available for this component.'; + } + + // NOTE: replaces | with U+FF5C since MDX renders \| in tables incorrectly + return ` +${methods + .map( + (method) => ` +### ${method.name} + +| | | +| --- | --- | +| **Description** | ${formatMultiline(method.docs)} | +| **Signature** | \`${method.signature.replace(/\|/g, '\uff5c')}\` | +` + ) + .join('\n')} + +`; +} + +function renderParts({ parts }) { + if (parts.length === 0) { + return 'No CSS shadow parts available for this component.'; + } + + return ` +| Name | Description | +| --- | --- | +${parts.map((prop) => `| \`${prop.name}\` | ${formatMultiline(prop.docs)} |`).join('\n')} + +`; +} + +function renderCustomProps({ styles: customProps }) { + if (customProps.length === 0) { + return 'No CSS custom properties available for this component.'; + } + + return ` +| Name | Description | +| --- | --- | +${customProps.map((prop) => `| \`${prop.name}\` | ${formatMultiline(prop.docs)} |`).join('\n')} + +`; +} + +function renderSlots({ slots }) { + if (slots.length === 0) { + return 'No slots available for this component.'; + } + + return ` +| Name | Description | +| --- | --- | +${slots.map((slot) => `| \`${slot.name}\` | ${formatMultiline(slot.docs)} |`).join('\n')} + +`; +} diff --git a/static/.gitignore b/static/.gitignore new file mode 100644 index 00000000000..6dddbb371e3 --- /dev/null +++ b/static/.gitignore @@ -0,0 +1 @@ +auto-generated/ diff --git a/versioned_docs/version-v6/api/accordion-group.md b/versioned_docs/version-v6/api/accordion-group.md index 80dac608394..2880703001c 100644 --- a/versioned_docs/version-v6/api/accordion-group.md +++ b/versioned_docs/version-v6/api/accordion-group.md @@ -1,13 +1,12 @@ --- -title: 'ion-accordion-group' +title: "ion-accordion-group" --- - -import Props from '@ionic-internal/component-api/v6/accordion-group/props.md'; -import Events from '@ionic-internal/component-api/v6/accordion-group/events.md'; -import Methods from '@ionic-internal/component-api/v6/accordion-group/methods.md'; -import Parts from '@ionic-internal/component-api/v6/accordion-group/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/accordion-group/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/accordion-group/slots.md'; +import Props from '@site/static/auto-generated/accordion-group/props.md'; +import Events from '@site/static/auto-generated/accordion-group/events.md'; +import Methods from '@site/static/auto-generated/accordion-group/methods.md'; +import Parts from '@site/static/auto-generated/accordion-group/parts.md'; +import CustomProps from '@site/static/auto-generated/accordion-group/custom-props.md'; +import Slots from '@site/static/auto-generated/accordion-group/slots.md'; import EncapsulationPill from '@components/page/api/EncapsulationPill'; @@ -17,6 +16,7 @@ Accordion group is a container for accordion instances. It manages the state of See the [Accordion](./accordion) documentation for more information. + ## Interfaces ### AccordionGroupChangeEventDetail @@ -38,26 +38,22 @@ interface AccordionGroupCustomEvent extends CustomEvent { } ``` -## Properties + +## Properties ## Events - ## Methods - ## CSS Shadow Parts - ## CSS Custom Properties - ## Slots - diff --git a/versioned_docs/version-v6/api/accordion.md b/versioned_docs/version-v6/api/accordion.md index 3cf53e1823f..803f0efbfe4 100644 --- a/versioned_docs/version-v6/api/accordion.md +++ b/versioned_docs/version-v6/api/accordion.md @@ -2,12 +2,12 @@ title: 'ion-accordion' --- -import Props from '@ionic-internal/component-api/v6/accordion/props.md'; -import Events from '@ionic-internal/component-api/v6/accordion/events.md'; -import Methods from '@ionic-internal/component-api/v6/accordion/methods.md'; -import Parts from '@ionic-internal/component-api/v6/accordion/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/accordion/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/accordion/slots.md'; +import Props from '@site/static/auto-generated/accordion/props.md'; +import Events from '@site/static/auto-generated/accordion/events.md'; +import Methods from '@site/static/auto-generated/accordion/methods.md'; +import Parts from '@site/static/auto-generated/accordion/parts.md'; +import CustomProps from '@site/static/auto-generated/accordion/custom-props.md'; +import Slots from '@site/static/auto-generated/accordion/slots.md'; Ion-Accordion Components: How to Build & Examples | Ionic diff --git a/versioned_docs/version-v6/api/action-sheet.md b/versioned_docs/version-v6/api/action-sheet.md index 67d0b6d193b..3f2917d979f 100644 --- a/versioned_docs/version-v6/api/action-sheet.md +++ b/versioned_docs/version-v6/api/action-sheet.md @@ -2,12 +2,12 @@ title: 'ion-action-sheet' --- -import Props from '@ionic-internal/component-api/v6/action-sheet/props.md'; -import Events from '@ionic-internal/component-api/v6/action-sheet/events.md'; -import Methods from '@ionic-internal/component-api/v6/action-sheet/methods.md'; -import Parts from '@ionic-internal/component-api/v6/action-sheet/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/action-sheet/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/action-sheet/slots.md'; +import Props from '@site/static/auto-generated/action-sheet/props.md'; +import Events from '@site/static/auto-generated/action-sheet/events.md'; +import Methods from '@site/static/auto-generated/action-sheet/methods.md'; +import Parts from '@site/static/auto-generated/action-sheet/parts.md'; +import CustomProps from '@site/static/auto-generated/action-sheet/custom-props.md'; +import Slots from '@site/static/auto-generated/action-sheet/slots.md'; ion-action-sheet | Action Sheet Dialog for iOS and Android Apps diff --git a/versioned_docs/version-v6/api/alert.md b/versioned_docs/version-v6/api/alert.md index 6a045bd3afc..19b8bd7177a 100644 --- a/versioned_docs/version-v6/api/alert.md +++ b/versioned_docs/version-v6/api/alert.md @@ -5,12 +5,12 @@ title: 'ion-alert' import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -import Props from '@ionic-internal/component-api/v6/alert/props.md'; -import Events from '@ionic-internal/component-api/v6/alert/events.md'; -import Methods from '@ionic-internal/component-api/v6/alert/methods.md'; -import Parts from '@ionic-internal/component-api/v6/alert/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/alert/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/alert/slots.md'; +import Props from '@site/static/auto-generated/alert/props.md'; +import Events from '@site/static/auto-generated/alert/events.md'; +import Methods from '@site/static/auto-generated/alert/methods.md'; +import Parts from '@site/static/auto-generated/alert/parts.md'; +import CustomProps from '@site/static/auto-generated/alert/custom-props.md'; +import Slots from '@site/static/auto-generated/alert/slots.md'; ion-alert: Ionic API Alert Buttons with Custom Message Prompts diff --git a/versioned_docs/version-v6/api/app.md b/versioned_docs/version-v6/api/app.md index 144734dd1c6..98125d4aa8e 100644 --- a/versioned_docs/version-v6/api/app.md +++ b/versioned_docs/version-v6/api/app.md @@ -1,55 +1,47 @@ --- -title: 'ion-app' +title: "ion-app" --- - -import Props from '@ionic-internal/component-api/v6/app/props.md'; -import Events from '@ionic-internal/component-api/v6/app/events.md'; -import Methods from '@ionic-internal/component-api/v6/app/methods.md'; -import Parts from '@ionic-internal/component-api/v6/app/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/app/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/app/slots.md'; +import Props from '@site/static/auto-generated/app/props.md'; +import Events from '@site/static/auto-generated/app/events.md'; +import Methods from '@site/static/auto-generated/app/methods.md'; +import Parts from '@site/static/auto-generated/app/parts.md'; +import CustomProps from '@site/static/auto-generated/app/custom-props.md'; +import Slots from '@site/static/auto-generated/app/slots.md'; ion-app: Container Element for an Ionic Application - + import EncapsulationPill from '@components/page/api/EncapsulationPill'; + App is a container element for an Ionic application. There should only be one `` element per project. An app can have many Ionic components including menus, headers, content, and footers. The overlay components get appended to the `` when they are presented. Using `ion-app` enables the following behaviors: -- [Keyboard Lifecycle Events](../developing/keyboard#keyboard-lifecycle-events) without the need for any native plugins -- [Hardware Back Button Listeners](../developing/hardware-back-button) for customizing the hardware back button behavior on Android devices -- Status bar support in Capacitor or Cordova which allows users to scroll to the top of the view by tapping the status bar -- Scroll assist utilities which scroll the content so focused text inputs are not covered by the on-screen keyboard -- [Ripple effect](./ripple-effect) when activating buttons on Material Design mode -- Other tap and focus utilities which make the experience of using an Ionic app feel more native +* [Keyboard Lifecycle Events](../developing/keyboard#keyboard-lifecycle-events) without the need for any native plugins +* [Hardware Back Button Listeners](../developing/hardware-back-button) for customizing the hardware back button behavior on Android devices +* Status bar support in Capacitor or Cordova which allows users to scroll to the top of the view by tapping the status bar +* Scroll assist utilities which scroll the content so focused text inputs are not covered by the on-screen keyboard +* [Ripple effect](./ripple-effect) when activating buttons on Material Design mode +* Other tap and focus utilities which make the experience of using an Ionic app feel more native -## Properties +## Properties ## Events - ## Methods - ## CSS Shadow Parts - ## CSS Custom Properties - ## Slots - diff --git a/versioned_docs/version-v6/api/avatar.md b/versioned_docs/version-v6/api/avatar.md index da0f858dabc..0f32507e1d7 100644 --- a/versioned_docs/version-v6/api/avatar.md +++ b/versioned_docs/version-v6/api/avatar.md @@ -2,12 +2,12 @@ title: 'ion-avatar' --- -import Props from '@ionic-internal/component-api/v6/avatar/props.md'; -import Events from '@ionic-internal/component-api/v6/avatar/events.md'; -import Methods from '@ionic-internal/component-api/v6/avatar/methods.md'; -import Parts from '@ionic-internal/component-api/v6/avatar/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/avatar/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/avatar/slots.md'; +import Props from '@site/static/auto-generated/avatar/props.md'; +import Events from '@site/static/auto-generated/avatar/events.md'; +import Methods from '@site/static/auto-generated/avatar/methods.md'; +import Parts from '@site/static/auto-generated/avatar/parts.md'; +import CustomProps from '@site/static/auto-generated/avatar/custom-props.md'; +import Slots from '@site/static/auto-generated/avatar/slots.md'; ion-avatar: Circular Application Avatar Icon Component diff --git a/versioned_docs/version-v6/api/back-button.md b/versioned_docs/version-v6/api/back-button.md index 6d7472f98ef..d74db2d2cfa 100644 --- a/versioned_docs/version-v6/api/back-button.md +++ b/versioned_docs/version-v6/api/back-button.md @@ -1,26 +1,23 @@ --- -title: 'ion-back-button' +title: "ion-back-button" --- - -import Props from '@ionic-internal/component-api/v6/back-button/props.md'; -import Events from '@ionic-internal/component-api/v6/back-button/events.md'; -import Methods from '@ionic-internal/component-api/v6/back-button/methods.md'; -import Parts from '@ionic-internal/component-api/v6/back-button/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/back-button/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/back-button/slots.md'; +import Props from '@site/static/auto-generated/back-button/props.md'; +import Events from '@site/static/auto-generated/back-button/events.md'; +import Methods from '@site/static/auto-generated/back-button/methods.md'; +import Parts from '@site/static/auto-generated/back-button/parts.md'; +import CustomProps from '@site/static/auto-generated/back-button/custom-props.md'; +import Slots from '@site/static/auto-generated/back-button/slots.md'; Back Button | ion-back-button: Custom Menu Icon for Applications - + import EncapsulationPill from '@components/page/api/EncapsulationPill'; + The back button navigates back in the app's history when clicked. It is only displayed when there is history in the navigation stack, unless [`defaultHref`](#default-back-history) is set. The back button displays different text and icon based on the mode, but this can be customized. ## Basic Usage @@ -42,25 +39,19 @@ import Custom from '@site/static/usage/v6/back-button/custom/index.md'; Occasionally an app may need to show the back button and navigate back when there is no history. This can be done by setting the `defaultHref` on the back button to a path. In order to use `defaultHref`, the app must contain a router with paths set. ## Properties - ## Events - ## Methods - ## CSS Shadow Parts - ## CSS Custom Properties - ## Slots - diff --git a/versioned_docs/version-v6/api/backdrop.md b/versioned_docs/version-v6/api/backdrop.md index ae1ecd965b4..97217b36b59 100644 --- a/versioned_docs/version-v6/api/backdrop.md +++ b/versioned_docs/version-v6/api/backdrop.md @@ -2,12 +2,12 @@ title: 'ion-backdrop' --- -import Props from '@ionic-internal/component-api/v6/backdrop/props.md'; -import Events from '@ionic-internal/component-api/v6/backdrop/events.md'; -import Methods from '@ionic-internal/component-api/v6/backdrop/methods.md'; -import Parts from '@ionic-internal/component-api/v6/backdrop/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/backdrop/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/backdrop/slots.md'; +import Props from '@site/static/auto-generated/backdrop/props.md'; +import Events from '@site/static/auto-generated/backdrop/events.md'; +import Methods from '@site/static/auto-generated/backdrop/methods.md'; +import Parts from '@site/static/auto-generated/backdrop/parts.md'; +import CustomProps from '@site/static/auto-generated/backdrop/custom-props.md'; +import Slots from '@site/static/auto-generated/backdrop/slots.md'; import EncapsulationPill from '@components/page/api/EncapsulationPill'; diff --git a/versioned_docs/version-v6/api/badge.md b/versioned_docs/version-v6/api/badge.md index 539e07309f4..202b2f32878 100644 --- a/versioned_docs/version-v6/api/badge.md +++ b/versioned_docs/version-v6/api/badge.md @@ -2,12 +2,12 @@ title: 'ion-badge' --- -import Props from '@ionic-internal/component-api/v6/badge/props.md'; -import Events from '@ionic-internal/component-api/v6/badge/events.md'; -import Methods from '@ionic-internal/component-api/v6/badge/methods.md'; -import Parts from '@ionic-internal/component-api/v6/badge/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/badge/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/badge/slots.md'; +import Props from '@site/static/auto-generated/badge/props.md'; +import Events from '@site/static/auto-generated/badge/events.md'; +import Methods from '@site/static/auto-generated/badge/methods.md'; +import Parts from '@site/static/auto-generated/badge/parts.md'; +import CustomProps from '@site/static/auto-generated/badge/custom-props.md'; +import Slots from '@site/static/auto-generated/badge/slots.md'; Badges | ion-badge: iOS & Android App Notification Badge Icons diff --git a/versioned_docs/version-v6/api/breadcrumb.md b/versioned_docs/version-v6/api/breadcrumb.md index c964549933b..5be2aa6c695 100644 --- a/versioned_docs/version-v6/api/breadcrumb.md +++ b/versioned_docs/version-v6/api/breadcrumb.md @@ -1,18 +1,18 @@ --- -title: 'ion-breadcrumb' +title: "ion-breadcrumb" --- - -import Props from '@ionic-internal/component-api/v6/breadcrumb/props.md'; -import Events from '@ionic-internal/component-api/v6/breadcrumb/events.md'; -import Methods from '@ionic-internal/component-api/v6/breadcrumb/methods.md'; -import Parts from '@ionic-internal/component-api/v6/breadcrumb/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/breadcrumb/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/breadcrumb/slots.md'; +import Props from '@site/static/auto-generated/breadcrumb/props.md'; +import Events from '@site/static/auto-generated/breadcrumb/events.md'; +import Methods from '@site/static/auto-generated/breadcrumb/methods.md'; +import Parts from '@site/static/auto-generated/breadcrumb/parts.md'; +import CustomProps from '@site/static/auto-generated/breadcrumb/custom-props.md'; +import Slots from '@site/static/auto-generated/breadcrumb/slots.md'; import EncapsulationPill from '@components/page/api/EncapsulationPill'; + A Breadcrumb is a single navigation item that is a child of the Breadcrumbs component. A breadcrumb can link elsewhere in an app or it can be plain text. Each breadcrumb has a separator between it and the next breadcrumb and can optionally contain an icon. See the [Breadcrumbs](./breadcrumbs) documentation for more information. @@ -38,26 +38,23 @@ interface BreadcrumbCustomEvent extends CustomEvent { } ``` -## Properties + + +## Properties ## Events - ## Methods - ## CSS Shadow Parts - ## CSS Custom Properties - ## Slots - diff --git a/versioned_docs/version-v6/api/breadcrumbs.md b/versioned_docs/version-v6/api/breadcrumbs.md index 471f5dd4291..561539a973e 100644 --- a/versioned_docs/version-v6/api/breadcrumbs.md +++ b/versioned_docs/version-v6/api/breadcrumbs.md @@ -2,12 +2,12 @@ title: 'ion-breadcrumbs' --- -import Props from '@ionic-internal/component-api/v6/breadcrumbs/props.md'; -import Events from '@ionic-internal/component-api/v6/breadcrumbs/events.md'; -import Methods from '@ionic-internal/component-api/v6/breadcrumbs/methods.md'; -import Parts from '@ionic-internal/component-api/v6/breadcrumbs/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/breadcrumbs/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/breadcrumbs/slots.md'; +import Props from '@site/static/auto-generated/breadcrumbs/props.md'; +import Events from '@site/static/auto-generated/breadcrumbs/events.md'; +import Methods from '@site/static/auto-generated/breadcrumbs/methods.md'; +import Parts from '@site/static/auto-generated/breadcrumbs/parts.md'; +import CustomProps from '@site/static/auto-generated/breadcrumbs/custom-props.md'; +import Slots from '@site/static/auto-generated/breadcrumbs/slots.md'; import EncapsulationPill from '@components/page/api/EncapsulationPill'; diff --git a/versioned_docs/version-v6/api/button.md b/versioned_docs/version-v6/api/button.md index 897d4d3f8e5..a78f98da7a8 100644 --- a/versioned_docs/version-v6/api/button.md +++ b/versioned_docs/version-v6/api/button.md @@ -2,12 +2,12 @@ title: 'ion-button' --- -import Props from '@ionic-internal/component-api/v6/button/props.md'; -import Events from '@ionic-internal/component-api/v6/button/events.md'; -import Methods from '@ionic-internal/component-api/v6/button/methods.md'; -import Parts from '@ionic-internal/component-api/v6/button/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/button/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/button/slots.md'; +import Props from '@site/static/auto-generated/button/props.md'; +import Events from '@site/static/auto-generated/button/events.md'; +import Methods from '@site/static/auto-generated/button/methods.md'; +import Parts from '@site/static/auto-generated/button/parts.md'; +import CustomProps from '@site/static/auto-generated/button/custom-props.md'; +import Slots from '@site/static/auto-generated/button/slots.md'; ion-button: Design and Style Buttons with Custom CSS Properties diff --git a/versioned_docs/version-v6/api/buttons.md b/versioned_docs/version-v6/api/buttons.md index d20c05adee6..c22bd4c0ad5 100644 --- a/versioned_docs/version-v6/api/buttons.md +++ b/versioned_docs/version-v6/api/buttons.md @@ -2,12 +2,12 @@ title: 'ion-buttons' --- -import Props from '@ionic-internal/component-api/v6/buttons/props.md'; -import Events from '@ionic-internal/component-api/v6/buttons/events.md'; -import Methods from '@ionic-internal/component-api/v6/buttons/methods.md'; -import Parts from '@ionic-internal/component-api/v6/buttons/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/buttons/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/buttons/slots.md'; +import Props from '@site/static/auto-generated/buttons/props.md'; +import Events from '@site/static/auto-generated/buttons/events.md'; +import Methods from '@site/static/auto-generated/buttons/methods.md'; +import Parts from '@site/static/auto-generated/buttons/parts.md'; +import CustomProps from '@site/static/auto-generated/buttons/custom-props.md'; +import Slots from '@site/static/auto-generated/buttons/slots.md'; ion-buttons: Toolbar Element with Named Slots for Buttons diff --git a/versioned_docs/version-v6/api/card-content.md b/versioned_docs/version-v6/api/card-content.md index 58f621b3d89..647cba00897 100644 --- a/versioned_docs/version-v6/api/card-content.md +++ b/versioned_docs/version-v6/api/card-content.md @@ -1,40 +1,35 @@ --- -title: 'ion-card-content' +title: "ion-card-content" --- - -import Props from '@ionic-internal/component-api/v6/card-content/props.md'; -import Events from '@ionic-internal/component-api/v6/card-content/events.md'; -import Methods from '@ionic-internal/component-api/v6/card-content/methods.md'; -import Parts from '@ionic-internal/component-api/v6/card-content/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/card-content/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/card-content/slots.md'; +import Props from '@site/static/auto-generated/card-content/props.md'; +import Events from '@site/static/auto-generated/card-content/events.md'; +import Methods from '@site/static/auto-generated/card-content/methods.md'; +import Parts from '@site/static/auto-generated/card-content/parts.md'; +import CustomProps from '@site/static/auto-generated/card-content/custom-props.md'; +import Slots from '@site/static/auto-generated/card-content/slots.md'; import EncapsulationPill from '@components/page/api/EncapsulationPill'; + Card content is a child component of card that adds padding around its contents. It is recommended that any text content for a card should be placed inside of card content. See the [Card](./card) documentation for more information. -## Properties +## Properties ## Events - ## Methods - ## CSS Shadow Parts - ## CSS Custom Properties - ## Slots - diff --git a/versioned_docs/version-v6/api/card-header.md b/versioned_docs/version-v6/api/card-header.md index 0461d60b54e..2e52467ed43 100644 --- a/versioned_docs/version-v6/api/card-header.md +++ b/versioned_docs/version-v6/api/card-header.md @@ -1,42 +1,37 @@ --- -title: 'ion-card-header' +title: "ion-card-header" --- - -import Props from '@ionic-internal/component-api/v6/card-header/props.md'; -import Events from '@ionic-internal/component-api/v6/card-header/events.md'; -import Methods from '@ionic-internal/component-api/v6/card-header/methods.md'; -import Parts from '@ionic-internal/component-api/v6/card-header/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/card-header/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/card-header/slots.md'; +import Props from '@site/static/auto-generated/card-header/props.md'; +import Events from '@site/static/auto-generated/card-header/events.md'; +import Methods from '@site/static/auto-generated/card-header/methods.md'; +import Parts from '@site/static/auto-generated/card-header/parts.md'; +import CustomProps from '@site/static/auto-generated/card-header/custom-props.md'; +import Slots from '@site/static/auto-generated/card-header/slots.md'; import EncapsulationPill from '@components/page/api/EncapsulationPill'; + Card header is a child component of card that should be placed before the card content. It can contain a [card title](./card-title) and a [card subtitle](./card-subtitle). See the [Card](./card) documentation for more information. -## Properties +## Properties ## Events - ## Methods - ## CSS Shadow Parts - ## CSS Custom Properties - ## Slots - diff --git a/versioned_docs/version-v6/api/card-subtitle.md b/versioned_docs/version-v6/api/card-subtitle.md index 2779735e71f..ec72784cd99 100644 --- a/versioned_docs/version-v6/api/card-subtitle.md +++ b/versioned_docs/version-v6/api/card-subtitle.md @@ -1,42 +1,37 @@ --- -title: 'ion-card-subtitle' +title: "ion-card-subtitle" --- - -import Props from '@ionic-internal/component-api/v6/card-subtitle/props.md'; -import Events from '@ionic-internal/component-api/v6/card-subtitle/events.md'; -import Methods from '@ionic-internal/component-api/v6/card-subtitle/methods.md'; -import Parts from '@ionic-internal/component-api/v6/card-subtitle/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/card-subtitle/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/card-subtitle/slots.md'; +import Props from '@site/static/auto-generated/card-subtitle/props.md'; +import Events from '@site/static/auto-generated/card-subtitle/events.md'; +import Methods from '@site/static/auto-generated/card-subtitle/methods.md'; +import Parts from '@site/static/auto-generated/card-subtitle/parts.md'; +import CustomProps from '@site/static/auto-generated/card-subtitle/custom-props.md'; +import Slots from '@site/static/auto-generated/card-subtitle/slots.md'; import EncapsulationPill from '@components/page/api/EncapsulationPill'; + Card subtitle is a child component of card that should be placed inside of a [card header](./card-header). See the [Card](./card) documentation for more information. -## Properties +## Properties ## Events - ## Methods - ## CSS Shadow Parts - ## CSS Custom Properties - ## Slots - diff --git a/versioned_docs/version-v6/api/card-title.md b/versioned_docs/version-v6/api/card-title.md index ee72f051ed3..33b24158eb5 100644 --- a/versioned_docs/version-v6/api/card-title.md +++ b/versioned_docs/version-v6/api/card-title.md @@ -1,50 +1,42 @@ --- -title: 'ion-card-title' +title: "ion-card-title" --- - -import Props from '@ionic-internal/component-api/v6/card-title/props.md'; -import Events from '@ionic-internal/component-api/v6/card-title/events.md'; -import Methods from '@ionic-internal/component-api/v6/card-title/methods.md'; -import Parts from '@ionic-internal/component-api/v6/card-title/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/card-title/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/card-title/slots.md'; +import Props from '@site/static/auto-generated/card-title/props.md'; +import Events from '@site/static/auto-generated/card-title/events.md'; +import Methods from '@site/static/auto-generated/card-title/methods.md'; +import Parts from '@site/static/auto-generated/card-title/parts.md'; +import CustomProps from '@site/static/auto-generated/card-title/custom-props.md'; +import Slots from '@site/static/auto-generated/card-title/slots.md'; import EncapsulationPill from '@components/page/api/EncapsulationPill'; ion-card-title | Ionic App Card Title Component and Properties - + + Card title is a child component of card that should be placed inside of a [card header](./card-header). See the [Card](./card) documentation for more information. -## Properties +## Properties ## Events - ## Methods - ## CSS Shadow Parts - ## CSS Custom Properties - ## Slots - diff --git a/versioned_docs/version-v6/api/card.md b/versioned_docs/version-v6/api/card.md index c67dd2a27b8..fda33f2e804 100644 --- a/versioned_docs/version-v6/api/card.md +++ b/versioned_docs/version-v6/api/card.md @@ -2,12 +2,12 @@ title: 'ion-card' --- -import Props from '@ionic-internal/component-api/v6/card/props.md'; -import Events from '@ionic-internal/component-api/v6/card/events.md'; -import Methods from '@ionic-internal/component-api/v6/card/methods.md'; -import Parts from '@ionic-internal/component-api/v6/card/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/card/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/card/slots.md'; +import Props from '@site/static/auto-generated/card/props.md'; +import Events from '@site/static/auto-generated/card/events.md'; +import Methods from '@site/static/auto-generated/card/methods.md'; +import Parts from '@site/static/auto-generated/card/parts.md'; +import CustomProps from '@site/static/auto-generated/card/custom-props.md'; +import Slots from '@site/static/auto-generated/card/slots.md'; import EncapsulationPill from '@components/page/api/EncapsulationPill'; diff --git a/versioned_docs/version-v6/api/checkbox.md b/versioned_docs/version-v6/api/checkbox.md index 727c09811c9..7344a77f0d1 100644 --- a/versioned_docs/version-v6/api/checkbox.md +++ b/versioned_docs/version-v6/api/checkbox.md @@ -2,12 +2,12 @@ title: 'ion-checkbox' --- -import Props from '@ionic-internal/component-api/v6/checkbox/props.md'; -import Events from '@ionic-internal/component-api/v6/checkbox/events.md'; -import Methods from '@ionic-internal/component-api/v6/checkbox/methods.md'; -import Parts from '@ionic-internal/component-api/v6/checkbox/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/checkbox/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/checkbox/slots.md'; +import Props from '@site/static/auto-generated/checkbox/props.md'; +import Events from '@site/static/auto-generated/checkbox/events.md'; +import Methods from '@site/static/auto-generated/checkbox/methods.md'; +import Parts from '@site/static/auto-generated/checkbox/parts.md'; +import CustomProps from '@site/static/auto-generated/checkbox/custom-props.md'; +import Slots from '@site/static/auto-generated/checkbox/slots.md'; ion-checkboxes: Ionic App Component to Select Multiple Options diff --git a/versioned_docs/version-v6/api/chip.md b/versioned_docs/version-v6/api/chip.md index 91f6bb5e264..46e13e98292 100644 --- a/versioned_docs/version-v6/api/chip.md +++ b/versioned_docs/version-v6/api/chip.md @@ -2,12 +2,12 @@ title: 'ion-chip' --- -import Props from '@ionic-internal/component-api/v6/chip/props.md'; -import Events from '@ionic-internal/component-api/v6/chip/events.md'; -import Methods from '@ionic-internal/component-api/v6/chip/methods.md'; -import Parts from '@ionic-internal/component-api/v6/chip/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/chip/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/chip/slots.md'; +import Props from '@site/static/auto-generated/chip/props.md'; +import Events from '@site/static/auto-generated/chip/events.md'; +import Methods from '@site/static/auto-generated/chip/methods.md'; +import Parts from '@site/static/auto-generated/chip/parts.md'; +import CustomProps from '@site/static/auto-generated/chip/custom-props.md'; +import Slots from '@site/static/auto-generated/chip/slots.md'; ion-chip: Name, Text, Icon and Avatar for Ionic Framework Apps diff --git a/versioned_docs/version-v6/api/col.md b/versioned_docs/version-v6/api/col.md index 5a19f67b49b..e5872b4f6a1 100644 --- a/versioned_docs/version-v6/api/col.md +++ b/versioned_docs/version-v6/api/col.md @@ -1,54 +1,49 @@ --- -title: 'ion-col' +title: "ion-col" --- - -import Props from '@ionic-internal/component-api/v6/col/props.md'; -import Events from '@ionic-internal/component-api/v6/col/events.md'; -import Methods from '@ionic-internal/component-api/v6/col/methods.md'; -import Parts from '@ionic-internal/component-api/v6/col/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/col/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/col/slots.md'; +import Props from '@site/static/auto-generated/col/props.md'; +import Events from '@site/static/auto-generated/col/events.md'; +import Methods from '@site/static/auto-generated/col/methods.md'; +import Parts from '@site/static/auto-generated/col/parts.md'; +import CustomProps from '@site/static/auto-generated/col/custom-props.md'; +import Slots from '@site/static/auto-generated/col/slots.md'; ion-col: Column Component Padding, Size and Other Properties - + import EncapsulationPill from '@components/page/api/EncapsulationPill'; + Columns are cellular components of the [grid](./grid) system and go inside of a [row](./row). They will expand to fill the row. All content within a grid should go inside of a column. See the [grid](./grid) documentation for more information. + ## Column Alignment By default, columns will stretch to fill the entire height of the row. Columns are [flex items](https://developer.mozilla.org/en-US/docs/Glossary/Flex_Item), so there are several [CSS classes](/docs/layout/css-utilities#flex-item-properties) that can be applied to a column to customize this behavior. -## Properties + + +## Properties ## Events - ## Methods - ## CSS Shadow Parts - ## CSS Custom Properties - ## Slots - diff --git a/versioned_docs/version-v6/api/content.md b/versioned_docs/version-v6/api/content.md index 912c05d4515..528f39b7958 100644 --- a/versioned_docs/version-v6/api/content.md +++ b/versioned_docs/version-v6/api/content.md @@ -2,12 +2,12 @@ title: 'ion-content' --- -import Props from '@ionic-internal/component-api/v6/content/props.md'; -import Events from '@ionic-internal/component-api/v6/content/events.md'; -import Methods from '@ionic-internal/component-api/v6/content/methods.md'; -import Parts from '@ionic-internal/component-api/v6/content/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/content/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/content/slots.md'; +import Props from '@site/static/auto-generated/content/props.md'; +import Events from '@site/static/auto-generated/content/events.md'; +import Methods from '@site/static/auto-generated/content/methods.md'; +import Parts from '@site/static/auto-generated/content/parts.md'; +import CustomProps from '@site/static/auto-generated/content/custom-props.md'; +import Slots from '@site/static/auto-generated/content/slots.md'; ion-content: Scrollable CSS Component for Ionic App Content Areas diff --git a/versioned_docs/version-v6/api/datetime-button.md b/versioned_docs/version-v6/api/datetime-button.md index dd76005abc2..78e691b231d 100644 --- a/versioned_docs/version-v6/api/datetime-button.md +++ b/versioned_docs/version-v6/api/datetime-button.md @@ -2,12 +2,12 @@ title: 'ion-datetime-button' --- -import Props from '@ionic-internal/component-api/v6/datetime-button/props.md'; -import Events from '@ionic-internal/component-api/v6/datetime-button/events.md'; -import Methods from '@ionic-internal/component-api/v6/datetime-button/methods.md'; -import Parts from '@ionic-internal/component-api/v6/datetime-button/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/datetime-button/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/datetime-button/slots.md'; +import Props from '@site/static/auto-generated/datetime-button/props.md'; +import Events from '@site/static/auto-generated/datetime-button/events.md'; +import Methods from '@site/static/auto-generated/datetime-button/methods.md'; +import Parts from '@site/static/auto-generated/datetime-button/parts.md'; +import CustomProps from '@site/static/auto-generated/datetime-button/custom-props.md'; +import Slots from '@site/static/auto-generated/datetime-button/slots.md'; ion-datetime-button: Ionic API Input for interacting with Datetime picker diff --git a/versioned_docs/version-v6/api/datetime.md b/versioned_docs/version-v6/api/datetime.md index a4abc8d33a6..ffe8e673934 100644 --- a/versioned_docs/version-v6/api/datetime.md +++ b/versioned_docs/version-v6/api/datetime.md @@ -2,12 +2,12 @@ title: 'ion-datetime' --- -import Props from '@ionic-internal/component-api/v6/datetime/props.md'; -import Events from '@ionic-internal/component-api/v6/datetime/events.md'; -import Methods from '@ionic-internal/component-api/v6/datetime/methods.md'; -import Parts from '@ionic-internal/component-api/v6/datetime/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/datetime/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/datetime/slots.md'; +import Props from '@site/static/auto-generated/datetime/props.md'; +import Events from '@site/static/auto-generated/datetime/events.md'; +import Methods from '@site/static/auto-generated/datetime/methods.md'; +import Parts from '@site/static/auto-generated/datetime/parts.md'; +import CustomProps from '@site/static/auto-generated/datetime/custom-props.md'; +import Slots from '@site/static/auto-generated/datetime/slots.md'; import Basic from '@site/static/usage/v6/datetime/basic/index.md'; diff --git a/versioned_docs/version-v6/api/fab-button.md b/versioned_docs/version-v6/api/fab-button.md index bd1c98cc848..ab86a48426e 100644 --- a/versioned_docs/version-v6/api/fab-button.md +++ b/versioned_docs/version-v6/api/fab-button.md @@ -1,26 +1,23 @@ --- -title: 'ion-fab-button' +title: "ion-fab-button" --- - -import Props from '@ionic-internal/component-api/v6/fab-button/props.md'; -import Events from '@ionic-internal/component-api/v6/fab-button/events.md'; -import Methods from '@ionic-internal/component-api/v6/fab-button/methods.md'; -import Parts from '@ionic-internal/component-api/v6/fab-button/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/fab-button/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/fab-button/slots.md'; +import Props from '@site/static/auto-generated/fab-button/props.md'; +import Events from '@site/static/auto-generated/fab-button/events.md'; +import Methods from '@site/static/auto-generated/fab-button/methods.md'; +import Parts from '@site/static/auto-generated/fab-button/parts.md'; +import CustomProps from '@site/static/auto-generated/fab-button/custom-props.md'; +import Slots from '@site/static/auto-generated/fab-button/slots.md'; Floating Action Button | Ionic FAB Button Icon for Primary Action - + import EncapsulationPill from '@components/page/api/EncapsulationPill'; + 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 achieved by wrapping the fab button in a [fab](./fab) component. If the button is not wrapped with a fab, it will scroll with the content. @@ -28,25 +25,19 @@ As the name suggests, FABs generally float over the content in a fixed position. For usage examples, see the [fab documentation](./fab). ## Properties - ## Events - ## Methods - ## CSS Shadow Parts - ## CSS Custom Properties - ## Slots - - + \ No newline at end of file diff --git a/versioned_docs/version-v6/api/fab-list.md b/versioned_docs/version-v6/api/fab-list.md index 36d1040bda6..a0659a394d7 100644 --- a/versioned_docs/version-v6/api/fab-list.md +++ b/versioned_docs/version-v6/api/fab-list.md @@ -1,13 +1,12 @@ --- -title: 'ion-fab-list' +title: "ion-fab-list" --- - -import Props from '@ionic-internal/component-api/v6/fab-list/props.md'; -import Events from '@ionic-internal/component-api/v6/fab-list/events.md'; -import Methods from '@ionic-internal/component-api/v6/fab-list/methods.md'; -import Parts from '@ionic-internal/component-api/v6/fab-list/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/fab-list/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/fab-list/slots.md'; +import Props from '@site/static/auto-generated/fab-list/props.md'; +import Events from '@site/static/auto-generated/fab-list/events.md'; +import Methods from '@site/static/auto-generated/fab-list/methods.md'; +import Parts from '@site/static/auto-generated/fab-list/parts.md'; +import CustomProps from '@site/static/auto-generated/fab-list/custom-props.md'; +import Slots from '@site/static/auto-generated/fab-list/slots.md'; import EncapsulationPill from '@components/page/api/EncapsulationPill'; @@ -18,25 +17,19 @@ The fab list component is a container for multiple [fab buttons](./fab-button). For usage examples, see the [fab documentation](./fab). ## Properties - ## Events - ## Methods - ## CSS Shadow Parts - ## CSS Custom Properties - ## Slots - - + \ No newline at end of file diff --git a/versioned_docs/version-v6/api/fab.md b/versioned_docs/version-v6/api/fab.md index 008063d0f2e..5ecfbbd012d 100644 --- a/versioned_docs/version-v6/api/fab.md +++ b/versioned_docs/version-v6/api/fab.md @@ -2,12 +2,12 @@ title: 'ion-fab' --- -import Props from '@ionic-internal/component-api/v6/fab/props.md'; -import Events from '@ionic-internal/component-api/v6/fab/events.md'; -import Methods from '@ionic-internal/component-api/v6/fab/methods.md'; -import Parts from '@ionic-internal/component-api/v6/fab/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/fab/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/fab/slots.md'; +import Props from '@site/static/auto-generated/fab/props.md'; +import Events from '@site/static/auto-generated/fab/events.md'; +import Methods from '@site/static/auto-generated/fab/methods.md'; +import Parts from '@site/static/auto-generated/fab/parts.md'; +import CustomProps from '@site/static/auto-generated/fab/custom-props.md'; +import Slots from '@site/static/auto-generated/fab/slots.md'; ion-fab: Floating Action Button for Android and iOS Ionic Apps diff --git a/versioned_docs/version-v6/api/footer.md b/versioned_docs/version-v6/api/footer.md index a2c7b74fad8..0a4820b5713 100644 --- a/versioned_docs/version-v6/api/footer.md +++ b/versioned_docs/version-v6/api/footer.md @@ -2,12 +2,12 @@ title: 'ion-footer' --- -import Props from '@ionic-internal/component-api/v6/footer/props.md'; -import Events from '@ionic-internal/component-api/v6/footer/events.md'; -import Methods from '@ionic-internal/component-api/v6/footer/methods.md'; -import Parts from '@ionic-internal/component-api/v6/footer/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/footer/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/footer/slots.md'; +import Props from '@site/static/auto-generated/footer/props.md'; +import Events from '@site/static/auto-generated/footer/events.md'; +import Methods from '@site/static/auto-generated/footer/methods.md'; +import Parts from '@site/static/auto-generated/footer/parts.md'; +import CustomProps from '@site/static/auto-generated/footer/custom-props.md'; +import Slots from '@site/static/auto-generated/footer/slots.md'; Page Footer | Ionic App Footer: Wrapper Root Page Component diff --git a/versioned_docs/version-v6/api/grid.md b/versioned_docs/version-v6/api/grid.md index 9eedd1955ab..22ea8c2f0f1 100644 --- a/versioned_docs/version-v6/api/grid.md +++ b/versioned_docs/version-v6/api/grid.md @@ -2,12 +2,12 @@ title: 'ion-grid' --- -import Props from '@ionic-internal/component-api/v6/grid/props.md'; -import Events from '@ionic-internal/component-api/v6/grid/events.md'; -import Methods from '@ionic-internal/component-api/v6/grid/methods.md'; -import Parts from '@ionic-internal/component-api/v6/grid/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/grid/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/grid/slots.md'; +import Props from '@site/static/auto-generated/grid/props.md'; +import Events from '@site/static/auto-generated/grid/events.md'; +import Methods from '@site/static/auto-generated/grid/methods.md'; +import Parts from '@site/static/auto-generated/grid/parts.md'; +import CustomProps from '@site/static/auto-generated/grid/custom-props.md'; +import Slots from '@site/static/auto-generated/grid/slots.md'; Ion-Grid: Display Grids to Build Mobile-First Custom App Layout diff --git a/versioned_docs/version-v6/api/header.md b/versioned_docs/version-v6/api/header.md index d3305b4c027..a746f955361 100644 --- a/versioned_docs/version-v6/api/header.md +++ b/versioned_docs/version-v6/api/header.md @@ -2,12 +2,12 @@ title: 'ion-header' --- -import Props from '@ionic-internal/component-api/v6/header/props.md'; -import Events from '@ionic-internal/component-api/v6/header/events.md'; -import Methods from '@ionic-internal/component-api/v6/header/methods.md'; -import Parts from '@ionic-internal/component-api/v6/header/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/header/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/header/slots.md'; +import Props from '@site/static/auto-generated/header/props.md'; +import Events from '@site/static/auto-generated/header/events.md'; +import Methods from '@site/static/auto-generated/header/methods.md'; +import Parts from '@site/static/auto-generated/header/parts.md'; +import CustomProps from '@site/static/auto-generated/header/custom-props.md'; +import Slots from '@site/static/auto-generated/header/slots.md'; ion-header: Header Parent Component for Ionic Framework Apps diff --git a/versioned_docs/version-v6/api/img.md b/versioned_docs/version-v6/api/img.md index 44e3adbb1d3..aa1010e46b5 100644 --- a/versioned_docs/version-v6/api/img.md +++ b/versioned_docs/version-v6/api/img.md @@ -2,12 +2,12 @@ title: 'ion-img' --- -import Props from '@ionic-internal/component-api/v6/img/props.md'; -import Events from '@ionic-internal/component-api/v6/img/events.md'; -import Methods from '@ionic-internal/component-api/v6/img/methods.md'; -import Parts from '@ionic-internal/component-api/v6/img/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/img/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/img/slots.md'; +import Props from '@site/static/auto-generated/img/props.md'; +import Events from '@site/static/auto-generated/img/events.md'; +import Methods from '@site/static/auto-generated/img/methods.md'; +import Parts from '@site/static/auto-generated/img/parts.md'; +import CustomProps from '@site/static/auto-generated/img/custom-props.md'; +import Slots from '@site/static/auto-generated/img/slots.md'; Img Tag to Lazy Load Images in Viewport | ion-img Tag diff --git a/versioned_docs/version-v6/api/infinite-scroll-content.md b/versioned_docs/version-v6/api/infinite-scroll-content.md index 53b4829e731..2647dffdb87 100644 --- a/versioned_docs/version-v6/api/infinite-scroll-content.md +++ b/versioned_docs/version-v6/api/infinite-scroll-content.md @@ -1,13 +1,13 @@ --- -title: 'ion-infinite-scroll-content' +title: "ion-infinite-scroll-content" --- -import Props from '@ionic-internal/component-api/v6/infinite-scroll-content/props.md'; -import Events from '@ionic-internal/component-api/v6/infinite-scroll-content/events.md'; -import Methods from '@ionic-internal/component-api/v6/infinite-scroll-content/methods.md'; -import Parts from '@ionic-internal/component-api/v6/infinite-scroll-content/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/infinite-scroll-content/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/infinite-scroll-content/slots.md'; +import Props from '@site/static/auto-generated/infinite-scroll-content/props.md'; +import Events from '@site/static/auto-generated/infinite-scroll-content/events.md'; +import Methods from '@site/static/auto-generated/infinite-scroll-content/methods.md'; +import Parts from '@site/static/auto-generated/infinite-scroll-content/parts.md'; +import CustomProps from '@site/static/auto-generated/infinite-scroll-content/custom-props.md'; +import Slots from '@site/static/auto-generated/infinite-scroll-content/slots.md'; import EncapsulationPill from '@components/page/api/EncapsulationPill'; @@ -16,25 +16,19 @@ The `ion-infinite-scroll-content` component is the default child used by the `io For more information as well as usage, see the [Infinite Scroll Documentation](./infinite-scroll.md#infinite-scroll-content). ## Properties - ## Events - ## Methods - ## CSS Shadow Parts - ## CSS Custom Properties - ## Slots - - + \ No newline at end of file diff --git a/versioned_docs/version-v6/api/infinite-scroll.md b/versioned_docs/version-v6/api/infinite-scroll.md index e8788dde143..0ea2be497e9 100644 --- a/versioned_docs/version-v6/api/infinite-scroll.md +++ b/versioned_docs/version-v6/api/infinite-scroll.md @@ -2,12 +2,12 @@ title: 'ion-infinite-scroll' --- -import Props from '@ionic-internal/component-api/v6/infinite-scroll/props.md'; -import Events from '@ionic-internal/component-api/v6/infinite-scroll/events.md'; -import Methods from '@ionic-internal/component-api/v6/infinite-scroll/methods.md'; -import Parts from '@ionic-internal/component-api/v6/infinite-scroll/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/infinite-scroll/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/infinite-scroll/slots.md'; +import Props from '@site/static/auto-generated/infinite-scroll/props.md'; +import Events from '@site/static/auto-generated/infinite-scroll/events.md'; +import Methods from '@site/static/auto-generated/infinite-scroll/methods.md'; +import Parts from '@site/static/auto-generated/infinite-scroll/parts.md'; +import CustomProps from '@site/static/auto-generated/infinite-scroll/custom-props.md'; +import Slots from '@site/static/auto-generated/infinite-scroll/slots.md'; Infinite Scroller | ion-infinite-scroll Action Component diff --git a/versioned_docs/version-v6/api/input.md b/versioned_docs/version-v6/api/input.md index 3f439459ada..f9c328996e7 100644 --- a/versioned_docs/version-v6/api/input.md +++ b/versioned_docs/version-v6/api/input.md @@ -2,12 +2,12 @@ title: 'ion-input' --- -import Props from '@ionic-internal/component-api/v6/input/props.md'; -import Events from '@ionic-internal/component-api/v6/input/events.md'; -import Methods from '@ionic-internal/component-api/v6/input/methods.md'; -import Parts from '@ionic-internal/component-api/v6/input/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/input/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/input/slots.md'; +import Props from '@site/static/auto-generated/input/props.md'; +import Events from '@site/static/auto-generated/input/events.md'; +import Methods from '@site/static/auto-generated/input/methods.md'; +import Parts from '@site/static/auto-generated/input/parts.md'; +import CustomProps from '@site/static/auto-generated/input/custom-props.md'; +import Slots from '@site/static/auto-generated/input/slots.md'; ion-input: Custom Input Value Type Styling and CSS Properties diff --git a/versioned_docs/version-v6/api/item-divider.md b/versioned_docs/version-v6/api/item-divider.md index cf5cb8cad4a..381d9eb414a 100644 --- a/versioned_docs/version-v6/api/item-divider.md +++ b/versioned_docs/version-v6/api/item-divider.md @@ -2,12 +2,12 @@ title: 'ion-item-divider' --- -import Props from '@ionic-internal/component-api/v6/item-divider/props.md'; -import Events from '@ionic-internal/component-api/v6/item-divider/events.md'; -import Methods from '@ionic-internal/component-api/v6/item-divider/methods.md'; -import Parts from '@ionic-internal/component-api/v6/item-divider/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/item-divider/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/item-divider/slots.md'; +import Props from '@site/static/auto-generated/item-divider/props.md'; +import Events from '@site/static/auto-generated/item-divider/events.md'; +import Methods from '@site/static/auto-generated/item-divider/methods.md'; +import Parts from '@site/static/auto-generated/item-divider/parts.md'; +import CustomProps from '@site/static/auto-generated/item-divider/custom-props.md'; +import Slots from '@site/static/auto-generated/item-divider/slots.md'; Item Divider | List Item Divider Block Element for Ionic Apps diff --git a/versioned_docs/version-v6/api/item-group.md b/versioned_docs/version-v6/api/item-group.md index c4909aa35b8..c7920c017dd 100644 --- a/versioned_docs/version-v6/api/item-group.md +++ b/versioned_docs/version-v6/api/item-group.md @@ -2,12 +2,12 @@ title: 'ion-item-group' --- -import Props from '@ionic-internal/component-api/v6/item-group/props.md'; -import Events from '@ionic-internal/component-api/v6/item-group/events.md'; -import Methods from '@ionic-internal/component-api/v6/item-group/methods.md'; -import Parts from '@ionic-internal/component-api/v6/item-group/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/item-group/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/item-group/slots.md'; +import Props from '@site/static/auto-generated/item-group/props.md'; +import Events from '@site/static/auto-generated/item-group/events.md'; +import Methods from '@site/static/auto-generated/item-group/methods.md'; +import Parts from '@site/static/auto-generated/item-group/parts.md'; +import CustomProps from '@site/static/auto-generated/item-group/custom-props.md'; +import Slots from '@site/static/auto-generated/item-group/slots.md'; ion-item-group: Group Items to Divide into Multiple Sections diff --git a/versioned_docs/version-v6/api/item-option.md b/versioned_docs/version-v6/api/item-option.md index 8ef658c9bd8..800d1030f50 100644 --- a/versioned_docs/version-v6/api/item-option.md +++ b/versioned_docs/version-v6/api/item-option.md @@ -1,50 +1,42 @@ --- -title: 'ion-item-option' +title: "ion-item-option" --- - -import Props from '@ionic-internal/component-api/v6/item-option/props.md'; -import Events from '@ionic-internal/component-api/v6/item-option/events.md'; -import Methods from '@ionic-internal/component-api/v6/item-option/methods.md'; -import Parts from '@ionic-internal/component-api/v6/item-option/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/item-option/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/item-option/slots.md'; +import Props from '@site/static/auto-generated/item-option/props.md'; +import Events from '@site/static/auto-generated/item-option/events.md'; +import Methods from '@site/static/auto-generated/item-option/methods.md'; +import Parts from '@site/static/auto-generated/item-option/parts.md'; +import CustomProps from '@site/static/auto-generated/item-option/custom-props.md'; +import Slots from '@site/static/auto-generated/item-option/slots.md'; ion-item-options: Option Button Components for Ionic Apps - + import EncapsulationPill from '@components/page/api/EncapsulationPill'; + The item option component is an button for a sliding item. It must be placed inside of [item options](./item-options). The `ionSwipe` event and the `expandable` property can be combined to create a full swipe action for the item. See the [item sliding](./item-sliding) documentation for more information. -## Properties +## Properties ## Events - ## Methods - ## CSS Shadow Parts - ## CSS Custom Properties - ## Slots - diff --git a/versioned_docs/version-v6/api/item-options.md b/versioned_docs/version-v6/api/item-options.md index 6035574119c..cbee8f5289b 100644 --- a/versioned_docs/version-v6/api/item-options.md +++ b/versioned_docs/version-v6/api/item-options.md @@ -1,55 +1,50 @@ --- -title: 'ion-item-options' +title: "ion-item-options" --- - -import Props from '@ionic-internal/component-api/v6/item-options/props.md'; -import Events from '@ionic-internal/component-api/v6/item-options/events.md'; -import Methods from '@ionic-internal/component-api/v6/item-options/methods.md'; -import Parts from '@ionic-internal/component-api/v6/item-options/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/item-options/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/item-options/slots.md'; +import Props from '@site/static/auto-generated/item-options/props.md'; +import Events from '@site/static/auto-generated/item-options/events.md'; +import Methods from '@site/static/auto-generated/item-options/methods.md'; +import Parts from '@site/static/auto-generated/item-options/parts.md'; +import CustomProps from '@site/static/auto-generated/item-options/custom-props.md'; +import Slots from '@site/static/auto-generated/item-options/slots.md'; ion-item-options: Option Button Components for Ionic Apps - + import EncapsulationPill from '@components/page/api/EncapsulationPill'; + The item options component is a container for the [item option](./item-option) buttons in a sliding item. These buttons can be placed either on the [start or end side](#side-description). See the [item sliding](./item-sliding) documentation for more information. + ## Side Description | Side | Position | Swipe Direction | -| ------- | --------------------------------------------------------------- | ----------------------------------------------------------------- | +|---------|-----------------------------------------------------------------|-------------------------------------------------------------------| | `start` | To the `left` of the content in LTR, and to the `right` in RTL. | From `left` to `right` in LTR, and from `right` to `left` in RTL. | | `end` | To the `right` of the content in LTR, and to the `left` in RTL. | From `right` to `left` in LTR, and from `left` to `right` in RTL. | -## Properties + + +## Properties ## Events - ## Methods - ## CSS Shadow Parts - ## CSS Custom Properties - ## Slots - diff --git a/versioned_docs/version-v6/api/item-sliding.md b/versioned_docs/version-v6/api/item-sliding.md index 62e496d51e8..dba424f2b7f 100644 --- a/versioned_docs/version-v6/api/item-sliding.md +++ b/versioned_docs/version-v6/api/item-sliding.md @@ -2,12 +2,12 @@ title: 'ion-item-sliding' --- -import Props from '@ionic-internal/component-api/v6/item-sliding/props.md'; -import Events from '@ionic-internal/component-api/v6/item-sliding/events.md'; -import Methods from '@ionic-internal/component-api/v6/item-sliding/methods.md'; -import Parts from '@ionic-internal/component-api/v6/item-sliding/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/item-sliding/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/item-sliding/slots.md'; +import Props from '@site/static/auto-generated/item-sliding/props.md'; +import Events from '@site/static/auto-generated/item-sliding/events.md'; +import Methods from '@site/static/auto-generated/item-sliding/methods.md'; +import Parts from '@site/static/auto-generated/item-sliding/parts.md'; +import CustomProps from '@site/static/auto-generated/item-sliding/custom-props.md'; +import Slots from '@site/static/auto-generated/item-sliding/slots.md'; Slide Buttons | Slide Right to Left with ion-item-sliding diff --git a/versioned_docs/version-v6/api/item.md b/versioned_docs/version-v6/api/item.md index cb318d9fb04..eb3df16d32e 100644 --- a/versioned_docs/version-v6/api/item.md +++ b/versioned_docs/version-v6/api/item.md @@ -2,12 +2,12 @@ title: 'ion-item' --- -import Props from '@ionic-internal/component-api/v6/item/props.md'; -import Events from '@ionic-internal/component-api/v6/item/events.md'; -import Methods from '@ionic-internal/component-api/v6/item/methods.md'; -import Parts from '@ionic-internal/component-api/v6/item/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/item/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/item/slots.md'; +import Props from '@site/static/auto-generated/item/props.md'; +import Events from '@site/static/auto-generated/item/events.md'; +import Methods from '@site/static/auto-generated/item/methods.md'; +import Parts from '@site/static/auto-generated/item/parts.md'; +import CustomProps from '@site/static/auto-generated/item/custom-props.md'; +import Slots from '@site/static/auto-generated/item/slots.md'; ion-item: Input, Edit, or Delete iOS and Android Item Elements diff --git a/versioned_docs/version-v6/api/label.md b/versioned_docs/version-v6/api/label.md index 4b17032fe56..329f40c56a4 100644 --- a/versioned_docs/version-v6/api/label.md +++ b/versioned_docs/version-v6/api/label.md @@ -2,12 +2,12 @@ title: 'ion-label' --- -import Props from '@ionic-internal/component-api/v6/label/props.md'; -import Events from '@ionic-internal/component-api/v6/label/events.md'; -import Methods from '@ionic-internal/component-api/v6/label/methods.md'; -import Parts from '@ionic-internal/component-api/v6/label/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/label/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/label/slots.md'; +import Props from '@site/static/auto-generated/label/props.md'; +import Events from '@site/static/auto-generated/label/events.md'; +import Methods from '@site/static/auto-generated/label/methods.md'; +import Parts from '@site/static/auto-generated/label/parts.md'; +import CustomProps from '@site/static/auto-generated/label/custom-props.md'; +import Slots from '@site/static/auto-generated/label/slots.md'; Item Label Color and Properties for Applications | ion-label diff --git a/versioned_docs/version-v6/api/list-header.md b/versioned_docs/version-v6/api/list-header.md index bf16332d0fc..2410ffc044f 100644 --- a/versioned_docs/version-v6/api/list-header.md +++ b/versioned_docs/version-v6/api/list-header.md @@ -2,12 +2,12 @@ title: 'ion-list-header' --- -import Props from '@ionic-internal/component-api/v6/list-header/props.md'; -import Events from '@ionic-internal/component-api/v6/list-header/events.md'; -import Methods from '@ionic-internal/component-api/v6/list-header/methods.md'; -import Parts from '@ionic-internal/component-api/v6/list-header/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/list-header/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/list-header/slots.md'; +import Props from '@site/static/auto-generated/list-header/props.md'; +import Events from '@site/static/auto-generated/list-header/events.md'; +import Methods from '@site/static/auto-generated/list-header/methods.md'; +import Parts from '@site/static/auto-generated/list-header/parts.md'; +import CustomProps from '@site/static/auto-generated/list-header/custom-props.md'; +import Slots from '@site/static/auto-generated/list-header/slots.md'; import EncapsulationPill from '@components/page/api/EncapsulationPill'; diff --git a/versioned_docs/version-v6/api/list.md b/versioned_docs/version-v6/api/list.md index 054686768c7..336fe851f08 100644 --- a/versioned_docs/version-v6/api/list.md +++ b/versioned_docs/version-v6/api/list.md @@ -2,12 +2,12 @@ title: 'ion-list' --- -import Props from '@ionic-internal/component-api/v6/list/props.md'; -import Events from '@ionic-internal/component-api/v6/list/events.md'; -import Methods from '@ionic-internal/component-api/v6/list/methods.md'; -import Parts from '@ionic-internal/component-api/v6/list/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/list/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/list/slots.md'; +import Props from '@site/static/auto-generated/list/props.md'; +import Events from '@site/static/auto-generated/list/events.md'; +import Methods from '@site/static/auto-generated/list/methods.md'; +import Parts from '@site/static/auto-generated/list/parts.md'; +import CustomProps from '@site/static/auto-generated/list/custom-props.md'; +import Slots from '@site/static/auto-generated/list/slots.md'; ion-list: Item List View Component for iOS and Android Apps diff --git a/versioned_docs/version-v6/api/loading.md b/versioned_docs/version-v6/api/loading.md index 2c61ce88c14..c9bd57dd163 100644 --- a/versioned_docs/version-v6/api/loading.md +++ b/versioned_docs/version-v6/api/loading.md @@ -5,12 +5,12 @@ title: 'ion-loading' import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -import Props from '@ionic-internal/component-api/v6/loading/props.md'; -import Events from '@ionic-internal/component-api/v6/loading/events.md'; -import Methods from '@ionic-internal/component-api/v6/loading/methods.md'; -import Parts from '@ionic-internal/component-api/v6/loading/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/loading/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/loading/slots.md'; +import Props from '@site/static/auto-generated/loading/props.md'; +import Events from '@site/static/auto-generated/loading/events.md'; +import Methods from '@site/static/auto-generated/loading/methods.md'; +import Parts from '@site/static/auto-generated/loading/parts.md'; +import CustomProps from '@site/static/auto-generated/loading/custom-props.md'; +import Slots from '@site/static/auto-generated/loading/slots.md'; Loading | Application Loading Indicator Overlay | ion-loading diff --git a/versioned_docs/version-v6/api/menu-button.md b/versioned_docs/version-v6/api/menu-button.md index 180f59dab48..adba980b958 100644 --- a/versioned_docs/version-v6/api/menu-button.md +++ b/versioned_docs/version-v6/api/menu-button.md @@ -1,50 +1,42 @@ --- -title: 'ion-menu-button' +title: "ion-menu-button" --- - -import Props from '@ionic-internal/component-api/v6/menu-button/props.md'; -import Events from '@ionic-internal/component-api/v6/menu-button/events.md'; -import Methods from '@ionic-internal/component-api/v6/menu-button/methods.md'; -import Parts from '@ionic-internal/component-api/v6/menu-button/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/menu-button/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/menu-button/slots.md'; +import Props from '@site/static/auto-generated/menu-button/props.md'; +import Events from '@site/static/auto-generated/menu-button/events.md'; +import Methods from '@site/static/auto-generated/menu-button/methods.md'; +import Parts from '@site/static/auto-generated/menu-button/parts.md'; +import CustomProps from '@site/static/auto-generated/menu-button/custom-props.md'; +import Slots from '@site/static/auto-generated/menu-button/slots.md'; Menu Button | ion-menu-button to Open an App Menu on A Page - + import EncapsulationPill from '@components/page/api/EncapsulationPill'; + The Menu Button component contains an icon and automatically adds functionality to open a menu when clicked. See the [menu](./menu) documentation for more information. -## Properties +## Properties ## Events - ## Methods - ## CSS Shadow Parts - ## CSS Custom Properties - ## Slots - diff --git a/versioned_docs/version-v6/api/menu-toggle.md b/versioned_docs/version-v6/api/menu-toggle.md index a68507aa4f4..e6a10201362 100644 --- a/versioned_docs/version-v6/api/menu-toggle.md +++ b/versioned_docs/version-v6/api/menu-toggle.md @@ -1,52 +1,44 @@ --- -title: 'ion-menu-toggle' +title: "ion-menu-toggle" --- - -import Props from '@ionic-internal/component-api/v6/menu-toggle/props.md'; -import Events from '@ionic-internal/component-api/v6/menu-toggle/events.md'; -import Methods from '@ionic-internal/component-api/v6/menu-toggle/methods.md'; -import Parts from '@ionic-internal/component-api/v6/menu-toggle/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/menu-toggle/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/menu-toggle/slots.md'; +import Props from '@site/static/auto-generated/menu-toggle/props.md'; +import Events from '@site/static/auto-generated/menu-toggle/events.md'; +import Methods from '@site/static/auto-generated/menu-toggle/methods.md'; +import Parts from '@site/static/auto-generated/menu-toggle/parts.md'; +import CustomProps from '@site/static/auto-generated/menu-toggle/custom-props.md'; +import Slots from '@site/static/auto-generated/menu-toggle/slots.md'; ion-menu-toggle | MenuToggle Component to Open/Close Active Menus - + import EncapsulationPill from '@components/page/api/EncapsulationPill'; + The Menu Toggle component can be used to toggle a menu open or closed. Menu toggles are only visible when the selected menu is enabled. If the menu is disabled or it's being presented as a split pane, the menu toggle will be hidden. To always display the menu toggle, the `autoHide` property can be set to `false`. See the [menu](./menu#menu-toggle) documentation for more information. -## Properties +## Properties ## Events - ## Methods - ## CSS Shadow Parts - ## CSS Custom Properties - ## Slots - diff --git a/versioned_docs/version-v6/api/menu.md b/versioned_docs/version-v6/api/menu.md index e6ba58d6e82..323f90dd18b 100644 --- a/versioned_docs/version-v6/api/menu.md +++ b/versioned_docs/version-v6/api/menu.md @@ -2,12 +2,12 @@ title: 'ion-menu' --- -import Props from '@ionic-internal/component-api/v6/menu/props.md'; -import Events from '@ionic-internal/component-api/v6/menu/events.md'; -import Methods from '@ionic-internal/component-api/v6/menu/methods.md'; -import Parts from '@ionic-internal/component-api/v6/menu/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/menu/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/menu/slots.md'; +import Props from '@site/static/auto-generated/menu/props.md'; +import Events from '@site/static/auto-generated/menu/events.md'; +import Methods from '@site/static/auto-generated/menu/methods.md'; +import Parts from '@site/static/auto-generated/menu/parts.md'; +import CustomProps from '@site/static/auto-generated/menu/custom-props.md'; +import Slots from '@site/static/auto-generated/menu/slots.md'; ion-menu: API Framework Docs for Types of Menu Components diff --git a/versioned_docs/version-v6/api/modal.md b/versioned_docs/version-v6/api/modal.md index 0ad556d9173..68d44332e4e 100644 --- a/versioned_docs/version-v6/api/modal.md +++ b/versioned_docs/version-v6/api/modal.md @@ -2,12 +2,12 @@ title: 'ion-modal' --- -import Props from '@ionic-internal/component-api/v6/modal/props.md'; -import Events from '@ionic-internal/component-api/v6/modal/events.md'; -import Methods from '@ionic-internal/component-api/v6/modal/methods.md'; -import Parts from '@ionic-internal/component-api/v6/modal/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/modal/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/modal/slots.md'; +import Props from '@site/static/auto-generated/modal/props.md'; +import Events from '@site/static/auto-generated/modal/events.md'; +import Methods from '@site/static/auto-generated/modal/methods.md'; +import Parts from '@site/static/auto-generated/modal/parts.md'; +import CustomProps from '@site/static/auto-generated/modal/custom-props.md'; +import Slots from '@site/static/auto-generated/modal/slots.md'; ion-modal: Ionic Mobile App Custom Modal API Component diff --git a/versioned_docs/version-v6/api/nav-link.md b/versioned_docs/version-v6/api/nav-link.md index 8d5857465dc..30a8f3264ed 100644 --- a/versioned_docs/version-v6/api/nav-link.md +++ b/versioned_docs/version-v6/api/nav-link.md @@ -1,50 +1,42 @@ --- -title: 'ion-nav-link' +title: "ion-nav-link" --- - -import Props from '@ionic-internal/component-api/v6/nav-link/props.md'; -import Events from '@ionic-internal/component-api/v6/nav-link/events.md'; -import Methods from '@ionic-internal/component-api/v6/nav-link/methods.md'; -import Parts from '@ionic-internal/component-api/v6/nav-link/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/nav-link/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/nav-link/slots.md'; +import Props from '@site/static/auto-generated/nav-link/props.md'; +import Events from '@site/static/auto-generated/nav-link/events.md'; +import Methods from '@site/static/auto-generated/nav-link/methods.md'; +import Parts from '@site/static/auto-generated/nav-link/parts.md'; +import CustomProps from '@site/static/auto-generated/nav-link/custom-props.md'; +import Slots from '@site/static/auto-generated/nav-link/slots.md'; ion-nav-link: The Element for Navigation to a Specified Component - + import EncapsulationPill from '@components/page/api/EncapsulationPill'; + 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. It is the element form of calling the `push()`, `pop()`, and `setRoot()` methods on the navigation controller. See the [nav](./nav#using-navlink) documentation for more information. -## Properties +## Properties ## Events - ## Methods - ## CSS Shadow Parts - ## CSS Custom Properties - ## Slots - diff --git a/versioned_docs/version-v6/api/nav.md b/versioned_docs/version-v6/api/nav.md index 330f38561c4..0e4262885d2 100644 --- a/versioned_docs/version-v6/api/nav.md +++ b/versioned_docs/version-v6/api/nav.md @@ -2,12 +2,12 @@ title: 'ion-nav' --- -import Props from '@ionic-internal/component-api/v6/nav/props.md'; -import Events from '@ionic-internal/component-api/v6/nav/events.md'; -import Methods from '@ionic-internal/component-api/v6/nav/methods.md'; -import Parts from '@ionic-internal/component-api/v6/nav/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/nav/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/nav/slots.md'; +import Props from '@site/static/auto-generated/nav/props.md'; +import Events from '@site/static/auto-generated/nav/events.md'; +import Methods from '@site/static/auto-generated/nav/methods.md'; +import Parts from '@site/static/auto-generated/nav/parts.md'; +import CustomProps from '@site/static/auto-generated/nav/custom-props.md'; +import Slots from '@site/static/auto-generated/nav/slots.md'; ion-nav | Nav View Component for Ionic Framework Apps diff --git a/versioned_docs/version-v6/api/note.md b/versioned_docs/version-v6/api/note.md index fd8cbc92fdf..f512aaf7753 100644 --- a/versioned_docs/version-v6/api/note.md +++ b/versioned_docs/version-v6/api/note.md @@ -2,12 +2,12 @@ title: 'ion-note' --- -import Props from '@ionic-internal/component-api/v6/note/props.md'; -import Events from '@ionic-internal/component-api/v6/note/events.md'; -import Methods from '@ionic-internal/component-api/v6/note/methods.md'; -import Parts from '@ionic-internal/component-api/v6/note/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/note/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/note/slots.md'; +import Props from '@site/static/auto-generated/note/props.md'; +import Events from '@site/static/auto-generated/note/events.md'; +import Methods from '@site/static/auto-generated/note/methods.md'; +import Parts from '@site/static/auto-generated/note/parts.md'; +import CustomProps from '@site/static/auto-generated/note/custom-props.md'; +import Slots from '@site/static/auto-generated/note/slots.md'; ion-note: Note Text Elements for iOS and Android Ionic Apps diff --git a/versioned_docs/version-v6/api/picker.md b/versioned_docs/version-v6/api/picker.md index 1c3ab46eab4..8eec3438db2 100644 --- a/versioned_docs/version-v6/api/picker.md +++ b/versioned_docs/version-v6/api/picker.md @@ -1,13 +1,12 @@ --- title: 'ion-picker' --- - -import Props from '@ionic-internal/component-api/v6/picker/props.md'; -import Events from '@ionic-internal/component-api/v6/picker/events.md'; -import Methods from '@ionic-internal/component-api/v6/picker/methods.md'; -import Parts from '@ionic-internal/component-api/v6/picker/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/picker/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/picker/slots.md'; +import Props from '@site/static/auto-generated/picker/props.md'; +import Events from '@site/static/auto-generated/picker/events.md'; +import Methods from '@site/static/auto-generated/picker/methods.md'; +import Parts from '@site/static/auto-generated/picker/parts.md'; +import CustomProps from '@site/static/auto-generated/picker/custom-props.md'; +import Slots from '@site/static/auto-generated/picker/slots.md'; Picker | Display Buttons and Columns for ion-picker on Ionic Apps diff --git a/versioned_docs/version-v6/api/popover.md b/versioned_docs/version-v6/api/popover.md index 041db143901..a65065904f5 100644 --- a/versioned_docs/version-v6/api/popover.md +++ b/versioned_docs/version-v6/api/popover.md @@ -2,12 +2,12 @@ title: 'ion-popover' --- -import Props from '@ionic-internal/component-api/v6/popover/props.md'; -import Events from '@ionic-internal/component-api/v6/popover/events.md'; -import Methods from '@ionic-internal/component-api/v6/popover/methods.md'; -import Parts from '@ionic-internal/component-api/v6/popover/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/popover/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/popover/slots.md'; +import Props from '@site/static/auto-generated/popover/props.md'; +import Events from '@site/static/auto-generated/popover/events.md'; +import Methods from '@site/static/auto-generated/popover/methods.md'; +import Parts from '@site/static/auto-generated/popover/parts.md'; +import CustomProps from '@site/static/auto-generated/popover/custom-props.md'; +import Slots from '@site/static/auto-generated/popover/slots.md'; ion-popover: iOS / Android Popover UI Component & CSS Properties diff --git a/versioned_docs/version-v6/api/progress-bar.md b/versioned_docs/version-v6/api/progress-bar.md index e5f75f384ef..f28e826e60d 100644 --- a/versioned_docs/version-v6/api/progress-bar.md +++ b/versioned_docs/version-v6/api/progress-bar.md @@ -2,12 +2,12 @@ title: 'ion-progress-bar' --- -import Props from '@ionic-internal/component-api/v6/progress-bar/props.md'; -import Events from '@ionic-internal/component-api/v6/progress-bar/events.md'; -import Methods from '@ionic-internal/component-api/v6/progress-bar/methods.md'; -import Parts from '@ionic-internal/component-api/v6/progress-bar/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/progress-bar/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/progress-bar/slots.md'; +import Props from '@site/static/auto-generated/progress-bar/props.md'; +import Events from '@site/static/auto-generated/progress-bar/events.md'; +import Methods from '@site/static/auto-generated/progress-bar/methods.md'; +import Parts from '@site/static/auto-generated/progress-bar/parts.md'; +import CustomProps from '@site/static/auto-generated/progress-bar/custom-props.md'; +import Slots from '@site/static/auto-generated/progress-bar/slots.md'; Progress Bar | Horizontal App Progress Bar for Loading Indicator diff --git a/versioned_docs/version-v6/api/radio-group.md b/versioned_docs/version-v6/api/radio-group.md index dcfb8138e77..b083ee208b2 100644 --- a/versioned_docs/version-v6/api/radio-group.md +++ b/versioned_docs/version-v6/api/radio-group.md @@ -1,26 +1,24 @@ --- -title: 'ion-radio-group' +title: "ion-radio-group" --- - -import Props from '@ionic-internal/component-api/v6/radio-group/props.md'; -import Events from '@ionic-internal/component-api/v6/radio-group/events.md'; -import Methods from '@ionic-internal/component-api/v6/radio-group/methods.md'; -import Parts from '@ionic-internal/component-api/v6/radio-group/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/radio-group/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/radio-group/slots.md'; +import Props from '@site/static/auto-generated/radio-group/props.md'; +import Events from '@site/static/auto-generated/radio-group/events.md'; +import Methods from '@site/static/auto-generated/radio-group/methods.md'; +import Parts from '@site/static/auto-generated/radio-group/parts.md'; +import CustomProps from '@site/static/auto-generated/radio-group/custom-props.md'; +import Slots from '@site/static/auto-generated/radio-group/slots.md'; ion-radio-group | Radio Button Group Usage for Ionic Apps - + import EncapsulationPill from '@components/page/api/EncapsulationPill'; + A radio group is a container for a group of [radios](./radio). It allows a user to select at most one radio button from a set. Checking one radio button that belongs to a radio group unchecks any previous checked radio button within the same group. For example usage of the radio group, see the [radio](./radio) documentation. + ## Interfaces ### RadioGroupChangeEventDetail @@ -42,26 +40,21 @@ interface RadioGroupCustomEvent extends CustomEvent { } ``` -## Properties +## Properties ## Events - ## Methods - ## CSS Shadow Parts - ## CSS Custom Properties - ## Slots - diff --git a/versioned_docs/version-v6/api/radio.md b/versioned_docs/version-v6/api/radio.md index ab82907bea1..a841a557642 100644 --- a/versioned_docs/version-v6/api/radio.md +++ b/versioned_docs/version-v6/api/radio.md @@ -2,12 +2,12 @@ title: 'ion-radio' --- -import Props from '@ionic-internal/component-api/v6/radio/props.md'; -import Events from '@ionic-internal/component-api/v6/radio/events.md'; -import Methods from '@ionic-internal/component-api/v6/radio/methods.md'; -import Parts from '@ionic-internal/component-api/v6/radio/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/radio/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/radio/slots.md'; +import Props from '@site/static/auto-generated/radio/props.md'; +import Events from '@site/static/auto-generated/radio/events.md'; +import Methods from '@site/static/auto-generated/radio/methods.md'; +import Parts from '@site/static/auto-generated/radio/parts.md'; +import CustomProps from '@site/static/auto-generated/radio/custom-props.md'; +import Slots from '@site/static/auto-generated/radio/slots.md'; ion-radio Component: Radio Property for iOS and Android diff --git a/versioned_docs/version-v6/api/range.md b/versioned_docs/version-v6/api/range.md index 75a7c4af8fa..98492b83314 100644 --- a/versioned_docs/version-v6/api/range.md +++ b/versioned_docs/version-v6/api/range.md @@ -2,12 +2,12 @@ title: 'ion-range' --- -import Props from '@ionic-internal/component-api/v6/range/props.md'; -import Events from '@ionic-internal/component-api/v6/range/events.md'; -import Methods from '@ionic-internal/component-api/v6/range/methods.md'; -import Parts from '@ionic-internal/component-api/v6/range/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/range/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/range/slots.md'; +import Props from '@site/static/auto-generated/range/props.md'; +import Events from '@site/static/auto-generated/range/events.md'; +import Methods from '@site/static/auto-generated/range/methods.md'; +import Parts from '@site/static/auto-generated/range/parts.md'; +import CustomProps from '@site/static/auto-generated/range/custom-props.md'; +import Slots from '@site/static/auto-generated/range/slots.md'; Range Slider | ion-range: Slider Knob Controls with Labels diff --git a/versioned_docs/version-v6/api/refresher-content.md b/versioned_docs/version-v6/api/refresher-content.md index c0091c89d0f..1b80d4ef40c 100644 --- a/versioned_docs/version-v6/api/refresher-content.md +++ b/versioned_docs/version-v6/api/refresher-content.md @@ -1,40 +1,35 @@ --- -title: 'ion-refresher-content' +title: "ion-refresher-content" --- - -import Props from '@ionic-internal/component-api/v6/refresher-content/props.md'; -import Events from '@ionic-internal/component-api/v6/refresher-content/events.md'; -import Methods from '@ionic-internal/component-api/v6/refresher-content/methods.md'; -import Parts from '@ionic-internal/component-api/v6/refresher-content/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/refresher-content/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/refresher-content/slots.md'; +import Props from '@site/static/auto-generated/refresher-content/props.md'; +import Events from '@site/static/auto-generated/refresher-content/events.md'; +import Methods from '@site/static/auto-generated/refresher-content/methods.md'; +import Parts from '@site/static/auto-generated/refresher-content/parts.md'; +import CustomProps from '@site/static/auto-generated/refresher-content/custom-props.md'; +import Slots from '@site/static/auto-generated/refresher-content/slots.md'; import EncapsulationPill from '@components/page/api/EncapsulationPill'; + The refresher content contains the text, icon and spinner to display during a pull-to-refresh. Ionic displays a 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. For usage examples, see the [Refresher](/docs/api/refresher) documentation. -## Properties +## Properties ## Events - ## Methods - ## CSS Shadow Parts - ## CSS Custom Properties - ## Slots - diff --git a/versioned_docs/version-v6/api/refresher.md b/versioned_docs/version-v6/api/refresher.md index 31914ee2e7d..1f69dd3d268 100644 --- a/versioned_docs/version-v6/api/refresher.md +++ b/versioned_docs/version-v6/api/refresher.md @@ -2,12 +2,12 @@ title: 'ion-refresher' --- -import Props from '@ionic-internal/component-api/v6/refresher/props.md'; -import Events from '@ionic-internal/component-api/v6/refresher/events.md'; -import Methods from '@ionic-internal/component-api/v6/refresher/methods.md'; -import Parts from '@ionic-internal/component-api/v6/refresher/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/refresher/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/refresher/slots.md'; +import Props from '@site/static/auto-generated/refresher/props.md'; +import Events from '@site/static/auto-generated/refresher/events.md'; +import Methods from '@site/static/auto-generated/refresher/methods.md'; +import Parts from '@site/static/auto-generated/refresher/parts.md'; +import CustomProps from '@site/static/auto-generated/refresher/custom-props.md'; +import Slots from '@site/static/auto-generated/refresher/slots.md'; ion-refresher: Pull-to-Refresh Page Content on Ionic Apps diff --git a/versioned_docs/version-v6/api/reorder-group.md b/versioned_docs/version-v6/api/reorder-group.md index 2c8615cee46..674bc2561b9 100644 --- a/versioned_docs/version-v6/api/reorder-group.md +++ b/versioned_docs/version-v6/api/reorder-group.md @@ -1,28 +1,26 @@ --- -title: 'ion-reorder-group' +title: "ion-reorder-group" --- - -import Props from '@ionic-internal/component-api/v6/reorder-group/props.md'; -import Events from '@ionic-internal/component-api/v6/reorder-group/events.md'; -import Methods from '@ionic-internal/component-api/v6/reorder-group/methods.md'; -import Parts from '@ionic-internal/component-api/v6/reorder-group/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/reorder-group/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/reorder-group/slots.md'; +import Props from '@site/static/auto-generated/reorder-group/props.md'; +import Events from '@site/static/auto-generated/reorder-group/events.md'; +import Methods from '@site/static/auto-generated/reorder-group/methods.md'; +import Parts from '@site/static/auto-generated/reorder-group/parts.md'; +import CustomProps from '@site/static/auto-generated/reorder-group/custom-props.md'; +import Slots from '@site/static/auto-generated/reorder-group/slots.md'; ion-reorder-group: Wrapper Component for Ionic Framework Apps - + import EncapsulationPill from '@components/page/api/EncapsulationPill'; + The reorder group is a container for items using the [reorder](./reorder) component. When the user drags an item and drops it in a new position, the `ionItemReorder` event is dispatched. A handler for this event should be implemented that calls the `complete` method. The `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. For example usage of the reorder group, see the [reorder](./reorder) documentation. + ## Interfaces ### ItemReorderEventDetail @@ -46,26 +44,21 @@ interface ItemReorderCustomEvent extends CustomEvent { } ``` -## Properties +## Properties ## Events - ## Methods - ## CSS Shadow Parts - ## CSS Custom Properties - ## Slots - diff --git a/versioned_docs/version-v6/api/reorder.md b/versioned_docs/version-v6/api/reorder.md index 38301d71bbe..e7d57830079 100644 --- a/versioned_docs/version-v6/api/reorder.md +++ b/versioned_docs/version-v6/api/reorder.md @@ -2,12 +2,12 @@ title: 'ion-reorder' --- -import Props from '@ionic-internal/component-api/v6/reorder/props.md'; -import Events from '@ionic-internal/component-api/v6/reorder/events.md'; -import Methods from '@ionic-internal/component-api/v6/reorder/methods.md'; -import Parts from '@ionic-internal/component-api/v6/reorder/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/reorder/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/reorder/slots.md'; +import Props from '@site/static/auto-generated/reorder/props.md'; +import Events from '@site/static/auto-generated/reorder/events.md'; +import Methods from '@site/static/auto-generated/reorder/methods.md'; +import Parts from '@site/static/auto-generated/reorder/parts.md'; +import CustomProps from '@site/static/auto-generated/reorder/custom-props.md'; +import Slots from '@site/static/auto-generated/reorder/slots.md'; Reorder | ion-reorder: Drag and Drop Icon to Reorder Items diff --git a/versioned_docs/version-v6/api/ripple-effect.md b/versioned_docs/version-v6/api/ripple-effect.md index e2def63ac03..83f5e0b8486 100644 --- a/versioned_docs/version-v6/api/ripple-effect.md +++ b/versioned_docs/version-v6/api/ripple-effect.md @@ -2,12 +2,12 @@ title: 'ion-ripple-effect' --- -import Props from '@ionic-internal/component-api/v6/ripple-effect/props.md'; -import Events from '@ionic-internal/component-api/v6/ripple-effect/events.md'; -import Methods from '@ionic-internal/component-api/v6/ripple-effect/methods.md'; -import Parts from '@ionic-internal/component-api/v6/ripple-effect/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/ripple-effect/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/ripple-effect/slots.md'; +import Props from '@site/static/auto-generated/ripple-effect/props.md'; +import Events from '@site/static/auto-generated/ripple-effect/events.md'; +import Methods from '@site/static/auto-generated/ripple-effect/methods.md'; +import Parts from '@site/static/auto-generated/ripple-effect/parts.md'; +import CustomProps from '@site/static/auto-generated/ripple-effect/custom-props.md'; +import Slots from '@site/static/auto-generated/ripple-effect/slots.md'; import EncapsulationPill from '@components/page/api/EncapsulationPill'; diff --git a/versioned_docs/version-v6/api/route-redirect.md b/versioned_docs/version-v6/api/route-redirect.md index a2ace00dbea..ac4febd161d 100644 --- a/versioned_docs/version-v6/api/route-redirect.md +++ b/versioned_docs/version-v6/api/route-redirect.md @@ -1,37 +1,36 @@ --- -title: 'ion-route-redirect' +title: "ion-route-redirect" --- -import Props from '@ionic-internal/component-api/v6/route-redirect/props.md'; -import Events from '@ionic-internal/component-api/v6/route-redirect/events.md'; -import Methods from '@ionic-internal/component-api/v6/route-redirect/methods.md'; -import Parts from '@ionic-internal/component-api/v6/route-redirect/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/route-redirect/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/route-redirect/slots.md'; +import Props from '@site/static/auto-generated/route-redirect/props.md'; +import Events from '@site/static/auto-generated/route-redirect/events.md'; +import Methods from '@site/static/auto-generated/route-redirect/methods.md'; +import Parts from '@site/static/auto-generated/route-redirect/parts.md'; +import CustomProps from '@site/static/auto-generated/route-redirect/custom-props.md'; +import Slots from '@site/static/auto-generated/route-redirect/slots.md'; ion-route-redirect Plugin: Redirect 'from' a URL 'to' Another URL - + import EncapsulationPill from '@components/page/api/EncapsulationPill'; + A route redirect can only be used with an `ion-router` as a direct child of it. :::note -Note: this component should only be used with vanilla and Stencil JavaScript projects. For Angular projects, use [`ion-router-outlet`](router-outlet.md) and the Angular router. + Note: this component should only be used with vanilla and Stencil JavaScript projects. For Angular projects, use [`ion-router-outlet`](router-outlet.md) and the Angular router. ::: -The route redirect has two configurable properties: -- `from` -- `to` +The route redirect has two configurable properties: + - `from` + - `to` It 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. + ## Multiple Route Redirects An arbitrary number of redirect routes can be defined inside an `ion-router`, but only one can match. @@ -49,6 +48,9 @@ Take the following two redirects: If the user navigates to `/admin` the router will redirect to `/login` and stop there. It will never evaluate more than one redirect. + + + ## Usage ```html @@ -94,25 +96,19 @@ routeRedirect.setAttribute('to', isLoggedIn ? undefined : '/login'); ``` ## Properties - ## Events - ## Methods - ## CSS Shadow Parts - ## CSS Custom Properties - ## Slots - - + \ No newline at end of file diff --git a/versioned_docs/version-v6/api/route.md b/versioned_docs/version-v6/api/route.md index e8be6cb3627..46803354c95 100644 --- a/versioned_docs/version-v6/api/route.md +++ b/versioned_docs/version-v6/api/route.md @@ -1,33 +1,32 @@ --- -title: 'ion-route' +title: "ion-route" --- - import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -import Props from '@ionic-internal/component-api/v6/route/props.md'; -import Events from '@ionic-internal/component-api/v6/route/events.md'; -import Methods from '@ionic-internal/component-api/v6/route/methods.md'; -import Parts from '@ionic-internal/component-api/v6/route/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/route/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/route/slots.md'; +import Props from '@site/static/auto-generated/route/props.md'; +import Events from '@site/static/auto-generated/route/events.md'; +import Methods from '@site/static/auto-generated/route/methods.md'; +import Parts from '@site/static/auto-generated/route/parts.md'; +import CustomProps from '@site/static/auto-generated/route/custom-props.md'; +import Slots from '@site/static/auto-generated/route/slots.md'; ion-route: API Route Component for Ionic Framework Apps - + import EncapsulationPill from '@components/page/api/EncapsulationPill'; + + The route component takes a component and renders it when the Browser URL matches the url property. :::note -Note: this component should only be used with vanilla and Stencil JavaScript projects. For Angular projects, use [`ion-router-outlet`](router-outlet.md) and the Angular router. + Note: this component should only be used with vanilla and Stencil JavaScript projects. For Angular projects, use [`ion-router-outlet`](router-outlet.md) and the Angular router. ::: + ## Navigation Hooks Navigation hooks can be used to perform tasks or act as navigation guards. Hooks are used by providing functions to the `beforeEnter` and `beforeLeave` properties on each `ion-route`. Returning `true` allows navigation to proceed, while returning `false` causes it to be cancelled. Returning an object of type `NavigationHookOptions` allows you to redirect navigation to another page. @@ -43,6 +42,9 @@ interface NavigationHookOptions { } ``` + + + ## Usage @@ -67,23 +69,23 @@ newMessagePage.beforeLeave = hasUnsavedDataGuard; const isLoggedInGuard = async () => { const isLoggedIn = await UserData.isLoggedIn(); // Replace this with actual login validation - + if (isLoggedIn) { return true; } else { return { redirect: '/login' }; // If a user is not logged in, they will be redirected to the /login page } -}; +} const hasUnsavedDataGuard = async () => { const hasUnsavedData = await checkData(); // Replace this with actual validation - + if (hasUnsavedData) { return await confirmDiscardChanges(); } else { return true; } -}; +} const confirmDiscardChanges = async () => { const alert = document.createElement('ion-alert'); @@ -97,21 +99,23 @@ const confirmDiscardChanges = async () => { { text: 'Discard', role: 'destructive', - }, + } ]; - + document.body.appendChild(alert); - + await alert.present(); - + const { role } = await alert.onDidDismiss(); - - return role === 'Cancel' ? false : true; -}; + + return (role === 'Cancel') ? false : true; +} ``` + + ```typescript @@ -120,7 +124,7 @@ import { alertController } from '@ionic/core'; @Component({ tag: 'router-example', - styleUrl: 'router-example.css', + styleUrl: 'router-example.css' }) export class RouterExample { render() { @@ -131,29 +135,29 @@ export class RouterExample { - ); + ) } } const isLoggedInGuard = async () => { const isLoggedIn = await UserData.isLoggedIn(); // Replace this with actual login validation - + if (isLoggedIn) { return true; } else { return { redirect: '/login' }; // If a user is not logged in, they will be redirected to the /login page } -}; +} const hasUnsavedDataGuard = async () => { const hasUnsavedData = await checkData(); // Replace this with actual validation - + if (hasUnsavedData) { return await confirmDiscardChanges(); } else { return true; } -}; +} const confirmDiscardChanges = async () => { const alert = await alertController.create({ @@ -167,20 +171,22 @@ const confirmDiscardChanges = async () => { { text: 'Discard', role: 'destructive', - }, - ], + } + ] }); - + await alert.present(); - + const { role } = await alert.onDidDismiss(); - - return role === 'Cancel' ? false : true; -}; + + return (role === 'Cancel') ? false : true; +} ``` + + ```html @@ -198,24 +204,24 @@ const confirmDiscardChanges = async () => { const isLoggedInGuard = async () => { const isLoggedIn = await UserData.isLoggedIn(); // Replace this with actual login validation - + if (isLoggedIn) { return true; } else { return { redirect: '/login' }; // If a user is not logged in, they will be redirected to the /login page } - }; - + } + const hasUnsavedDataGuard = async () => { const hasUnsavedData = await checkData(); // Replace this with actual validation - + if (hasUnsavedData) { return await confirmDiscardChanges(); } else { return true; } - }; - + } + const confirmDiscardChanges = async () => { const alert = await alertController.create({ header: 'Discard Unsaved Changes?', @@ -228,16 +234,16 @@ const confirmDiscardChanges = async () => { { text: 'Discard', role: 'destructive', - }, - ], + } + ] }); - + await alert.present(); - + const { role } = await alert.onDidDismiss(); - - return role === 'Cancel' ? false : true; - }; + + return (role === 'Cancel') ? false : true; + } ``` @@ -246,25 +252,19 @@ const confirmDiscardChanges = async () => { ## Properties - ## Events - ## Methods - ## CSS Shadow Parts - ## CSS Custom Properties - ## Slots - - + \ No newline at end of file diff --git a/versioned_docs/version-v6/api/router-link.md b/versioned_docs/version-v6/api/router-link.md index bcccd576c42..dd87a4c9354 100644 --- a/versioned_docs/version-v6/api/router-link.md +++ b/versioned_docs/version-v6/api/router-link.md @@ -1,61 +1,59 @@ --- -title: 'ion-router-link' +title: "ion-router-link" hide_table_of_contents: true -demoUrl: '/docs/demos/api/router-link/index.html' -demoSourceUrl: 'https://github.com/ionic-team/ionic-docs/tree/main/static/demos/api/router-link/index.html' +demoUrl: "/docs/demos/api/router-link/index.html" +demoSourceUrl: "https://github.com/ionic-team/ionic-docs/tree/main/static/demos/api/router-link/index.html" --- - import TOCInline from '@theme/TOCInline'; -import Props from '@ionic-internal/component-api/v6/router-link/props.md'; -import Events from '@ionic-internal/component-api/v6/router-link/events.md'; -import Methods from '@ionic-internal/component-api/v6/router-link/methods.md'; -import Parts from '@ionic-internal/component-api/v6/router-link/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/router-link/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/router-link/slots.md'; +import Props from '@site/static/auto-generated/router-link/props.md'; +import Events from '@site/static/auto-generated/router-link/events.md'; +import Methods from '@site/static/auto-generated/router-link/methods.md'; +import Parts from '@site/static/auto-generated/router-link/parts.md'; +import CustomProps from '@site/static/auto-generated/router-link/custom-props.md'; +import Slots from '@site/static/auto-generated/router-link/slots.md'; Router Link | Navigating The ion-router-link Component - + import EncapsulationPill from '@components/page/api/EncapsulationPill'; - +

Contents

- + + + 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. :::note -Note: this component should only be used with vanilla and Stencil JavaScript projects. For Angular projects, use an `` and `routerLink` with the Angular router. + Note: this component should only be used with vanilla and Stencil JavaScript projects. For Angular projects, use an `` and `routerLink` with the Angular router. ::: -## Properties + + +## Properties ## Events - ## Methods - ## CSS Shadow Parts - ## CSS Custom Properties - ## Slots - - + \ No newline at end of file diff --git a/versioned_docs/version-v6/api/router-outlet.md b/versioned_docs/version-v6/api/router-outlet.md index 882aaaa1b29..c15289ab77b 100644 --- a/versioned_docs/version-v6/api/router-outlet.md +++ b/versioned_docs/version-v6/api/router-outlet.md @@ -1,18 +1,21 @@ --- -title: 'ion-router-outlet' +title: "ion-router-outlet" --- -import Props from '@ionic-internal/component-api/v6/router-outlet/props.md'; -import Events from '@ionic-internal/component-api/v6/router-outlet/events.md'; -import Methods from '@ionic-internal/component-api/v6/router-outlet/methods.md'; -import Parts from '@ionic-internal/component-api/v6/router-outlet/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/router-outlet/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/router-outlet/slots.md'; +import Props from '@site/static/auto-generated/router-outlet/props.md'; +import Events from '@site/static/auto-generated/router-outlet/events.md'; +import Methods from '@site/static/auto-generated/router-outlet/methods.md'; +import Parts from '@site/static/auto-generated/router-outlet/parts.md'; +import CustomProps from '@site/static/auto-generated/router-outlet/custom-props.md'; +import Slots from '@site/static/auto-generated/router-outlet/slots.md'; + + import EncapsulationPill from '@components/page/api/EncapsulationPill'; + The router outlet 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. Although router outlet has methods for navigating around, it's recommended to use the navigation methods in your framework's router. @@ -21,37 +24,36 @@ Although router outlet has methods for navigating around, it's recommended to us Routes rendered in a Router Outlet have access to specific Ionic events that are wired up to animations + | Event Name | Trigger | -| ------------------ | ------------------------------------------------------------------ | +|--------------------|--------------------------------------------------------------------| | `ionViewWillEnter` | Fired when the component routing to is about to animate into view. | | `ionViewDidEnter` | Fired when the component routing to has finished animating. | | `ionViewWillLeave` | Fired when the component routing from is about to animate. | | `ionViewDidLeave` | Fired when the component routing to has finished animating. | + These event tie into Ionic's animation system and can be used to coordinate parts of your app when a Components is done with its animation. These events are not a replacement for your framework's own event system, but an addition. For handling Router Guards, the older `ionViewCanEnter` and `ionViewCanLeave` have been replaced with their framework specific equivalent. For Angular, there are [Router Guards](https://angular.io/guide/router#milestone-5-route-guards). -## Properties + + +## Properties ## Events - ## Methods - ## CSS Shadow Parts - ## CSS Custom Properties - ## Slots - - + \ No newline at end of file diff --git a/versioned_docs/version-v6/api/router.md b/versioned_docs/version-v6/api/router.md index 32c31f6d4e9..1f70135b7d2 100644 --- a/versioned_docs/version-v6/api/router.md +++ b/versioned_docs/version-v6/api/router.md @@ -1,30 +1,29 @@ --- -title: 'ion-router' +title: "ion-router" --- -import Props from '@ionic-internal/component-api/v6/router/props.md'; -import Events from '@ionic-internal/component-api/v6/router/events.md'; -import Methods from '@ionic-internal/component-api/v6/router/methods.md'; -import Parts from '@ionic-internal/component-api/v6/router/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/router/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/router/slots.md'; +import Props from '@site/static/auto-generated/router/props.md'; +import Events from '@site/static/auto-generated/router/events.md'; +import Methods from '@site/static/auto-generated/router/methods.md'; +import Parts from '@site/static/auto-generated/router/parts.md'; +import CustomProps from '@site/static/auto-generated/router/custom-props.md'; +import Slots from '@site/static/auto-generated/router/slots.md'; ion-router: Router Component to Coordinate URL Navigation - + import EncapsulationPill from '@components/page/api/EncapsulationPill'; + The router is a component for handling routing inside vanilla and Stencil JavaScript projects. :::note -Note: This component should only be used with vanilla and Stencil JavaScript projects. See the routing guides for [Angular](../angular/navigation), [React](../react/navigation), and [Vue](../vue/navigation) for framework-specific routing solutions. + Note: This component should only be used with vanilla and Stencil JavaScript projects. See the routing guides for [Angular](../angular/navigation), [React](../react/navigation), and [Vue](../vue/navigation) for framework-specific routing solutions. ::: + Apps should have a single `ion-router` component in the codebase. This component controls all interactions with the browser history and it aggregates updates through an event system. @@ -63,6 +62,8 @@ interface RouterCustomEvent extends CustomEvent { } ``` + + ## Usage ```html @@ -89,28 +90,24 @@ interface RouterCustomEvent extends CustomEvent { + ``` -## Properties +## Properties ## Events - ## Methods - ## CSS Shadow Parts - ## CSS Custom Properties - ## Slots - - + \ No newline at end of file diff --git a/versioned_docs/version-v6/api/row.md b/versioned_docs/version-v6/api/row.md index 4a01eb80f00..48fc21c4ba0 100644 --- a/versioned_docs/version-v6/api/row.md +++ b/versioned_docs/version-v6/api/row.md @@ -1,20 +1,16 @@ --- -title: 'ion-row' +title: "ion-row" --- - -import Props from '@ionic-internal/component-api/v6/row/props.md'; -import Events from '@ionic-internal/component-api/v6/row/events.md'; -import Methods from '@ionic-internal/component-api/v6/row/methods.md'; -import Parts from '@ionic-internal/component-api/v6/row/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/row/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/row/slots.md'; +import Props from '@site/static/auto-generated/row/props.md'; +import Events from '@site/static/auto-generated/row/events.md'; +import Methods from '@site/static/auto-generated/row/methods.md'; +import Parts from '@site/static/auto-generated/row/parts.md'; +import CustomProps from '@site/static/auto-generated/row/custom-props.md'; +import Slots from '@site/static/auto-generated/row/slots.md'; ion-row: Horizontal Row Components and Alignment | Ionic API Docs - + import EncapsulationPill from '@components/page/api/EncapsulationPill'; @@ -26,30 +22,28 @@ Rows are horizontal components of the [grid](./grid) system and contain varying See the [grid](./grid) documentation for more information. + ## Row Alignment By default, columns will stretch to fill the entire height of the row and wrap when necessary. Rows are [flex containers](https://developer.mozilla.org/en-US/docs/Glossary/Flex_Container), so there are several [CSS classes](/docs/layout/css-utilities#flex-container-properties) that can be applied to a row to customize this behavior. -## Properties + + +## Properties ## Events - ## Methods - ## CSS Shadow Parts - ## CSS Custom Properties - ## Slots - diff --git a/versioned_docs/version-v6/api/searchbar.md b/versioned_docs/version-v6/api/searchbar.md index ce0c62b2a41..5e75b8dc412 100644 --- a/versioned_docs/version-v6/api/searchbar.md +++ b/versioned_docs/version-v6/api/searchbar.md @@ -2,12 +2,12 @@ title: 'ion-searchbar' --- -import Props from '@ionic-internal/component-api/v6/searchbar/props.md'; -import Events from '@ionic-internal/component-api/v6/searchbar/events.md'; -import Methods from '@ionic-internal/component-api/v6/searchbar/methods.md'; -import Parts from '@ionic-internal/component-api/v6/searchbar/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/searchbar/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/searchbar/slots.md'; +import Props from '@site/static/auto-generated/searchbar/props.md'; +import Events from '@site/static/auto-generated/searchbar/events.md'; +import Methods from '@site/static/auto-generated/searchbar/methods.md'; +import Parts from '@site/static/auto-generated/searchbar/parts.md'; +import CustomProps from '@site/static/auto-generated/searchbar/custom-props.md'; +import Slots from '@site/static/auto-generated/searchbar/slots.md'; Search Bar Icon for Keyboard Text Display | Ion-Search Bar diff --git a/versioned_docs/version-v6/api/segment-button.md b/versioned_docs/version-v6/api/segment-button.md index 0e7d688742b..a5a87ccd7d9 100644 --- a/versioned_docs/version-v6/api/segment-button.md +++ b/versioned_docs/version-v6/api/segment-button.md @@ -2,12 +2,12 @@ title: 'ion-segment-button' --- -import Props from '@ionic-internal/component-api/v6/segment-button/props.md'; -import Events from '@ionic-internal/component-api/v6/segment-button/events.md'; -import Methods from '@ionic-internal/component-api/v6/segment-button/methods.md'; -import Parts from '@ionic-internal/component-api/v6/segment-button/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/segment-button/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/segment-button/slots.md'; +import Props from '@site/static/auto-generated/segment-button/props.md'; +import Events from '@site/static/auto-generated/segment-button/events.md'; +import Methods from '@site/static/auto-generated/segment-button/methods.md'; +import Parts from '@site/static/auto-generated/segment-button/parts.md'; +import CustomProps from '@site/static/auto-generated/segment-button/custom-props.md'; +import Slots from '@site/static/auto-generated/segment-button/slots.md'; ion-segment-button | Segment Button Icon and Segment Value diff --git a/versioned_docs/version-v6/api/segment.md b/versioned_docs/version-v6/api/segment.md index 1283792ad65..14f795ac0ed 100644 --- a/versioned_docs/version-v6/api/segment.md +++ b/versioned_docs/version-v6/api/segment.md @@ -2,12 +2,12 @@ title: 'ion-segment' --- -import Props from '@ionic-internal/component-api/v6/segment/props.md'; -import Events from '@ionic-internal/component-api/v6/segment/events.md'; -import Methods from '@ionic-internal/component-api/v6/segment/methods.md'; -import Parts from '@ionic-internal/component-api/v6/segment/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/segment/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/segment/slots.md'; +import Props from '@site/static/auto-generated/segment/props.md'; +import Events from '@site/static/auto-generated/segment/events.md'; +import Methods from '@site/static/auto-generated/segment/methods.md'; +import Parts from '@site/static/auto-generated/segment/parts.md'; +import CustomProps from '@site/static/auto-generated/segment/custom-props.md'; +import Slots from '@site/static/auto-generated/segment/slots.md'; ion-segment: API Documentation for Segmented Controls diff --git a/versioned_docs/version-v6/api/select-option.md b/versioned_docs/version-v6/api/select-option.md index 4d4b3e2c90d..73dbf015e2b 100644 --- a/versioned_docs/version-v6/api/select-option.md +++ b/versioned_docs/version-v6/api/select-option.md @@ -1,50 +1,42 @@ --- -title: 'ion-select-option' +title: "ion-select-option" --- - -import Props from '@ionic-internal/component-api/v6/select-option/props.md'; -import Events from '@ionic-internal/component-api/v6/select-option/events.md'; -import Methods from '@ionic-internal/component-api/v6/select-option/methods.md'; -import Parts from '@ionic-internal/component-api/v6/select-option/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/select-option/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/select-option/slots.md'; +import Props from '@site/static/auto-generated/select-option/props.md'; +import Events from '@site/static/auto-generated/select-option/events.md'; +import Methods from '@site/static/auto-generated/select-option/methods.md'; +import Parts from '@site/static/auto-generated/select-option/parts.md'; +import CustomProps from '@site/static/auto-generated/select-option/custom-props.md'; +import Slots from '@site/static/auto-generated/select-option/slots.md'; Select Option | What Is An Option Select on Ionic Framework Apps - + import EncapsulationPill from '@components/page/api/EncapsulationPill'; + Select Options are components that are child elements of a Select. Each option defined is passed and displayed in the Select dialog. For usage examples, see the [Select](./select) documentation. -## Properties +## Properties ## Events - ## Methods - ## CSS Shadow Parts - ## CSS Custom Properties - ## Slots - - + \ No newline at end of file diff --git a/versioned_docs/version-v6/api/select.md b/versioned_docs/version-v6/api/select.md index 89509c1becc..3682cc13f04 100644 --- a/versioned_docs/version-v6/api/select.md +++ b/versioned_docs/version-v6/api/select.md @@ -2,12 +2,12 @@ title: 'ion-select' --- -import Props from '@ionic-internal/component-api/v6/select/props.md'; -import Events from '@ionic-internal/component-api/v6/select/events.md'; -import Methods from '@ionic-internal/component-api/v6/select/methods.md'; -import Parts from '@ionic-internal/component-api/v6/select/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/select/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/select/slots.md'; +import Props from '@site/static/auto-generated/select/props.md'; +import Events from '@site/static/auto-generated/select/events.md'; +import Methods from '@site/static/auto-generated/select/methods.md'; +import Parts from '@site/static/auto-generated/select/parts.md'; +import CustomProps from '@site/static/auto-generated/select/custom-props.md'; +import Slots from '@site/static/auto-generated/select/slots.md'; ion-select: Select One or Multiple Value Boxes or Placeholders diff --git a/versioned_docs/version-v6/api/skeleton-text.md b/versioned_docs/version-v6/api/skeleton-text.md index f26f3d1f6ac..86ec40d8a6f 100644 --- a/versioned_docs/version-v6/api/skeleton-text.md +++ b/versioned_docs/version-v6/api/skeleton-text.md @@ -2,12 +2,12 @@ title: 'ion-skeleton-text' --- -import Props from '@ionic-internal/component-api/v6/skeleton-text/props.md'; -import Events from '@ionic-internal/component-api/v6/skeleton-text/events.md'; -import Methods from '@ionic-internal/component-api/v6/skeleton-text/methods.md'; -import Parts from '@ionic-internal/component-api/v6/skeleton-text/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/skeleton-text/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/skeleton-text/slots.md'; +import Props from '@site/static/auto-generated/skeleton-text/props.md'; +import Events from '@site/static/auto-generated/skeleton-text/events.md'; +import Methods from '@site/static/auto-generated/skeleton-text/methods.md'; +import Parts from '@site/static/auto-generated/skeleton-text/parts.md'; +import CustomProps from '@site/static/auto-generated/skeleton-text/custom-props.md'; +import Slots from '@site/static/auto-generated/skeleton-text/slots.md'; Skeleton Text | Skeleton Loading Placeholder & Framework for Text diff --git a/versioned_docs/version-v6/api/slide.md b/versioned_docs/version-v6/api/slide.md index 58f5ec52068..6fb9aedacdf 100644 --- a/versioned_docs/version-v6/api/slide.md +++ b/versioned_docs/version-v6/api/slide.md @@ -1,20 +1,17 @@ --- -title: 'ion-slide' +title: "ion-slide" --- -import Props from '@ionic-internal/component-api/v6/slide/props.md'; -import Events from '@ionic-internal/component-api/v6/slide/events.md'; -import Methods from '@ionic-internal/component-api/v6/slide/methods.md'; -import Parts from '@ionic-internal/component-api/v6/slide/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/slide/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/slide/slots.md'; +import Props from '@site/static/auto-generated/slide/props.md'; +import Events from '@site/static/auto-generated/slide/events.md'; +import Methods from '@site/static/auto-generated/slide/methods.md'; +import Parts from '@site/static/auto-generated/slide/parts.md'; +import CustomProps from '@site/static/auto-generated/slide/custom-props.md'; +import Slots from '@site/static/auto-generated/slide/slots.md'; ion-slide | Slide API Component for Ionic Framework Apps - + import EncapsulationPill from '@components/page/api/EncapsulationPill'; @@ -23,32 +20,30 @@ import EncapsulationPill from '@components/page/api/EncapsulationPill'; This component has been deprecated in favor of using Swiper.js directly. Please see the [Slides Documentation](./slides#migration) for a migration guide. ::: + The Slide component is a child component of [Slides](./slides). The template should be written as `ion-slide`. Any slide content should be written in this component and it should be used in conjunction with [Slides](./slides). See the [Slides API Docs](./slides) for more usage information. -## Properties + + +## Properties ## Events - ## Methods - ## CSS Shadow Parts - ## CSS Custom Properties - ## Slots - - + \ No newline at end of file diff --git a/versioned_docs/version-v6/api/slides.md b/versioned_docs/version-v6/api/slides.md index 0c8ee78edc8..6cef08674c6 100644 --- a/versioned_docs/version-v6/api/slides.md +++ b/versioned_docs/version-v6/api/slides.md @@ -1,39 +1,40 @@ --- -title: 'ion-slides' +title: "ion-slides" hide_table_of_contents: true -demoUrl: '/docs/demos/api/slides/index.html' -demoSourceUrl: 'https://github.com/ionic-team/ionic-docs/tree/main/static/demos/api/slides/index.html' +demoUrl: "/docs/demos/api/slides/index.html" +demoSourceUrl: "https://github.com/ionic-team/ionic-docs/tree/main/static/demos/api/slides/index.html" --- - import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; import TOCInline from '@theme/TOCInline'; -import Props from '@ionic-internal/component-api/v6/slides/props.md'; -import Events from '@ionic-internal/component-api/v6/slides/events.md'; -import Methods from '@ionic-internal/component-api/v6/slides/methods.md'; -import Parts from '@ionic-internal/component-api/v6/slides/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/slides/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/slides/slots.md'; +import Props from '@site/static/auto-generated/slides/props.md'; +import Events from '@site/static/auto-generated/slides/events.md'; +import Methods from '@site/static/auto-generated/slides/methods.md'; +import Parts from '@site/static/auto-generated/slides/parts.md'; +import CustomProps from '@site/static/auto-generated/slides/custom-props.md'; +import Slots from '@site/static/auto-generated/slides/slots.md'; Ion-Slides: Mobile Touch Slider with Built-In & Custom Animation - + import EncapsulationPill from '@components/page/api/EncapsulationPill'; +

Contents

- + :::note This component has been deprecated in favor of using Swiper.js directly. Please see the [migration guide](#migration) below. ::: + The Slides component is a multi-section container. Each section can be swiped or dragged between. It contains any number of [Slide](slide.md) components. @@ -84,7 +85,7 @@ Since the underlying technology that powers your slides is the same, the migrati [Migration for Ionic Vue users](../vue/slides) ---- +------ The following documentation applies to the `ion-slides` component. @@ -92,6 +93,7 @@ The following documentation applies to the `ion-slides` component. By default, Ionic slides use the built-in `slide` animation effect. Custom animations can be provided via the `options` property. Examples of other animations can be found below. + ### Coverflow ```typescript @@ -116,11 +118,13 @@ const slideOpts = { }, setTranslate() { const swiper = this; - const { width: swiperWidth, height: swiperHeight, slides, $wrapperEl, slidesSizesGrid, $ } = swiper; + const { + width: swiperWidth, height: swiperHeight, slides, $wrapperEl, slidesSizesGrid, $ + } = swiper; const params = swiper.params.coverflowEffect; const isHorizontal = swiper.isHorizontal(); const transform$$1 = swiper.translate; - const center = isHorizontal ? -transform$$1 + swiperWidth / 2 : -transform$$1 + swiperHeight / 2; + const center = isHorizontal ? -transform$$1 + (swiperWidth / 2) : -transform$$1 + (swiperHeight / 2); const rotate = isHorizontal ? params.rotate : -params.rotate; const translate = params.depth; // Each slide offset from center @@ -128,35 +132,31 @@ const slideOpts = { const $slideEl = slides.eq(i); const slideSize = slidesSizesGrid[i]; const slideOffset = $slideEl[0].swiperSlideOffset; - const offsetMultiplier = ((center - slideOffset - slideSize / 2) / slideSize) * params.modifier; + const offsetMultiplier = ((center - slideOffset - (slideSize / 2)) / slideSize) * params.modifier; - let rotateY = isHorizontal ? rotate * offsetMultiplier : 0; + let rotateY = isHorizontal ? rotate * offsetMultiplier : 0; let rotateX = isHorizontal ? 0 : rotate * offsetMultiplier; // var rotateZ = 0 let translateZ = -translate * Math.abs(offsetMultiplier); - let translateY = isHorizontal ? 0 : params.stretch * offsetMultiplier; - let translateX = isHorizontal ? params.stretch * offsetMultiplier : 0; + let translateY = isHorizontal ? 0 : params.stretch * (offsetMultiplier); + let translateX = isHorizontal ? params.stretch * (offsetMultiplier) : 0; - // Fix for ultra small values + // Fix for ultra small values if (Math.abs(translateX) < 0.001) translateX = 0; if (Math.abs(translateY) < 0.001) translateY = 0; if (Math.abs(translateZ) < 0.001) translateZ = 0; if (Math.abs(rotateY) < 0.001) rotateY = 0; if (Math.abs(rotateX) < 0.001) rotateX = 0; - const slideTransform = `translate3d(${translateX}px,${translateY}px,${translateZ}px) rotateX(${rotateX}deg) rotateY(${rotateY}deg)`; + const slideTransform = `translate3d(${translateX}px,${translateY}px,${translateZ}px) rotateX(${rotateX}deg) rotateY(${rotateY}deg)`; - $slideEl.transform(slideTransform); + $slideEl.transform(slideTransform); $slideEl[0].style.zIndex = -Math.abs(Math.round(offsetMultiplier)) + 1; if (params.slideShadows) { // Set shadows - let $shadowBeforeEl = isHorizontal - ? $slideEl.find('.swiper-slide-shadow-left') - : $slideEl.find('.swiper-slide-shadow-top'); - let $shadowAfterEl = isHorizontal - ? $slideEl.find('.swiper-slide-shadow-right') - : $slideEl.find('.swiper-slide-shadow-bottom'); + let $shadowBeforeEl = isHorizontal ? $slideEl.find('.swiper-slide-shadow-left') : $slideEl.find('.swiper-slide-shadow-top'); + let $shadowAfterEl = isHorizontal ? $slideEl.find('.swiper-slide-shadow-right') : $slideEl.find('.swiper-slide-shadow-bottom'); if ($shadowBeforeEl.length === 0) { $shadowBeforeEl = swiper.$(`
`); $slideEl.append($shadowBeforeEl); @@ -166,11 +166,11 @@ const slideOpts = { $slideEl.append($shadowAfterEl); } if ($shadowBeforeEl.length) $shadowBeforeEl[0].style.opacity = offsetMultiplier > 0 ? offsetMultiplier : 0; - if ($shadowAfterEl.length) $shadowAfterEl[0].style.opacity = -offsetMultiplier > 0 ? -offsetMultiplier : 0; + if ($shadowAfterEl.length) $shadowAfterEl[0].style.opacity = (-offsetMultiplier) > 0 ? -offsetMultiplier : 0; } } - // Set correct perspective for IE10 + // Set correct perspective for IE10 if (swiper.support.pointerEvents || swiper.support.prefixedPointerEvents) { const ws = $wrapperEl[0].style; ws.perspectiveOrigin = `${center}px 50%`; @@ -180,13 +180,11 @@ const slideOpts = { const swiper = this; swiper.slides .transition(duration) - .find( - '.swiper-slide-shadow-top, .swiper-slide-shadow-right, .swiper-slide-shadow-bottom, .swiper-slide-shadow-left' - ) + .find('.swiper-slide-shadow-top, .swiper-slide-shadow-right, .swiper-slide-shadow-bottom, .swiper-slide-shadow-left') .transition(duration); - }, - }, -}; + } + } +} ``` ### Cube @@ -201,7 +199,7 @@ const slideOpts = { shadowScale: 0.94, }, on: { - beforeInit: function () { + beforeInit: function() { const swiper = this; swiper.classNames.push(`${swiper.params.containerModifierClass}cube`); swiper.classNames.push(`${swiper.params.containerModifierClass}3d`); @@ -220,16 +218,10 @@ const slideOpts = { this.params = Object.assign(this.params, overwriteParams); this.originalParams = Object.assign(this.originalParams, overwriteParams); }, - setTranslate: function () { + setTranslate: function() { const swiper = this; const { - $el, - $wrapperEl, - slides, - width: swiperWidth, - height: swiperHeight, - rtlTranslate: rtl, - size: swiperSize, + $el, $wrapperEl, slides, width: swiperWidth, height: swiperHeight, rtlTranslate: rtl, size: swiperSize, } = swiper; const params = swiper.params.cubeEffect; const isHorizontal = swiper.isHorizontal(); @@ -276,37 +268,31 @@ const slideOpts = { tx = 0; tz = -round * 4 * swiperSize; } else if ((slideIndex - 2) % 4 === 0) { - tx = swiperSize + round * 4 * swiperSize; + tx = swiperSize + (round * 4 * swiperSize); tz = swiperSize; } else if ((slideIndex - 3) % 4 === 0) { tx = -swiperSize; - tz = 3 * swiperSize + swiperSize * 4 * round; + tz = (3 * swiperSize) + (swiperSize * 4 * round); } if (rtl) { tx = -tx; } - if (!isHorizontal) { + if (!isHorizontal) { ty = tx; tx = 0; } - const transform$$1 = `rotateX(${isHorizontal ? 0 : -slideAngle}deg) rotateY(${ - isHorizontal ? slideAngle : 0 - }deg) translate3d(${tx}px, ${ty}px, ${tz}px)`; + const transform$$1 = `rotateX(${isHorizontal ? 0 : -slideAngle}deg) rotateY(${isHorizontal ? slideAngle : 0}deg) translate3d(${tx}px, ${ty}px, ${tz}px)`; if (progress <= 1 && progress > -1) { - wrapperRotate = slideIndex * 90 + progress * 90; - if (rtl) wrapperRotate = -slideIndex * 90 - progress * 90; + wrapperRotate = (slideIndex * 90) + (progress * 90); + if (rtl) wrapperRotate = (-slideIndex * 90) - (progress * 90); } $slideEl.transform(transform$$1); if (params.slideShadows) { // Set shadows - let shadowBefore = isHorizontal - ? $slideEl.find('.swiper-slide-shadow-left') - : $slideEl.find('.swiper-slide-shadow-top'); - let shadowAfter = isHorizontal - ? $slideEl.find('.swiper-slide-shadow-right') - : $slideEl.find('.swiper-slide-shadow-bottom'); + let shadowBefore = isHorizontal ? $slideEl.find('.swiper-slide-shadow-left') : $slideEl.find('.swiper-slide-shadow-top'); + let shadowAfter = isHorizontal ? $slideEl.find('.swiper-slide-shadow-right') : $slideEl.find('.swiper-slide-shadow-bottom'); if (shadowBefore.length === 0) { shadowBefore = swiper.$(`
`); $slideEl.append(shadowBefore); @@ -326,50 +312,39 @@ const slideOpts = { 'transform-origin': `50% 50% -${swiperSize / 2}px`, }); - if (params.shadow) { + if (params.shadow) { if (isHorizontal) { - $cubeShadowEl.transform( - `translate3d(0px, ${swiperWidth / 2 + params.shadowOffset}px, ${ - -swiperWidth / 2 - }px) rotateX(90deg) rotateZ(0deg) scale(${params.shadowScale})` - ); + $cubeShadowEl.transform(`translate3d(0px, ${(swiperWidth / 2) + params.shadowOffset}px, ${-swiperWidth / 2}px) rotateX(90deg) rotateZ(0deg) scale(${params.shadowScale})`); } else { - const shadowAngle = Math.abs(wrapperRotate) - Math.floor(Math.abs(wrapperRotate) / 90) * 90; - const multiplier = - 1.5 - (Math.sin((shadowAngle * 2 * Math.PI) / 360) / 2 + Math.cos((shadowAngle * 2 * Math.PI) / 360) / 2); + const shadowAngle = Math.abs(wrapperRotate) - (Math.floor(Math.abs(wrapperRotate) / 90) * 90); + const multiplier = 1.5 - ( + (Math.sin((shadowAngle * 2 * Math.PI) / 360) / 2) + + (Math.cos((shadowAngle * 2 * Math.PI) / 360) / 2) + ); const scale1 = params.shadowScale; const scale2 = params.shadowScale / multiplier; const offset$$1 = params.shadowOffset; - $cubeShadowEl.transform( - `scale3d(${scale1}, 1, ${scale2}) translate3d(0px, ${swiperHeight / 2 + offset$$1}px, ${ - -swiperHeight / 2 / scale2 - }px) rotateX(-90deg)` - ); + $cubeShadowEl.transform(`scale3d(${scale1}, 1, ${scale2}) translate3d(0px, ${(swiperHeight / 2) + offset$$1}px, ${-swiperHeight / 2 / scale2}px) rotateX(-90deg)`); } } - const zFactor = swiper.browser.isSafari || swiper.browser.isUiWebView ? -swiperSize / 2 : 0; - $wrapperEl.transform( - `translate3d(0px,0,${zFactor}px) rotateX(${swiper.isHorizontal() ? 0 : wrapperRotate}deg) rotateY(${ - swiper.isHorizontal() ? -wrapperRotate : 0 - }deg)` - ); + const zFactor = (swiper.browser.isSafari || swiper.browser.isUiWebView) ? (-swiperSize / 2) : 0; + $wrapperEl + .transform(`translate3d(0px,0,${zFactor}px) rotateX(${swiper.isHorizontal() ? 0 : wrapperRotate}deg) rotateY(${swiper.isHorizontal() ? -wrapperRotate : 0}deg)`); }, - setTransition: function (duration) { + setTransition: function(duration) { const swiper = this; const { $el, slides } = swiper; slides .transition(duration) - .find( - '.swiper-slide-shadow-top, .swiper-slide-shadow-right, .swiper-slide-shadow-bottom, .swiper-slide-shadow-left' - ) + .find('.swiper-slide-shadow-top, .swiper-slide-shadow-right, .swiper-slide-shadow-bottom, .swiper-slide-shadow-left') .transition(duration); if (swiper.params.cubeEffect.shadow && !swiper.isHorizontal()) { $el.find('.swiper-cube-shadow').transition(duration); } }, - }, -}; + } +} ``` ### Fade @@ -432,8 +407,8 @@ const slideOpts = { }); } }, - }, -}; + } +} ``` ### Flip @@ -480,32 +455,25 @@ const slideOpts = { rotateY = -rotateY; } - $slideEl[0].style.zIndex = -Math.abs(Math.round(progress)) + slides.length; + $slideEl[0].style.zIndex = -Math.abs(Math.round(progress)) + slides.length; - if (swiper.params.flipEffect.slideShadows) { + if (swiper.params.flipEffect.slideShadows) { // Set shadows - let shadowBefore = swiper.isHorizontal() - ? $slideEl.find('.swiper-slide-shadow-left') - : $slideEl.find('.swiper-slide-shadow-top'); - let shadowAfter = swiper.isHorizontal() - ? $slideEl.find('.swiper-slide-shadow-right') - : $slideEl.find('.swiper-slide-shadow-bottom'); + let shadowBefore = swiper.isHorizontal() ? $slideEl.find('.swiper-slide-shadow-left') : $slideEl.find('.swiper-slide-shadow-top'); + let shadowAfter = swiper.isHorizontal() ? $slideEl.find('.swiper-slide-shadow-right') : $slideEl.find('.swiper-slide-shadow-bottom'); if (shadowBefore.length === 0) { - shadowBefore = swiper.$( - `
` - ); + shadowBefore = swiper.$(`
`); $slideEl.append(shadowBefore); } if (shadowAfter.length === 0) { - shadowAfter = swiper.$( - `
` - ); + shadowAfter = swiper.$(`
`); $slideEl.append(shadowAfter); } if (shadowBefore.length) shadowBefore[0].style.opacity = Math.max(-progress, 0); if (shadowAfter.length) shadowAfter[0].style.opacity = Math.max(progress, 0); } - $slideEl.transform(`translate3d(${tx}px, ${ty}px, 0px) rotateX(${rotateX}deg) rotateY(${rotateY}deg)`); + $slideEl + .transform(`translate3d(${tx}px, ${ty}px, 0px) rotateX(${rotateX}deg) rotateY(${rotateY}deg)`); } }, setTransition(duration) { @@ -513,9 +481,7 @@ const slideOpts = { const { slides, activeIndex, $wrapperEl } = swiper; slides .transition(duration) - .find( - '.swiper-slide-shadow-top, .swiper-slide-shadow-right, .swiper-slide-shadow-bottom, .swiper-slide-shadow-left' - ) + .find('.swiper-slide-shadow-top, .swiper-slide-shadow-right, .swiper-slide-shadow-bottom, .swiper-slide-shadow-left') .transition(duration); if (swiper.params.virtualTranslate && duration !== 0) { let eventTriggered = false; @@ -532,11 +498,13 @@ const slideOpts = { } }); } - }, - }, + } + } }; ``` + + ## Usage @@ -562,14 +530,14 @@ import { Component } from '@angular/core'; - `, + ` }) export class SlideExample { // Optional parameters to pass to the swiper instance. // See https://swiperjs.com/swiper-api for valid options. slideOpts = { initialSlide: 1, - speed: 400, + speed: 400 }; constructor() {} } @@ -582,8 +550,10 @@ ion-slides { } ``` + + ```html @@ -611,8 +581,8 @@ var slides = document.querySelector('ion-slides'); // See https://swiperjs.com/swiper-api for valid options. slides.options = { initialSlide: 1, - speed: 400, -}; + speed: 400 +} ``` ```css @@ -622,8 +592,10 @@ ion-slides { } ``` + + ```tsx @@ -634,7 +606,7 @@ import { IonSlides, IonSlide, IonContent } from '@ionic/react'; // See https://swiperjs.com/swiper-api for valid options. const slideOpts = { initialSlide: 1, - speed: 400, + speed: 400 }; export const SlidesExample: React.FC = () => ( @@ -663,6 +635,7 @@ ion-slides { + ```tsx @@ -670,14 +643,14 @@ import { Component, h } from '@stencil/core'; @Component({ tag: 'slides-example', - styleUrl: 'slides-example.css', + styleUrl: 'slides-example.css' }) export class SlidesExample { // Optional parameters to pass to the swiper instance. // See https://swiperjs.com/swiper-api for valid options. private slideOpts = { initialSlide: 1, - speed: 400, + speed: 400 }; render() { @@ -696,7 +669,7 @@ export class SlidesExample {

Slide 3

- , + ]; } } @@ -711,6 +684,7 @@ ion-slides {
+ ```html @@ -728,48 +702,44 @@ ion-slides { + ``` +
## Properties - ## Events - ## Methods - ## CSS Shadow Parts - ## CSS Custom Properties - ## Slots - - + \ No newline at end of file diff --git a/versioned_docs/version-v6/api/spinner.md b/versioned_docs/version-v6/api/spinner.md index e6bf760869c..abe69520719 100644 --- a/versioned_docs/version-v6/api/spinner.md +++ b/versioned_docs/version-v6/api/spinner.md @@ -2,12 +2,12 @@ title: 'ion-spinner' --- -import Props from '@ionic-internal/component-api/v6/spinner/props.md'; -import Events from '@ionic-internal/component-api/v6/spinner/events.md'; -import Methods from '@ionic-internal/component-api/v6/spinner/methods.md'; -import Parts from '@ionic-internal/component-api/v6/spinner/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/spinner/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/spinner/slots.md'; +import Props from '@site/static/auto-generated/spinner/props.md'; +import Events from '@site/static/auto-generated/spinner/events.md'; +import Methods from '@site/static/auto-generated/spinner/methods.md'; +import Parts from '@site/static/auto-generated/spinner/parts.md'; +import CustomProps from '@site/static/auto-generated/spinner/custom-props.md'; +import Slots from '@site/static/auto-generated/spinner/slots.md'; ion-spinner | Animated Spinner Icon Components and Properties diff --git a/versioned_docs/version-v6/api/split-pane.md b/versioned_docs/version-v6/api/split-pane.md index 87b29ff3b2f..fa5f03fc403 100644 --- a/versioned_docs/version-v6/api/split-pane.md +++ b/versioned_docs/version-v6/api/split-pane.md @@ -2,12 +2,12 @@ title: 'ion-split-pane' --- -import Props from '@ionic-internal/component-api/v6/split-pane/props.md'; -import Events from '@ionic-internal/component-api/v6/split-pane/events.md'; -import Methods from '@ionic-internal/component-api/v6/split-pane/methods.md'; -import Parts from '@ionic-internal/component-api/v6/split-pane/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/split-pane/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/split-pane/slots.md'; +import Props from '@site/static/auto-generated/split-pane/props.md'; +import Events from '@site/static/auto-generated/split-pane/events.md'; +import Methods from '@site/static/auto-generated/split-pane/methods.md'; +import Parts from '@site/static/auto-generated/split-pane/parts.md'; +import CustomProps from '@site/static/auto-generated/split-pane/custom-props.md'; +import Slots from '@site/static/auto-generated/split-pane/slots.md'; ion-split-pane: Split Plane View for Menus and Multi-View Layouts diff --git a/versioned_docs/version-v6/api/tab-bar.md b/versioned_docs/version-v6/api/tab-bar.md index cbf15815ba7..5cd9d97fe3d 100644 --- a/versioned_docs/version-v6/api/tab-bar.md +++ b/versioned_docs/version-v6/api/tab-bar.md @@ -1,31 +1,31 @@ --- -title: 'ion-tab-bar' +title: "ion-tab-bar" --- - import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -import Props from '@ionic-internal/component-api/v6/tab-bar/props.md'; -import Events from '@ionic-internal/component-api/v6/tab-bar/events.md'; -import Methods from '@ionic-internal/component-api/v6/tab-bar/methods.md'; -import Parts from '@ionic-internal/component-api/v6/tab-bar/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/tab-bar/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/tab-bar/slots.md'; +import Props from '@site/static/auto-generated/tab-bar/props.md'; +import Events from '@site/static/auto-generated/tab-bar/events.md'; +import Methods from '@site/static/auto-generated/tab-bar/methods.md'; +import Parts from '@site/static/auto-generated/tab-bar/parts.md'; +import CustomProps from '@site/static/auto-generated/tab-bar/custom-props.md'; +import Slots from '@site/static/auto-generated/tab-bar/slots.md'; ion-tab-bar with CSS Custom Properties for Tab Bar Components - + import EncapsulationPill from '@components/page/api/EncapsulationPill'; + The tab bar is a UI component that contains a set of [tab buttons](tab-button.md). A tab bar must be provided inside of [tabs](tabs.md) to communicate with each [tab](tab.md). + + + ## Usage @@ -51,6 +51,7 @@ The tab bar is a UI component that contains a set of [tab buttons](tab-button.md + ```html @@ -77,6 +78,7 @@ The tab bar is a UI component that contains a set of [tab buttons](tab-button.md + ```tsx @@ -104,8 +106,10 @@ export const TabBarExample: React.FC = () => ( ); ``` + + ```tsx @@ -113,7 +117,7 @@ import { Component, h } from '@stencil/core'; @Component({ tag: 'tab-bar-example', - styleUrl: 'tab-bar-example.css', + styleUrl: 'tab-bar-example.css' }) export class TabBarExample { render() { @@ -136,14 +140,16 @@ export class TabBarExample { - , + ]; } } ``` + + ```html @@ -165,16 +171,16 @@ export class TabBarExample { ``` @@ -183,25 +189,19 @@ export class TabBarExample { ## Properties - ## Events - ## Methods - ## CSS Shadow Parts - ## CSS Custom Properties - ## Slots - - + \ No newline at end of file diff --git a/versioned_docs/version-v6/api/tab-button.md b/versioned_docs/version-v6/api/tab-button.md index a989563be88..1ac51b3c34e 100644 --- a/versioned_docs/version-v6/api/tab-button.md +++ b/versioned_docs/version-v6/api/tab-button.md @@ -1,25 +1,30 @@ --- -title: 'ion-tab-button' +title: "ion-tab-button" --- - import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -import Props from '@ionic-internal/component-api/v6/tab-button/props.md'; -import Events from '@ionic-internal/component-api/v6/tab-button/events.md'; -import Methods from '@ionic-internal/component-api/v6/tab-button/methods.md'; -import Parts from '@ionic-internal/component-api/v6/tab-button/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/tab-button/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/tab-button/slots.md'; +import Props from '@site/static/auto-generated/tab-button/props.md'; +import Events from '@site/static/auto-generated/tab-button/events.md'; +import Methods from '@site/static/auto-generated/tab-button/methods.md'; +import Parts from '@site/static/auto-generated/tab-button/parts.md'; +import CustomProps from '@site/static/auto-generated/tab-button/custom-props.md'; +import Slots from '@site/static/auto-generated/tab-button/slots.md'; + + import EncapsulationPill from '@components/page/api/EncapsulationPill'; + A tab button is a UI component that is placed inside of a [tab bar](tab-bar.md). The tab button can specify the layout of the icon and label and connect to a [tab view](tab.md). See the [tabs documentation](tabs.md) for more details on configuring tabs. + + + ## Usage @@ -53,8 +58,10 @@ See the [tabs documentation](tabs.md) for more details on configuring tabs. ``` + + ```html @@ -101,8 +108,10 @@ See the [tabs documentation](tabs.md) for more details on configuring tabs. ``` + + ```tsx @@ -140,8 +149,10 @@ export const TabButtonExample: React.FC = () => ( ); ``` + + ```tsx @@ -149,7 +160,7 @@ import { Component, h } from '@stencil/core'; @Component({ tag: 'tab-button-example', - styleUrl: 'tab-button-example.css', + styleUrl: 'tab-button-example.css' }) export class TabButtonExample { render() { @@ -194,14 +205,16 @@ export class TabButtonExample { About - , + ]; } } ``` + + ```html @@ -233,49 +246,50 @@ export class TabButtonExample { ``` + ## Properties - ## Events - ## Methods - ## CSS Shadow Parts - ## CSS Custom Properties - ## Slots - - + \ No newline at end of file diff --git a/versioned_docs/version-v6/api/tab.md b/versioned_docs/version-v6/api/tab.md index deafa889116..899e3c6c484 100644 --- a/versioned_docs/version-v6/api/tab.md +++ b/versioned_docs/version-v6/api/tab.md @@ -1,54 +1,49 @@ --- -title: 'ion-tab' +title: "ion-tab" --- -import Props from '@ionic-internal/component-api/v6/tab/props.md'; -import Events from '@ionic-internal/component-api/v6/tab/events.md'; -import Methods from '@ionic-internal/component-api/v6/tab/methods.md'; -import Parts from '@ionic-internal/component-api/v6/tab/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/tab/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/tab/slots.md'; +import Props from '@site/static/auto-generated/tab/props.md'; +import Events from '@site/static/auto-generated/tab/events.md'; +import Methods from '@site/static/auto-generated/tab/methods.md'; +import Parts from '@site/static/auto-generated/tab/parts.md'; +import CustomProps from '@site/static/auto-generated/tab/custom-props.md'; +import Slots from '@site/static/auto-generated/tab/slots.md'; ion-tab - Ionic Framework Application Component - + import EncapsulationPill from '@components/page/api/EncapsulationPill'; + The tab component is a child component of [tabs](tabs.md). 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. :::note -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. + 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. ::: + See the [tabs documentation](tabs.md) for more details on configuring tabs. -## Properties + +## Properties ## Events - ## Methods - ## CSS Shadow Parts - ## CSS Custom Properties - ## Slots - - + \ No newline at end of file diff --git a/versioned_docs/version-v6/api/tabs.md b/versioned_docs/version-v6/api/tabs.md index 8c200d9a226..c97ef582190 100644 --- a/versioned_docs/version-v6/api/tabs.md +++ b/versioned_docs/version-v6/api/tabs.md @@ -2,12 +2,12 @@ title: 'ion-tabs' --- -import Props from '@ionic-internal/component-api/v6/tabs/props.md'; -import Events from '@ionic-internal/component-api/v6/tabs/events.md'; -import Methods from '@ionic-internal/component-api/v6/tabs/methods.md'; -import Parts from '@ionic-internal/component-api/v6/tabs/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/tabs/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/tabs/slots.md'; +import Props from '@site/static/auto-generated/tabs/props.md'; +import Events from '@site/static/auto-generated/tabs/events.md'; +import Methods from '@site/static/auto-generated/tabs/methods.md'; +import Parts from '@site/static/auto-generated/tabs/parts.md'; +import CustomProps from '@site/static/auto-generated/tabs/custom-props.md'; +import Slots from '@site/static/auto-generated/tabs/slots.md'; Ion-Tabs: Tab-Based Component for App Top-Level Navigation diff --git a/versioned_docs/version-v6/api/text.md b/versioned_docs/version-v6/api/text.md index ac2d82988e3..c6fcee4c2db 100644 --- a/versioned_docs/version-v6/api/text.md +++ b/versioned_docs/version-v6/api/text.md @@ -2,12 +2,12 @@ title: 'ion-text' --- -import Props from '@ionic-internal/component-api/v6/text/props.md'; -import Events from '@ionic-internal/component-api/v6/text/events.md'; -import Methods from '@ionic-internal/component-api/v6/text/methods.md'; -import Parts from '@ionic-internal/component-api/v6/text/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/text/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/text/slots.md'; +import Props from '@site/static/auto-generated/text/props.md'; +import Events from '@site/static/auto-generated/text/events.md'; +import Methods from '@site/static/auto-generated/text/methods.md'; +import Parts from '@site/static/auto-generated/text/parts.md'; +import CustomProps from '@site/static/auto-generated/text/custom-props.md'; +import Slots from '@site/static/auto-generated/text/slots.md'; ion-text: Ionic App Component to Style or Change Text Color diff --git a/versioned_docs/version-v6/api/textarea.md b/versioned_docs/version-v6/api/textarea.md index 169ba5f1372..5b6def11096 100644 --- a/versioned_docs/version-v6/api/textarea.md +++ b/versioned_docs/version-v6/api/textarea.md @@ -2,12 +2,12 @@ title: 'ion-textarea' --- -import Props from '@ionic-internal/component-api/v6/textarea/props.md'; -import Events from '@ionic-internal/component-api/v6/textarea/events.md'; -import Methods from '@ionic-internal/component-api/v6/textarea/methods.md'; -import Parts from '@ionic-internal/component-api/v6/textarea/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/textarea/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/textarea/slots.md'; +import Props from '@site/static/auto-generated/textarea/props.md'; +import Events from '@site/static/auto-generated/textarea/events.md'; +import Methods from '@site/static/auto-generated/textarea/methods.md'; +import Parts from '@site/static/auto-generated/textarea/parts.md'; +import CustomProps from '@site/static/auto-generated/textarea/custom-props.md'; +import Slots from '@site/static/auto-generated/textarea/slots.md'; Ionic Textarea Component and CSS Properties for Multi-Line Input diff --git a/versioned_docs/version-v6/api/thumbnail.md b/versioned_docs/version-v6/api/thumbnail.md index 759c793a7cf..f21d2f25b59 100644 --- a/versioned_docs/version-v6/api/thumbnail.md +++ b/versioned_docs/version-v6/api/thumbnail.md @@ -2,12 +2,12 @@ title: 'ion-thumbnail' --- -import Props from '@ionic-internal/component-api/v6/thumbnail/props.md'; -import Events from '@ionic-internal/component-api/v6/thumbnail/events.md'; -import Methods from '@ionic-internal/component-api/v6/thumbnail/methods.md'; -import Parts from '@ionic-internal/component-api/v6/thumbnail/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/thumbnail/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/thumbnail/slots.md'; +import Props from '@site/static/auto-generated/thumbnail/props.md'; +import Events from '@site/static/auto-generated/thumbnail/events.md'; +import Methods from '@site/static/auto-generated/thumbnail/methods.md'; +import Parts from '@site/static/auto-generated/thumbnail/parts.md'; +import CustomProps from '@site/static/auto-generated/thumbnail/custom-props.md'; +import Slots from '@site/static/auto-generated/thumbnail/slots.md'; ion-thumbnail | Thumbnail App Component to Wrap Images or Icons diff --git a/versioned_docs/version-v6/api/title.md b/versioned_docs/version-v6/api/title.md index 69d24cfb592..07a1a36eb03 100644 --- a/versioned_docs/version-v6/api/title.md +++ b/versioned_docs/version-v6/api/title.md @@ -2,12 +2,12 @@ title: 'ion-title' --- -import Props from '@ionic-internal/component-api/v6/title/props.md'; -import Events from '@ionic-internal/component-api/v6/title/events.md'; -import Methods from '@ionic-internal/component-api/v6/title/methods.md'; -import Parts from '@ionic-internal/component-api/v6/title/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/title/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/title/slots.md'; +import Props from '@site/static/auto-generated/title/props.md'; +import Events from '@site/static/auto-generated/title/events.md'; +import Methods from '@site/static/auto-generated/title/methods.md'; +import Parts from '@site/static/auto-generated/title/parts.md'; +import CustomProps from '@site/static/auto-generated/title/custom-props.md'; +import Slots from '@site/static/auto-generated/title/slots.md'; ion-title: Ionic Framework App Title Component for Toolbars diff --git a/versioned_docs/version-v6/api/toast.md b/versioned_docs/version-v6/api/toast.md index 463a73f6e99..b0915d8cf8c 100644 --- a/versioned_docs/version-v6/api/toast.md +++ b/versioned_docs/version-v6/api/toast.md @@ -5,12 +5,12 @@ title: 'ion-toast' import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -import Props from '@ionic-internal/component-api/v6/toast/props.md'; -import Events from '@ionic-internal/component-api/v6/toast/events.md'; -import Methods from '@ionic-internal/component-api/v6/toast/methods.md'; -import Parts from '@ionic-internal/component-api/v6/toast/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/toast/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/toast/slots.md'; +import Props from '@site/static/auto-generated/toast/props.md'; +import Events from '@site/static/auto-generated/toast/events.md'; +import Methods from '@site/static/auto-generated/toast/methods.md'; +import Parts from '@site/static/auto-generated/toast/parts.md'; +import CustomProps from '@site/static/auto-generated/toast/custom-props.md'; +import Slots from '@site/static/auto-generated/toast/slots.md'; ion-toast Component: A Dismissible App Notification Alert diff --git a/versioned_docs/version-v6/api/toggle.md b/versioned_docs/version-v6/api/toggle.md index 513dbae47d4..bb22c827d6f 100644 --- a/versioned_docs/version-v6/api/toggle.md +++ b/versioned_docs/version-v6/api/toggle.md @@ -2,12 +2,12 @@ title: 'ion-toggle' --- -import Props from '@ionic-internal/component-api/v6/toggle/props.md'; -import Events from '@ionic-internal/component-api/v6/toggle/events.md'; -import Methods from '@ionic-internal/component-api/v6/toggle/methods.md'; -import Parts from '@ionic-internal/component-api/v6/toggle/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/toggle/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/toggle/slots.md'; +import Props from '@site/static/auto-generated/toggle/props.md'; +import Events from '@site/static/auto-generated/toggle/events.md'; +import Methods from '@site/static/auto-generated/toggle/methods.md'; +import Parts from '@site/static/auto-generated/toggle/parts.md'; +import CustomProps from '@site/static/auto-generated/toggle/custom-props.md'; +import Slots from '@site/static/auto-generated/toggle/slots.md'; Toggle | ion-toggle: Custom Toggle Button for Ionic Applications diff --git a/versioned_docs/version-v6/api/toolbar.md b/versioned_docs/version-v6/api/toolbar.md index 96464f3e46c..dbd61f85818 100644 --- a/versioned_docs/version-v6/api/toolbar.md +++ b/versioned_docs/version-v6/api/toolbar.md @@ -2,12 +2,12 @@ title: 'ion-toolbar' --- -import Props from '@ionic-internal/component-api/v6/toolbar/props.md'; -import Events from '@ionic-internal/component-api/v6/toolbar/events.md'; -import Methods from '@ionic-internal/component-api/v6/toolbar/methods.md'; -import Parts from '@ionic-internal/component-api/v6/toolbar/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/toolbar/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/toolbar/slots.md'; +import Props from '@site/static/auto-generated/toolbar/props.md'; +import Events from '@site/static/auto-generated/toolbar/events.md'; +import Methods from '@site/static/auto-generated/toolbar/methods.md'; +import Parts from '@site/static/auto-generated/toolbar/parts.md'; +import CustomProps from '@site/static/auto-generated/toolbar/custom-props.md'; +import Slots from '@site/static/auto-generated/toolbar/slots.md'; Toolbar | Customize App Menu Toolbar Buttons and Icons diff --git a/versioned_docs/version-v6/api/virtual-scroll.md b/versioned_docs/version-v6/api/virtual-scroll.md index 54d1a78f01b..84f85ac329f 100644 --- a/versioned_docs/version-v6/api/virtual-scroll.md +++ b/versioned_docs/version-v6/api/virtual-scroll.md @@ -1,28 +1,27 @@ --- -title: 'ion-virtual-scroll' +title: "ion-virtual-scroll" --- -import Props from '@ionic-internal/component-api/v6/virtual-scroll/props.md'; -import Events from '@ionic-internal/component-api/v6/virtual-scroll/events.md'; -import Methods from '@ionic-internal/component-api/v6/virtual-scroll/methods.md'; -import Parts from '@ionic-internal/component-api/v6/virtual-scroll/parts.md'; -import CustomProps from '@ionic-internal/component-api/v6/virtual-scroll/custom-props.md'; -import Slots from '@ionic-internal/component-api/v6/virtual-scroll/slots.md'; +import Props from '@site/static/auto-generated/virtual-scroll/props.md'; +import Events from '@site/static/auto-generated/virtual-scroll/events.md'; +import Methods from '@site/static/auto-generated/virtual-scroll/methods.md'; +import Parts from '@site/static/auto-generated/virtual-scroll/parts.md'; +import CustomProps from '@site/static/auto-generated/virtual-scroll/custom-props.md'; +import Slots from '@site/static/auto-generated/virtual-scroll/slots.md'; ion-virtual-scroll | Angular Virtual Scroll List for Ionic Apps - + import EncapsulationPill from '@components/page/api/EncapsulationPill'; + :::note This component has been deprecated in favor of using virtual scrolling libraries provided by each JavaScript Framework. See below for alternatives. ::: + Virtual Scroll displays a virtual, "infinite" list. An array of records is passed to the virtual scroll containing the data to create templates for. The template created for each record, referred to as a cell, can @@ -44,7 +43,7 @@ For virtual scrolling options in Ionic React, please see [React Virtual Scroll G For virtual scrolling options in Ionic Vue, please see [Vue Virtual Scroll Guide](../vue/virtual-scroll.md). ---- +------ The following documentation applies to the `ion-virtual-scroll` component. @@ -86,6 +85,7 @@ renders whenever it wants which could be while the user is scrolling. However, `` is governed by the containing `ion-content` and does not render images while scrolling quickly. + ## Virtual Scroll Performance Tips ### iOS Cordova WKWebView @@ -131,12 +131,13 @@ different identities, and Ionic will tear down the entire DOM and rebuild it. This is an expensive operation and should be avoided if possible. ### Efficient headers and footer functions - Each virtual item must stay extremely efficient, but one way to really kill its performance is to perform any DOM operations within section header and footer functions. These functions are called for every record in the dataset, so please make sure they're performant. + + ## Usage ```html @@ -146,10 +147,10 @@ dataset, so please make sure they're performant.
- - {{ item.name }} - - {{ item.content }} + + {{ item.name }} + + {{ item.content }} @@ -166,7 +167,7 @@ export class VirtualScrollPageComponent { imgSrc: getImgSrc(), avatarSrc: getImgSrc(), imgHeight: Math.floor(Math.random() * 50 + 150), - content: lorem.substring(0, Math.random() * (lorem.length - 100) + 100), + content: lorem.substring(0, Math.random() * (lorem.length - 100) + 100) }); rotateImg++; @@ -177,8 +178,7 @@ export class VirtualScrollPageComponent { } } -const lorem = - 'Lorem ipsum dolor sit amet, consectetur adipiscing elit, seddo eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.'; +const lorem = 'Lorem ipsum dolor sit amet, consectetur adipiscing elit, seddo eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.'; const images = [ 'bandit', @@ -190,7 +190,7 @@ const images = [ 'general-lee', 'ghostbusters', 'knight-rider', - 'mirth-mobile', + 'mirth-mobile' ]; function getImgSrc() { @@ -212,7 +212,9 @@ The data given to the `items` property must be an array. An item template with t ```html - {{ item }} + + {{ item }} + ``` @@ -228,8 +230,12 @@ return `null` if a template shouldn't be created. ```html - {{ header }} - Item: {{ item }} + + {{ header }} + + + Item: {{ item }} + ``` @@ -250,6 +256,7 @@ myHeaderFn(record, recordIndex, records) { } ``` + ### Custom Components If a custom component is going to be used within Virtual Scroll, it's best @@ -260,31 +267,27 @@ within a `
` is a safe way to make sure dimensions are measured correctly. ```html
- {{ item }} + + {{ item }} +
``` ## Properties - ## Events - ## Methods - ## CSS Shadow Parts - ## CSS Custom Properties - ## Slots - - + \ No newline at end of file