From ce67296db0b2f45ef7207ac402615da410f3252f Mon Sep 17 00:00:00 2001 From: Sean Perkins Date: Fri, 24 Feb 2023 12:37:20 -0500 Subject: [PATCH 1/3] chore: update api script to version api docs --- scripts/api.js | 61 +++++++++++++++++++++++++++++++++++--------------- 1 file changed, 43 insertions(+), 18 deletions(-) diff --git a/scripts/api.js b/scripts/api.js index 470aadb449..df881e8a06 100644 --- a/scripts/api.js +++ b/scripts/api.js @@ -1,6 +1,21 @@ const fetch = require('node-fetch'); const fs = require('fs'); +/** + * The versions of Ionic to generate static markdown files for the API. Supports + * an array of objects, allowing you to specify the `npmTag`, in instances where you + * need to point to a dev-build or next tag for an upcoming major release. + */ +const versions = [ + { + npmTag: '@v6', // The tag to load from unpkg + version: 6, // The version, used to create the folder name `v${version}` + }, + { + npmTag: '@next', + version: 7, + }, +]; /** * * This script will create the autogenerated MDX files for each component. @@ -18,26 +33,36 @@ const fs = require('fs'); */ (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)); - }); + for (let { npmTag, version } of versions) { + 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); + writeAutoGeneratedPage(compTag, version, 'props', renderProperties(comp)); + writeAutoGeneratedPage(compTag, version, 'events', renderEvents(comp)); + writeAutoGeneratedPage(compTag, version, 'methods', renderMethods(comp)); + writeAutoGeneratedPage(compTag, version, 'parts', renderParts(comp)); + writeAutoGeneratedPage(compTag, version, 'custom-props', renderCustomProps(comp)); + writeAutoGeneratedPage(compTag, version, 'slots', renderSlots(comp)); + }); + } })(); -function writeAutoGeneratedPage(componentTag, fileName, data) { - const dir = `./static/auto-generated/${componentTag}`; +/** + * Creates a markdown file and writes the contents to file in the static/auto-generated + * directory. + * @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.: 6 + * @param {*} fileName The name of the generated markdown file, excluding the extension. + * @param {*} data The data to write to the markdown file. + */ +function writeAutoGeneratedPage(componentTag, version, fileName, data) { + const dir = `./static/auto-generated/v${version}/${componentTag}`; const path = `${dir}/${fileName}.md`; fs.mkdirSync(dir, { recursive: true }); fs.writeFileSync(path, data); From 6a5e8020f7c18c08bae4c21dcc720065d4d491c4 Mon Sep 17 00:00:00 2001 From: Sean Perkins Date: Fri, 24 Feb 2023 12:39:35 -0500 Subject: [PATCH 2/3] chore: update v7 md docs to use v7 directory for api reference --- docs/api/accordion-group.md | 12 ++++++------ docs/api/accordion.md | 12 ++++++------ docs/api/action-sheet.md | 12 ++++++------ docs/api/alert.md | 12 ++++++------ docs/api/app.md | 12 ++++++------ docs/api/avatar.md | 12 ++++++------ docs/api/back-button.md | 12 ++++++------ docs/api/backdrop.md | 12 ++++++------ docs/api/badge.md | 12 ++++++------ docs/api/breadcrumb.md | 12 ++++++------ docs/api/breadcrumbs.md | 12 ++++++------ docs/api/button.md | 12 ++++++------ docs/api/buttons.md | 12 ++++++------ docs/api/card-content.md | 12 ++++++------ docs/api/card-header.md | 12 ++++++------ docs/api/card-subtitle.md | 12 ++++++------ docs/api/card-title.md | 12 ++++++------ docs/api/card.md | 12 ++++++------ docs/api/checkbox.md | 12 ++++++------ docs/api/chip.md | 12 ++++++------ docs/api/col.md | 12 ++++++------ docs/api/content.md | 12 ++++++------ docs/api/datetime-button.md | 12 ++++++------ docs/api/datetime.md | 12 ++++++------ docs/api/fab-button.md | 12 ++++++------ docs/api/fab-list.md | 12 ++++++------ docs/api/fab.md | 12 ++++++------ docs/api/footer.md | 12 ++++++------ docs/api/grid.md | 12 ++++++------ docs/api/header.md | 12 ++++++------ docs/api/img.md | 12 ++++++------ docs/api/infinite-scroll-content.md | 12 ++++++------ docs/api/infinite-scroll.md | 12 ++++++------ docs/api/input.md | 12 ++++++------ docs/api/item-divider.md | 12 ++++++------ docs/api/item-group.md | 12 ++++++------ docs/api/item-option.md | 12 ++++++------ docs/api/item-options.md | 12 ++++++------ docs/api/item-sliding.md | 12 ++++++------ docs/api/item.md | 12 ++++++------ docs/api/label.md | 12 ++++++------ docs/api/list-header.md | 12 ++++++------ docs/api/list.md | 12 ++++++------ docs/api/loading.md | 12 ++++++------ docs/api/menu-button.md | 12 ++++++------ docs/api/menu-toggle.md | 12 ++++++------ docs/api/menu.md | 12 ++++++------ docs/api/modal.md | 12 ++++++------ docs/api/nav-link.md | 12 ++++++------ docs/api/nav.md | 12 ++++++------ docs/api/note.md | 12 ++++++------ docs/api/picker.md | 12 ++++++------ docs/api/popover.md | 12 ++++++------ docs/api/progress-bar.md | 12 ++++++------ docs/api/radio-group.md | 12 ++++++------ docs/api/radio.md | 12 ++++++------ docs/api/range.md | 12 ++++++------ docs/api/refresher-content.md | 12 ++++++------ docs/api/refresher.md | 12 ++++++------ docs/api/reorder-group.md | 12 ++++++------ docs/api/reorder.md | 12 ++++++------ docs/api/ripple-effect.md | 12 ++++++------ docs/api/route-redirect.md | 12 ++++++------ docs/api/route.md | 12 ++++++------ docs/api/router-link.md | 12 ++++++------ docs/api/router-outlet.md | 12 ++++++------ docs/api/router.md | 12 ++++++------ docs/api/row.md | 12 ++++++------ docs/api/searchbar.md | 12 ++++++------ docs/api/segment-button.md | 12 ++++++------ docs/api/segment.md | 12 ++++++------ docs/api/select-option.md | 12 ++++++------ docs/api/select.md | 12 ++++++------ docs/api/skeleton-text.md | 12 ++++++------ docs/api/spinner.md | 12 ++++++------ docs/api/split-pane.md | 12 ++++++------ docs/api/tab-bar.md | 12 ++++++------ docs/api/tab-button.md | 12 ++++++------ docs/api/tab.md | 12 ++++++------ docs/api/tabs.md | 12 ++++++------ docs/api/text.md | 12 ++++++------ docs/api/textarea.md | 12 ++++++------ docs/api/thumbnail.md | 12 ++++++------ docs/api/title.md | 12 ++++++------ docs/api/toast.md | 12 ++++++------ docs/api/toggle.md | 12 ++++++------ docs/api/toolbar.md | 12 ++++++------ 87 files changed, 522 insertions(+), 522 deletions(-) diff --git a/docs/api/accordion-group.md b/docs/api/accordion-group.md index 2880703001..812d424d9b 100644 --- a/docs/api/accordion-group.md +++ b/docs/api/accordion-group.md @@ -1,12 +1,12 @@ --- title: "ion-accordion-group" --- -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 Props from '@site/static/auto-generated/v7/accordion-group/props.md'; +import Events from '@site/static/auto-generated/v7/accordion-group/events.md'; +import Methods from '@site/static/auto-generated/v7/accordion-group/methods.md'; +import Parts from '@site/static/auto-generated/v7/accordion-group/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/accordion-group/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/accordion-group/slots.md'; import EncapsulationPill from '@components/page/api/EncapsulationPill'; diff --git a/docs/api/accordion.md b/docs/api/accordion.md index 0fb249825c..ca1f54855f 100644 --- a/docs/api/accordion.md +++ b/docs/api/accordion.md @@ -1,12 +1,12 @@ --- title: "ion-accordion" --- -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'; +import Props from '@site/static/auto-generated/v7/accordion/props.md'; +import Events from '@site/static/auto-generated/v7/accordion/events.md'; +import Methods from '@site/static/auto-generated/v7/accordion/methods.md'; +import Parts from '@site/static/auto-generated/v7/accordion/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/accordion/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 64943f9fcf..e33b1ef967 100644 --- a/docs/api/action-sheet.md +++ b/docs/api/action-sheet.md @@ -1,12 +1,12 @@ --- title: "ion-action-sheet" --- -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'; +import Props from '@site/static/auto-generated/v7/action-sheet/props.md'; +import Events from '@site/static/auto-generated/v7/action-sheet/events.md'; +import Methods from '@site/static/auto-generated/v7/action-sheet/methods.md'; +import Parts from '@site/static/auto-generated/v7/action-sheet/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/action-sheet/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 66cfe9e147..f4777f3c05 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 '@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'; +import Props from '@site/static/auto-generated/v7/alert/props.md'; +import Events from '@site/static/auto-generated/v7/alert/events.md'; +import Methods from '@site/static/auto-generated/v7/alert/methods.md'; +import Parts from '@site/static/auto-generated/v7/alert/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/alert/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 98125d4aa8..d086092c91 100644 --- a/docs/api/app.md +++ b/docs/api/app.md @@ -1,12 +1,12 @@ --- title: "ion-app" --- -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'; +import Props from '@site/static/auto-generated/v7/app/props.md'; +import Events from '@site/static/auto-generated/v7/app/events.md'; +import Methods from '@site/static/auto-generated/v7/app/methods.md'; +import Parts from '@site/static/auto-generated/v7/app/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/app/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/app/slots.md'; ion-app: Container Element for an Ionic Application diff --git a/docs/api/avatar.md b/docs/api/avatar.md index ed6cd9db89..da38c24d34 100644 --- a/docs/api/avatar.md +++ b/docs/api/avatar.md @@ -2,12 +2,12 @@ title: "ion-avatar" --- -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'; +import Props from '@site/static/auto-generated/v7/avatar/props.md'; +import Events from '@site/static/auto-generated/v7/avatar/events.md'; +import Methods from '@site/static/auto-generated/v7/avatar/methods.md'; +import Parts from '@site/static/auto-generated/v7/avatar/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/avatar/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 6500a8ab78..6f89ce9e73 100644 --- a/docs/api/back-button.md +++ b/docs/api/back-button.md @@ -1,12 +1,12 @@ --- title: "ion-back-button" --- -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'; +import Props from '@site/static/auto-generated/v7/back-button/props.md'; +import Events from '@site/static/auto-generated/v7/back-button/events.md'; +import Methods from '@site/static/auto-generated/v7/back-button/methods.md'; +import Parts from '@site/static/auto-generated/v7/back-button/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/back-button/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 e23d11b058..53dfc04c3d 100644 --- a/docs/api/backdrop.md +++ b/docs/api/backdrop.md @@ -1,12 +1,12 @@ --- title: "ion-backdrop" --- -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 Props from '@site/static/auto-generated/v7/backdrop/props.md'; +import Events from '@site/static/auto-generated/v7/backdrop/events.md'; +import Methods from '@site/static/auto-generated/v7/backdrop/methods.md'; +import Parts from '@site/static/auto-generated/v7/backdrop/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/backdrop/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/backdrop/slots.md'; import EncapsulationPill from '@components/page/api/EncapsulationPill'; diff --git a/docs/api/badge.md b/docs/api/badge.md index 21e2f29835..79e326e994 100644 --- a/docs/api/badge.md +++ b/docs/api/badge.md @@ -1,12 +1,12 @@ --- title: "ion-badge" --- -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'; +import Props from '@site/static/auto-generated/v7/badge/props.md'; +import Events from '@site/static/auto-generated/v7/badge/events.md'; +import Methods from '@site/static/auto-generated/v7/badge/methods.md'; +import Parts from '@site/static/auto-generated/v7/badge/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/badge/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 5be2aa6c69..90d12a6281 100644 --- a/docs/api/breadcrumb.md +++ b/docs/api/breadcrumb.md @@ -1,12 +1,12 @@ --- title: "ion-breadcrumb" --- -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 Props from '@site/static/auto-generated/v7/breadcrumb/props.md'; +import Events from '@site/static/auto-generated/v7/breadcrumb/events.md'; +import Methods from '@site/static/auto-generated/v7/breadcrumb/methods.md'; +import Parts from '@site/static/auto-generated/v7/breadcrumb/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/breadcrumb/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/breadcrumb/slots.md'; import EncapsulationPill from '@components/page/api/EncapsulationPill'; diff --git a/docs/api/breadcrumbs.md b/docs/api/breadcrumbs.md index d9a12c4c9a..113b9930bf 100644 --- a/docs/api/breadcrumbs.md +++ b/docs/api/breadcrumbs.md @@ -1,12 +1,12 @@ --- title: "ion-breadcrumbs" --- -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 Props from '@site/static/auto-generated/v7/breadcrumbs/props.md'; +import Events from '@site/static/auto-generated/v7/breadcrumbs/events.md'; +import Methods from '@site/static/auto-generated/v7/breadcrumbs/methods.md'; +import Parts from '@site/static/auto-generated/v7/breadcrumbs/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/breadcrumbs/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/breadcrumbs/slots.md'; diff --git a/docs/api/button.md b/docs/api/button.md index b3161ccb0e..996e67c315 100644 --- a/docs/api/button.md +++ b/docs/api/button.md @@ -1,12 +1,12 @@ --- title: "ion-button" --- -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'; +import Props from '@site/static/auto-generated/v7/button/props.md'; +import Events from '@site/static/auto-generated/v7/button/events.md'; +import Methods from '@site/static/auto-generated/v7/button/methods.md'; +import Parts from '@site/static/auto-generated/v7/button/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/button/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 3e4db87783..9a35df622a 100644 --- a/docs/api/buttons.md +++ b/docs/api/buttons.md @@ -1,12 +1,12 @@ --- title: "ion-buttons" --- -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'; +import Props from '@site/static/auto-generated/v7/buttons/props.md'; +import Events from '@site/static/auto-generated/v7/buttons/events.md'; +import Methods from '@site/static/auto-generated/v7/buttons/methods.md'; +import Parts from '@site/static/auto-generated/v7/buttons/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/buttons/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 647cba0089..12491b3f85 100644 --- a/docs/api/card-content.md +++ b/docs/api/card-content.md @@ -1,12 +1,12 @@ --- title: "ion-card-content" --- -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 Props from '@site/static/auto-generated/v7/card-content/props.md'; +import Events from '@site/static/auto-generated/v7/card-content/events.md'; +import Methods from '@site/static/auto-generated/v7/card-content/methods.md'; +import Parts from '@site/static/auto-generated/v7/card-content/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/card-content/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 2e52467ed4..f52fd1f171 100644 --- a/docs/api/card-header.md +++ b/docs/api/card-header.md @@ -1,12 +1,12 @@ --- title: "ion-card-header" --- -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 Props from '@site/static/auto-generated/v7/card-header/props.md'; +import Events from '@site/static/auto-generated/v7/card-header/events.md'; +import Methods from '@site/static/auto-generated/v7/card-header/methods.md'; +import Parts from '@site/static/auto-generated/v7/card-header/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/card-header/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 ec72784cd9..6cd6d26ebb 100644 --- a/docs/api/card-subtitle.md +++ b/docs/api/card-subtitle.md @@ -1,12 +1,12 @@ --- title: "ion-card-subtitle" --- -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 Props from '@site/static/auto-generated/v7/card-subtitle/props.md'; +import Events from '@site/static/auto-generated/v7/card-subtitle/events.md'; +import Methods from '@site/static/auto-generated/v7/card-subtitle/methods.md'; +import Parts from '@site/static/auto-generated/v7/card-subtitle/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/card-subtitle/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 33b24158eb..95235449af 100644 --- a/docs/api/card-title.md +++ b/docs/api/card-title.md @@ -1,12 +1,12 @@ --- title: "ion-card-title" --- -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 Props from '@site/static/auto-generated/v7/card-title/props.md'; +import Events from '@site/static/auto-generated/v7/card-title/events.md'; +import Methods from '@site/static/auto-generated/v7/card-title/methods.md'; +import Parts from '@site/static/auto-generated/v7/card-title/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/card-title/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/card-title/slots.md'; import EncapsulationPill from '@components/page/api/EncapsulationPill'; diff --git a/docs/api/card.md b/docs/api/card.md index b9419281ab..4add37999f 100644 --- a/docs/api/card.md +++ b/docs/api/card.md @@ -1,12 +1,12 @@ --- title: "ion-card" --- -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 Props from '@site/static/auto-generated/v7/card/props.md'; +import Events from '@site/static/auto-generated/v7/card/events.md'; +import Methods from '@site/static/auto-generated/v7/card/methods.md'; +import Parts from '@site/static/auto-generated/v7/card/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/card/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/card/slots.md'; import EncapsulationPill from '@components/page/api/EncapsulationPill'; diff --git a/docs/api/checkbox.md b/docs/api/checkbox.md index c861b994ff..d16480b71a 100644 --- a/docs/api/checkbox.md +++ b/docs/api/checkbox.md @@ -2,12 +2,12 @@ title: "ion-checkbox" --- -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'; +import Props from '@site/static/auto-generated/v7/checkbox/props.md'; +import Events from '@site/static/auto-generated/v7/checkbox/events.md'; +import Methods from '@site/static/auto-generated/v7/checkbox/methods.md'; +import Parts from '@site/static/auto-generated/v7/checkbox/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/checkbox/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 e032f7e5e0..7b1203a8ea 100644 --- a/docs/api/chip.md +++ b/docs/api/chip.md @@ -1,12 +1,12 @@ --- title: "ion-chip" --- -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'; +import Props from '@site/static/auto-generated/v7/chip/props.md'; +import Events from '@site/static/auto-generated/v7/chip/events.md'; +import Methods from '@site/static/auto-generated/v7/chip/methods.md'; +import Parts from '@site/static/auto-generated/v7/chip/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/chip/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 e5872b4f6a..3bdc85b5c4 100644 --- a/docs/api/col.md +++ b/docs/api/col.md @@ -1,12 +1,12 @@ --- title: "ion-col" --- -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'; +import Props from '@site/static/auto-generated/v7/col/props.md'; +import Events from '@site/static/auto-generated/v7/col/events.md'; +import Methods from '@site/static/auto-generated/v7/col/methods.md'; +import Parts from '@site/static/auto-generated/v7/col/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/col/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 a0feb3f2cc..10d7d8b327 100644 --- a/docs/api/content.md +++ b/docs/api/content.md @@ -1,12 +1,12 @@ --- title: "ion-content" --- -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'; +import Props from '@site/static/auto-generated/v7/content/props.md'; +import Events from '@site/static/auto-generated/v7/content/events.md'; +import Methods from '@site/static/auto-generated/v7/content/methods.md'; +import Parts from '@site/static/auto-generated/v7/content/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/content/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 a17b50b498..839bc52afd 100644 --- a/docs/api/datetime-button.md +++ b/docs/api/datetime-button.md @@ -1,12 +1,12 @@ --- title: "ion-datetime-button" --- -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'; +import Props from '@site/static/auto-generated/v7/datetime-button/props.md'; +import Events from '@site/static/auto-generated/v7/datetime-button/events.md'; +import Methods from '@site/static/auto-generated/v7/datetime-button/methods.md'; +import Parts from '@site/static/auto-generated/v7/datetime-button/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/datetime-button/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 ab856254ca..07470a006c 100644 --- a/docs/api/datetime.md +++ b/docs/api/datetime.md @@ -1,12 +1,12 @@ --- title: "ion-datetime" --- -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 Props from '@site/static/auto-generated/v7/datetime/props.md'; +import Events from '@site/static/auto-generated/v7/datetime/events.md'; +import Methods from '@site/static/auto-generated/v7/datetime/methods.md'; +import Parts from '@site/static/auto-generated/v7/datetime/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/datetime/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 ab86a48426..2b27ed12f6 100644 --- a/docs/api/fab-button.md +++ b/docs/api/fab-button.md @@ -1,12 +1,12 @@ --- title: "ion-fab-button" --- -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'; +import Props from '@site/static/auto-generated/v7/fab-button/props.md'; +import Events from '@site/static/auto-generated/v7/fab-button/events.md'; +import Methods from '@site/static/auto-generated/v7/fab-button/methods.md'; +import Parts from '@site/static/auto-generated/v7/fab-button/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/fab-button/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 a0659a394d..9d760fa7cf 100644 --- a/docs/api/fab-list.md +++ b/docs/api/fab-list.md @@ -1,12 +1,12 @@ --- title: "ion-fab-list" --- -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 Props from '@site/static/auto-generated/v7/fab-list/props.md'; +import Events from '@site/static/auto-generated/v7/fab-list/events.md'; +import Methods from '@site/static/auto-generated/v7/fab-list/methods.md'; +import Parts from '@site/static/auto-generated/v7/fab-list/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/fab-list/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/fab-list/slots.md'; import EncapsulationPill from '@components/page/api/EncapsulationPill'; diff --git a/docs/api/fab.md b/docs/api/fab.md index 55ce35332f..c5e11be78f 100644 --- a/docs/api/fab.md +++ b/docs/api/fab.md @@ -1,12 +1,12 @@ --- title: "ion-fab" --- -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'; +import Props from '@site/static/auto-generated/v7/fab/props.md'; +import Events from '@site/static/auto-generated/v7/fab/events.md'; +import Methods from '@site/static/auto-generated/v7/fab/methods.md'; +import Parts from '@site/static/auto-generated/v7/fab/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/fab/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 b5298d7bcc..5dc63ef050 100644 --- a/docs/api/footer.md +++ b/docs/api/footer.md @@ -1,12 +1,12 @@ --- title: "ion-footer" --- -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'; +import Props from '@site/static/auto-generated/v7/footer/props.md'; +import Events from '@site/static/auto-generated/v7/footer/events.md'; +import Methods from '@site/static/auto-generated/v7/footer/methods.md'; +import Parts from '@site/static/auto-generated/v7/footer/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/footer/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 30b504cd3c..25b30f8912 100644 --- a/docs/api/grid.md +++ b/docs/api/grid.md @@ -1,12 +1,12 @@ --- title: "ion-grid" --- -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'; +import Props from '@site/static/auto-generated/v7/grid/props.md'; +import Events from '@site/static/auto-generated/v7/grid/events.md'; +import Methods from '@site/static/auto-generated/v7/grid/methods.md'; +import Parts from '@site/static/auto-generated/v7/grid/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/grid/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 7288b636ab..14b0a33f32 100644 --- a/docs/api/header.md +++ b/docs/api/header.md @@ -1,12 +1,12 @@ --- title: "ion-header" --- -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'; +import Props from '@site/static/auto-generated/v7/header/props.md'; +import Events from '@site/static/auto-generated/v7/header/events.md'; +import Methods from '@site/static/auto-generated/v7/header/methods.md'; +import Parts from '@site/static/auto-generated/v7/header/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/header/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 14c697c760..ae1d9e701d 100644 --- a/docs/api/img.md +++ b/docs/api/img.md @@ -2,12 +2,12 @@ title: "ion-img" --- -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'; +import Props from '@site/static/auto-generated/v7/img/props.md'; +import Events from '@site/static/auto-generated/v7/img/events.md'; +import Methods from '@site/static/auto-generated/v7/img/methods.md'; +import Parts from '@site/static/auto-generated/v7/img/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/img/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 2647dffdb8..100c7844e4 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 '@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 Props from '@site/static/auto-generated/v7/infinite-scroll-content/props.md'; +import Events from '@site/static/auto-generated/v7/infinite-scroll-content/events.md'; +import Methods from '@site/static/auto-generated/v7/infinite-scroll-content/methods.md'; +import Parts from '@site/static/auto-generated/v7/infinite-scroll-content/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/infinite-scroll-content/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 5675984b44..60710d1933 100644 --- a/docs/api/infinite-scroll.md +++ b/docs/api/infinite-scroll.md @@ -2,12 +2,12 @@ title: "ion-infinite-scroll" --- -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'; +import Props from '@site/static/auto-generated/v7/infinite-scroll/props.md'; +import Events from '@site/static/auto-generated/v7/infinite-scroll/events.md'; +import Methods from '@site/static/auto-generated/v7/infinite-scroll/methods.md'; +import Parts from '@site/static/auto-generated/v7/infinite-scroll/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/infinite-scroll/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/infinite-scroll/slots.md'; Infinite Scroller | ion-infinite-scroll Action Component diff --git a/docs/api/input.md b/docs/api/input.md index 4d7df8eef1..78f897c232 100644 --- a/docs/api/input.md +++ b/docs/api/input.md @@ -1,12 +1,12 @@ --- title: "ion-input" --- -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'; +import Props from '@site/static/auto-generated/v7/input/props.md'; +import Events from '@site/static/auto-generated/v7/input/events.md'; +import Methods from '@site/static/auto-generated/v7/input/methods.md'; +import Parts from '@site/static/auto-generated/v7/input/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/input/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 0f4dd8c40f..af7f01b687 100644 --- a/docs/api/item-divider.md +++ b/docs/api/item-divider.md @@ -1,12 +1,12 @@ --- title: "ion-item-divider" --- -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'; +import Props from '@site/static/auto-generated/v7/item-divider/props.md'; +import Events from '@site/static/auto-generated/v7/item-divider/events.md'; +import Methods from '@site/static/auto-generated/v7/item-divider/methods.md'; +import Parts from '@site/static/auto-generated/v7/item-divider/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/item-divider/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 60cf8b0938..2f889cdbd7 100644 --- a/docs/api/item-group.md +++ b/docs/api/item-group.md @@ -1,12 +1,12 @@ --- title: "ion-item-group" --- -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'; +import Props from '@site/static/auto-generated/v7/item-group/props.md'; +import Events from '@site/static/auto-generated/v7/item-group/events.md'; +import Methods from '@site/static/auto-generated/v7/item-group/methods.md'; +import Parts from '@site/static/auto-generated/v7/item-group/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/item-group/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 800d1030f5..8077cead32 100644 --- a/docs/api/item-option.md +++ b/docs/api/item-option.md @@ -1,12 +1,12 @@ --- title: "ion-item-option" --- -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'; +import Props from '@site/static/auto-generated/v7/item-option/props.md'; +import Events from '@site/static/auto-generated/v7/item-option/events.md'; +import Methods from '@site/static/auto-generated/v7/item-option/methods.md'; +import Parts from '@site/static/auto-generated/v7/item-option/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/item-option/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 cbee8f5289..02a5bcae3c 100644 --- a/docs/api/item-options.md +++ b/docs/api/item-options.md @@ -1,12 +1,12 @@ --- title: "ion-item-options" --- -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'; +import Props from '@site/static/auto-generated/v7/item-options/props.md'; +import Events from '@site/static/auto-generated/v7/item-options/events.md'; +import Methods from '@site/static/auto-generated/v7/item-options/methods.md'; +import Parts from '@site/static/auto-generated/v7/item-options/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/item-options/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 526f4d1263..2ceb046d4a 100644 --- a/docs/api/item-sliding.md +++ b/docs/api/item-sliding.md @@ -1,12 +1,12 @@ --- title: "ion-item-sliding" --- -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'; +import Props from '@site/static/auto-generated/v7/item-sliding/props.md'; +import Events from '@site/static/auto-generated/v7/item-sliding/events.md'; +import Methods from '@site/static/auto-generated/v7/item-sliding/methods.md'; +import Parts from '@site/static/auto-generated/v7/item-sliding/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/item-sliding/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 09f89b1132..067912f6c6 100644 --- a/docs/api/item.md +++ b/docs/api/item.md @@ -1,12 +1,12 @@ --- title: "ion-item" --- -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'; +import Props from '@site/static/auto-generated/v7/item/props.md'; +import Events from '@site/static/auto-generated/v7/item/events.md'; +import Methods from '@site/static/auto-generated/v7/item/methods.md'; +import Parts from '@site/static/auto-generated/v7/item/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/item/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 a7b6422775..f2f848bb7c 100644 --- a/docs/api/label.md +++ b/docs/api/label.md @@ -1,12 +1,12 @@ --- title: "ion-label" --- -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'; +import Props from '@site/static/auto-generated/v7/label/props.md'; +import Events from '@site/static/auto-generated/v7/label/events.md'; +import Methods from '@site/static/auto-generated/v7/label/methods.md'; +import Parts from '@site/static/auto-generated/v7/label/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/label/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 f2ecb78162..7777059bf3 100644 --- a/docs/api/list-header.md +++ b/docs/api/list-header.md @@ -1,12 +1,12 @@ --- title: "ion-list-header" --- -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 Props from '@site/static/auto-generated/v7/list-header/props.md'; +import Events from '@site/static/auto-generated/v7/list-header/events.md'; +import Methods from '@site/static/auto-generated/v7/list-header/methods.md'; +import Parts from '@site/static/auto-generated/v7/list-header/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/list-header/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/list-header/slots.md'; import EncapsulationPill from '@components/page/api/EncapsulationPill'; diff --git a/docs/api/list.md b/docs/api/list.md index b590782392..15f264693e 100644 --- a/docs/api/list.md +++ b/docs/api/list.md @@ -1,12 +1,12 @@ --- title: "ion-list" --- -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'; +import Props from '@site/static/auto-generated/v7/list/props.md'; +import Events from '@site/static/auto-generated/v7/list/events.md'; +import Methods from '@site/static/auto-generated/v7/list/methods.md'; +import Parts from '@site/static/auto-generated/v7/list/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/list/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 f4e4f04f00..03b6657d0d 100644 --- a/docs/api/loading.md +++ b/docs/api/loading.md @@ -1,12 +1,12 @@ --- title: "ion-loading" --- -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'; +import Props from '@site/static/auto-generated/v7/loading/props.md'; +import Events from '@site/static/auto-generated/v7/loading/events.md'; +import Methods from '@site/static/auto-generated/v7/loading/methods.md'; +import Parts from '@site/static/auto-generated/v7/loading/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/loading/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 adba980b95..d5e77f4078 100644 --- a/docs/api/menu-button.md +++ b/docs/api/menu-button.md @@ -1,12 +1,12 @@ --- title: "ion-menu-button" --- -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'; +import Props from '@site/static/auto-generated/v7/menu-button/props.md'; +import Events from '@site/static/auto-generated/v7/menu-button/events.md'; +import Methods from '@site/static/auto-generated/v7/menu-button/methods.md'; +import Parts from '@site/static/auto-generated/v7/menu-button/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/menu-button/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 e6a1020136..a277a8ef25 100644 --- a/docs/api/menu-toggle.md +++ b/docs/api/menu-toggle.md @@ -1,12 +1,12 @@ --- title: "ion-menu-toggle" --- -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'; +import Props from '@site/static/auto-generated/v7/menu-toggle/props.md'; +import Events from '@site/static/auto-generated/v7/menu-toggle/events.md'; +import Methods from '@site/static/auto-generated/v7/menu-toggle/methods.md'; +import Parts from '@site/static/auto-generated/v7/menu-toggle/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/menu-toggle/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 8a12ff4335..0dfe0e0176 100644 --- a/docs/api/menu.md +++ b/docs/api/menu.md @@ -1,12 +1,12 @@ --- title: "ion-menu" --- -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'; +import Props from '@site/static/auto-generated/v7/menu/props.md'; +import Events from '@site/static/auto-generated/v7/menu/events.md'; +import Methods from '@site/static/auto-generated/v7/menu/methods.md'; +import Parts from '@site/static/auto-generated/v7/menu/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/menu/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 6e68846652..3fff29af2a 100644 --- a/docs/api/modal.md +++ b/docs/api/modal.md @@ -1,12 +1,12 @@ --- title: "ion-modal" --- -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'; +import Props from '@site/static/auto-generated/v7/modal/props.md'; +import Events from '@site/static/auto-generated/v7/modal/events.md'; +import Methods from '@site/static/auto-generated/v7/modal/methods.md'; +import Parts from '@site/static/auto-generated/v7/modal/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/modal/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 30a8f3264e..28ab69dbfe 100644 --- a/docs/api/nav-link.md +++ b/docs/api/nav-link.md @@ -1,12 +1,12 @@ --- title: "ion-nav-link" --- -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'; +import Props from '@site/static/auto-generated/v7/nav-link/props.md'; +import Events from '@site/static/auto-generated/v7/nav-link/events.md'; +import Methods from '@site/static/auto-generated/v7/nav-link/methods.md'; +import Parts from '@site/static/auto-generated/v7/nav-link/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/nav-link/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 727add0a05..7670d3bb78 100644 --- a/docs/api/nav.md +++ b/docs/api/nav.md @@ -1,12 +1,12 @@ --- title: "ion-nav" --- -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'; +import Props from '@site/static/auto-generated/v7/nav/props.md'; +import Events from '@site/static/auto-generated/v7/nav/events.md'; +import Methods from '@site/static/auto-generated/v7/nav/methods.md'; +import Parts from '@site/static/auto-generated/v7/nav/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/nav/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 5d142dd53b..2023dfe327 100644 --- a/docs/api/note.md +++ b/docs/api/note.md @@ -1,12 +1,12 @@ --- title: "ion-note" --- -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'; +import Props from '@site/static/auto-generated/v7/note/props.md'; +import Events from '@site/static/auto-generated/v7/note/events.md'; +import Methods from '@site/static/auto-generated/v7/note/methods.md'; +import Parts from '@site/static/auto-generated/v7/note/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/note/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 8a1d4d59f6..2636641d67 100644 --- a/docs/api/picker.md +++ b/docs/api/picker.md @@ -1,12 +1,12 @@ --- title: "ion-picker" --- -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'; +import Props from '@site/static/auto-generated/v7/picker/props.md'; +import Events from '@site/static/auto-generated/v7/picker/events.md'; +import Methods from '@site/static/auto-generated/v7/picker/methods.md'; +import Parts from '@site/static/auto-generated/v7/picker/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/picker/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 3301729287..3b6937fc8b 100644 --- a/docs/api/popover.md +++ b/docs/api/popover.md @@ -1,12 +1,12 @@ --- title: "ion-popover" --- -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'; +import Props from '@site/static/auto-generated/v7/popover/props.md'; +import Events from '@site/static/auto-generated/v7/popover/events.md'; +import Methods from '@site/static/auto-generated/v7/popover/methods.md'; +import Parts from '@site/static/auto-generated/v7/popover/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/popover/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 15a7c27fbc..42050e4eb1 100644 --- a/docs/api/progress-bar.md +++ b/docs/api/progress-bar.md @@ -1,12 +1,12 @@ --- title: "ion-progress-bar" --- -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'; +import Props from '@site/static/auto-generated/v7/progress-bar/props.md'; +import Events from '@site/static/auto-generated/v7/progress-bar/events.md'; +import Methods from '@site/static/auto-generated/v7/progress-bar/methods.md'; +import Parts from '@site/static/auto-generated/v7/progress-bar/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/progress-bar/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 b083ee208b..9b0f31f2e4 100644 --- a/docs/api/radio-group.md +++ b/docs/api/radio-group.md @@ -1,12 +1,12 @@ --- title: "ion-radio-group" --- -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'; +import Props from '@site/static/auto-generated/v7/radio-group/props.md'; +import Events from '@site/static/auto-generated/v7/radio-group/events.md'; +import Methods from '@site/static/auto-generated/v7/radio-group/methods.md'; +import Parts from '@site/static/auto-generated/v7/radio-group/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/radio-group/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 b5f94c0b8f..6fda632be9 100644 --- a/docs/api/radio.md +++ b/docs/api/radio.md @@ -1,12 +1,12 @@ --- title: "ion-radio" --- -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'; +import Props from '@site/static/auto-generated/v7/radio/props.md'; +import Events from '@site/static/auto-generated/v7/radio/events.md'; +import Methods from '@site/static/auto-generated/v7/radio/methods.md'; +import Parts from '@site/static/auto-generated/v7/radio/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/radio/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 d102bcbc97..3f39c32fe0 100644 --- a/docs/api/range.md +++ b/docs/api/range.md @@ -1,12 +1,12 @@ --- title: "ion-range" --- -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'; +import Props from '@site/static/auto-generated/v7/range/props.md'; +import Events from '@site/static/auto-generated/v7/range/events.md'; +import Methods from '@site/static/auto-generated/v7/range/methods.md'; +import Parts from '@site/static/auto-generated/v7/range/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/range/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 1b80d4ef40..cce9e12b67 100644 --- a/docs/api/refresher-content.md +++ b/docs/api/refresher-content.md @@ -1,12 +1,12 @@ --- title: "ion-refresher-content" --- -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 Props from '@site/static/auto-generated/v7/refresher-content/props.md'; +import Events from '@site/static/auto-generated/v7/refresher-content/events.md'; +import Methods from '@site/static/auto-generated/v7/refresher-content/methods.md'; +import Parts from '@site/static/auto-generated/v7/refresher-content/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/refresher-content/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/refresher-content/slots.md'; import EncapsulationPill from '@components/page/api/EncapsulationPill'; diff --git a/docs/api/refresher.md b/docs/api/refresher.md index 744200a218..85a3f1e744 100644 --- a/docs/api/refresher.md +++ b/docs/api/refresher.md @@ -1,12 +1,12 @@ --- title: "ion-refresher" --- -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'; +import Props from '@site/static/auto-generated/v7/refresher/props.md'; +import Events from '@site/static/auto-generated/v7/refresher/events.md'; +import Methods from '@site/static/auto-generated/v7/refresher/methods.md'; +import Parts from '@site/static/auto-generated/v7/refresher/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/refresher/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 674bc2561b..65eab8cae9 100644 --- a/docs/api/reorder-group.md +++ b/docs/api/reorder-group.md @@ -1,12 +1,12 @@ --- title: "ion-reorder-group" --- -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'; +import Props from '@site/static/auto-generated/v7/reorder-group/props.md'; +import Events from '@site/static/auto-generated/v7/reorder-group/events.md'; +import Methods from '@site/static/auto-generated/v7/reorder-group/methods.md'; +import Parts from '@site/static/auto-generated/v7/reorder-group/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/reorder-group/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 1043f82b81..50d31e3ae4 100644 --- a/docs/api/reorder.md +++ b/docs/api/reorder.md @@ -1,12 +1,12 @@ --- title: "ion-reorder" --- -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'; +import Props from '@site/static/auto-generated/v7/reorder/props.md'; +import Events from '@site/static/auto-generated/v7/reorder/events.md'; +import Methods from '@site/static/auto-generated/v7/reorder/methods.md'; +import Parts from '@site/static/auto-generated/v7/reorder/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/reorder/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 1861b13a11..989f7e5540 100644 --- a/docs/api/ripple-effect.md +++ b/docs/api/ripple-effect.md @@ -1,12 +1,12 @@ --- title: "ion-ripple-effect" --- -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 Props from '@site/static/auto-generated/v7/ripple-effect/props.md'; +import Events from '@site/static/auto-generated/v7/ripple-effect/events.md'; +import Methods from '@site/static/auto-generated/v7/ripple-effect/methods.md'; +import Parts from '@site/static/auto-generated/v7/ripple-effect/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/ripple-effect/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 ac4febd161..06d5e58fcb 100644 --- a/docs/api/route-redirect.md +++ b/docs/api/route-redirect.md @@ -2,12 +2,12 @@ title: "ion-route-redirect" --- -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'; +import Props from '@site/static/auto-generated/v7/route-redirect/props.md'; +import Events from '@site/static/auto-generated/v7/route-redirect/events.md'; +import Methods from '@site/static/auto-generated/v7/route-redirect/methods.md'; +import Parts from '@site/static/auto-generated/v7/route-redirect/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/route-redirect/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 91b607971e..bf454800a7 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 '@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'; +import Props from '@site/static/auto-generated/v7/route/props.md'; +import Events from '@site/static/auto-generated/v7/route/events.md'; +import Methods from '@site/static/auto-generated/v7/route/methods.md'; +import Parts from '@site/static/auto-generated/v7/route/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/route/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 ea95869eea..d10f69a4ed 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 '@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'; +import Props from '@site/static/auto-generated/v7/router-link/props.md'; +import Events from '@site/static/auto-generated/v7/router-link/events.md'; +import Methods from '@site/static/auto-generated/v7/router-link/methods.md'; +import Parts from '@site/static/auto-generated/v7/router-link/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/router-link/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 c15289ab77..073fc27e63 100644 --- a/docs/api/router-outlet.md +++ b/docs/api/router-outlet.md @@ -2,12 +2,12 @@ title: "ion-router-outlet" --- -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 Props from '@site/static/auto-generated/v7/router-outlet/props.md'; +import Events from '@site/static/auto-generated/v7/router-outlet/events.md'; +import Methods from '@site/static/auto-generated/v7/router-outlet/methods.md'; +import Parts from '@site/static/auto-generated/v7/router-outlet/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/router-outlet/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/router-outlet/slots.md'; diff --git a/docs/api/router.md b/docs/api/router.md index 48b8b522e0..3eb7784649 100644 --- a/docs/api/router.md +++ b/docs/api/router.md @@ -2,12 +2,12 @@ title: "ion-router" --- -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'; +import Props from '@site/static/auto-generated/v7/router/props.md'; +import Events from '@site/static/auto-generated/v7/router/events.md'; +import Methods from '@site/static/auto-generated/v7/router/methods.md'; +import Parts from '@site/static/auto-generated/v7/router/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/router/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/router/slots.md'; ion-router: Router Component to Coordinate URL Navigation diff --git a/docs/api/row.md b/docs/api/row.md index 48fc21c4ba..ef523e808b 100644 --- a/docs/api/row.md +++ b/docs/api/row.md @@ -1,12 +1,12 @@ --- title: "ion-row" --- -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'; +import Props from '@site/static/auto-generated/v7/row/props.md'; +import Events from '@site/static/auto-generated/v7/row/events.md'; +import Methods from '@site/static/auto-generated/v7/row/methods.md'; +import Parts from '@site/static/auto-generated/v7/row/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/row/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 c11c14c4c7..670e688c66 100644 --- a/docs/api/searchbar.md +++ b/docs/api/searchbar.md @@ -1,12 +1,12 @@ --- title: "ion-searchbar" --- -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'; +import Props from '@site/static/auto-generated/v7/searchbar/props.md'; +import Events from '@site/static/auto-generated/v7/searchbar/events.md'; +import Methods from '@site/static/auto-generated/v7/searchbar/methods.md'; +import Parts from '@site/static/auto-generated/v7/searchbar/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/searchbar/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 2567e2ecbe..8acab12c97 100644 --- a/docs/api/segment-button.md +++ b/docs/api/segment-button.md @@ -1,12 +1,12 @@ --- title: "ion-segment-button" --- -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'; +import Props from '@site/static/auto-generated/v7/segment-button/props.md'; +import Events from '@site/static/auto-generated/v7/segment-button/events.md'; +import Methods from '@site/static/auto-generated/v7/segment-button/methods.md'; +import Parts from '@site/static/auto-generated/v7/segment-button/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/segment-button/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 0ff953288d..344b6df1c9 100644 --- a/docs/api/segment.md +++ b/docs/api/segment.md @@ -1,12 +1,12 @@ --- title: "ion-segment" --- -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'; +import Props from '@site/static/auto-generated/v7/segment/props.md'; +import Events from '@site/static/auto-generated/v7/segment/events.md'; +import Methods from '@site/static/auto-generated/v7/segment/methods.md'; +import Parts from '@site/static/auto-generated/v7/segment/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/segment/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 73dbf015e2..ec4e447cd8 100644 --- a/docs/api/select-option.md +++ b/docs/api/select-option.md @@ -1,12 +1,12 @@ --- title: "ion-select-option" --- -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'; +import Props from '@site/static/auto-generated/v7/select-option/props.md'; +import Events from '@site/static/auto-generated/v7/select-option/events.md'; +import Methods from '@site/static/auto-generated/v7/select-option/methods.md'; +import Parts from '@site/static/auto-generated/v7/select-option/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/select-option/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 b632d93675..28db8efecd 100644 --- a/docs/api/select.md +++ b/docs/api/select.md @@ -1,12 +1,12 @@ --- title: "ion-select" --- -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'; +import Props from '@site/static/auto-generated/v7/select/props.md'; +import Events from '@site/static/auto-generated/v7/select/events.md'; +import Methods from '@site/static/auto-generated/v7/select/methods.md'; +import Parts from '@site/static/auto-generated/v7/select/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/select/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 7b62712710..5c2574061c 100644 --- a/docs/api/skeleton-text.md +++ b/docs/api/skeleton-text.md @@ -1,12 +1,12 @@ --- title: "ion-skeleton-text" --- -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'; +import Props from '@site/static/auto-generated/v7/skeleton-text/props.md'; +import Events from '@site/static/auto-generated/v7/skeleton-text/events.md'; +import Methods from '@site/static/auto-generated/v7/skeleton-text/methods.md'; +import Parts from '@site/static/auto-generated/v7/skeleton-text/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/skeleton-text/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 7d805fa697..888a330927 100644 --- a/docs/api/spinner.md +++ b/docs/api/spinner.md @@ -1,12 +1,12 @@ --- title: "ion-spinner" --- -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'; +import Props from '@site/static/auto-generated/v7/spinner/props.md'; +import Events from '@site/static/auto-generated/v7/spinner/events.md'; +import Methods from '@site/static/auto-generated/v7/spinner/methods.md'; +import Parts from '@site/static/auto-generated/v7/spinner/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/spinner/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 87ffe6c1ae..a74471b108 100644 --- a/docs/api/split-pane.md +++ b/docs/api/split-pane.md @@ -2,12 +2,12 @@ title: "ion-split-pane" --- -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'; +import Props from '@site/static/auto-generated/v7/split-pane/props.md'; +import Events from '@site/static/auto-generated/v7/split-pane/events.md'; +import Methods from '@site/static/auto-generated/v7/split-pane/methods.md'; +import Parts from '@site/static/auto-generated/v7/split-pane/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/split-pane/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 5cd9d97fe3..2072548679 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 '@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'; +import Props from '@site/static/auto-generated/v7/tab-bar/props.md'; +import Events from '@site/static/auto-generated/v7/tab-bar/events.md'; +import Methods from '@site/static/auto-generated/v7/tab-bar/methods.md'; +import Parts from '@site/static/auto-generated/v7/tab-bar/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/tab-bar/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 0fb186e077..d04fb16da6 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 '@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 Props from '@site/static/auto-generated/v7/tab-button/props.md'; +import Events from '@site/static/auto-generated/v7/tab-button/events.md'; +import Methods from '@site/static/auto-generated/v7/tab-button/methods.md'; +import Parts from '@site/static/auto-generated/v7/tab-button/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/tab-button/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/tab-button/slots.md'; diff --git a/docs/api/tab.md b/docs/api/tab.md index 899e3c6c48..3f17a0bec8 100644 --- a/docs/api/tab.md +++ b/docs/api/tab.md @@ -2,12 +2,12 @@ title: "ion-tab" --- -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'; +import Props from '@site/static/auto-generated/v7/tab/props.md'; +import Events from '@site/static/auto-generated/v7/tab/events.md'; +import Methods from '@site/static/auto-generated/v7/tab/methods.md'; +import Parts from '@site/static/auto-generated/v7/tab/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/tab/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/tab/slots.md'; ion-tab - Ionic Framework Application Component diff --git a/docs/api/tabs.md b/docs/api/tabs.md index 0920727d48..f8d2d51eca 100644 --- a/docs/api/tabs.md +++ b/docs/api/tabs.md @@ -1,12 +1,12 @@ --- title: "ion-tabs" --- -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'; +import Props from '@site/static/auto-generated/v7/tabs/props.md'; +import Events from '@site/static/auto-generated/v7/tabs/events.md'; +import Methods from '@site/static/auto-generated/v7/tabs/methods.md'; +import Parts from '@site/static/auto-generated/v7/tabs/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/tabs/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 ea9db032f6..37809c4aee 100644 --- a/docs/api/text.md +++ b/docs/api/text.md @@ -1,12 +1,12 @@ --- title: "ion-text" --- -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'; +import Props from '@site/static/auto-generated/v7/text/props.md'; +import Events from '@site/static/auto-generated/v7/text/events.md'; +import Methods from '@site/static/auto-generated/v7/text/methods.md'; +import Parts from '@site/static/auto-generated/v7/text/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/text/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 bfd0e16d1f..43f9a0b6b9 100644 --- a/docs/api/textarea.md +++ b/docs/api/textarea.md @@ -1,12 +1,12 @@ --- title: "ion-textarea" --- -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'; +import Props from '@site/static/auto-generated/v7/textarea/props.md'; +import Events from '@site/static/auto-generated/v7/textarea/events.md'; +import Methods from '@site/static/auto-generated/v7/textarea/methods.md'; +import Parts from '@site/static/auto-generated/v7/textarea/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/textarea/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 cf35320080..fa14e48558 100644 --- a/docs/api/thumbnail.md +++ b/docs/api/thumbnail.md @@ -2,12 +2,12 @@ title: "ion-thumbnail" --- -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'; +import Props from '@site/static/auto-generated/v7/thumbnail/props.md'; +import Events from '@site/static/auto-generated/v7/thumbnail/events.md'; +import Methods from '@site/static/auto-generated/v7/thumbnail/methods.md'; +import Parts from '@site/static/auto-generated/v7/thumbnail/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/thumbnail/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 4eb8eee4ac..50d09d92e6 100644 --- a/docs/api/title.md +++ b/docs/api/title.md @@ -1,12 +1,12 @@ --- title: "ion-title" --- -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'; +import Props from '@site/static/auto-generated/v7/title/props.md'; +import Events from '@site/static/auto-generated/v7/title/events.md'; +import Methods from '@site/static/auto-generated/v7/title/methods.md'; +import Parts from '@site/static/auto-generated/v7/title/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/title/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 8d3c0ba3a4..3ca4385151 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 '@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'; +import Props from '@site/static/auto-generated/v7/toast/props.md'; +import Events from '@site/static/auto-generated/v7/toast/events.md'; +import Methods from '@site/static/auto-generated/v7/toast/methods.md'; +import Parts from '@site/static/auto-generated/v7/toast/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/toast/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/toast/slots.md'; ion-toast Component: A Dismissible App Notification Alert diff --git a/docs/api/toggle.md b/docs/api/toggle.md index 78119d191a..57de6ce4bf 100644 --- a/docs/api/toggle.md +++ b/docs/api/toggle.md @@ -1,12 +1,12 @@ --- title: "ion-toggle" --- -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'; +import Props from '@site/static/auto-generated/v7/toggle/props.md'; +import Events from '@site/static/auto-generated/v7/toggle/events.md'; +import Methods from '@site/static/auto-generated/v7/toggle/methods.md'; +import Parts from '@site/static/auto-generated/v7/toggle/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/toggle/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/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 9db8ed00aa..3b564d917c 100644 --- a/docs/api/toolbar.md +++ b/docs/api/toolbar.md @@ -1,12 +1,12 @@ --- title: "ion-toolbar" --- -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'; +import Props from '@site/static/auto-generated/v7/toolbar/props.md'; +import Events from '@site/static/auto-generated/v7/toolbar/events.md'; +import Methods from '@site/static/auto-generated/v7/toolbar/methods.md'; +import Parts from '@site/static/auto-generated/v7/toolbar/parts.md'; +import CustomProps from '@site/static/auto-generated/v7/toolbar/custom-props.md'; +import Slots from '@site/static/auto-generated/v7/toolbar/slots.md'; Toolbar | Customize App Menu Toolbar Buttons and Icons From d7a91b8be01cd1587774bb575cd8b1afb6e06c7d Mon Sep 17 00:00:00 2001 From: Sean Perkins Date: Fri, 24 Feb 2023 12:40:50 -0500 Subject: [PATCH 3/3] chore: update v6 md docs to use v6 directory for api reference --- .../version-v6/api/accordion-group.md | 24 +- versioned_docs/version-v6/api/accordion.md | 12 +- versioned_docs/version-v6/api/action-sheet.md | 12 +- versioned_docs/version-v6/api/alert.md | 12 +- versioned_docs/version-v6/api/app.md | 40 +-- versioned_docs/version-v6/api/avatar.md | 12 +- versioned_docs/version-v6/api/back-button.md | 27 +- versioned_docs/version-v6/api/backdrop.md | 12 +- versioned_docs/version-v6/api/badge.md | 12 +- versioned_docs/version-v6/api/breadcrumb.md | 25 +- versioned_docs/version-v6/api/breadcrumbs.md | 12 +- versioned_docs/version-v6/api/button.md | 12 +- versioned_docs/version-v6/api/buttons.md | 12 +- versioned_docs/version-v6/api/card-content.md | 23 +- versioned_docs/version-v6/api/card-header.md | 23 +- .../version-v6/api/card-subtitle.md | 23 +- versioned_docs/version-v6/api/card-title.md | 28 +- versioned_docs/version-v6/api/card.md | 12 +- versioned_docs/version-v6/api/checkbox.md | 12 +- versioned_docs/version-v6/api/chip.md | 12 +- versioned_docs/version-v6/api/col.md | 31 ++- versioned_docs/version-v6/api/content.md | 12 +- .../version-v6/api/datetime-button.md | 12 +- versioned_docs/version-v6/api/datetime.md | 12 +- versioned_docs/version-v6/api/fab-button.md | 29 +- versioned_docs/version-v6/api/fab-list.md | 23 +- versioned_docs/version-v6/api/fab.md | 12 +- versioned_docs/version-v6/api/footer.md | 12 +- versioned_docs/version-v6/api/grid.md | 12 +- versioned_docs/version-v6/api/header.md | 12 +- versioned_docs/version-v6/api/img.md | 12 +- .../version-v6/api/infinite-scroll-content.md | 22 +- .../version-v6/api/infinite-scroll.md | 12 +- versioned_docs/version-v6/api/input.md | 12 +- versioned_docs/version-v6/api/item-divider.md | 12 +- versioned_docs/version-v6/api/item-group.md | 12 +- versioned_docs/version-v6/api/item-option.md | 28 +- versioned_docs/version-v6/api/item-options.md | 33 ++- versioned_docs/version-v6/api/item-sliding.md | 12 +- versioned_docs/version-v6/api/item.md | 12 +- versioned_docs/version-v6/api/label.md | 12 +- versioned_docs/version-v6/api/list-header.md | 12 +- versioned_docs/version-v6/api/list.md | 12 +- versioned_docs/version-v6/api/loading.md | 12 +- versioned_docs/version-v6/api/menu-button.md | 28 +- versioned_docs/version-v6/api/menu-toggle.md | 28 +- versioned_docs/version-v6/api/menu.md | 12 +- versioned_docs/version-v6/api/modal.md | 12 +- versioned_docs/version-v6/api/nav-link.md | 28 +- versioned_docs/version-v6/api/nav.md | 12 +- versioned_docs/version-v6/api/note.md | 12 +- versioned_docs/version-v6/api/picker.md | 13 +- versioned_docs/version-v6/api/popover.md | 12 +- versioned_docs/version-v6/api/progress-bar.md | 12 +- versioned_docs/version-v6/api/radio-group.md | 29 +- versioned_docs/version-v6/api/radio.md | 12 +- versioned_docs/version-v6/api/range.md | 12 +- .../version-v6/api/refresher-content.md | 23 +- versioned_docs/version-v6/api/refresher.md | 12 +- .../version-v6/api/reorder-group.md | 29 +- versioned_docs/version-v6/api/reorder.md | 12 +- .../version-v6/api/ripple-effect.md | 12 +- .../version-v6/api/route-redirect.md | 40 +-- versioned_docs/version-v6/api/route.md | 114 ++++---- versioned_docs/version-v6/api/router-link.md | 46 ++-- .../version-v6/api/router-outlet.md | 32 ++- versioned_docs/version-v6/api/router.md | 35 +-- versioned_docs/version-v6/api/row.md | 30 ++- versioned_docs/version-v6/api/searchbar.md | 12 +- .../version-v6/api/segment-button.md | 12 +- versioned_docs/version-v6/api/segment.md | 12 +- .../version-v6/api/select-option.md | 30 ++- versioned_docs/version-v6/api/select.md | 12 +- .../version-v6/api/skeleton-text.md | 12 +- versioned_docs/version-v6/api/slide.md | 31 ++- versioned_docs/version-v6/api/slides.md | 248 ++++++++++-------- versioned_docs/version-v6/api/spinner.md | 12 +- versioned_docs/version-v6/api/split-pane.md | 12 +- versioned_docs/version-v6/api/tab-bar.md | 62 ++--- versioned_docs/version-v6/api/tab-button.md | 80 +++--- versioned_docs/version-v6/api/tab.md | 33 ++- versioned_docs/version-v6/api/tabs.md | 12 +- versioned_docs/version-v6/api/text.md | 12 +- versioned_docs/version-v6/api/textarea.md | 12 +- versioned_docs/version-v6/api/thumbnail.md | 12 +- versioned_docs/version-v6/api/title.md | 12 +- versioned_docs/version-v6/api/toast.md | 12 +- versioned_docs/version-v6/api/toggle.md | 12 +- versioned_docs/version-v6/api/toolbar.md | 12 +- .../version-v6/api/virtual-scroll.md | 67 +++-- 90 files changed, 1126 insertions(+), 951 deletions(-) diff --git a/versioned_docs/version-v6/api/accordion-group.md b/versioned_docs/version-v6/api/accordion-group.md index 2880703001..1ce5db9ba8 100644 --- a/versioned_docs/version-v6/api/accordion-group.md +++ b/versioned_docs/version-v6/api/accordion-group.md @@ -1,12 +1,13 @@ --- -title: "ion-accordion-group" +title: 'ion-accordion-group' --- -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 Props from '@site/static/auto-generated/v6/accordion-group/props.md'; +import Events from '@site/static/auto-generated/v6/accordion-group/events.md'; +import Methods from '@site/static/auto-generated/v6/accordion-group/methods.md'; +import Parts from '@site/static/auto-generated/v6/accordion-group/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/accordion-group/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/accordion-group/slots.md'; import EncapsulationPill from '@components/page/api/EncapsulationPill'; @@ -16,7 +17,6 @@ Accordion group is a container for accordion instances. It manages the state of See the [Accordion](./accordion) documentation for more information. - ## Interfaces ### AccordionGroupChangeEventDetail @@ -38,22 +38,26 @@ interface AccordionGroupCustomEvent extends CustomEvent { } ``` - - ## 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 803f0efbfe..6f7287bea1 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 '@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'; +import Props from '@site/static/auto-generated/v6/accordion/props.md'; +import Events from '@site/static/auto-generated/v6/accordion/events.md'; +import Methods from '@site/static/auto-generated/v6/accordion/methods.md'; +import Parts from '@site/static/auto-generated/v6/accordion/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/accordion/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 3f2917d979..7d5ec411cb 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 '@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'; +import Props from '@site/static/auto-generated/v6/action-sheet/props.md'; +import Events from '@site/static/auto-generated/v6/action-sheet/events.md'; +import Methods from '@site/static/auto-generated/v6/action-sheet/methods.md'; +import Parts from '@site/static/auto-generated/v6/action-sheet/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/action-sheet/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 a90625feb2..b0ceefd59e 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 '@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'; +import Props from '@site/static/auto-generated/v6/alert/props.md'; +import Events from '@site/static/auto-generated/v6/alert/events.md'; +import Methods from '@site/static/auto-generated/v6/alert/methods.md'; +import Parts from '@site/static/auto-generated/v6/alert/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/alert/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 98125d4aa8..d22216e02c 100644 --- a/versioned_docs/version-v6/api/app.md +++ b/versioned_docs/version-v6/api/app.md @@ -1,47 +1,55 @@ --- -title: "ion-app" +title: 'ion-app' --- -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'; + +import Props from '@site/static/auto-generated/v6/app/props.md'; +import Events from '@site/static/auto-generated/v6/app/events.md'; +import Methods from '@site/static/auto-generated/v6/app/methods.md'; +import Parts from '@site/static/auto-generated/v6/app/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/app/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 + ## 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 0f32507e1d..b937eec87c 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 '@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'; +import Props from '@site/static/auto-generated/v6/avatar/props.md'; +import Events from '@site/static/auto-generated/v6/avatar/events.md'; +import Methods from '@site/static/auto-generated/v6/avatar/methods.md'; +import Parts from '@site/static/auto-generated/v6/avatar/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/avatar/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 d74db2d2cf..d37830d728 100644 --- a/versioned_docs/version-v6/api/back-button.md +++ b/versioned_docs/version-v6/api/back-button.md @@ -1,23 +1,26 @@ --- -title: "ion-back-button" +title: 'ion-back-button' --- -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'; + +import Props from '@site/static/auto-generated/v6/back-button/props.md'; +import Events from '@site/static/auto-generated/v6/back-button/events.md'; +import Methods from '@site/static/auto-generated/v6/back-button/methods.md'; +import Parts from '@site/static/auto-generated/v6/back-button/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/back-button/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 @@ -39,19 +42,25 @@ 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 97217b36b5..9094666be8 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 '@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 Props from '@site/static/auto-generated/v6/backdrop/props.md'; +import Events from '@site/static/auto-generated/v6/backdrop/events.md'; +import Methods from '@site/static/auto-generated/v6/backdrop/methods.md'; +import Parts from '@site/static/auto-generated/v6/backdrop/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/backdrop/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 202b2f3287..70f60ae594 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 '@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'; +import Props from '@site/static/auto-generated/v6/badge/props.md'; +import Events from '@site/static/auto-generated/v6/badge/events.md'; +import Methods from '@site/static/auto-generated/v6/badge/methods.md'; +import Parts from '@site/static/auto-generated/v6/badge/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/badge/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 5be2aa6c69..ad77bdcf73 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 '@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 Props from '@site/static/auto-generated/v6/breadcrumb/props.md'; +import Events from '@site/static/auto-generated/v6/breadcrumb/events.md'; +import Methods from '@site/static/auto-generated/v6/breadcrumb/methods.md'; +import Parts from '@site/static/auto-generated/v6/breadcrumb/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/breadcrumb/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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,23 +38,26 @@ interface BreadcrumbCustomEvent extends CustomEvent { } ``` - - - ## 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 561539a973..8afadd3b44 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 '@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 Props from '@site/static/auto-generated/v6/breadcrumbs/props.md'; +import Events from '@site/static/auto-generated/v6/breadcrumbs/events.md'; +import Methods from '@site/static/auto-generated/v6/breadcrumbs/methods.md'; +import Parts from '@site/static/auto-generated/v6/breadcrumbs/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/breadcrumbs/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 a78f98da7a..aa01c7641b 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 '@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'; +import Props from '@site/static/auto-generated/v6/button/props.md'; +import Events from '@site/static/auto-generated/v6/button/events.md'; +import Methods from '@site/static/auto-generated/v6/button/methods.md'; +import Parts from '@site/static/auto-generated/v6/button/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/button/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 c22bd4c0ad..7e675a8e84 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 '@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'; +import Props from '@site/static/auto-generated/v6/buttons/props.md'; +import Events from '@site/static/auto-generated/v6/buttons/events.md'; +import Methods from '@site/static/auto-generated/v6/buttons/methods.md'; +import Parts from '@site/static/auto-generated/v6/buttons/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/buttons/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 647cba0089..fc49a0db79 100644 --- a/versioned_docs/version-v6/api/card-content.md +++ b/versioned_docs/version-v6/api/card-content.md @@ -1,35 +1,40 @@ --- -title: "ion-card-content" +title: 'ion-card-content' --- -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'; +import Props from '@site/static/auto-generated/v6/card-content/props.md'; +import Events from '@site/static/auto-generated/v6/card-content/events.md'; +import Methods from '@site/static/auto-generated/v6/card-content/methods.md'; +import Parts from '@site/static/auto-generated/v6/card-content/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/card-content/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 + ## 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 2e52467ed4..deffb082c4 100644 --- a/versioned_docs/version-v6/api/card-header.md +++ b/versioned_docs/version-v6/api/card-header.md @@ -1,37 +1,42 @@ --- -title: "ion-card-header" +title: 'ion-card-header' --- -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 Props from '@site/static/auto-generated/v6/card-header/props.md'; +import Events from '@site/static/auto-generated/v6/card-header/events.md'; +import Methods from '@site/static/auto-generated/v6/card-header/methods.md'; +import Parts from '@site/static/auto-generated/v6/card-header/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/card-header/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 + ## 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 ec72784cd9..863ae5208d 100644 --- a/versioned_docs/version-v6/api/card-subtitle.md +++ b/versioned_docs/version-v6/api/card-subtitle.md @@ -1,37 +1,42 @@ --- -title: "ion-card-subtitle" +title: 'ion-card-subtitle' --- -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 Props from '@site/static/auto-generated/v6/card-subtitle/props.md'; +import Events from '@site/static/auto-generated/v6/card-subtitle/events.md'; +import Methods from '@site/static/auto-generated/v6/card-subtitle/methods.md'; +import Parts from '@site/static/auto-generated/v6/card-subtitle/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/card-subtitle/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 + ## 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 33b24158eb..e396405692 100644 --- a/versioned_docs/version-v6/api/card-title.md +++ b/versioned_docs/version-v6/api/card-title.md @@ -1,42 +1,50 @@ --- -title: "ion-card-title" +title: 'ion-card-title' --- -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 Props from '@site/static/auto-generated/v6/card-title/props.md'; +import Events from '@site/static/auto-generated/v6/card-title/events.md'; +import Methods from '@site/static/auto-generated/v6/card-title/methods.md'; +import Parts from '@site/static/auto-generated/v6/card-title/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/card-title/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 + ## 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 fda33f2e80..aacd35398d 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 '@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 Props from '@site/static/auto-generated/v6/card/props.md'; +import Events from '@site/static/auto-generated/v6/card/events.md'; +import Methods from '@site/static/auto-generated/v6/card/methods.md'; +import Parts from '@site/static/auto-generated/v6/card/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/card/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 7344a77f0d..fe002f4b12 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 '@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'; +import Props from '@site/static/auto-generated/v6/checkbox/props.md'; +import Events from '@site/static/auto-generated/v6/checkbox/events.md'; +import Methods from '@site/static/auto-generated/v6/checkbox/methods.md'; +import Parts from '@site/static/auto-generated/v6/checkbox/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/checkbox/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 46e13e9829..1226ded3d8 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 '@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'; +import Props from '@site/static/auto-generated/v6/chip/props.md'; +import Events from '@site/static/auto-generated/v6/chip/events.md'; +import Methods from '@site/static/auto-generated/v6/chip/methods.md'; +import Parts from '@site/static/auto-generated/v6/chip/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/chip/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 e5872b4f6a..b43f02a0a2 100644 --- a/versioned_docs/version-v6/api/col.md +++ b/versioned_docs/version-v6/api/col.md @@ -1,49 +1,54 @@ --- -title: "ion-col" +title: 'ion-col' --- -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'; + +import Props from '@site/static/auto-generated/v6/col/props.md'; +import Events from '@site/static/auto-generated/v6/col/events.md'; +import Methods from '@site/static/auto-generated/v6/col/methods.md'; +import Parts from '@site/static/auto-generated/v6/col/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/col/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 + ## 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 528f39b795..317f8f7cf3 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 '@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'; +import Props from '@site/static/auto-generated/v6/content/props.md'; +import Events from '@site/static/auto-generated/v6/content/events.md'; +import Methods from '@site/static/auto-generated/v6/content/methods.md'; +import Parts from '@site/static/auto-generated/v6/content/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/content/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 78e691b231..744392100b 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 '@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'; +import Props from '@site/static/auto-generated/v6/datetime-button/props.md'; +import Events from '@site/static/auto-generated/v6/datetime-button/events.md'; +import Methods from '@site/static/auto-generated/v6/datetime-button/methods.md'; +import Parts from '@site/static/auto-generated/v6/datetime-button/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/datetime-button/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 021146d87f..213b9fc91d 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 '@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 Props from '@site/static/auto-generated/v6/datetime/props.md'; +import Events from '@site/static/auto-generated/v6/datetime/events.md'; +import Methods from '@site/static/auto-generated/v6/datetime/methods.md'; +import Parts from '@site/static/auto-generated/v6/datetime/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/datetime/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 ab86a48426..f6d9dc6e01 100644 --- a/versioned_docs/version-v6/api/fab-button.md +++ b/versioned_docs/version-v6/api/fab-button.md @@ -1,23 +1,26 @@ --- -title: "ion-fab-button" +title: 'ion-fab-button' --- -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'; + +import Props from '@site/static/auto-generated/v6/fab-button/props.md'; +import Events from '@site/static/auto-generated/v6/fab-button/events.md'; +import Methods from '@site/static/auto-generated/v6/fab-button/methods.md'; +import Parts from '@site/static/auto-generated/v6/fab-button/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/fab-button/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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. @@ -25,19 +28,25 @@ 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 a0659a394d..8ed4d9f8a2 100644 --- a/versioned_docs/version-v6/api/fab-list.md +++ b/versioned_docs/version-v6/api/fab-list.md @@ -1,12 +1,13 @@ --- -title: "ion-fab-list" +title: 'ion-fab-list' --- -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 Props from '@site/static/auto-generated/v6/fab-list/props.md'; +import Events from '@site/static/auto-generated/v6/fab-list/events.md'; +import Methods from '@site/static/auto-generated/v6/fab-list/methods.md'; +import Parts from '@site/static/auto-generated/v6/fab-list/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/fab-list/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/fab-list/slots.md'; import EncapsulationPill from '@components/page/api/EncapsulationPill'; @@ -17,19 +18,25 @@ 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 5ecfbbd012..91dbdeb3a3 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 '@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'; +import Props from '@site/static/auto-generated/v6/fab/props.md'; +import Events from '@site/static/auto-generated/v6/fab/events.md'; +import Methods from '@site/static/auto-generated/v6/fab/methods.md'; +import Parts from '@site/static/auto-generated/v6/fab/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/fab/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 0a4820b571..cab82d5537 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 '@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'; +import Props from '@site/static/auto-generated/v6/footer/props.md'; +import Events from '@site/static/auto-generated/v6/footer/events.md'; +import Methods from '@site/static/auto-generated/v6/footer/methods.md'; +import Parts from '@site/static/auto-generated/v6/footer/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/footer/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 22ea8c2f0f..ed05619f79 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 '@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'; +import Props from '@site/static/auto-generated/v6/grid/props.md'; +import Events from '@site/static/auto-generated/v6/grid/events.md'; +import Methods from '@site/static/auto-generated/v6/grid/methods.md'; +import Parts from '@site/static/auto-generated/v6/grid/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/grid/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 a746f95536..021202cb9a 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 '@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'; +import Props from '@site/static/auto-generated/v6/header/props.md'; +import Events from '@site/static/auto-generated/v6/header/events.md'; +import Methods from '@site/static/auto-generated/v6/header/methods.md'; +import Parts from '@site/static/auto-generated/v6/header/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/header/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 aa1010e46b..86e3505c5c 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 '@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'; +import Props from '@site/static/auto-generated/v6/img/props.md'; +import Events from '@site/static/auto-generated/v6/img/events.md'; +import Methods from '@site/static/auto-generated/v6/img/methods.md'; +import Parts from '@site/static/auto-generated/v6/img/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/img/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 2647dffdb8..8f9494681e 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 '@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 Props from '@site/static/auto-generated/v6/infinite-scroll-content/props.md'; +import Events from '@site/static/auto-generated/v6/infinite-scroll-content/events.md'; +import Methods from '@site/static/auto-generated/v6/infinite-scroll-content/methods.md'; +import Parts from '@site/static/auto-generated/v6/infinite-scroll-content/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/infinite-scroll-content/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/infinite-scroll-content/slots.md'; import EncapsulationPill from '@components/page/api/EncapsulationPill'; @@ -16,19 +16,25 @@ 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 0ea2be497e..0e31edfc1f 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 '@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'; +import Props from '@site/static/auto-generated/v6/infinite-scroll/props.md'; +import Events from '@site/static/auto-generated/v6/infinite-scroll/events.md'; +import Methods from '@site/static/auto-generated/v6/infinite-scroll/methods.md'; +import Parts from '@site/static/auto-generated/v6/infinite-scroll/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/infinite-scroll/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 f9c328996e..db58657eae 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 '@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'; +import Props from '@site/static/auto-generated/v6/input/props.md'; +import Events from '@site/static/auto-generated/v6/input/events.md'; +import Methods from '@site/static/auto-generated/v6/input/methods.md'; +import Parts from '@site/static/auto-generated/v6/input/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/input/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 381d9eb414..88fd7075f4 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 '@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'; +import Props from '@site/static/auto-generated/v6/item-divider/props.md'; +import Events from '@site/static/auto-generated/v6/item-divider/events.md'; +import Methods from '@site/static/auto-generated/v6/item-divider/methods.md'; +import Parts from '@site/static/auto-generated/v6/item-divider/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/item-divider/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 c7920c017d..cd6105ae61 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 '@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'; +import Props from '@site/static/auto-generated/v6/item-group/props.md'; +import Events from '@site/static/auto-generated/v6/item-group/events.md'; +import Methods from '@site/static/auto-generated/v6/item-group/methods.md'; +import Parts from '@site/static/auto-generated/v6/item-group/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/item-group/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 800d1030f5..d48f1e6e00 100644 --- a/versioned_docs/version-v6/api/item-option.md +++ b/versioned_docs/version-v6/api/item-option.md @@ -1,42 +1,50 @@ --- -title: "ion-item-option" +title: 'ion-item-option' --- -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'; + +import Props from '@site/static/auto-generated/v6/item-option/props.md'; +import Events from '@site/static/auto-generated/v6/item-option/events.md'; +import Methods from '@site/static/auto-generated/v6/item-option/methods.md'; +import Parts from '@site/static/auto-generated/v6/item-option/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/item-option/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 + ## 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 cbee8f5289..d8d905db57 100644 --- a/versioned_docs/version-v6/api/item-options.md +++ b/versioned_docs/version-v6/api/item-options.md @@ -1,50 +1,55 @@ --- -title: "ion-item-options" +title: 'ion-item-options' --- -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'; + +import Props from '@site/static/auto-generated/v6/item-options/props.md'; +import Events from '@site/static/auto-generated/v6/item-options/events.md'; +import Methods from '@site/static/auto-generated/v6/item-options/methods.md'; +import Parts from '@site/static/auto-generated/v6/item-options/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/item-options/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 + ## 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 dba424f2b7..5b9c8a3dcf 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 '@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'; +import Props from '@site/static/auto-generated/v6/item-sliding/props.md'; +import Events from '@site/static/auto-generated/v6/item-sliding/events.md'; +import Methods from '@site/static/auto-generated/v6/item-sliding/methods.md'; +import Parts from '@site/static/auto-generated/v6/item-sliding/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/item-sliding/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 eb3df16d32..80ea8c71e8 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 '@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'; +import Props from '@site/static/auto-generated/v6/item/props.md'; +import Events from '@site/static/auto-generated/v6/item/events.md'; +import Methods from '@site/static/auto-generated/v6/item/methods.md'; +import Parts from '@site/static/auto-generated/v6/item/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/item/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 329f40c56a..d46a88edd0 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 '@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'; +import Props from '@site/static/auto-generated/v6/label/props.md'; +import Events from '@site/static/auto-generated/v6/label/events.md'; +import Methods from '@site/static/auto-generated/v6/label/methods.md'; +import Parts from '@site/static/auto-generated/v6/label/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/label/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 2410ffc044..74555bd432 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 '@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 Props from '@site/static/auto-generated/v6/list-header/props.md'; +import Events from '@site/static/auto-generated/v6/list-header/events.md'; +import Methods from '@site/static/auto-generated/v6/list-header/methods.md'; +import Parts from '@site/static/auto-generated/v6/list-header/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/list-header/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 336fe851f0..cdbb08de28 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 '@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'; +import Props from '@site/static/auto-generated/v6/list/props.md'; +import Events from '@site/static/auto-generated/v6/list/events.md'; +import Methods from '@site/static/auto-generated/v6/list/methods.md'; +import Parts from '@site/static/auto-generated/v6/list/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/list/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 c9bd57dd16..e893543271 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 '@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'; +import Props from '@site/static/auto-generated/v6/loading/props.md'; +import Events from '@site/static/auto-generated/v6/loading/events.md'; +import Methods from '@site/static/auto-generated/v6/loading/methods.md'; +import Parts from '@site/static/auto-generated/v6/loading/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/loading/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 adba980b95..0c99050db1 100644 --- a/versioned_docs/version-v6/api/menu-button.md +++ b/versioned_docs/version-v6/api/menu-button.md @@ -1,42 +1,50 @@ --- -title: "ion-menu-button" +title: 'ion-menu-button' --- -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'; + +import Props from '@site/static/auto-generated/v6/menu-button/props.md'; +import Events from '@site/static/auto-generated/v6/menu-button/events.md'; +import Methods from '@site/static/auto-generated/v6/menu-button/methods.md'; +import Parts from '@site/static/auto-generated/v6/menu-button/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/menu-button/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 + ## 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 e6a1020136..a70f5c24de 100644 --- a/versioned_docs/version-v6/api/menu-toggle.md +++ b/versioned_docs/version-v6/api/menu-toggle.md @@ -1,44 +1,52 @@ --- -title: "ion-menu-toggle" +title: 'ion-menu-toggle' --- -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'; + +import Props from '@site/static/auto-generated/v6/menu-toggle/props.md'; +import Events from '@site/static/auto-generated/v6/menu-toggle/events.md'; +import Methods from '@site/static/auto-generated/v6/menu-toggle/methods.md'; +import Parts from '@site/static/auto-generated/v6/menu-toggle/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/menu-toggle/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 + ## 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 323f90dd18..2bb6296702 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 '@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'; +import Props from '@site/static/auto-generated/v6/menu/props.md'; +import Events from '@site/static/auto-generated/v6/menu/events.md'; +import Methods from '@site/static/auto-generated/v6/menu/methods.md'; +import Parts from '@site/static/auto-generated/v6/menu/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/menu/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 68d44332e4..b616cc3eab 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 '@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'; +import Props from '@site/static/auto-generated/v6/modal/props.md'; +import Events from '@site/static/auto-generated/v6/modal/events.md'; +import Methods from '@site/static/auto-generated/v6/modal/methods.md'; +import Parts from '@site/static/auto-generated/v6/modal/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/modal/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 30a8f3264e..8da19c21b7 100644 --- a/versioned_docs/version-v6/api/nav-link.md +++ b/versioned_docs/version-v6/api/nav-link.md @@ -1,42 +1,50 @@ --- -title: "ion-nav-link" +title: 'ion-nav-link' --- -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'; + +import Props from '@site/static/auto-generated/v6/nav-link/props.md'; +import Events from '@site/static/auto-generated/v6/nav-link/events.md'; +import Methods from '@site/static/auto-generated/v6/nav-link/methods.md'; +import Parts from '@site/static/auto-generated/v6/nav-link/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/nav-link/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 + ## 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 0e4262885d..cc258d95d4 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 '@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'; +import Props from '@site/static/auto-generated/v6/nav/props.md'; +import Events from '@site/static/auto-generated/v6/nav/events.md'; +import Methods from '@site/static/auto-generated/v6/nav/methods.md'; +import Parts from '@site/static/auto-generated/v6/nav/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/nav/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 f512aaf775..f3db997780 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 '@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'; +import Props from '@site/static/auto-generated/v6/note/props.md'; +import Events from '@site/static/auto-generated/v6/note/events.md'; +import Methods from '@site/static/auto-generated/v6/note/methods.md'; +import Parts from '@site/static/auto-generated/v6/note/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/note/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 8eec3438db..2211be2db8 100644 --- a/versioned_docs/version-v6/api/picker.md +++ b/versioned_docs/version-v6/api/picker.md @@ -1,12 +1,13 @@ --- title: 'ion-picker' --- -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'; + +import Props from '@site/static/auto-generated/v6/picker/props.md'; +import Events from '@site/static/auto-generated/v6/picker/events.md'; +import Methods from '@site/static/auto-generated/v6/picker/methods.md'; +import Parts from '@site/static/auto-generated/v6/picker/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/picker/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 a65065904f..116c1f9549 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 '@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'; +import Props from '@site/static/auto-generated/v6/popover/props.md'; +import Events from '@site/static/auto-generated/v6/popover/events.md'; +import Methods from '@site/static/auto-generated/v6/popover/methods.md'; +import Parts from '@site/static/auto-generated/v6/popover/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/popover/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 f28e826e60..2f205fa14f 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 '@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'; +import Props from '@site/static/auto-generated/v6/progress-bar/props.md'; +import Events from '@site/static/auto-generated/v6/progress-bar/events.md'; +import Methods from '@site/static/auto-generated/v6/progress-bar/methods.md'; +import Parts from '@site/static/auto-generated/v6/progress-bar/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/progress-bar/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 b083ee208b..1ec4af5c6d 100644 --- a/versioned_docs/version-v6/api/radio-group.md +++ b/versioned_docs/version-v6/api/radio-group.md @@ -1,24 +1,26 @@ --- -title: "ion-radio-group" +title: 'ion-radio-group' --- -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'; + +import Props from '@site/static/auto-generated/v6/radio-group/props.md'; +import Events from '@site/static/auto-generated/v6/radio-group/events.md'; +import Methods from '@site/static/auto-generated/v6/radio-group/methods.md'; +import Parts from '@site/static/auto-generated/v6/radio-group/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/radio-group/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 @@ -40,21 +42,26 @@ interface RadioGroupCustomEvent extends CustomEvent { } ``` - ## 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 a841a55764..3cc093efe3 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 '@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'; +import Props from '@site/static/auto-generated/v6/radio/props.md'; +import Events from '@site/static/auto-generated/v6/radio/events.md'; +import Methods from '@site/static/auto-generated/v6/radio/methods.md'; +import Parts from '@site/static/auto-generated/v6/radio/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/radio/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 98492b8331..31dd840dd8 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 '@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'; +import Props from '@site/static/auto-generated/v6/range/props.md'; +import Events from '@site/static/auto-generated/v6/range/events.md'; +import Methods from '@site/static/auto-generated/v6/range/methods.md'; +import Parts from '@site/static/auto-generated/v6/range/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/range/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 1b80d4ef40..36dc4046cf 100644 --- a/versioned_docs/version-v6/api/refresher-content.md +++ b/versioned_docs/version-v6/api/refresher-content.md @@ -1,35 +1,40 @@ --- -title: "ion-refresher-content" +title: 'ion-refresher-content' --- -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'; +import Props from '@site/static/auto-generated/v6/refresher-content/props.md'; +import Events from '@site/static/auto-generated/v6/refresher-content/events.md'; +import Methods from '@site/static/auto-generated/v6/refresher-content/methods.md'; +import Parts from '@site/static/auto-generated/v6/refresher-content/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/refresher-content/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 + ## 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 1f69dd3d26..d04c7b9d9a 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 '@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'; +import Props from '@site/static/auto-generated/v6/refresher/props.md'; +import Events from '@site/static/auto-generated/v6/refresher/events.md'; +import Methods from '@site/static/auto-generated/v6/refresher/methods.md'; +import Parts from '@site/static/auto-generated/v6/refresher/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/refresher/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 674bc2561b..c0742f3502 100644 --- a/versioned_docs/version-v6/api/reorder-group.md +++ b/versioned_docs/version-v6/api/reorder-group.md @@ -1,26 +1,28 @@ --- -title: "ion-reorder-group" +title: 'ion-reorder-group' --- -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'; + +import Props from '@site/static/auto-generated/v6/reorder-group/props.md'; +import Events from '@site/static/auto-generated/v6/reorder-group/events.md'; +import Methods from '@site/static/auto-generated/v6/reorder-group/methods.md'; +import Parts from '@site/static/auto-generated/v6/reorder-group/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/reorder-group/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 @@ -44,21 +46,26 @@ interface ItemReorderCustomEvent extends CustomEvent { } ``` - ## 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 e7d5783007..182209f27f 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 '@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'; +import Props from '@site/static/auto-generated/v6/reorder/props.md'; +import Events from '@site/static/auto-generated/v6/reorder/events.md'; +import Methods from '@site/static/auto-generated/v6/reorder/methods.md'; +import Parts from '@site/static/auto-generated/v6/reorder/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/reorder/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 83f5e0b848..0600d92e48 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 '@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 Props from '@site/static/auto-generated/v6/ripple-effect/props.md'; +import Events from '@site/static/auto-generated/v6/ripple-effect/events.md'; +import Methods from '@site/static/auto-generated/v6/ripple-effect/methods.md'; +import Parts from '@site/static/auto-generated/v6/ripple-effect/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/ripple-effect/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 ac4febd161..bd337e0abd 100644 --- a/versioned_docs/version-v6/api/route-redirect.md +++ b/versioned_docs/version-v6/api/route-redirect.md @@ -1,35 +1,36 @@ --- -title: "ion-route-redirect" +title: 'ion-route-redirect' --- -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'; +import Props from '@site/static/auto-generated/v6/route-redirect/props.md'; +import Events from '@site/static/auto-generated/v6/route-redirect/events.md'; +import Methods from '@site/static/auto-generated/v6/route-redirect/methods.md'; +import Parts from '@site/static/auto-generated/v6/route-redirect/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/route-redirect/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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` -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. +- `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 @@ -48,9 +49,6 @@ 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 @@ -96,19 +94,25 @@ 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 46803354c9..d3a761af49 100644 --- a/versioned_docs/version-v6/api/route.md +++ b/versioned_docs/version-v6/api/route.md @@ -1,32 +1,33 @@ --- -title: "ion-route" +title: 'ion-route' --- + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -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'; +import Props from '@site/static/auto-generated/v6/route/props.md'; +import Events from '@site/static/auto-generated/v6/route/events.md'; +import Methods from '@site/static/auto-generated/v6/route/methods.md'; +import Parts from '@site/static/auto-generated/v6/route/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/route/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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. @@ -42,9 +43,6 @@ interface NavigationHookOptions { } ``` - - - ## Usage @@ -69,23 +67,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'); @@ -99,23 +97,21 @@ 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 @@ -124,7 +120,7 @@ import { alertController } from '@ionic/core'; @Component({ tag: 'router-example', - styleUrl: 'router-example.css' + styleUrl: 'router-example.css', }) export class RouterExample { render() { @@ -135,29 +131,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({ @@ -171,22 +167,20 @@ 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 @@ -204,24 +198,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?', @@ -234,16 +228,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; + }; ``` @@ -252,19 +246,25 @@ 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 dd87a4c935..f88b2ca058 100644 --- a/versioned_docs/version-v6/api/router-link.md +++ b/versioned_docs/version-v6/api/router-link.md @@ -1,59 +1,61 @@ --- -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 '@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'; +import Props from '@site/static/auto-generated/v6/router-link/props.md'; +import Events from '@site/static/auto-generated/v6/router-link/events.md'; +import Methods from '@site/static/auto-generated/v6/router-link/methods.md'; +import Parts from '@site/static/auto-generated/v6/router-link/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/router-link/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/router-link/slots.md'; Router Link | Navigating The ion-router-link Component - + import EncapsulationPill from '@components/page/api/EncapsulationPill'; - -

Contents

- - +

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 + ## 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 c15289ab77..6f8d664ec8 100644 --- a/versioned_docs/version-v6/api/router-outlet.md +++ b/versioned_docs/version-v6/api/router-outlet.md @@ -1,21 +1,18 @@ --- -title: "ion-router-outlet" +title: 'ion-router-outlet' --- -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 Props from '@site/static/auto-generated/v6/router-outlet/props.md'; +import Events from '@site/static/auto-generated/v6/router-outlet/events.md'; +import Methods from '@site/static/auto-generated/v6/router-outlet/methods.md'; +import Parts from '@site/static/auto-generated/v6/router-outlet/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/router-outlet/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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. @@ -24,36 +21,37 @@ 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 + ## 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 1f70135b7d..6b01daea22 100644 --- a/versioned_docs/version-v6/api/router.md +++ b/versioned_docs/version-v6/api/router.md @@ -1,29 +1,30 @@ --- -title: "ion-router" +title: 'ion-router' --- -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'; +import Props from '@site/static/auto-generated/v6/router/props.md'; +import Events from '@site/static/auto-generated/v6/router/events.md'; +import Methods from '@site/static/auto-generated/v6/router/methods.md'; +import Parts from '@site/static/auto-generated/v6/router/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/router/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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. @@ -62,8 +63,6 @@ interface RouterCustomEvent extends CustomEvent { } ``` - - ## Usage ```html @@ -90,24 +89,28 @@ interface RouterCustomEvent extends CustomEvent { - ``` - ## 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 48fc21c4ba..0c81af0f84 100644 --- a/versioned_docs/version-v6/api/row.md +++ b/versioned_docs/version-v6/api/row.md @@ -1,16 +1,20 @@ --- -title: "ion-row" +title: 'ion-row' --- -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'; + +import Props from '@site/static/auto-generated/v6/row/props.md'; +import Events from '@site/static/auto-generated/v6/row/events.md'; +import Methods from '@site/static/auto-generated/v6/row/methods.md'; +import Parts from '@site/static/auto-generated/v6/row/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/row/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/row/slots.md'; ion-row: Horizontal Row Components and Alignment | Ionic API Docs - + import EncapsulationPill from '@components/page/api/EncapsulationPill'; @@ -22,28 +26,30 @@ 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 + ## 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 5e75b8dc41..539184d7c2 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 '@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'; +import Props from '@site/static/auto-generated/v6/searchbar/props.md'; +import Events from '@site/static/auto-generated/v6/searchbar/events.md'; +import Methods from '@site/static/auto-generated/v6/searchbar/methods.md'; +import Parts from '@site/static/auto-generated/v6/searchbar/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/searchbar/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 a5a87ccd7d..975301125c 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 '@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'; +import Props from '@site/static/auto-generated/v6/segment-button/props.md'; +import Events from '@site/static/auto-generated/v6/segment-button/events.md'; +import Methods from '@site/static/auto-generated/v6/segment-button/methods.md'; +import Parts from '@site/static/auto-generated/v6/segment-button/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/segment-button/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 14f795ac0e..694011bcbf 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 '@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'; +import Props from '@site/static/auto-generated/v6/segment/props.md'; +import Events from '@site/static/auto-generated/v6/segment/events.md'; +import Methods from '@site/static/auto-generated/v6/segment/methods.md'; +import Parts from '@site/static/auto-generated/v6/segment/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/segment/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 73dbf015e2..d629c82565 100644 --- a/versioned_docs/version-v6/api/select-option.md +++ b/versioned_docs/version-v6/api/select-option.md @@ -1,42 +1,50 @@ --- -title: "ion-select-option" +title: 'ion-select-option' --- -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'; + +import Props from '@site/static/auto-generated/v6/select-option/props.md'; +import Events from '@site/static/auto-generated/v6/select-option/events.md'; +import Methods from '@site/static/auto-generated/v6/select-option/methods.md'; +import Parts from '@site/static/auto-generated/v6/select-option/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/select-option/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 + ## 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 3682cc13f0..00b15978fd 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 '@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'; +import Props from '@site/static/auto-generated/v6/select/props.md'; +import Events from '@site/static/auto-generated/v6/select/events.md'; +import Methods from '@site/static/auto-generated/v6/select/methods.md'; +import Parts from '@site/static/auto-generated/v6/select/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/select/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 86ec40d8a6..998192068c 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 '@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'; +import Props from '@site/static/auto-generated/v6/skeleton-text/props.md'; +import Events from '@site/static/auto-generated/v6/skeleton-text/events.md'; +import Methods from '@site/static/auto-generated/v6/skeleton-text/methods.md'; +import Parts from '@site/static/auto-generated/v6/skeleton-text/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/skeleton-text/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 6fb9aedacd..7ae1bace45 100644 --- a/versioned_docs/version-v6/api/slide.md +++ b/versioned_docs/version-v6/api/slide.md @@ -1,17 +1,20 @@ --- -title: "ion-slide" +title: 'ion-slide' --- -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'; +import Props from '@site/static/auto-generated/v6/slide/props.md'; +import Events from '@site/static/auto-generated/v6/slide/events.md'; +import Methods from '@site/static/auto-generated/v6/slide/methods.md'; +import Parts from '@site/static/auto-generated/v6/slide/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/slide/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/slide/slots.md'; ion-slide | Slide API Component for Ionic Framework Apps - + import EncapsulationPill from '@components/page/api/EncapsulationPill'; @@ -20,30 +23,32 @@ 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 + ## 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 6cef08674c..c12fe6d0dd 100644 --- a/versioned_docs/version-v6/api/slides.md +++ b/versioned_docs/version-v6/api/slides.md @@ -1,40 +1,39 @@ --- -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 '@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'; +import Props from '@site/static/auto-generated/v6/slides/props.md'; +import Events from '@site/static/auto-generated/v6/slides/events.md'; +import Methods from '@site/static/auto-generated/v6/slides/methods.md'; +import Parts from '@site/static/auto-generated/v6/slides/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/slides/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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. @@ -85,7 +84,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. @@ -93,7 +92,6 @@ 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 @@ -118,13 +116,11 @@ 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 @@ -132,31 +128,35 @@ 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,11 +180,13 @@ 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 @@ -199,7 +201,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`); @@ -218,10 +220,16 @@ 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(); @@ -268,31 +276,37 @@ 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); @@ -312,39 +326,50 @@ 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})`); - } 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) + $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 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 @@ -407,8 +432,8 @@ const slideOpts = { }); } }, - } -} + }, +}; ``` ### Flip @@ -455,25 +480,32 @@ 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) { @@ -481,7 +513,9 @@ 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; @@ -498,13 +532,11 @@ const slideOpts = { } }); } - } - } + }, + }, }; ``` - - ## Usage @@ -530,14 +562,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() {} } @@ -550,10 +582,8 @@ ion-slides { } ``` - - ```html @@ -581,8 +611,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 @@ -592,10 +622,8 @@ ion-slides { } ``` - - ```tsx @@ -606,7 +634,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 = () => ( @@ -635,7 +663,6 @@ ion-slides { - ```tsx @@ -643,14 +670,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() { @@ -669,7 +696,7 @@ export class SlidesExample {

Slide 3

- + , ]; } } @@ -684,7 +711,6 @@ ion-slides {
- ```html @@ -702,44 +728,48 @@ 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 abe6952071..74c04362f1 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 '@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'; +import Props from '@site/static/auto-generated/v6/spinner/props.md'; +import Events from '@site/static/auto-generated/v6/spinner/events.md'; +import Methods from '@site/static/auto-generated/v6/spinner/methods.md'; +import Parts from '@site/static/auto-generated/v6/spinner/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/spinner/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 fa5f03fc40..de6af115b4 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 '@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'; +import Props from '@site/static/auto-generated/v6/split-pane/props.md'; +import Events from '@site/static/auto-generated/v6/split-pane/events.md'; +import Methods from '@site/static/auto-generated/v6/split-pane/methods.md'; +import Parts from '@site/static/auto-generated/v6/split-pane/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/split-pane/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 5cd9d97fe3..5330663718 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 '@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'; +import Props from '@site/static/auto-generated/v6/tab-bar/props.md'; +import Events from '@site/static/auto-generated/v6/tab-bar/events.md'; +import Methods from '@site/static/auto-generated/v6/tab-bar/methods.md'; +import Parts from '@site/static/auto-generated/v6/tab-bar/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/tab-bar/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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,7 +51,6 @@ The tab bar is a UI component that contains a set of [tab buttons](tab-button.md - ```html @@ -78,7 +77,6 @@ The tab bar is a UI component that contains a set of [tab buttons](tab-button.md - ```tsx @@ -106,10 +104,8 @@ export const TabBarExample: React.FC = () => ( ); ``` - - ```tsx @@ -117,7 +113,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() { @@ -140,16 +136,14 @@ export class TabBarExample { - + , ]; } } ``` - - ```html @@ -171,16 +165,16 @@ export class TabBarExample { ``` @@ -189,19 +183,25 @@ export default defineComponent({ ## 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 1ac51b3c34..3a38d3d1d4 100644 --- a/versioned_docs/version-v6/api/tab-button.md +++ b/versioned_docs/version-v6/api/tab-button.md @@ -1,30 +1,25 @@ --- -title: "ion-tab-button" +title: 'ion-tab-button' --- + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -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 Props from '@site/static/auto-generated/v6/tab-button/props.md'; +import Events from '@site/static/auto-generated/v6/tab-button/events.md'; +import Methods from '@site/static/auto-generated/v6/tab-button/methods.md'; +import Parts from '@site/static/auto-generated/v6/tab-button/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/tab-button/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 @@ -58,10 +53,8 @@ See the [tabs documentation](tabs.md) for more details on configuring tabs. ``` - - ```html @@ -108,10 +101,8 @@ See the [tabs documentation](tabs.md) for more details on configuring tabs. ``` - - ```tsx @@ -149,10 +140,8 @@ export const TabButtonExample: React.FC = () => ( ); ``` - - ```tsx @@ -160,7 +149,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() { @@ -205,16 +194,14 @@ export class TabButtonExample { About - + , ]; } } ``` - - ```html @@ -246,50 +233,49 @@ 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 899e3c6c48..6208cc936a 100644 --- a/versioned_docs/version-v6/api/tab.md +++ b/versioned_docs/version-v6/api/tab.md @@ -1,49 +1,54 @@ --- -title: "ion-tab" +title: 'ion-tab' --- -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'; +import Props from '@site/static/auto-generated/v6/tab/props.md'; +import Events from '@site/static/auto-generated/v6/tab/events.md'; +import Methods from '@site/static/auto-generated/v6/tab/methods.md'; +import Parts from '@site/static/auto-generated/v6/tab/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/tab/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 + ## 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 c97ef58219..65efb8f85f 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 '@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'; +import Props from '@site/static/auto-generated/v6/tabs/props.md'; +import Events from '@site/static/auto-generated/v6/tabs/events.md'; +import Methods from '@site/static/auto-generated/v6/tabs/methods.md'; +import Parts from '@site/static/auto-generated/v6/tabs/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/tabs/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 c6fcee4c2d..7c12b794a9 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 '@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'; +import Props from '@site/static/auto-generated/v6/text/props.md'; +import Events from '@site/static/auto-generated/v6/text/events.md'; +import Methods from '@site/static/auto-generated/v6/text/methods.md'; +import Parts from '@site/static/auto-generated/v6/text/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/text/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 5b6def1109..6c1fd3a9cc 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 '@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'; +import Props from '@site/static/auto-generated/v6/textarea/props.md'; +import Events from '@site/static/auto-generated/v6/textarea/events.md'; +import Methods from '@site/static/auto-generated/v6/textarea/methods.md'; +import Parts from '@site/static/auto-generated/v6/textarea/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/textarea/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 f21d2f25b5..298be33324 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 '@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'; +import Props from '@site/static/auto-generated/v6/thumbnail/props.md'; +import Events from '@site/static/auto-generated/v6/thumbnail/events.md'; +import Methods from '@site/static/auto-generated/v6/thumbnail/methods.md'; +import Parts from '@site/static/auto-generated/v6/thumbnail/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/thumbnail/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 07a1a36eb0..b85c867cfe 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 '@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'; +import Props from '@site/static/auto-generated/v6/title/props.md'; +import Events from '@site/static/auto-generated/v6/title/events.md'; +import Methods from '@site/static/auto-generated/v6/title/methods.md'; +import Parts from '@site/static/auto-generated/v6/title/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/title/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 de515e72bb..4ee9eadc07 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 '@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'; +import Props from '@site/static/auto-generated/v6/toast/props.md'; +import Events from '@site/static/auto-generated/v6/toast/events.md'; +import Methods from '@site/static/auto-generated/v6/toast/methods.md'; +import Parts from '@site/static/auto-generated/v6/toast/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/toast/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 bb22c827d6..ce0e43ada7 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 '@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'; +import Props from '@site/static/auto-generated/v6/toggle/props.md'; +import Events from '@site/static/auto-generated/v6/toggle/events.md'; +import Methods from '@site/static/auto-generated/v6/toggle/methods.md'; +import Parts from '@site/static/auto-generated/v6/toggle/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/toggle/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 dbd61f8581..7155b8f44b 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 '@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'; +import Props from '@site/static/auto-generated/v6/toolbar/props.md'; +import Events from '@site/static/auto-generated/v6/toolbar/events.md'; +import Methods from '@site/static/auto-generated/v6/toolbar/methods.md'; +import Parts from '@site/static/auto-generated/v6/toolbar/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/toolbar/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 84f85ac329..def6bebc5c 100644 --- a/versioned_docs/version-v6/api/virtual-scroll.md +++ b/versioned_docs/version-v6/api/virtual-scroll.md @@ -1,27 +1,28 @@ --- -title: "ion-virtual-scroll" +title: 'ion-virtual-scroll' --- -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'; +import Props from '@site/static/auto-generated/v6/virtual-scroll/props.md'; +import Events from '@site/static/auto-generated/v6/virtual-scroll/events.md'; +import Methods from '@site/static/auto-generated/v6/virtual-scroll/methods.md'; +import Parts from '@site/static/auto-generated/v6/virtual-scroll/parts.md'; +import CustomProps from '@site/static/auto-generated/v6/virtual-scroll/custom-props.md'; +import Slots from '@site/static/auto-generated/v6/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 @@ -43,7 +44,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. @@ -85,7 +86,6 @@ 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,13 +131,12 @@ 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 @@ -147,10 +146,10 @@ dataset, so please make sure they're performant.
- - {{ item.name }} - - {{ item.content }} + + {{ item.name }} + + {{ item.content }} @@ -167,7 +166,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++; @@ -178,7 +177,8 @@ 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,9 +212,7 @@ The data given to the `items` property must be an array. An item template with t ```html - - {{ item }} - + {{ item }} ``` @@ -230,12 +228,8 @@ return `null` if a template shouldn't be created. ```html - - {{ header }} - - - Item: {{ item }} - + {{ header }} + Item: {{ item }} ``` @@ -256,7 +250,6 @@ myHeaderFn(record, recordIndex, records) { } ``` - ### Custom Components If a custom component is going to be used within Virtual Scroll, it's best @@ -267,27 +260,31 @@ 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 + +