diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a0938dbe5b..d810e00760 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -227,6 +227,8 @@ Use Markdown for links and headings whenever possible. When you need JSX, such a - [``](https://docusaurus.io/docs/docusaurus-core#link) from `@docusaurus/Link` instead of ``. It handles the base URL and locale, and opens external URLs in a new tab with `rel="noopener noreferrer"`. - [``](https://docusaurus.io/docs/api/misc/@docusaurus/eslint-plugin/prefer-docusaurus-heading) from `@theme/Heading` instead of `

` to `

`. +Link to another doc by its relative file path, with the extension, such as `[Accordion](./accordion.mdx)` or `[Config](../developing/config.mdx)`. Docusaurus resolves it to the page in the same version, the build fails if the file doesn't exist, and editors can follow it to the file. A JSX prop such as `href` skips that step, so use the URL path without `/docs` or an extension instead: `/api/accordion`, or `/v8/api/accordion` on a v8 page. + The build only checks links and anchors that go through Markdown or these components. A raw `` to a page that doesn't exist builds without errors, and a raw heading's `id` can't be used as a link target. Markup inside code samples is exempt, since it's example code rather than part of the page. CI fails on a raw `` or heading anywhere else. To check before pushing, run: diff --git a/docs/angular/add-to-existing.mdx b/docs/angular/add-to-existing.mdx index 2ef3d72357..1ab3c14e64 100644 --- a/docs/angular/add-to-existing.mdx +++ b/docs/angular/add-to-existing.mdx @@ -14,7 +14,7 @@ import DocsCards from '@components/global/DocsCards'; /> -This guide covers how to add Ionic Angular to an existing Angular project. If you're looking to start a new project from scratch, check out the [Ionic Angular Quickstart](/angular/quickstart.mdx) guide. For an overview of how Ionic Angular works with Angular, including version support and tooling, check out the [Ionic Angular Overview](/angular/overview.mdx). +This guide covers how to add Ionic Angular to an existing Angular project. If you're looking to start a new project from scratch, check out the [Ionic Angular Quickstart](./quickstart.mdx) guide. For an overview of how Ionic Angular works with Angular, including version support and tooling, check out the [Ionic Angular Overview](./overview.mdx). :::tip @@ -76,7 +76,7 @@ Replace the existing `styles` array in `angular.json` with the following: :::info -While `core.css` is required, `normalize.css`, `structure.css`, and `typography.css` are recommended but not required. They normalize cross-browser differences, ensure proper scrolling behavior, and provide consistent typography and form styling. Without them, you may need to handle these concerns yourself. For more details, refer to [Global Stylesheets](/layout/global-stylesheets.mdx). +While `core.css` is required, `normalize.css`, `structure.css`, and `typography.css` are recommended but not required. They normalize cross-browser differences, ensure proper scrolling behavior, and provide consistent typography and form styling. Without them, you may need to handle these concerns yourself. For more details, refer to [Global Stylesheets](../layout/global-stylesheets.mdx). ::: @@ -96,7 +96,7 @@ export const appConfig: ApplicationConfig = { }; ``` -This reflects the Angular 21 and 22 scaffold, which is zoneless by default. If your existing app is on Angular 18 through 20, it still has `provideZoneChangeDetection({ eventCoalescing: true })`; keep that provider and add `provideIonicAngular({})` alongside it. Refer to [Zoneless Change Detection](/angular/zoneless.mdx) for details. +This reflects the Angular 21 and 22 scaffold, which is zoneless by default. If your existing app is on Angular 18 through 20, it still has `provideZoneChangeDetection({ eventCoalescing: true })`; keep that provider and add `provideIonicAngular({})` alongside it. Refer to [Zoneless Change Detection](./zoneless.mdx) for details. ## Using Individual Components {/* #using-individual-components */} @@ -123,7 +123,7 @@ import { IonButton, IonDatetime } from '@ionic/angular'; export class App {} ``` -Visit the [components](/components.mdx) page for all of the available Ionic components. +Visit the [components](../components.mdx) page for all of the available Ionic components. ## Using Ionic Pages {/* #using-ionic-pages */} @@ -172,7 +172,7 @@ Replace the existing `styles` array in `angular.json` with the following: ] ``` -These stylesheets set up the overall page structure and provide [CSS utilities](/layout/css-utilities.mdx) for faster development. Some stylesheets are optional. For details on which stylesheets are required, check out [Global Stylesheets](/layout/global-stylesheets.mdx). +These stylesheets set up the overall page structure and provide [CSS utilities](../layout/css-utilities.mdx) for faster development. Some stylesheets are optional. For details on which stylesheets are required, check out [Global Stylesheets](../layout/global-stylesheets.mdx). #### 2. Set up Theming {/* #2-set-up-theming */} @@ -191,7 +191,7 @@ Create a `src/theme/variables.css` file with the following content: @import '@ionic/angular/css/palettes/dark.system.css'; ``` -This file enables [dark mode support](/theming/dark-mode.mdx) for your Ionic app when the system is set to prefer a dark appearance. You can customize the theming behavior by uncommenting different dark palette imports or adding custom CSS variables. +This file enables [dark mode support](../theming/dark-mode.mdx) for your Ionic app when the system is set to prefer a dark appearance. You can customize the theming behavior by uncommenting different dark palette imports or adding custom CSS variables. #### 3. Update the App Component {/* #3-update-the-app-component */} @@ -322,7 +322,7 @@ Now that you have Ionic Angular integrated into your project, check out: - +

Discover how to handle routing and navigation in Ionic Angular apps using the Angular Router.

diff --git a/docs/angular/build-options.mdx b/docs/angular/build-options.mdx index f9dc9e3323..a6de6ba6ce 100644 --- a/docs/angular/build-options.mdx +++ b/docs/angular/build-options.mdx @@ -47,7 +47,7 @@ All Ionic imports should be imported from the `@ionic/angular` submodule. This i **Bootstrapping and Configuration** -Ionic Angular needs to be configured when the Angular application calls `bootstrapApplication` using the `provideIonicAngular` function. Developers can pass any [IonicConfig](../developing/config#ionicconfig) values as an object in this function. Note that `provideIonicAngular` needs to be called even if no custom config is passed. +Ionic Angular needs to be configured when the Angular application calls `bootstrapApplication` using the `provideIonicAngular` function. Developers can pass any [IonicConfig](../developing/config.mdx#ionicconfig) values as an object in this function. Note that `provideIonicAngular` needs to be called even if no custom config is passed. ```typescript title="main.ts" import { enableProdMode, importProvidersFrom } from '@angular/core'; @@ -216,7 +216,7 @@ All Ionic imports should be imported from the `@ionic/angular` submodule. This i **Bootstrapping and Configuration** -Ionic Angular needs to be configured in the `providers` array of `app.module.ts` using the `provideIonicAngular` function. Developers can pass any [IonicConfig](../developing/config#ionicconfig) values as an object in this function. Note that `provideIonicAngular` needs to be called even if no custom config is passed. +Ionic Angular needs to be configured in the `providers` array of `app.module.ts` using the `provideIonicAngular` function. Developers can pass any [IonicConfig](../developing/config.mdx#ionicconfig) values as an object in this function. Note that `provideIonicAngular` needs to be called even if no custom config is passed. ```typescript title="app.module.ts" import { NgModule } from '@angular/core'; diff --git a/docs/angular/lifecycle.mdx b/docs/angular/lifecycle.mdx index 4450d54e4e..a8c17e4bf1 100644 --- a/docs/angular/lifecycle.mdx +++ b/docs/angular/lifecycle.mdx @@ -32,7 +32,7 @@ If your pages keep state in plain fields rather than signals, the component host On **Angular 18 through 21** this only affects you if you set `OnPush` on those components yourself, because a component that does not declare a strategy is eager. -**Angular 22** makes `OnPush` the default for components that do not declare one, so refer to [Change detection on Angular 22](/angular/zoneless.mdx#change-detection-on-angular-22) for what your app shell has to declare. +**Angular 22** makes `OnPush` the default for components that do not declare one, so refer to [Change detection on Angular 22](./zoneless.mdx#change-detection-on-angular-22) for what your app shell has to declare. ::: diff --git a/docs/angular/overview.mdx b/docs/angular/overview.mdx index 1fb4aa3982..a19b9752b7 100644 --- a/docs/angular/overview.mdx +++ b/docs/angular/overview.mdx @@ -18,7 +18,7 @@ import DocsCards from '@components/global/DocsCards'; ## Angular Version Support {/* #angular-version-support */} -Ionic Angular v9 supports Angular versions 18 through 22. For detailed information on supported versions and our support policy, refer to the [Ionic Angular Support Policy](/reference/support.mdx#ionic-angular). +Ionic Angular v9 supports Angular versions 18 through 22. For detailed information on supported versions and our support policy, refer to the [Ionic Angular Support Policy](../reference/support.mdx#ionic-angular). ## Angular Tooling {/* #angular-tooling */} @@ -44,7 +44,7 @@ $ ionic serve █ - +

Quickly set up your first Ionic Angular app and learn the basics of the framework and CLI.

@@ -52,7 +52,7 @@ $ ionic serve █

Learn more about Angular's core concepts, tools, and best practices from the official Angular documentation.

- +

Discover how to handle routing and navigation in Ionic Angular apps using the Angular Router.

diff --git a/docs/angular/platform.mdx b/docs/angular/platform.mdx index d11ebf80db..55bc767c9c 100644 --- a/docs/angular/platform.mdx +++ b/docs/angular/platform.mdx @@ -93,7 +93,7 @@ Below is a table listing all the possible platform values along with correspondi #### Customizing Platform Detection Functions {/* #customizing-platform-detection-functions */} -The function used to detect a specific platform can be overridden by providing an alternative function in the global [Ionic config](../developing/config). Each function takes `window` as a parameter and returns a boolean. +The function used to detect a specific platform can be overridden by providing an alternative function in the global [Ionic config](../developing/config.mdx). Each function takes `window` as a parameter and returns a boolean. ``` -This creates a page with a header and scrollable content area. The second header shows a [collapsible large title](/api/title.mdx#collapsible-large-titles) that displays on iOS devices when at the top of the content, then condenses to show the smaller title in the first header when scrolling down. +This creates a page with a header and scrollable content area. The second header shows a [collapsible large title](../api/title.mdx#collapsible-large-titles) that displays on iOS devices when at the top of the content, then condenses to show the smaller title in the first header when scrolling down. :::tip[Learn More] -For detailed information about Ionic layout components, refer to the [Header](/api/header.mdx), [Toolbar](/api/toolbar.mdx), [Title](/api/title.mdx), and [Content](/api/content.mdx) documentation. +For detailed information about Ionic layout components, refer to the [Header](../api/header.mdx), [Toolbar](../api/toolbar.mdx), [Title](../api/title.mdx), and [Content](../api/content.mdx) documentation. ::: ## Add an Ionic Component {/* #add-an-ionic-component */} -You can enhance your Home page with more Ionic UI components. For example, add a [Button](/api/button.mdx) at the end of the `ion-content`: +You can enhance your Home page with more Ionic UI components. For example, add a [Button](../api/button.mdx) at the end of the `ion-content`: ```html title="src/app/home/home.page.html" @@ -214,7 +214,7 @@ ionic generate page new A route will be automatically added to `app.routes.ts`. -In `new.page.html`, you can add a [Back Button](/api/back-button.mdx) to the [Toolbar](/api/toolbar.mdx): +In `new.page.html`, you can add a [Back Button](../api/back-button.mdx) to the [Toolbar](../api/toolbar.mdx): ```html title="src/app/new/new.page.html" @@ -261,7 +261,7 @@ import { RouterLink } from '@angular/router'; :::info -Navigating can also be performed using Angular's Router service. Refer to the [Angular Navigation documentation](/angular/navigation.mdx#navigating-to-different-routes) for more information. +Navigating can also be performed using Angular's Router service. Refer to the [Angular Navigation documentation](./navigation.mdx#navigating-to-different-routes) for more information. ::: @@ -306,7 +306,7 @@ export class NewPage implements OnInit { Alternatively, you can register icons in `app.component.ts` to use them throughout your app. -For more information, refer to the [Icon documentation](/api/icon.mdx) and the [Ionicons documentation](https://ionic.io/ionicons/). +For more information, refer to the [Icon documentation](../api/icon.mdx) and the [Ionicons documentation](https://ionic.io/ionicons/). ## Call Component Methods {/* #call-component-methods */} @@ -392,7 +392,7 @@ To call methods on Ionic components: 1. Create a `ViewChild` reference for the component 2. Call the method directly on the component instance -You can find available methods for each component in the [Methods](/api/content.mdx#methods) section of their API documentation. +You can find available methods for each component in the [Methods](../api/content.mdx#methods) section of their API documentation. ## Run on a Device {/* #run-on-a-device */} @@ -419,7 +419,7 @@ This guide covered the basics of creating an Ionic Angular app, adding navigatio - +

Build a real Photo Gallery app with Ionic Angular and native device features.

@@ -427,7 +427,7 @@ This guide covered the basics of creating an Ionic Angular app, adding navigatio

Learn more about Angular's core concepts, tools, and best practices from the official Angular documentation.

- +

Discover how to handle routing and navigation in Ionic Angular apps using the Angular Router.

diff --git a/docs/angular/your-first-app.mdx b/docs/angular/your-first-app.mdx index 89c4ce5f26..8e49383a74 100644 --- a/docs/angular/your-first-app.mdx +++ b/docs/angular/your-first-app.mdx @@ -32,7 +32,7 @@ Highlights include: - One Angular-based codebase that runs on the web, iOS, and Android using Ionic Framework [UI components](../components.mdx). - Deployed as a native iOS and Android mobile app using [Capacitor](https://capacitorjs.com), Ionic's official native app runtime. -- Photo Gallery functionality powered by the Capacitor [Camera](/native/camera.mdx), [Filesystem](/native/filesystem.mdx), and [Preferences](/native/preferences.mdx) APIs. +- Photo Gallery functionality powered by the Capacitor [Camera](../native/camera.mdx), [Filesystem](../native/filesystem.mdx), and [Preferences](../native/preferences.mdx) APIs. Find the [complete app code](https://github.com/ionic-team/tutorial-photo-gallery-angular) referenced in this guide on GitHub. @@ -98,7 +98,7 @@ npm install @capacitor/camera @capacitor/preferences @capacitor/filesystem ### PWA Elements {/* #pwa-elements */} -Some Capacitor plugins, including the [Camera API](/native/camera.mdx), provide the web-based functionality and UI via the Ionic [PWA Elements library](https://github.com/ionic-team/pwa-elements). +Some Capacitor plugins, including the [Camera API](../native/camera.mdx), provide the web-based functionality and UI via the Ionic [PWA Elements library](https://github.com/ionic-team/pwa-elements). It's a separate dependency, so install it next: diff --git a/docs/angular/your-first-app/2-taking-photos.mdx b/docs/angular/your-first-app/2-taking-photos.mdx index f9bea16149..8dab03dd0f 100644 --- a/docs/angular/your-first-app/2-taking-photos.mdx +++ b/docs/angular/your-first-app/2-taking-photos.mdx @@ -11,7 +11,7 @@ sidebar_label: Taking Photos /> -Now for the fun part - adding the ability to take photos with the device’s camera using the Capacitor [Camera API](/native/camera.mdx). We’ll begin with building it for the web, then make some small tweaks to make it work on mobile (iOS and Android). +Now for the fun part - adding the ability to take photos with the device’s camera using the Capacitor [Camera API](../../native/camera.mdx). We’ll begin with building it for the web, then make some small tweaks to make it work on mobile (iOS and Android). ## Photo Service {/* #photo-service */} diff --git a/docs/angular/your-first-app/3-saving-photos.mdx b/docs/angular/your-first-app/3-saving-photos.mdx index 73eac223d1..33fe92a56a 100644 --- a/docs/angular/your-first-app/3-saving-photos.mdx +++ b/docs/angular/your-first-app/3-saving-photos.mdx @@ -87,7 +87,7 @@ export interface UserPhoto { } ``` -We'll use the Capacitor [Filesystem API](/native/filesystem.mdx) to save the photo. First, convert the photo to base64 format. +We'll use the Capacitor [Filesystem API](../../native/filesystem.mdx) to save the photo. First, convert the photo to base64 format. Then, pass the data to the Filesystem's `writeFile` method. Recall that we display photos by setting the image's source path (`src`) to the `webviewPath` property. So, set the `webviewPath` and return the new `Photo` object. diff --git a/docs/angular/your-first-app/4-loading-photos.mdx b/docs/angular/your-first-app/4-loading-photos.mdx index 6b92091810..2cc91d12e7 100644 --- a/docs/angular/your-first-app/4-loading-photos.mdx +++ b/docs/angular/your-first-app/4-loading-photos.mdx @@ -13,7 +13,7 @@ sidebar_label: Loading Photos We’ve implemented photo taking and saving to the filesystem. There’s one last piece of functionality missing: the photos are stored in the filesystem, but we need a way to save pointers to each file so that they can be displayed again in the photo gallery. -Fortunately, this is easy: we’ll leverage the Capacitor [Preferences API](/native/preferences.mdx) to store our array of Photos in a key-value store. +Fortunately, this is easy: we’ll leverage the Capacitor [Preferences API](../../native/preferences.mdx) to store our array of Photos in a key-value store. ## Preferences API {/* #preferences-api */} diff --git a/docs/angular/zoneless.mdx b/docs/angular/zoneless.mdx index dfe025eadc..d39b0ee6f6 100644 --- a/docs/angular/zoneless.mdx +++ b/docs/angular/zoneless.mdx @@ -28,7 +28,7 @@ You do not need to change these. Angular schedules change detection for them in :::note[Angular 22] -Angular 22 also makes `OnPush` the default change detection strategy. Under `OnPush`, synchronous state set as a plain field (including in the lifecycle hooks above) no longer re-renders on its own, even though Ionic notifies Angular. Signals still update the view. Refer to [Change detection on Angular 22](#change-detection-on-angular-22) for what this means for your app shell, and to the [OnPush Change Detection section of the Ionic 9 upgrade guide](/updating/9-0.mdx#onpush-change-detection-on-angular-22) for the migration steps. +Angular 22 also makes `OnPush` the default change detection strategy. Under `OnPush`, synchronous state set as a plain field (including in the lifecycle hooks above) no longer re-renders on its own, even though Ionic notifies Angular. Signals still update the view. Refer to [Change detection on Angular 22](#change-detection-on-angular-22) for what this means for your app shell, and to the [OnPush Change Detection section of the Ionic 9 upgrade guide](../updating/9-0.mdx#onpush-change-detection-on-angular-22) for the migration steps. ::: @@ -174,4 +174,4 @@ Hosting an `ion-nav` is fine either way, because its pages are attached as root ## Staying on Zone.js {/* #staying-on-zonejs */} -If you are not ready to adopt zoneless change detection, you can opt back into Zone.js with `provideZoneChangeDetection()`. Refer to the [Keeping Zone.js section of the Ionic 9 upgrade guide](/updating/9-0.mdx#keeping-zonejs) for the exact configuration. +If you are not ready to adopt zoneless change detection, you can opt back into Zone.js with `provideZoneChangeDetection()`. Refer to the [Keeping Zone.js section of the Ionic 9 upgrade guide](../updating/9-0.mdx#keeping-zonejs) for the exact configuration. diff --git a/docs/api.mdx b/docs/api.mdx index 161ba1b8a3..501f9a836b 100644 --- a/docs/api.mdx +++ b/docs/api.mdx @@ -12,6 +12,6 @@ import APIList from '@components/page/api/APIList'; /> -Each Ionic [component](/components.mdx) consists of one or more [custom elements](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_custom_elements). Each custom element, in turn, may expose properties, methods, events, and CSS custom properties. +Each Ionic [component](./components.mdx) consists of one or more [custom elements](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_custom_elements). Each custom element, in turn, may expose properties, methods, events, and CSS custom properties. diff --git a/docs/api/accordion-group.mdx b/docs/api/accordion-group.mdx index b168fafb79..8504a503c2 100644 --- a/docs/api/accordion-group.mdx +++ b/docs/api/accordion-group.mdx @@ -15,7 +15,7 @@ import EncapsulationPill from '@components/page/api/EncapsulationPill'; Accordion group is a container for accordion instances. It manages the state of the accordions and provides keyboard navigation. -Refer to the [Accordion](./accordion) documentation for more information. +Refer to the [Accordion](./accordion.mdx) documentation for more information. ## Interfaces {/* #interfaces */} diff --git a/docs/api/accordion.mdx b/docs/api/accordion.mdx index 7ab8d8928d..d97f81f465 100644 --- a/docs/api/accordion.mdx +++ b/docs/api/accordion.mdx @@ -41,7 +41,7 @@ import Toggle from '@site/static/usage/v9/accordion/toggle/index.mdx'; :::caution -Most `ionChange` events emitted by other components such as [Input](./input) and [Textarea](./textarea) bubble. As a result, these events will bubble up and cause your `ionChange` listener on the Accordion Group to fire if the associated components are used inside of an Accordion. +Most `ionChange` events emitted by other components such as [Input](./input.mdx) and [Textarea](./textarea.mdx) bubble. As a result, these events will bubble up and cause your `ionChange` listener on the Accordion Group to fire if the associated components are used inside of an Accordion. When using other components that emit `ionChange` inside of Accordion it is recommended to have the `ionChange` callback on Accordion Group check the `target` key on the event passed to the callback to verify that `ionChange` is coming from the Accordion Group and not any descendants. @@ -159,7 +159,7 @@ import Icons from '@site/static/usage/v9/accordion/customization/icons/index.mdx ### Theming {/* #theming */} -Since `ion-accordion` acts as a shell around the header and content elements, you can easily theme the accordion however you would like. You can theme the header by targeting the slotted `ion-item`. Since you are using `ion-item`, you also have access to all of the [ion-item CSS Variables](./item#css-custom-properties) and [ion-item Shadow Parts](./item#css-shadow-parts). Theming the content is also easily achieved by targeting the element that is in the `content` slot. +Since `ion-accordion` acts as a shell around the header and content elements, you can easily theme the accordion however you would like. You can theme the header by targeting the slotted `ion-item`. Since you are using `ion-item`, you also have access to all of the [ion-item CSS Variables](./item.mdx#css-custom-properties) and [ion-item Shadow Parts](./item.mdx#css-shadow-parts). Theming the content is also easily achieved by targeting the element that is in the `content` slot. import Theming from '@site/static/usage/v9/accordion/customization/theming/index.mdx'; @@ -201,7 +201,7 @@ For example, lazily loading images may cause layout shifts as they load. As the 2. Reserve space for the image ahead of time. If you need lazy loading and know the dimensions of the images (such as loading icons of the same size), set a width and height on the `` using its attributes or CSS. This gives you the benefit of lazy loading while avoiding layout shifts. -3. If neither of these options are applicable, developers may want to consider disabling animations altogether by using the `animated` property on [ion-accordion-group](./accordion-group). +3. If neither of these options are applicable, developers may want to consider disabling animations altogether by using the `animated` property on [ion-accordion-group](./accordion-group.mdx). ## Properties {/* #properties */} diff --git a/docs/api/action-sheet.mdx b/docs/api/action-sheet.mdx index 1c0ba71a6c..166b0e68f4 100644 --- a/docs/api/action-sheet.mdx +++ b/docs/api/action-sheet.mdx @@ -102,7 +102,7 @@ import CssCustomProperties from '@site/static/usage/v9/action-sheet/theming/css- ### Screen Readers {/* #screen-readers */} -Action Sheets set aria properties in order to be [accessible](../reference/glossary#a11y) to screen readers, but these properties can be overridden if they aren't descriptive enough or don't align with how the action sheet is being used in an app. +Action Sheets set aria properties in order to be [accessible](../reference/glossary.mdx#a11y) to screen readers, but these properties can be overridden if they aren't descriptive enough or don't align with how the action sheet is being used in an app. #### Role {/* #role */} diff --git a/docs/api/alert.mdx b/docs/api/alert.mdx index 170e17fde8..850e6d1070 100644 --- a/docs/api/alert.mdx +++ b/docs/api/alert.mdx @@ -118,7 +118,7 @@ If you are building an Ionic Angular app, the styles need to be added to a globa ### Screen Readers {/* #screen-readers */} -Alerts set aria properties in order to be [accessible](../reference/glossary#a11y) to screen readers, but these properties can be overridden if they aren't descriptive enough or don't align with how the alert is being used in an app. +Alerts set aria properties in order to be [accessible](../reference/glossary.mdx#a11y) to screen readers, but these properties can be overridden if they aren't descriptive enough or don't align with how the alert is being used in an app. #### Role {/* #role */} diff --git a/docs/api/app.mdx b/docs/api/app.mdx index b4f87b3d58..32c36ced24 100644 --- a/docs/api/app.mdx +++ b/docs/api/app.mdx @@ -23,11 +23,11 @@ App is a container element for an Ionic application. There should only be one `< 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 +- [Keyboard Lifecycle Events](../developing/keyboard.mdx#keyboard-lifecycle-events) without the need for any native plugins +- [Hardware Back Button Listeners](../developing/hardware-back-button.mdx) 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 +- [Ripple effect](./ripple-effect.mdx) when activating buttons on Material Design mode - Other tap and focus utilities which make the experience of using an Ionic app feel more native ## Programmatic Focus {/* #programmatic-focus */} diff --git a/docs/api/back-button.mdx b/docs/api/back-button.mdx index 88ae38cc7e..6ad1eb452c 100644 --- a/docs/api/back-button.mdx +++ b/docs/api/back-button.mdx @@ -31,7 +31,7 @@ import Basic from '@site/static/usage/v9/back-button/basic/index.mdx'; ## Custom Back Button {/* #custom-back-button */} -By default, the back button will display the text `"Back"` with a `"chevron-back"` icon on `ios`, and an `"arrow-back-sharp"` icon on `md`. This can be customized per back button component by setting the `icon` or `text` properties. Alternatively, it can be set globally using the `backButtonIcon` or `backButtonText` properties in the global config. Refer to the [Config docs](../developing/config) for more information. +By default, the back button will display the text `"Back"` with a `"chevron-back"` icon on `ios`, and an `"arrow-back-sharp"` icon on `md`. This can be customized per back button component by setting the `icon` or `text` properties. Alternatively, it can be set globally using the `backButtonIcon` or `backButtonText` properties in the global config. Refer to the [Config docs](../developing/config.mdx) for more information. import Custom from '@site/static/usage/v9/back-button/custom/index.mdx'; diff --git a/docs/api/breadcrumb.mdx b/docs/api/breadcrumb.mdx index 2ef9d9d0d0..010b10cbfc 100644 --- a/docs/api/breadcrumb.mdx +++ b/docs/api/breadcrumb.mdx @@ -15,7 +15,7 @@ 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. -Refer to the [Breadcrumbs](./breadcrumbs) documentation for more information. +Refer to the [Breadcrumbs](./breadcrumbs.mdx) documentation for more information. ## Interfaces {/* #interfaces */} diff --git a/docs/api/buttons.mdx b/docs/api/buttons.mdx index 5f9f8de81e..bf828f6364 100644 --- a/docs/api/buttons.mdx +++ b/docs/api/buttons.mdx @@ -21,7 +21,7 @@ import EncapsulationPill from '@components/page/api/EncapsulationPill'; -The Buttons component is a container element. It should be used inside of a [toolbar](./toolbar) and can contain several types of buttons, including standard [buttons](./button), [menu buttons](./menu-button), and [back buttons](./back-button). +The Buttons component is a container element. It should be used inside of a [toolbar](./toolbar.mdx) and can contain several types of buttons, including standard [buttons](./button.mdx), [menu buttons](./menu-button.mdx), and [back buttons](./back-button.mdx). ## Basic Usage {/* #basic-usage */} @@ -46,7 +46,7 @@ import Placement from '@site/static/usage/v9/buttons/placement/index.mdx'; ## Types of Buttons {/* #types-of-buttons */} -A button in a toolbar is styled to be clear by default, but this can be changed using the [`fill`](./button#fill) property on the button. The properties included on [back button](./back-button) and [menu button](./menu-button) in this example are for display purposes; refer to their respective documentation for proper usage. +A button in a toolbar is styled to be clear by default, but this can be changed using the [`fill`](./button.mdx#fill) property on the button. The properties included on [back button](./back-button.mdx) and [menu button](./menu-button.mdx) in this example are for display purposes; refer to their respective documentation for proper usage. import Types from '@site/static/usage/v9/buttons/types/index.mdx'; @@ -54,7 +54,7 @@ import Types from '@site/static/usage/v9/buttons/types/index.mdx'; ## Collapsible Buttons {/* #collapsible-buttons */} -The `collapse` property can be set on the buttons to collapse them when the header collapses. This is typically used with [collapsible large titles](./title#collapsible-large-titles). +The `collapse` property can be set on the buttons to collapse them when the header collapses. This is typically used with [collapsible large titles](./title.mdx#collapsible-large-titles). :::info diff --git a/docs/api/card-content.mdx b/docs/api/card-content.mdx index a81f1e8aef..3df180c400 100644 --- a/docs/api/card-content.mdx +++ b/docs/api/card-content.mdx @@ -13,7 +13,7 @@ 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. -Refer to the [Card](./card) documentation for more information. +Refer to the [Card](./card.mdx) documentation for more information. ## Properties {/* #properties */} diff --git a/docs/api/card-header.mdx b/docs/api/card-header.mdx index 958eb43452..b3c0141a46 100644 --- a/docs/api/card-header.mdx +++ b/docs/api/card-header.mdx @@ -13,9 +13,9 @@ 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). +Card header is a child component of card that should be placed before the card content. It can contain a [card title](./card-title.mdx) and a [card subtitle](./card-subtitle.mdx). -Refer to the [Card](./card) documentation for more information. +Refer to the [Card](./card.mdx) documentation for more information. ## Properties {/* #properties */} diff --git a/docs/api/card-subtitle.mdx b/docs/api/card-subtitle.mdx index 3cab74c6fc..9d435fdd47 100644 --- a/docs/api/card-subtitle.mdx +++ b/docs/api/card-subtitle.mdx @@ -13,9 +13,9 @@ 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). +Card subtitle is a child component of card that should be placed inside of a [card header](./card-header.mdx). -Refer to the [Card](./card) documentation for more information. +Refer to the [Card](./card.mdx) documentation for more information. ## Properties {/* #properties */} diff --git a/docs/api/card-title.mdx b/docs/api/card-title.mdx index 15752ea276..2272dee3be 100644 --- a/docs/api/card-title.mdx +++ b/docs/api/card-title.mdx @@ -21,9 +21,9 @@ import EncapsulationPill from '@components/page/api/EncapsulationPill'; -Card title is a child component of card that should be placed inside of a [card header](./card-header). +Card title is a child component of card that should be placed inside of a [card header](./card-header.mdx). -Refer to the [Card](./card) documentation for more information. +Refer to the [Card](./card.mdx) documentation for more information. ## Properties {/* #properties */} diff --git a/docs/api/card.mdx b/docs/api/card.mdx index 9913ba0a9f..4a0cc037b7 100644 --- a/docs/api/card.mdx +++ b/docs/api/card.mdx @@ -21,7 +21,7 @@ import EncapsulationPill from '@components/page/api/EncapsulationPill'; -Cards are containers that display content such as text, images, buttons, and lists. A card can be a single component, but is often made up of a header, title, subtitle, and content. Cards are broken up into several components to accommodate this structure: [card header](./card-header), [card title](./card-title), [card subtitle](./card-subtitle), and [card content](./card-content). +Cards are containers that display content such as text, images, buttons, and lists. A card can be a single component, but is often made up of a header, title, subtitle, and content. Cards are broken up into several components to accommodate this structure: [card header](./card-header.mdx), [card title](./card-title.mdx), [card subtitle](./card-subtitle.mdx), and [card content](./card-content.mdx). ## Basic Usage {/* #basic-usage */} diff --git a/docs/api/col.mdx b/docs/api/col.mdx index e3338a6ba8..71fe4c2cac 100644 --- a/docs/api/col.mdx +++ b/docs/api/col.mdx @@ -21,13 +21,13 @@ 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. +Columns are cellular components of the [grid](./grid.mdx) system and go inside of a [row](./row.mdx). They will expand to fill the row. All content within a grid should go inside of a column. -Refer to the [grid](./grid) documentation for more information. +Refer to the [grid](./grid.mdx) documentation for more information. ## Column Alignment {/* #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](/layout/css-utilities.mdx#flex-item-properties) that can be applied to a column to customize this behavior. +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](../layout/css-utilities.mdx#flex-item-properties) that can be applied to a column to customize this behavior. ## Properties {/* #properties */} diff --git a/docs/api/content.mdx b/docs/api/content.mdx index 4169cab4db..a6a82fff70 100644 --- a/docs/api/content.mdx +++ b/docs/api/content.mdx @@ -23,7 +23,7 @@ import EncapsulationPill from '@components/page/api/EncapsulationPill'; The content component provides an easy to use content area with some useful methods to control the scrollable area. There should only be one content in a single view. -Content, along with many other Ionic components, can be customized to modify its padding, margin, and more using the global styles provided in the [CSS Utilities](/layout/css-utilities.mdx) or by individually styling it using CSS and the available [CSS Custom Properties](#css-custom-properties). +Content, along with many other Ionic components, can be customized to modify its padding, margin, and more using the global styles provided in the [CSS Utilities](../layout/css-utilities.mdx) or by individually styling it using CSS and the available [CSS Custom Properties](#css-custom-properties). ## Basic Usage {/* #basic-usage */} @@ -33,7 +33,7 @@ import Basic from '@site/static/usage/v9/content/basic/index.mdx'; ## Header & Footer {/* #header--footer */} -Content can be the only top-level component in a page, or it can be used alongside a [header](./header), [footer](./footer), or both. When used with a header or footer, it will adjust its size to fill the remaining height. +Content can be the only top-level component in a page, or it can be used alongside a [header](./header.mdx), [footer](./footer.mdx), or both. When used with a header or footer, it will adjust its size to fill the remaining height. import HeaderFooter from '@site/static/usage/v9/content/header-footer/index.mdx'; @@ -41,7 +41,7 @@ import HeaderFooter from '@site/static/usage/v9/content/header-footer/index.mdx' ## Fullscreen Content {/* #fullscreen-content */} -By default, content fills the space between a [header](./header) and [footer](./footer) but does not go behind them. In certain cases, it may be desired to have the content scroll behind the header and footer, such as when the `translucent` property is set on either of them, or `opacity` is set on the toolbar. This can be achieved by setting the `fullscreen` property on the content to `true`. +By default, content fills the space between a [header](./header.mdx) and [footer](./footer.mdx) but does not go behind them. In certain cases, it may be desired to have the content scroll behind the header and footer, such as when the `translucent` property is set on either of them, or `opacity` is set on the toolbar. This can be achieved by setting the `fullscreen` property on the content to `true`. import Fullscreen from '@site/static/usage/v9/content/fullscreen/index.mdx'; @@ -51,7 +51,7 @@ import Fullscreen from '@site/static/usage/v9/content/fullscreen/index.mdx'; To place elements outside of the scrollable area, assign them to the `fixed` slot. Doing so will [absolutely position](https://developer.mozilla.org/en-US/docs/Web/CSS/position#absolute_positioning) the element to the top left of the content. In order to change the position of the element, it can be styled using the [top, right, bottom, and left](https://developer.mozilla.org/en-US/docs/Web/CSS/position) CSS properties. -The `fixedSlotPlacement` property is used to determine if content in the `fixed` slot is placed before or after the main content in the DOM. When set to `before`, fixed slot content will be placed before the main content and will therefore receive keyboard focus before the main content receives keyboard focus. This can be useful when the main content contains an infinitely-scrolling list, preventing a [FAB](./fab) or other fixed content from being reachable by pressing the tab key. +The `fixedSlotPlacement` property is used to determine if content in the `fixed` slot is placed before or after the main content in the DOM. When set to `before`, fixed slot content will be placed before the main content and will therefore receive keyboard focus before the main content receives keyboard focus. This can be useful when the main content contains an infinitely-scrolling list, preventing a [FAB](./fab.mdx) or other fixed content from being reachable by pressing the tab key. import Fixed from '@site/static/usage/v9/content/fixed/index.mdx'; @@ -95,7 +95,7 @@ import CSSProps from '@site/static/usage/v9/content/theming/css-properties/index ### Safe Area Padding {/* #safe-area-padding */} -The content component will not automatically apply padding to any of its sides to account for the [safe area](/theming/advanced.mdx#safe-area-padding). This is because the content component is often used in conjunction with other components that apply their own padding, such as [headers](./header) and [footers](./footer). However, if the content component is being used on its own, it may be desired to apply padding to the safe area. This can be done through CSS by using the `--ion-safe-area-(dir)` variables described in [Application Variables](../theming/advanced.mdx#application-variables). +The content component will not automatically apply padding to any of its sides to account for the [safe area](../theming/advanced.mdx#safe-area-padding). This is because the content component is often used in conjunction with other components that apply their own padding, such as [headers](./header.mdx) and [footers](./footer.mdx). However, if the content component is being used on its own, it may be desired to apply padding to the safe area. This can be done through CSS by using the `--ion-safe-area-(dir)` variables described in [Application Variables](../theming/advanced.mdx#application-variables). The most common use case for this is to apply padding to the top of the content to account for the status bar. This can be done by setting the `padding-top` property to the value of the `--ion-safe-area-top` variable. diff --git a/docs/api/datetime-button.mdx b/docs/api/datetime-button.mdx index 7792be0c88..85d4e134f8 100644 --- a/docs/api/datetime-button.mdx +++ b/docs/api/datetime-button.mdx @@ -21,13 +21,13 @@ import EncapsulationPill from '@components/page/api/EncapsulationPill'; -Datetime Button links with a [Datetime](./datetime) component to display the formatted date and time. It also provides buttons to present the datetime in a modal, popover, and more. +Datetime Button links with a [Datetime](./datetime.mdx) component to display the formatted date and time. It also provides buttons to present the datetime in a modal, popover, and more. ## Overview {/* #overview */} Datetime Button should be used when space is constrained. This component displays buttons which show the current date and time values. When the buttons are tapped, the date or time pickers open in the overlay. -When using Datetime Button with a JavaScript framework such as Angular, React, or Vue be sure to use the [keepContentsMounted property on ion-modal](./modal#prop-keep-contents-mounted) or the [keepContentsMounted property on ion-popover](./popover#prop-keep-contents-mounted). This allows the linked datetime instance to be mounted even if the overlay has not been presented yet. +When using Datetime Button with a JavaScript framework such as Angular, React, or Vue be sure to use the [keepContentsMounted property on ion-modal](./modal.mdx#prop-keep-contents-mounted) or the [keepContentsMounted property on ion-popover](./popover.mdx#prop-keep-contents-mounted). This allows the linked datetime instance to be mounted even if the overlay has not been presented yet. ## Basic Usage {/* #basic-usage */} @@ -37,11 +37,11 @@ import Basic from '@site/static/usage/v9/datetime-button/basic/index.mdx'; ## Localization {/* #localization */} -The localized text on `ion-datetime-button` is determined by the `locale` property on the associated `ion-datetime` instance. Refer to [Datetime Localization](./datetime#localization) for more details. +The localized text on `ion-datetime-button` is determined by the `locale` property on the associated `ion-datetime` instance. Refer to [Datetime Localization](./datetime.mdx#localization) for more details. ## Format Options {/* #format-options */} -You can customize the format of the date and time in a Datetime Button by providing `formatOptions` on the associated Datetime instance. Refer to [Datetime Format Options](./datetime#format-options) for more details. +You can customize the format of the date and time in a Datetime Button by providing `formatOptions` on the associated Datetime instance. Refer to [Datetime Format Options](./datetime.mdx#format-options) for more details. import FormatOptions from '@site/static/usage/v9/datetime-button/format-options/index.mdx'; @@ -49,7 +49,7 @@ import FormatOptions from '@site/static/usage/v9/datetime-button/format-options/ ## Usage with Modals and Popovers {/* #usage-with-modals-and-popovers */} -`ion-datetime-button` must be associated with a mounted `ion-datetime` instance. As a result, [Inline Modals](./modal#inline-modals-recommended) and [Inline Popovers](./popover#inline-popovers) with the `keepContentsMounted` property set to `true` must be used. +`ion-datetime-button` must be associated with a mounted `ion-datetime` instance. As a result, [Inline Modals](./modal.mdx#inline-modals-recommended) and [Inline Popovers](./popover.mdx#inline-popovers) with the `keepContentsMounted` property set to `true` must be used. ## Properties {/* #properties */} diff --git a/docs/api/datetime.mdx b/docs/api/datetime.mdx index ed9d8ba497..cd0e2beec3 100644 --- a/docs/api/datetime.mdx +++ b/docs/api/datetime.mdx @@ -97,7 +97,7 @@ While seconds, milliseconds, and time zone can be specified using the ISO 8601 d ## Usage with Datetime Button {/* #usage-with-datetime-button */} -If you need to present a datetime in an overlay such as a modal or a popover, we recommend using [ion-datetime-button](./datetime-button). `ion-datetime-button` should be used when space is constrained. This component displays buttons which show the current date and time values. When the buttons are tapped, the date or time pickers open in the overlay. +If you need to present a datetime in an overlay such as a modal or a popover, we recommend using [ion-datetime-button](./datetime-button.mdx). `ion-datetime-button` should be used when space is constrained. This component displays buttons which show the current date and time values. When the buttons are tapped, the date or time pickers open in the overlay. ## Setting Values Asynchronously {/* #setting-values-asynchronously */} @@ -326,7 +326,7 @@ Developers can provide their own buttons for advanced custom behavior. Using the `highlightedDates` property, developers can style particular dates with custom text or background colors. This property can be defined as either an array of dates and their colors, or a callback that receives an ISO string and returns the colors to use. -When specifying colors, any valid CSS color format can be used. This includes hex codes, `rgba`, [color variables](../theming/colors), etc. +When specifying colors, any valid CSS color format can be used. This includes hex codes, `rgba`, [color variables](../theming/colors.mdx), etc. To maintain a consistent user experience, the style of selected date(s) will always override custom highlights. @@ -352,7 +352,7 @@ A callback is better when the highlighted dates are recurring, such as birthdays ### Global Theming {/* #global-theming */} -Ionic's powerful theming system can be used to easily change your entire app to match a certain theme. In this example, we used the [Color Creator](../theming/colors#new-color-creator) and the [Stepped Color Generator](../theming/themes#stepped-color-generator) to create a rose color palette that we can use for `ion-datetime`. +Ionic's powerful theming system can be used to easily change your entire app to match a certain theme. In this example, we used the [Color Creator](../theming/colors.mdx#new-color-creator) and the [Stepped Color Generator](../theming/themes.mdx#stepped-color-generator) to create a rose color palette that we can use for `ion-datetime`. The benefit of this approach is that every component, not just `ion-datetime`, can automatically take advantage of this theme. @@ -476,7 +476,7 @@ The datetime picker provides the simplicity of selecting an exact format, and pe #### Time, Month, and Year Wheels {/* #time-month-and-year-wheels */} -The wheel picker in Datetime uses [Picker](./picker) internally. Refer to [Picker Accessibility](./picker#accessibility) for more information on accessibility features with the wheel picker. +The wheel picker in Datetime uses [Picker](./picker.mdx) internally. Refer to [Picker Accessibility](./picker.mdx#accessibility) for more information on accessibility features with the wheel picker. ## Interfaces {/* #interfaces */} diff --git a/docs/api/fab-button.mdx b/docs/api/fab-button.mdx index fcbf15724e..08c96625f9 100644 --- a/docs/api/fab-button.mdx +++ b/docs/api/fab-button.mdx @@ -23,9 +23,9 @@ 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. +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.mdx) component. If the button is not wrapped with a fab, it will scroll with the content. -For usage examples, refer to the [fab documentation](./fab). +For usage examples, refer to the [fab documentation](./fab.mdx). ## Properties {/* #properties */} diff --git a/docs/api/fab-list.mdx b/docs/api/fab-list.mdx index 4a5bad1c70..bdb6b13a91 100644 --- a/docs/api/fab-list.mdx +++ b/docs/api/fab-list.mdx @@ -13,9 +13,9 @@ import EncapsulationPill from '@components/page/api/EncapsulationPill'; -The fab list component is a container for multiple [fab buttons](./fab-button). It contains actions related to the main fab button and is flung out on click. To specify what side the buttons should appear on, set the `side` property to `"start"`, `"end"`, `"top"`, or `"bottom"`. +The fab list component is a container for multiple [fab buttons](./fab-button.mdx). It contains actions related to the main fab button and is flung out on click. To specify what side the buttons should appear on, set the `side` property to `"start"`, `"end"`, `"top"`, or `"bottom"`. -For usage examples, refer to the [fab documentation](./fab). +For usage examples, refer to the [fab documentation](./fab.mdx). ## Properties {/* #properties */} diff --git a/docs/api/fab.mdx b/docs/api/fab.mdx index 20014dcfbb..75d4f18967 100644 --- a/docs/api/fab.mdx +++ b/docs/api/fab.mdx @@ -21,7 +21,7 @@ import EncapsulationPill from '@components/page/api/EncapsulationPill'; -Fabs are container elements that contain one or more [fab buttons](./fab-button). They should be placed in a fixed position that does not scroll with the content. Fabs should have one main fab button. Fabs can also contain one or more [fab lists](./fab-list) which contain related buttons that show when the main fab button is clicked. +Fabs are container elements that contain one or more [fab buttons](./fab-button.mdx). They should be placed in a fixed position that does not scroll with the content. Fabs should have one main fab button. Fabs can also contain one or more [fab lists](./fab-list.mdx) which contain related buttons that show when the main fab button is clicked. ## Basic Usage {/* #basic-usage */} @@ -31,7 +31,7 @@ import BasicUsage from '@site/static/usage/v9/fab/basic/index.mdx'; ## List Side {/* #list-side */} -The `side` property of the [fab list](./fab-list) component controls where it appears relative to the main fab button. A single fab can have multiple fab lists as long as they all have different values for `side`. +The `side` property of the [fab list](./fab-list.mdx) component controls where it appears relative to the main fab button. A single fab can have multiple fab lists as long as they all have different values for `side`. import ListSide from '@site/static/usage/v9/fab/list-side/index.mdx'; @@ -39,7 +39,7 @@ import ListSide from '@site/static/usage/v9/fab/list-side/index.mdx'; ## Positioning {/* #positioning */} -In order to place the fab in a fixed position, it should be assigned to the `fixed` slot of the outer [content](./content) component. Use the `vertical` and `horizontal` props to control the alignment of the fab in the viewport. The `edge` prop will cause the fab button to overlap with the app's header or footer. +In order to place the fab in a fixed position, it should be assigned to the `fixed` slot of the outer [content](./content.mdx) component. Use the `vertical` and `horizontal` props to control the alignment of the fab in the viewport. The `edge` prop will cause the fab button to overlap with the app's header or footer. import Positioning from '@site/static/usage/v9/fab/positioning/index.mdx'; @@ -47,7 +47,7 @@ import Positioning from '@site/static/usage/v9/fab/positioning/index.mdx'; ### Safe Area {/* #safe-area */} -If there is no `ion-header` or `ion-footer` component, the fab may be covered by a device's notch, status bar, or other device UI. In these cases, the [safe area](/theming/advanced.mdx#safe-area-padding) on the top and bottom is not taken into account. This can be adjusted by using the [`--ion-safe-area-(dir)` variables](/theming/advanced.mdx#application-variables). +If there is no `ion-header` or `ion-footer` component, the fab may be covered by a device's notch, status bar, or other device UI. In these cases, the [safe area](../theming/advanced.mdx#safe-area-padding) on the top and bottom is not taken into account. This can be adjusted by using the [`--ion-safe-area-(dir)` variables](../theming/advanced.mdx#application-variables). When using a fab with `vertical` set to `"top"` without an `ion-header`, the top margin needs to be set: @@ -75,7 +75,7 @@ import SafeArea from '@site/static/usage/v9/fab/safe-area/index.mdx'; In scenarios where a view contains many interactive elements, such as an infinitely-scrolling list, it may be challenging for users to navigate to the Floating Action Button (FAB) if it is placed below all the items in the DOM. -By setting the `fixedSlotPlacement` property on [Content](./content) to `before`, the FAB will be placed before the main content in the DOM. This ensures that the FAB receives keyboard focus before other interactive elements receive focus, making it easier for users to access the FAB. +By setting the `fixedSlotPlacement` property on [Content](./content.mdx) to `before`, the FAB will be placed before the main content in the DOM. This ensures that the FAB receives keyboard focus before other interactive elements receive focus, making it easier for users to access the FAB. import BeforeContent from '@site/static/usage/v9/fab/before-content/index.mdx'; diff --git a/docs/api/footer.mdx b/docs/api/footer.mdx index 0d0da2d347..efd532cf1c 100644 --- a/docs/api/footer.mdx +++ b/docs/api/footer.mdx @@ -19,7 +19,7 @@ import Slots from '@ionic-internal/component-api/v9/footer/slots.mdx'; import EncapsulationPill from '@components/page/api/EncapsulationPill'; -Footer is a root component of a page that aligns itself to the bottom of the page. It is recommended to be used as a wrapper for one or more [toolbars](./toolbar), but it can be used to wrap any element. When a toolbar is used inside of a footer, the content will be adjusted so it is sized correctly, and the footer will account for any device safe areas. +Footer is a root component of a page that aligns itself to the bottom of the page. It is recommended to be used as a wrapper for one or more [toolbars](./toolbar.mdx), but it can be used to wrap any element. When a toolbar is used inside of a footer, the content will be adjusted so it is sized correctly, and the footer will account for any device safe areas. ## Basic Usage {/* #basic-usage */} diff --git a/docs/api/grid.mdx b/docs/api/grid.mdx index e15f7bfd12..ba270bc616 100644 --- a/docs/api/grid.mdx +++ b/docs/api/grid.mdx @@ -21,7 +21,7 @@ import EncapsulationPill from '@components/page/api/EncapsulationPill'; -The grid is a powerful mobile-first flexbox system for building custom layouts. It is composed of three units — a grid, [row(s)](row.mdx) and [column(s)](col.mdx). Columns will expand to fill the row, and will resize to fit additional columns. It is based on a 12 column layout with different breakpoints based on the screen size. The number of columns can be customized using CSS. +The grid is a powerful mobile-first flexbox system for building custom layouts. It is composed of three units — a grid, [row(s)](./row.mdx) and [column(s)](./col.mdx). Columns will expand to fill the row, and will resize to fit additional columns. It is based on a 12 column layout with different breakpoints based on the screen size. The number of columns can be customized using CSS. ## Overview {/* #overview */} @@ -31,14 +31,14 @@ The grid is a powerful mobile-first flexbox system for building custom layouts. - The `size` property indicates the number of columns to use out of the default 12 per row. So, `size="4"` can be added to a column in order to take up 1/3 of the grid, or 4 of the 12 columns. - Columns without a value for size will automatically have equal widths. For example, four columns will each automatically be 25% wide. - Column widths are set as a percentage, so they’re always fluid and sized relative to their parent element. -- There is padding between individual columns. However, the padding can be removed from the grid and columns by adding the `ion-no-padding` class to the grid. Refer to the [CSS Utilities](../layout/css-utilities) for more styles that can be applied to the grid. +- There is padding between individual columns. However, the padding can be removed from the grid and columns by adding the `ion-no-padding` class to the grid. Refer to the [CSS Utilities](../layout/css-utilities.mdx) for more styles that can be applied to the grid. - There are five grid tiers, one for each responsive breakpoint: all breakpoints (extra small), small, medium, large, and extra large. - Grid tiers are based on minimum widths, meaning they apply to their tier and all those larger than them (e.g., `size-sm="4"` applies to small, medium, large, and extra large devices). - Grids can be customized via CSS variables. Refer to [Customizing the Grid](#customizing-the-grid). ## Default Breakpoints {/* #default-breakpoints */} -The default breakpoints for the grid and the corresponding properties are defined in the table below. Breakpoint values can not be customized at this time. For more information on why they can't be customized, refer to [Variables in Media Queries](../theming/advanced#variables-in-media-queries). +The default breakpoints for the grid and the corresponding properties are defined in the table below. Breakpoint values can not be customized at this time. For more information on why they can't be customized, refer to [Variables in Media Queries](../theming/advanced.mdx#variables-in-media-queries). | Name | Value | Width Property | Offset Property | Push Property | Pull Property | Description | | --- | --- | --- | --- | --- | --- | --- | @@ -144,7 +144,7 @@ import PushPullResponsive from '@site/static/usage/v9/grid/push-pull-responsive/ ### Vertical Alignment {/* #vertical-alignment */} -All columns can be vertically aligned inside of a row by adding different classes to the row. For a list of available classes, refer to [css utilities](/layout/css-utilities#flex-container-properties). +All columns can be vertically aligned inside of a row by adding different classes to the row. For a list of available classes, refer to [css utilities](../layout/css-utilities.mdx#flex-container-properties). import VerticalAlignment from '@site/static/usage/v9/grid/vertical-alignment/index.mdx'; @@ -152,7 +152,7 @@ import VerticalAlignment from '@site/static/usage/v9/grid/vertical-alignment/ind ### Horizontal Alignment {/* #horizontal-alignment */} -All columns can be horizontally aligned inside of a row by adding different classes to the row. For a list of available classes, refer to [css utilities](/layout/css-utilities.mdx#flex-container-properties). +All columns can be horizontally aligned inside of a row by adding different classes to the row. For a list of available classes, refer to [css utilities](../layout/css-utilities.mdx#flex-container-properties). import HorizontalAlignment from '@site/static/usage/v9/grid/horizontal-alignment/index.mdx'; diff --git a/docs/api/header.mdx b/docs/api/header.mdx index 616a3f4250..1936e949f4 100644 --- a/docs/api/header.mdx +++ b/docs/api/header.mdx @@ -19,7 +19,7 @@ import Slots from '@ionic-internal/component-api/v9/header/slots.mdx'; import EncapsulationPill from '@components/page/api/EncapsulationPill'; -Header is a root component of a page that aligns itself to the top of the page. It is recommended to be used as a wrapper for one or more [toolbars](./toolbar), but it can be used to wrap any element. When a toolbar is used inside of a header, the content will be adjusted so it is sized correctly, and the header will account for any device safe areas. +Header is a root component of a page that aligns itself to the top of the page. It is recommended to be used as a wrapper for one or more [toolbars](./toolbar.mdx), but it can be used to wrap any element. When a toolbar is used inside of a header, the content will be adjusted so it is sized correctly, and the header will account for any device safe areas. ## Basic Usage {/* #basic-usage */} diff --git a/docs/api/input-password-toggle.mdx b/docs/api/input-password-toggle.mdx index 4c8e0c6399..6a185e2e8f 100644 --- a/docs/api/input-password-toggle.mdx +++ b/docs/api/input-password-toggle.mdx @@ -21,13 +21,13 @@ import EncapsulationPill from '@components/page/api/EncapsulationPill'; -The InputPasswordToggle component is a companion component to [Input](./input). It allows users to toggle the visibility of text in a password input. +The InputPasswordToggle component is a companion component to [Input](./input.mdx). It allows users to toggle the visibility of text in a password input. ## Basic Usage {/* #basic-usage */} :::info -InputPasswordToggle must be used with an [Input](./input) that has its [`type`](./input.mdx#prop-type) property set to either `'text'` or `'password'`. +InputPasswordToggle must be used with an [Input](./input.mdx) that has its [`type`](./input.mdx#prop-type) property set to either `'text'` or `'password'`. Using any other `type` will cause a warning to be logged. diff --git a/docs/api/item-divider.mdx b/docs/api/item-divider.mdx index 321db80c48..42fa77d09e 100644 --- a/docs/api/item-divider.mdx +++ b/docs/api/item-divider.mdx @@ -21,7 +21,7 @@ import EncapsulationPill from '@components/page/api/EncapsulationPill'; -Item dividers are block elements that can be used to separate [items](./item) in a list. They are similar to list headers, but instead of only being placed at the top of a list, they should go in between groups of items. +Item dividers are block elements that can be used to separate [items](./item.mdx) in a list. They are similar to list headers, but instead of only being placed at the top of a list, they should go in between groups of items. ## Basic Usage {/* #basic-usage */} diff --git a/docs/api/item-group.mdx b/docs/api/item-group.mdx index 0dfd64c783..5c52954e35 100644 --- a/docs/api/item-group.mdx +++ b/docs/api/item-group.mdx @@ -19,7 +19,7 @@ import Slots from '@ionic-internal/component-api/v9/item-group/slots.mdx'; import EncapsulationPill from '@components/page/api/EncapsulationPill'; -Item groups are containers that organize similar [items](./item) together. They can contain [item dividers](./item-divider) to divide the items into multiple sections. They can also be used to group [sliding items](./item-sliding). +Item groups are containers that organize similar [items](./item.mdx) together. They can contain [item dividers](./item-divider.mdx) to divide the items into multiple sections. They can also be used to group [sliding items](./item-sliding.mdx). ## Basic Usage {/* #basic-usage */} diff --git a/docs/api/item-option.mdx b/docs/api/item-option.mdx index f1c2ad0d87..91c929484f 100644 --- a/docs/api/item-option.mdx +++ b/docs/api/item-option.mdx @@ -21,9 +21,9 @@ 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. +The item option component is an button for a sliding item. It must be placed inside of [item options](./item-options.mdx). The `ionSwipe` event and the `expandable` property can be combined to create a full swipe action for the item. -Refer to the [item sliding](./item-sliding) documentation for more information. +Refer to the [item sliding](./item-sliding.mdx) documentation for more information. ## Properties {/* #properties */} diff --git a/docs/api/item-options.mdx b/docs/api/item-options.mdx index efea362064..8578252a53 100644 --- a/docs/api/item-options.mdx +++ b/docs/api/item-options.mdx @@ -19,9 +19,9 @@ import Slots from '@ionic-internal/component-api/v9/item-options/slots.mdx'; 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). +The item options component is a container for the [item option](./item-option.mdx) buttons in a sliding item. These buttons can be placed either on the [start or end side](#side-description). -Refer to the [item sliding](./item-sliding) documentation for more information. +Refer to the [item sliding](./item-sliding.mdx) documentation for more information. ## Side Description {/* #side-description */} diff --git a/docs/api/item-sliding.mdx b/docs/api/item-sliding.mdx index 076c9090c9..26f64dc920 100644 --- a/docs/api/item-sliding.mdx +++ b/docs/api/item-sliding.mdx @@ -19,11 +19,11 @@ import Slots from '@ionic-internal/component-api/v9/item-sliding/slots.mdx'; import EncapsulationPill from '@components/page/api/EncapsulationPill'; -A sliding item contains an item that can be dragged to reveal option buttons. It requires an [item](./item) component as a child. All options to reveal should be placed in the [item options](./item-options) element. +A sliding item contains an item that can be dragged to reveal option buttons. It requires an [item](./item.mdx) component as a child. All options to reveal should be placed in the [item options](./item-options.mdx) element. ## Basic Usage {/* #basic-usage */} -Sliding item options are placed on the `"end"` side of the item by default. This means that options are revealed when the item is swiped from end to start, i.e. from right to left in LTR, but from left to right in RTL. To place them on the opposite side, so that they are revealed when swiping in the opposite direction, set the side attribute to `"start"` on the [item options](./item-options) element. Up to two item options can be used at the same time in order to reveal two different sets of options depending on the swiping direction. +Sliding item options are placed on the `"end"` side of the item by default. This means that options are revealed when the item is swiped from end to start, i.e. from right to left in LTR, but from left to right in RTL. To place them on the opposite side, so that they are revealed when swiping in the opposite direction, set the side attribute to `"start"` on the [item options](./item-options.mdx) element. Up to two item options can be used at the same time in order to reveal two different sets of options depending on the swiping direction. import Basic from '@site/static/usage/v9/item-sliding/basic/index.mdx'; @@ -31,7 +31,7 @@ import Basic from '@site/static/usage/v9/item-sliding/basic/index.mdx'; ## Icon Options {/* #icon-options */} -When an icon is placed alongside text in the [item option](./item-option), it will display the icon on top of the text by default. The slot on the icon can be changed to any of the available [item option slots](./item-option#slots) to change its position. +When an icon is placed alongside text in the [item option](./item-option.mdx), it will display the icon on top of the text by default. The slot on the icon can be changed to any of the available [item option slots](./item-option.mdx#slots) to change its position. import Icons from '@site/static/usage/v9/item-sliding/icons/index.mdx'; @@ -39,7 +39,7 @@ import Icons from '@site/static/usage/v9/item-sliding/icons/index.mdx'; ## Expandable Options {/* #expandable-options */} -Options can be expanded to take up the full width of the parent `ion-item` if you swipe past a certain point. This can be combined with the `ionSwipe` event on the [item options](./item-options) to call a method when the item is fully swiped. +Options can be expanded to take up the full width of the parent `ion-item` if you swipe past a certain point. This can be combined with the `ionSwipe` event on the [item options](./item-options.mdx) to call a method when the item is fully swiped. import Expandable from '@site/static/usage/v9/item-sliding/expandable/index.mdx'; diff --git a/docs/api/item.mdx b/docs/api/item.mdx index 539aee3bd1..3d9c22431f 100644 --- a/docs/api/item.mdx +++ b/docs/api/item.mdx @@ -27,11 +27,11 @@ import EncapsulationPill from '@components/page/api/EncapsulationPill'; -Items are elements that can contain text, icons, avatars, images, inputs, and any other native or custom elements. Items should only be used as rows in a [List](./list) with other items. Items can be swiped, deleted, reordered, edited, and more. +Items are elements that can contain text, icons, avatars, images, inputs, and any other native or custom elements. Items should only be used as rows in a [List](./list.mdx) with other items. Items can be swiped, deleted, reordered, edited, and more. ## Basic Usage {/* #basic-usage */} -Items left align text and wrap when the text is wider than the item. We can modify this behavior using the CSS Utilities provided by Ionic Framework, such as using `.ion-text-nowrap` in the below example. Refer to the [CSS Utilities Documentation](/layout/css-utilities.mdx) for more classes that can be added to an item to transform the text. +Items left align text and wrap when the text is wider than the item. We can modify this behavior using the CSS Utilities provided by Ionic Framework, such as using `.ion-text-nowrap` in the below example. Refer to the [CSS Utilities Documentation](../layout/css-utilities.mdx) for more classes that can be added to an item to transform the text. import Basic from '@site/static/usage/v9/item/basic/index.mdx'; @@ -43,7 +43,7 @@ While items in a list take many forms, they typically support 5 different conten ### Supporting Visuals {/* #supporting-visuals */} -Supporting visuals are decorative icons or other adornments for an item. Common examples of supporting visuals are [Avatars](./avatar), [Icons](./icon), and [Thumbnails](./thumbnail). Since this content is not required to understand the intent of the item, it is typically hidden from screen readers using `aria-hidden="true"`. +Supporting visuals are decorative icons or other adornments for an item. Common examples of supporting visuals are [Avatars](./avatar.mdx), [Icons](./icon.mdx), and [Thumbnails](./thumbnail.mdx). Since this content is not required to understand the intent of the item, it is typically hidden from screen readers using `aria-hidden="true"`. If a visual is required to interact with the item, such as an icon button, then the visual is an [action](#actions) not a supporting visual. @@ -103,7 +103,7 @@ In the example below, we are creating a list with different types of text. The " The "Allow Notifications" label on the toggle has additional text underneath it that notes users can disable notifications. Since this text is short, it is placed inside of the item. -Below that list is another list containing a textarea with a [Note](./note) containing long text underneath. The textarea was placed in its own list to make it apparent that the long text is associated with the textarea and not any other fields. +Below that list is another list containing a textarea with a [Note](./note.mdx) containing long text underneath. The textarea was placed in its own list to make it apparent that the long text is associated with the textarea and not any other fields. import Text from '@site/static/usage/v9/item/content-types/text/index.mdx'; @@ -111,7 +111,7 @@ import Text from '@site/static/usage/v9/item/content-types/text/index.mdx'; ### Metadata {/* #metadata */} -Metadata provides additional context for an item such as status text or counts. Components like [Badge](./badge) or [Note](./note) are great ways of showing metadata. +Metadata provides additional context for an item such as status text or counts. Components like [Badge](./badge.mdx) or [Note](./note.mdx) are great ways of showing metadata. -In the example below, we are creating two lists with different kinds of metadata. The first list uses [Note](./note) to show how many tasks are in each to-do list. +In the example below, we are creating two lists with different kinds of metadata. The first list uses [Note](./note.mdx) to show how many tasks are in each to-do list. The second list mimics the iOS Mail app to show an inbox. This list makes use of custom metadata including an "unread message" indicator in the "start" slot as well as a timestamp and custom detail icon in the "end" slot. The "unread message" indicator is highlighted in blue to draw the user's attention to the unread messages, while the timestamp is more subtle. @@ -323,7 +323,7 @@ export class ExampleComponent {} -In JavaScript, set the `router-link` attribute on `ion-item` to navigate using [ion-router](./router). +In JavaScript, set the `router-link` attribute on `ion-item` to navigate using [ion-router](./router.mdx). ```html @@ -441,10 +441,10 @@ import CSSProps from '@site/static/usage/v9/item/theming/css-properties/index.md The following guidelines will help ensure your list items are easy to understand and use. -1. Items should only be used inside of [Lists](./list). +1. Items should only be used inside of [Lists](./list.mdx). 2. Items inside of a list should be presented in a consistent format. For example, if your items present decorative icons, the icons should be positioned in the same way between items. 3. Items should never render [nested interactives](https://dequeuniversity.com/rules/axe/4.4/nested-interactive). Screen readers are unable to select the correct interactive element when nested interactives are used. For example, avoid placing a button inside of an `ion-item` that has `button="true"`. -4. Use [content types](#content-types) correctly. The Item component is designed to be a row in a [List](./list) and should not be used as a general purpose container. +4. Use [content types](#content-types) correctly. The Item component is designed to be a row in a [List](./list.mdx) and should not be used as a general purpose container. ## Accessibility {/* #accessibility */} diff --git a/docs/api/list-header.mdx b/docs/api/list-header.mdx index 4c0891d4c9..4b6fdfe42d 100644 --- a/docs/api/list-header.mdx +++ b/docs/api/list-header.mdx @@ -13,7 +13,7 @@ import EncapsulationPill from '@components/page/api/EncapsulationPill'; -List headers are block elements that are used to describe the contents of a [list](./list). Unlike [item dividers](./item-divider), list headers should only be used once at the top of a list of [items](./item). +List headers are block elements that are used to describe the contents of a [list](./list.mdx). Unlike [item dividers](./item-divider.mdx), list headers should only be used once at the top of a list of [items](./item.mdx). ## Basic Usage {/* #basic-usage */} @@ -23,7 +23,7 @@ import Basic from '@site/static/usage/v9/list-header/basic/index.mdx'; ## Buttons in List Headers {/* #buttons-in-list-headers */} -A [button](./button) placed in a list header can be useful for showing part of a list and redirecting to the full list with the button. +A [button](./button.mdx) placed in a list header can be useful for showing part of a list and redirecting to the full list with the button. import Buttons from '@site/static/usage/v9/list-header/buttons/index.mdx'; diff --git a/docs/api/list.mdx b/docs/api/list.mdx index d671c24c2e..7e3c65e3af 100644 --- a/docs/api/list.mdx +++ b/docs/api/list.mdx @@ -19,9 +19,9 @@ import Slots from '@ionic-internal/component-api/v9/list/slots.mdx'; import EncapsulationPill from '@components/page/api/EncapsulationPill'; -Lists are made up of multiple rows of [items](./item) which can contain text, buttons, toggles, icons, thumbnails, and much more. Lists generally contain items with similar data content, such as images and text. +Lists are made up of multiple rows of [items](./item.mdx) which can contain text, buttons, toggles, icons, thumbnails, and much more. Lists generally contain items with similar data content, such as images and text. -Lists support several interactions including swiping items to reveal options, dragging to [reorder](./reorder) items within the list, and deleting items. +Lists support several interactions including swiping items to reveal options, dragging to [reorder](./reorder.mdx) items within the list, and deleting items. ## Basic Usage {/* #basic-usage */} diff --git a/docs/api/menu-button.mdx b/docs/api/menu-button.mdx index 47a2912430..03a966850a 100644 --- a/docs/api/menu-button.mdx +++ b/docs/api/menu-button.mdx @@ -23,7 +23,7 @@ import EncapsulationPill from '@components/page/api/EncapsulationPill'; The Menu Button component contains an icon and automatically adds functionality to open a menu when clicked. -Refer to the [menu](./menu) documentation for more information. +Refer to the [menu](./menu.mdx) documentation for more information. ## Properties {/* #properties */} diff --git a/docs/api/menu-toggle.mdx b/docs/api/menu-toggle.mdx index 6c26fcebbb..b1ccce9670 100644 --- a/docs/api/menu-toggle.mdx +++ b/docs/api/menu-toggle.mdx @@ -25,7 +25,7 @@ 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`. -Refer to the [menu](./menu#menu-toggle) documentation for more information. +Refer to the [menu](./menu.mdx#menu-toggle) documentation for more information. ## Properties {/* #properties */} diff --git a/docs/api/menu.mdx b/docs/api/menu.mdx index 8dd9467fde..c16580c843 100644 --- a/docs/api/menu.mdx +++ b/docs/api/menu.mdx @@ -33,7 +33,7 @@ import Basic from '@site/static/usage/v9/menu/basic/index.mdx'; ## Menu Toggle {/* #menu-toggle */} -The [menu toggle](./menu-toggle) component can be used to create custom button that can open or close the menu. +The [menu toggle](./menu-toggle.mdx) component can be used to create custom button that can open or close the menu. import MenuToggle from '@site/static/usage/v9/menu/toggle/index.mdx'; diff --git a/docs/api/modal.mdx b/docs/api/modal.mdx index 2f2af526a6..bd64ab5603 100644 --- a/docs/api/modal.mdx +++ b/docs/api/modal.mdx @@ -236,7 +236,7 @@ import AnimationsExample from '@site/static/usage/v9/modal/styling/animations/in ## Custom Dialogs {/* #custom-dialogs */} -While `ion-modal` is most often used for full-page views, cards, or sheets, it is also possible to use it for custom dialogs. This is useful if developers need an interface that is more complex than what components such as [ion-alert](./alert) or [ion-loading](./loading) provide. +While `ion-modal` is most often used for full-page views, cards, or sheets, it is also possible to use it for custom dialogs. This is useful if developers need an interface that is more complex than what components such as [ion-alert](./alert.mdx) or [ion-loading](./loading.mdx) provide. import CustomDialogs from '@site/static/usage/v9/modal/custom-dialogs/index.mdx'; diff --git a/docs/api/nav-link.mdx b/docs/api/nav-link.mdx index fb44c6b368..a10d9001a1 100644 --- a/docs/api/nav-link.mdx +++ b/docs/api/nav-link.mdx @@ -23,7 +23,7 @@ A navigation link is used to navigate to a specified component. The component ca It is the element form of calling the `push()`, `pop()`, and `setRoot()` methods on the navigation controller. -Refer to the [nav](./nav#using-navlink) documentation for more information. +Refer to the [nav](./nav.mdx#using-navlink) documentation for more information. ## Properties {/* #properties */} diff --git a/docs/api/nav.mdx b/docs/api/nav.mdx index a2a12231e8..3022a0bd7d 100644 --- a/docs/api/nav.mdx +++ b/docs/api/nav.mdx @@ -27,7 +27,7 @@ Unlike Router Outlet, Nav is not tied to a particular router. This means that if :::note -`ion-nav` is not meant to be used for routing. Instead, refer to the routing guides for [Angular](../angular/navigation), [React](../react/navigation), and [Vue](../vue/navigation), or [`ion-router`](./router) for vanilla JavaScript projects. +`ion-nav` is not meant to be used for routing. Instead, refer to the routing guides for [Angular](../angular/navigation.mdx), [React](../react/navigation.mdx), and [Vue](../vue/navigation.mdx), or [`ion-router`](./router.mdx) for vanilla JavaScript projects. ::: diff --git a/docs/api/picker.mdx b/docs/api/picker.mdx index 2dc1226b47..dc15c94dff 100644 --- a/docs/api/picker.mdx +++ b/docs/api/picker.mdx @@ -54,7 +54,7 @@ import ModalExample from '@site/static/usage/v9/picker/modal/index.mdx'; ### Screen Readers {/* #screen-readers */} -Picker supports navigation using a screen reader by implementing the [`slider` role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/slider_role) on each [Picker Column](./picker-column). The following gestures can be used to navigate the Picker. +Picker supports navigation using a screen reader by implementing the [`slider` role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/slider_role) on each [Picker Column](./picker-column.mdx). The following gestures can be used to navigate the Picker. | Gesture | Function | | --- | --- | @@ -72,7 +72,7 @@ The Swipe Up and Swipe Down gestures rely on the correct key events being synthe ### Keyboard Interactions {/* #keyboard-interactions */} -Each [Picker Column](./picker-column) can be navigated using the keyboard when focused. +Each [Picker Column](./picker-column.mdx) can be navigated using the keyboard when focused. | Key | Description | | -------------------- | ------------------------------------ | diff --git a/docs/api/radio-group.mdx b/docs/api/radio-group.mdx index 1cec1c9336..95c3426865 100644 --- a/docs/api/radio-group.mdx +++ b/docs/api/radio-group.mdx @@ -19,7 +19,7 @@ import Slots from '@ionic-internal/component-api/v9/radio-group/slots.mdx'; 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, refer to the [radio](./radio) documentation. +A radio group is a container for a group of [radios](./radio.mdx). 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, refer to the [radio](./radio.mdx) documentation. ## Interfaces {/* #interfaces */} diff --git a/docs/api/radio.mdx b/docs/api/radio.mdx index e013d6e848..2f14519c43 100644 --- a/docs/api/radio.mdx +++ b/docs/api/radio.mdx @@ -21,9 +21,9 @@ import EncapsulationPill from '@components/page/api/EncapsulationPill'; -Radios should be used inside of a [radio group](./radio-group). Pressing a radio will check it and uncheck the previously selected radio, if there is one. They can also be checked programmatically by setting the value property of the parent radio group to the value of the radio. +Radios should be used inside of a [radio group](./radio-group.mdx). Pressing a radio will check it and uncheck the previously selected radio, if there is one. They can also be checked programmatically by setting the value property of the parent radio group to the value of the radio. -When radios are inside of a radio group, only one radio will be checked at any time. If more than one item should be selected, [checkboxes](./checkbox) should be used instead. Radios can be disabled within a group to prevent interaction with them. +When radios are inside of a radio group, only one radio will be checked at any time. If more than one item should be selected, [checkboxes](./checkbox.mdx) should be used instead. Radios can be disabled within a group to prevent interaction with them. ## Basic Usage {/* #basic-usage */} diff --git a/docs/api/refresher-content.mdx b/docs/api/refresher-content.mdx index adb34a7dae..990203b22c 100644 --- a/docs/api/refresher-content.mdx +++ b/docs/api/refresher-content.mdx @@ -13,7 +13,7 @@ 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, refer to the [Refresher](/api/refresher.mdx) documentation. +For usage examples, refer to the [Refresher](./refresher.mdx) documentation. ## Properties {/* #properties */} diff --git a/docs/api/refresher.mdx b/docs/api/refresher.mdx index 6779a8659d..b6d5e406eb 100644 --- a/docs/api/refresher.mdx +++ b/docs/api/refresher.mdx @@ -41,7 +41,7 @@ import PullProperties from '@site/static/usage/v9/refresher/pull-properties/inde ## Custom Refresher Content {/* #custom-refresher-content */} -The default icon, spinner, and text can be customized on the [refresher content](./refresher-content) based on whether the state of the refresher is `pulling` or `refreshing`. +The default icon, spinner, and text can be customized on the [refresher content](./refresher-content.mdx) based on whether the state of the refresher is `pulling` or `refreshing`. Setting `pullingIcon` will disable the [native refresher](#native-refreshers). @@ -59,7 +59,7 @@ The native refresher uses a `circular` spinner for Material Design, while iOS us Certain refresher properties such as the [Pull Properties](#pull-properties), `closeDuration` and `snapbackDuration` are not compatible because much of the native refreshers are scroll-based. Refer to [Properties](#properties) for more information on unsupported properties. -The native refreshers can be disabled by setting the `pullingIcon` on the [refresher content](#custom-refresher-content) to any icon or spinner. Refer to the [Ionicons](https://ionic.io/ionicons) and [Spinner](./spinner) documentation for accepted values. +The native refreshers can be disabled by setting the `pullingIcon` on the [refresher content](#custom-refresher-content) to any icon or spinner. Refer to the [Ionicons](https://ionic.io/ionicons) and [Spinner](./spinner.mdx) documentation for accepted values. ## Usage with Virtual Scroll {/* #usage-with-virtual-scroll */} diff --git a/docs/api/reorder-group.mdx b/docs/api/reorder-group.mdx index 67b7f96524..ab72b27160 100644 --- a/docs/api/reorder-group.mdx +++ b/docs/api/reorder-group.mdx @@ -19,9 +19,9 @@ import Slots from '@ionic-internal/component-api/v9/reorder-group/slots.mdx'; 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, the `ionReorderEnd` event is dispatched. A handler for this event should be implemented that calls the `complete` method. +The reorder group is a container for items using the [reorder](./reorder.mdx) component. When the user drags an item and drops it, the `ionReorderEnd` event is dispatched. A handler for this event should be implemented that calls the `complete` method. -The `detail` property of the `ionReorderEnd` 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` an index. For example usage of the reorder group, refer to the [reorder](./reorder) documentation. +The `detail` property of the `ionReorderEnd` 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` an index. For example usage of the reorder group, refer to the [reorder](./reorder.mdx) documentation. ## Interfaces {/* #interfaces */} diff --git a/docs/api/reorder.mdx b/docs/api/reorder.mdx index bb8423c190..8b9417c2e8 100644 --- a/docs/api/reorder.mdx +++ b/docs/api/reorder.mdx @@ -21,7 +21,7 @@ import EncapsulationPill from '@components/page/api/EncapsulationPill'; -Reorder is a component that allows an item to be dragged to change its order within a group of items. It must be used within a [reorder group](./reorder-group) to provide a visual drag and drop interface. +Reorder is a component that allows an item to be dragged to change its order within a group of items. It must be used within a [reorder group](./reorder-group.mdx) to provide a visual drag and drop interface. The reorder is the anchor used to drag and drop the items. Once the reorder is complete, the `ionReorderEnd` event will be dispatched from the reorder group and the `complete` method needs to be called. diff --git a/docs/api/route-redirect.mdx b/docs/api/route-redirect.mdx index f550440348..693634ff84 100644 --- a/docs/api/route-redirect.mdx +++ b/docs/api/route-redirect.mdx @@ -23,7 +23,7 @@ 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.mdx) 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.mdx) and the Angular router. ::: diff --git a/docs/api/route.mdx b/docs/api/route.mdx index aee676feb2..eac4cd54dc 100644 --- a/docs/api/route.mdx +++ b/docs/api/route.mdx @@ -26,7 +26,7 @@ The route component takes a component and renders it when the Browser URL matche :::note -Note: this component should only be used with vanilla and Stencil JavaScript projects. For Angular projects, use [`ion-router-outlet`](router-outlet.mdx) 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.mdx) and the Angular router. ::: diff --git a/docs/api/router-link.mdx b/docs/api/router-link.mdx index c216e6cc70..e4e62963bb 100644 --- a/docs/api/router-link.mdx +++ b/docs/api/router-link.mdx @@ -29,7 +29,7 @@ Note: this component should only be used with vanilla and Stencil JavaScript pro ::: -Refer to the [Router](./router) documentation for more information. +Refer to the [Router](./router.mdx) documentation for more information. ## Properties {/* #properties */} diff --git a/docs/api/router.mdx b/docs/api/router.mdx index 2adaf7e3c2..4b16efceb6 100644 --- a/docs/api/router.mdx +++ b/docs/api/router.mdx @@ -23,7 +23,7 @@ The router is a component for handling routing inside vanilla and Stencil JavaSc :::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.mdx), [React](../react/navigation.mdx), and [Vue](../vue/navigation.mdx) for framework-specific routing solutions. ::: diff --git a/docs/api/row.mdx b/docs/api/row.mdx index 1cb31f2d2c..d7d269c84c 100644 --- a/docs/api/row.mdx +++ b/docs/api/row.mdx @@ -21,13 +21,13 @@ import EncapsulationPill from '@components/page/api/EncapsulationPill'; -Rows are horizontal components of the [grid](./grid) system and contain varying numbers of [columns](./col). They ensure the columns are positioned properly. +Rows are horizontal components of the [grid](./grid.mdx) system and contain varying numbers of [columns](./col.mdx). They ensure the columns are positioned properly. -Refer to the [grid](./grid) documentation for more information. +Refer to the [grid](./grid.mdx) documentation for more information. ## Row Alignment {/* #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](/layout/css-utilities.mdx#flex-container-properties) that can be applied to a row to customize this behavior. +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](../layout/css-utilities.mdx#flex-container-properties) that can be applied to a row to customize this behavior. ## Properties {/* #properties */} diff --git a/docs/api/segment-button.mdx b/docs/api/segment-button.mdx index 3a5346f814..179d12ba79 100644 --- a/docs/api/segment-button.mdx +++ b/docs/api/segment-button.mdx @@ -21,7 +21,7 @@ import EncapsulationPill from '@components/page/api/EncapsulationPill'; -Segment buttons are groups of related buttons inside of a [segment](segment.mdx). They are displayed in a horizontal row. A segment button can be selected by default by setting the `value` of the segment to the `value` of the segment button. Only one segment button can be selected at a time. +Segment buttons are groups of related buttons inside of a [segment](./segment.mdx). They are displayed in a horizontal row. A segment button can be selected by default by setting the `value` of the segment to the `value` of the segment button. Only one segment button can be selected at a time. ## Basic Usage {/* #basic-usage */} diff --git a/docs/api/segment.mdx b/docs/api/segment.mdx index b608b571eb..54f7baef58 100644 --- a/docs/api/segment.mdx +++ b/docs/api/segment.mdx @@ -27,7 +27,7 @@ Their functionality is similar to tabs, where selecting one will deselect all ot ## Basic Usage {/* #basic-usage */} -Segments consist of [segment buttons](./segment-button) with a `value` property on each button. Set the `value` property on the segment to match the value of a button to select that button. Segments can also be disabled to prevent users from interacting with them. +Segments consist of [segment buttons](./segment-button.mdx) with a `value` property on each button. Set the `value` property on the segment to match the value of a button to select that button. Segments can also be disabled to prevent users from interacting with them. import Basic from '@site/static/usage/v9/segment/basic/index.mdx'; diff --git a/docs/api/select-option.mdx b/docs/api/select-option.mdx index 7c0965dfe0..efe3c4907e 100644 --- a/docs/api/select-option.mdx +++ b/docs/api/select-option.mdx @@ -23,7 +23,7 @@ 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, refer to the [Select](./select) documentation. +For usage examples, refer to the [Select](./select.mdx) documentation. ## Properties {/* #properties */} diff --git a/docs/api/select.mdx b/docs/api/select.mdx index 97404ad072..4b40227484 100644 --- a/docs/api/select.mdx +++ b/docs/api/select.mdx @@ -89,7 +89,7 @@ import MultipleSelectionExample from '@site/static/usage/v9/select/basic/multipl ## Interfaces {/* #interfaces */} -By default, select uses [ion-alert](alert.mdx) to open up the overlay of options in an alert. The interface can be changed to use [ion-action-sheet](action-sheet.mdx), [ion-popover](popover.mdx), or [ion-modal](modal.mdx) by passing `action-sheet`, `popover`, or `modal`, respectively, to the `interface` property. Read on to the other sections for the limitations of the different interfaces. +By default, select uses [ion-alert](./alert.mdx) to open up the overlay of options in an alert. The interface can be changed to use [ion-action-sheet](./action-sheet.mdx), [ion-popover](./popover.mdx), or [ion-modal](./modal.mdx) by passing `action-sheet`, `popover`, or `modal`, respectively, to the `interface` property. Read on to the other sections for the limitations of the different interfaces. ### Alert {/* #alert */} @@ -181,7 +181,7 @@ import ButtonTextExample from '@site/static/usage/v9/select/customization/button Since select uses the alert, action sheet, popover, and modal interfaces, options can be passed to these components through the `interfaceOptions` property. This can be used to pass a custom header, subheader, css class, and more. -Refer to the [ion-alert docs](alert.mdx), [ion-action-sheet docs](action-sheet.mdx), [ion-popover docs](popover.mdx), and [ion-modal docs](modal.mdx) for the properties that each interface accepts. +Refer to the [ion-alert docs](./alert.mdx), [ion-action-sheet docs](./action-sheet.mdx), [ion-popover docs](./popover.mdx), and [ion-modal docs](./modal.mdx) for the properties that each interface accepts. Note: `interfaceOptions` will not override `inputs` or `buttons` with the `alert` interface. @@ -209,7 +209,7 @@ import StartEndSlots from '@site/static/usage/v9/select/start-end-slots/index.md :::important -Rich content in select options is disabled by default. Set [`innerHTMLTemplatesEnabled`](/developing/config.mdx#ionicconfig) to `true` in your [global Ionic config](/developing/config.mdx#global-config). Markup inside options is treated as plain text when it is disabled. Refer to [Security](/techniques/security.mdx) for sanitization guidance when enabling custom HTML. +Rich content in select options is disabled by default. Set [`innerHTMLTemplatesEnabled`](../developing/config.mdx#ionicconfig) to `true` in your [global Ionic config](../developing/config.mdx#global-config). Markup inside options is treated as plain text when it is disabled. Refer to [Security](../techniques/security.mdx) for sanitization guidance when enabling custom HTML. ::: @@ -241,12 +241,12 @@ import StylingSelectExample from '@site/static/usage/v9/select/customization/sty Customizing the interface dialog should be done by following the styling sections (CSS shadow parts, CSS custom properties, and slots) in that interface's documentation: -- [Alert](alert.mdx#css-shadow-parts) -- [Action Sheet](action-sheet.mdx#css-shadow-parts) -- [Popover](popover.mdx#css-shadow-parts) -- [Modal](modal.mdx#css-shadow-parts) +- [Alert](./alert.mdx#css-shadow-parts) +- [Action Sheet](./action-sheet.mdx#css-shadow-parts) +- [Popover](./popover.mdx#css-shadow-parts) +- [Modal](./modal.mdx#css-shadow-parts) -However, the Select Option does set a class for easier styling and allows for the ability to pass a class to the overlay option, refer to the [Select Options documentation](select-option.mdx) for usage examples of customizing options. +However, the Select Option does set a class for easier styling and allows for the ability to pass a class to the overlay option, refer to the [Select Options documentation](./select-option.mdx) for usage examples of customizing options. ### Custom Toggle Icons {/* #custom-toggle-icons */} diff --git a/docs/api/tab-bar.mdx b/docs/api/tab-bar.mdx index 42a5f39c6d..e4ab404af2 100644 --- a/docs/api/tab-bar.mdx +++ b/docs/api/tab-bar.mdx @@ -24,7 +24,7 @@ import EncapsulationPill from '@components/page/api/EncapsulationPill'; -The tab bar is a UI component that contains a set of [tab buttons](tab-button.mdx). A tab bar must be provided inside of [tabs](tabs.mdx) to communicate with each [tab](tab.mdx). +The tab bar is a UI component that contains a set of [tab buttons](./tab-button.mdx). A tab bar must be provided inside of [tabs](./tabs.mdx) to communicate with each [tab](./tab.mdx). ## Usage {/* #usage */} diff --git a/docs/api/tab-button.mdx b/docs/api/tab-button.mdx index 33d25635f9..cb6019bbbe 100644 --- a/docs/api/tab-button.mdx +++ b/docs/api/tab-button.mdx @@ -16,9 +16,9 @@ import EncapsulationPill from '@components/page/api/EncapsulationPill'; -A tab button is a UI component that is placed inside of a [tab bar](tab-bar.mdx). The tab button can specify the layout of the icon and label and connect to a [tab view](tab.mdx). +A tab button is a UI component that is placed inside of a [tab bar](./tab-bar.mdx). The tab button can specify the layout of the icon and label and connect to a [tab view](./tab.mdx). -Refer to the [tabs documentation](tabs.mdx) for more details on configuring tabs. +Refer to the [tabs documentation](./tabs.mdx) for more details on configuring tabs. ## Usage {/* #usage */} diff --git a/docs/api/tab.mdx b/docs/api/tab.mdx index bdc6173b77..f206d1b6c2 100644 --- a/docs/api/tab.mdx +++ b/docs/api/tab.mdx @@ -21,7 +21,7 @@ import EncapsulationPill from '@components/page/api/EncapsulationPill'; -The tab component is a child component of [tabs](tabs.mdx). 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. +The tab component is a child component of [tabs](./tabs.mdx). 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 @@ -31,7 +31,7 @@ In JavaScript, this component can be used with the `ion-tabs` component configur ::: -Refer to the [tabs documentation](tabs.mdx) for more details on configuring tabs. +Refer to the [tabs documentation](./tabs.mdx) for more details on configuring tabs. ## Properties {/* #properties */} diff --git a/docs/api/tabs.mdx b/docs/api/tabs.mdx index 2066798006..00f311dcf8 100644 --- a/docs/api/tabs.mdx +++ b/docs/api/tabs.mdx @@ -21,7 +21,7 @@ import EncapsulationPill from '@components/page/api/EncapsulationPill'; -Tabs are a top level navigation component to implement a tab-based navigation. The component is a container of individual [Tab](tab.mdx) components. +Tabs are a top level navigation component to implement a tab-based navigation. The component is a container of individual [Tab](./tab.mdx) components. The `ion-tabs` component does not have any styling and works as a router outlet in order to handle navigation. It does not provide any UI feedback or mechanism to switch between tabs. In order to do so, an `ion-tab-bar` should be provided as a direct child of `ion-tabs`. @@ -47,7 +47,7 @@ import Router from '@site/static/usage/v9/tabs/router/index.mdx'; :::tip[Best Practices] -Ionic has guides on best practices for routing patterns with tabs. Check out the guides for [Angular](/angular/navigation#working-with-tabs), [React](/react/navigation#working-with-tabs), and [Vue](/vue/navigation#working-with-tabs) for additional information. +Ionic has guides on best practices for routing patterns with tabs. Check out the guides for [Angular](../angular/navigation.mdx#working-with-tabs), [React](../react/navigation.mdx#working-with-tabs), and [Vue](../vue/navigation.mdx#working-with-tabs) for additional information. ::: diff --git a/docs/api/text.mdx b/docs/api/text.mdx index 5004b7d3c1..8199fc0abc 100644 --- a/docs/api/text.mdx +++ b/docs/api/text.mdx @@ -31,7 +31,7 @@ import Basic from '@site/static/usage/v9/text/basic/index.mdx'; ## Theming {/* #theming */} -The text component can be customized by changing any of the default [colors](/theming/colors.mdx) Ionic provides. +The text component can be customized by changing any of the default [colors](../theming/colors.mdx) Ionic provides. ## Properties {/* #properties */} diff --git a/docs/api/title.mdx b/docs/api/title.mdx index 3496800d9c..151cccb9ad 100644 --- a/docs/api/title.mdx +++ b/docs/api/title.mdx @@ -21,7 +21,7 @@ import EncapsulationPill from '@components/page/api/EncapsulationPill'; -Title is a text component that sets the title for a [toolbar](./toolbar). It can be used to describe the screen or section a user is currently on or the app being used. +Title is a text component that sets the title for a [toolbar](./toolbar.mdx). It can be used to describe the screen or section a user is currently on or the app being used. ## Basic {/* #basic */} @@ -31,7 +31,7 @@ import Basic from '@site/static/usage/v9/title/basic/index.mdx'; ## Collapsible Large Titles {/* #collapsible-large-titles */} -The large title will display when the [content](./content) is scrolled to the start of the scroll container. When the title is scrolled behind the header, the condensed title will fade in. +The large title will display when the [content](./content.mdx) is scrolled to the start of the scroll container. When the title is scrolled behind the header, the condensed title will fade in. :::info @@ -59,7 +59,7 @@ When creating headings, we typically recommend using [semantic heading elements To achieve this, developers should use the [`heading` role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/heading_role) on Title. This will indicate to assistive technologies that Title is a type of heading. From there, developers should use the [`aria-level` attribute](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-level) to set the heading level. -For example, if we wanted to make a Title behave like an `h1` element, we would set `role="heading"` and `aria-level="1"` on the Title. This is necessary when using the [Focus Manager](../developing/managing-focus#assistive-technology-focus-management). +For example, if we wanted to make a Title behave like an `h1` element, we would set `role="heading"` and `aria-level="1"` on the Title. This is necessary when using the [Focus Manager](../developing/managing-focus.mdx#assistive-technology-focus-management). Since multiple Title elements can be used on a view in conjunction with semantic heading elements, Ionic does not automatically set the Title's `role` or `aria-level`. It is the responsibility of the developer to handle this. diff --git a/docs/api/toast.mdx b/docs/api/toast.mdx index 518196a974..83ccd44c5b 100644 --- a/docs/api/toast.mdx +++ b/docs/api/toast.mdx @@ -94,7 +94,7 @@ import StackedPlayground from '@site/static/usage/v9/toast/layout/index.mdx'; ## Icons {/* #icons */} -An icon can be added next to the content inside of the toast. In general, icons in toasts should be used to add additional style or context, not to grab the user's attention or elevate the priority of the toast. If you wish to convey a higher priority message to the user or guarantee a response, we recommend using an [Alert](alert.mdx) instead. +An icon can be added next to the content inside of the toast. In general, icons in toasts should be used to add additional style or context, not to grab the user's attention or elevate the priority of the toast. If you wish to convey a higher priority message to the user or guarantee a response, we recommend using an [Alert](./alert.mdx) instead. import IconPlayground from '@site/static/usage/v9/toast/icon/index.mdx'; @@ -114,7 +114,7 @@ Toasts are intended to be subtle notifications and are not intended to interrupt ### Screen Readers {/* #screen-readers */} -Toasts set aria properties in order to be [accessible](../reference/glossary#a11y) to screen readers, but these properties can be overridden if they aren't descriptive enough or don't align with how the toast is being used in an app. +Toasts set aria properties in order to be [accessible](../reference/glossary.mdx#a11y) to screen readers, but these properties can be overridden if they aren't descriptive enough or don't align with how the toast is being used in an app. #### Role {/* #role */} @@ -122,7 +122,7 @@ Toasts set aria properties in order to be [accessible](../reference/glossary#a11 `aria-live` causes screen readers to announce the content of the toast when it is updated. However, since the attribute is set to `'polite'`, screen readers should not interrupt the current task. -Since toasts are intended to be subtle notification, `aria-live` should never be set to `"assertive"`. If developers need to interrupt the user with an important message, we recommend using an [alert](./alert). +Since toasts are intended to be subtle notification, `aria-live` should never be set to `"assertive"`. If developers need to interrupt the user with an important message, we recommend using an [alert](./alert.mdx). #### Toast Buttons Description {/* #toast-buttons-description */} @@ -208,13 +208,13 @@ const toast = await toastController.create({ While this is not a complete list, here are some guidelines to follow when using toasts. -- Do not require user interaction to dismiss toasts. For example, having a "Dismiss" button in the toast is fine, but the toast should also automatically dismiss on its own after a timeout period. If you need user interaction for a notification, consider using an [alert](./alert) instead. +- Do not require user interaction to dismiss toasts. For example, having a "Dismiss" button in the toast is fine, but the toast should also automatically dismiss on its own after a timeout period. If you need user interaction for a notification, consider using an [alert](./alert.mdx) instead. - For toasts with long messages, consider adjusting the `duration` property to allow users enough time to read the content of the toast. - If adding buttons to a toast, always provide alternative ways of completing the actions associated with each button. This ensures that even if the toast dismisses before a user can read it, they can still complete the actions shown in the toast. -- Avoid showing a toast with buttons from inside another overlay such as a [modal](./modal). Modals and other overlays implement [focus trapping](./modal#focus-trapping) that will prevent screen readers from moving focus to the toast to complete the actions. This may be confusing for users since the toast will still be announced by screen readers. This is true even if alternative ways of completing the actions associated with each button are implemented. Consider creating a [live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/ARIA_Live_Regions) within the focus-trapped modal instead of using a toast. +- Avoid showing a toast with buttons from inside another overlay such as a [modal](./modal.mdx). Modals and other overlays implement [focus trapping](./modal.mdx#focus-trapping) that will prevent screen readers from moving focus to the toast to complete the actions. This may be confusing for users since the toast will still be announced by screen readers. This is true even if alternative ways of completing the actions associated with each button are implemented. Consider creating a [live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/ARIA_Live_Regions) within the focus-trapped modal instead of using a toast. ## Interfaces {/* #interfaces */} diff --git a/docs/api/toggle.mdx b/docs/api/toggle.mdx index 36b1fe3906..2baa66446e 100644 --- a/docs/api/toggle.mdx +++ b/docs/api/toggle.mdx @@ -39,7 +39,7 @@ import OnOff from '@site/static/usage/v9/toggle/on-off/index.mdx'; ## Toggles in a List {/* #toggles-in-a-list */} -Toggles can also be used in a list view by using the [Item](./item) and [List](./list) components. +Toggles can also be used in a list view by using the [Item](./item.mdx) and [List](./list.mdx) components. import List from '@site/static/usage/v9/toggle/list/index.mdx'; diff --git a/docs/api/toolbar.mdx b/docs/api/toolbar.mdx index 34b575a9d9..39933babfb 100644 --- a/docs/api/toolbar.mdx +++ b/docs/api/toolbar.mdx @@ -21,13 +21,13 @@ import EncapsulationPill from '@components/page/api/EncapsulationPill'; -Toolbars are generally positioned above or below content and provide content and actions for the current screen. When placed within the [content](./content), toolbars will scroll with the content. +Toolbars are generally positioned above or below content and provide content and actions for the current screen. When placed within the [content](./content.mdx), toolbars will scroll with the content. Toolbars can contain several different components including titles, buttons, icons, back buttons, menu buttons, searchbars, segments, progress bars, and more. ## Basic Usage {/* #basic-usage */} -It is recommended to put a toolbar inside of a [header](./header) or [footer](./footer) for proper positioning. When a toolbar is placed in a header it will appear fixed at the top of the content. When it is placed in a footer it will appear fixed at the bottom. Fullscreen content will scroll behind a toolbar in a header or footer. A [title](./title) component can be used to display text inside of the toolbar. +It is recommended to put a toolbar inside of a [header](./header.mdx) or [footer](./footer.mdx) for proper positioning. When a toolbar is placed in a header it will appear fixed at the top of the content. When it is placed in a footer it will appear fixed at the bottom. Fullscreen content will scroll behind a toolbar in a header or footer. A [title](./title.mdx) component can be used to display text inside of the toolbar. import Basic from '@site/static/usage/v9/toolbar/basic/index.mdx'; @@ -35,9 +35,9 @@ import Basic from '@site/static/usage/v9/toolbar/basic/index.mdx'; ## Buttons in Toolbars {/* #buttons-in-toolbars */} -Buttons placed in a toolbar should be placed inside of the [buttons](./buttons) component. The buttons component can be positioned inside of the toolbar using a named [slot](#slots). The `"primary"` and `"secondary"` slots behave differently in `ios` and `md` mode. +Buttons placed in a toolbar should be placed inside of the [buttons](./buttons.mdx) component. The buttons component can be positioned inside of the toolbar using a named [slot](#slots). The `"primary"` and `"secondary"` slots behave differently in `ios` and `md` mode. -The buttons component can wrap a standard [button](./button), [back button](./back-button), [menu button](./menu-button), or several of any of them. A button in a toolbar is styled to be clear by default, but this can be changed using the [`fill`](./button#fill) property on the button. The properties included on back button and menu button in this example are for display purposes; refer to their respective documentation for proper usage. +The buttons component can wrap a standard [button](./button.mdx), [back button](./back-button.mdx), [menu button](./menu-button.mdx), or several of any of them. A button in a toolbar is styled to be clear by default, but this can be changed using the [`fill`](./button.mdx#fill) property on the button. The properties included on back button and menu button in this example are for display purposes; refer to their respective documentation for proper usage. import Buttons from '@site/static/usage/v9/toolbar/buttons/index.mdx'; @@ -45,7 +45,7 @@ import Buttons from '@site/static/usage/v9/toolbar/buttons/index.mdx'; ## Searchbars in Toolbars {/* #searchbars-in-toolbars */} -A [searchbar](./searchbar) can be placed inside of a toolbar to search through the content. It should be the only child component of the toolbar, and will take up the full width and height. +A [searchbar](./searchbar.mdx) can be placed inside of a toolbar to search through the content. It should be the only child component of the toolbar, and will take up the full width and height. import Searchbars from '@site/static/usage/v9/toolbar/searchbars/index.mdx'; @@ -53,7 +53,7 @@ import Searchbars from '@site/static/usage/v9/toolbar/searchbars/index.mdx'; ## Segments in Toolbars {/* #segments-in-toolbars */} -[Segments](./segment) are generally used in toolbars to toggle between two different content views on the same page. They can be placed in a toolbar with other components, such as buttons, but should not be placed alongside a title. +[Segments](./segment.mdx) are generally used in toolbars to toggle between two different content views on the same page. They can be placed in a toolbar with other components, such as buttons, but should not be placed alongside a title. import Segments from '@site/static/usage/v9/toolbar/segments/index.mdx'; @@ -61,7 +61,7 @@ import Segments from '@site/static/usage/v9/toolbar/segments/index.mdx'; ## Progress Bars in Toolbars {/* #progress-bars-in-toolbars */} -A [progress bar](./progress-bar) is used as a loading indicator to show an ongoing process in an app. Progress bars can be placed with any other components inside of a toolbar as they will align with the bottom of the toolbar. +A [progress bar](./progress-bar.mdx) is used as a loading indicator to show an ongoing process in an app. Progress bars can be placed with any other components inside of a toolbar as they will align with the bottom of the toolbar. import ProgressBars from '@site/static/usage/v9/toolbar/progress-bars/index.mdx'; diff --git a/docs/cli.mdx b/docs/cli.mdx index 08bf2b907c..9d16276a4f 100644 --- a/docs/cli.mdx +++ b/docs/cli.mdx @@ -11,7 +11,7 @@ sidebar_label: Overview /> -The Ionic command-line interface ([CLI](/reference/glossary.mdx#cli)) is the go-to tool for developing Ionic apps. +The Ionic command-line interface ([CLI](./reference/glossary.mdx#cli)) is the go-to tool for developing Ionic apps. ## Installation {/* #installation */} @@ -41,14 +41,14 @@ For some commands, such as `ionic serve`, the help documentation is contextual t ## Architecture {/* #architecture */} -The Ionic CLI is built with [TypeScript](/reference/glossary.mdx#typescript) and [Node.js](/reference/glossary.mdx#node). It supports Node 10.3+, but the latest Node LTS is always recommended. Follow development on the open source [GitHub repository](https://github.com/ionic-team/ionic-cli). +The Ionic CLI is built with [TypeScript](./reference/glossary.mdx#typescript) and [Node.js](./reference/glossary.mdx#node). It supports Node 10.3+, but the latest Node LTS is always recommended. Follow development on the open source [GitHub repository](https://github.com/ionic-team/ionic-cli). ## Troubleshooting {/* #troubleshooting */} To troubleshoot issues with the Ionic CLI, the following may be useful: - Make sure the latest version of the Ionic CLI is installed. Get the installed Ionic CLI version by running `ionic --version`. The Ionic CLI version is not related to the Ionic Framework version. -- Make sure the latest Node LTS is installed. Refer to [Node & npm](/intro/environment.mdx#node--npm) environment setup. +- Make sure the latest Node LTS is installed. Refer to [Node & npm](./intro/environment.mdx#node--npm) environment setup. - The `--verbose` flag prints debugging messages, which may narrow down the issue. -- Connection issues may be due to improperly configured proxy settings. Refer to [Using a Proxy](/cli/using-a-proxy.mdx) to configure request proxying. -- The global Ionic CLI configuration directory is `~/.ionic` on all platforms. It can safely be deleted and the Ionic CLI will repopulate it, but all configuration (including user sessions) will be lost. Configure this directory with [CLI environment variables](/cli/configuration.mdx#environment-variables). +- Connection issues may be due to improperly configured proxy settings. Refer to [Using a Proxy](./cli/using-a-proxy.mdx) to configure request proxying. +- The global Ionic CLI configuration directory is `~/.ionic` on all platforms. It can safely be deleted and the Ionic CLI will repopulate it, but all configuration (including user sessions) will be lost. Configure this directory with [CLI environment variables](./cli/configuration.mdx#environment-variables). diff --git a/docs/cli/configuration.mdx b/docs/cli/configuration.mdx index 4a5cc4fc14..eb3d7615f4 100644 --- a/docs/cli/configuration.mdx +++ b/docs/cli/configuration.mdx @@ -14,7 +14,7 @@ title: Configuration Configuration values are stored in JSON files. The Ionic CLI maintains a global configuration file, usually located at `~/.ionic/config.json`, and project configuration files, usually at the project's root directory as `ionic.config.json`. -The CLI provides commands for setting and printing config values from project config files and the global CLI config file. Run `ionic config --help` or refer to the documentation for usage of [`ionic config get`](/cli/commands/config-get.mdx) and [`ionic config set`](/cli/commands/config-set.mdx). +The CLI provides commands for setting and printing config values from project config files and the global CLI config file. Run `ionic config --help` or refer to the documentation for usage of [`ionic config get`](./commands/config-get.mdx) and [`ionic config set`](./commands/config-set.mdx). ### Project Configuration File {/* #project-configuration-file */} @@ -52,7 +52,7 @@ Each Ionic project has a project configuration file, usually at the project's ro The CLI will look for the following environment variables: - `IONIC_CONFIG_DIRECTORY`: The directory of the global CLI config. Defaults to `~/.ionic`. -- `IONIC_HTTP_PROXY`: Set a URL for proxying all CLI requests through. Refer to [Using a Proxy](using-a-proxy.mdx). +- `IONIC_HTTP_PROXY`: Set a URL for proxying all CLI requests through. Refer to [Using a Proxy](./using-a-proxy.mdx). - `IONIC_TOKEN`: Automatically authenticates with [Appflow](https://ionic.io/appflow). ## Flags {/* #flags */} diff --git a/docs/cli/livereload.mdx b/docs/cli/livereload.mdx index 62dca1c3d3..aa12e4e7dc 100644 --- a/docs/cli/livereload.mdx +++ b/docs/cli/livereload.mdx @@ -59,7 +59,7 @@ Remember, with the `--external` option, others on your Wi-Fi network will be abl ## Tips {/* #tips */} -- With Cordova, use the `--device`, `--emulator`, and `--target` options to narrow down target devices. Use the `--list` option to list all targets. See usage in the [command docs](/cli/commands/cordova-run.mdx). +- With Cordova, use the `--device`, `--emulator`, and `--target` options to narrow down target devices. Use the `--list` option to list all targets. See usage in the [command docs](./commands/cordova-run.mdx). - You can separate the dev server process and the deploy process by using `ionic serve` and the `--livereload-url` option of `ionic cordova run` or `ionic capacitor run`. - For Android, it is possible to configure [adb](https://developer.android.com/studio/command-line/adb) to always forward ports while the adb server is running (refer to `adb reverse`). With port forwarding set up, an external address would no longer be required. You can also setup the adb bridge over TCP such that subsequent deploys no longer need a USB cable. - If you are using a development container with Angular, live reload may not work. To fix it, set `projects.app.architect.serve.configurations.development.poll` to `1` in `angular.json`. diff --git a/docs/components.mdx b/docs/components.mdx index 34bfd4257c..5700d2be7e 100644 --- a/docs/components.mdx +++ b/docs/components.mdx @@ -19,156 +19,156 @@ import DocsCards from '@components/global/DocsCards'; `} -Ionic apps are made of high-level building blocks called Components, which allow you to quickly construct the UI for your app. Ionic comes stock with a number of components, including cards, lists, and tabs. Once you're familiar with the basics, refer to the [API Index](api.mdx) for a complete list of each component and sub-component. +Ionic apps are made of high-level building blocks called Components, which allow you to quickly construct the UI for your app. Ionic comes stock with a number of components, including cards, lists, and tabs. Once you're familiar with the basics, refer to the [API Index](./api.mdx) for a complete list of each component and sub-component. - +

Accordions provide collapsible sections in your content to reduce vertical space while providing a way of organizing and grouping information.

- +

Action Sheets display a set of options with the ability to confirm or cancel an action.

- +

Alerts are a great way to offer the user the ability to choose a specific action or list of actions.

- +

Badges are a small component that typically communicate a numerical value to the user.

- +

Breadcrumbs are navigation items that are used to indicate where a user is on an app.

- +

Buttons let your users take action. They're an essential way to interact with and navigate through an app.

- + Cards are a great way to display an important piece of content, and can contain images, buttons, text, and more. - +

Checkboxes can be used to let the user know they need to make a binary decision.

- +

Chips are a compact way to display data or actions.

- +

Content is the quintessential way to interact with and navigate through an app.

- +

Date & time pickers are used to present an interface that makes it easy for users to select dates and times.

- +

Floating action buttons are circular buttons that perform a primary action on a screen.

- +

The grid is a powerful mobile-first system for building custom layouts.

- +

Beautifully designed icons for use in web, iOS, and Android apps.

- +

Infinite scroll allows you to load new data as the user scrolls through your app.

- +

Inputs provide a way for users to enter data in your app.

- + Items are elements that can contain text, icons, avatars, images, inputs, and any other native or custom elements. Items can be swiped, deleted, reordered, edited, and more. - +

Lists can display rows of information, such as a contact list, playlist, or menu.

- + A collection of media components, including avatars, icons, images, and thumbnails, designed to enhance visual content. - +

Menus are a common navigation pattern. They can be permanently on-screen, or revealed when needed.

- +

Modals slide in and off screen to display a temporary UI and are often used for login or sign-up pages.

- +

Navigation is how users move between different pages in your app.

- +

Popover provides an easy way to present information or options without changing contexts.

- +

Progress indicators visualize the progression of an operation or activity.

- +

Radio inputs allow you to present a set of exclusive options.

- +

Range sliders let users select a value by dragging a knob along a track.

- +

Refresher provides pull-to-refresh functionality on a content component.

- +

Reorder lets users drag and drop to reorder a list of items.

- +

Routing allows navigation based on the current path.

- +

Searchbar is used to search or filter items, usually from a toolbar.

- +

Segments provide a set of exclusive buttons that can be used as a filter or view switcher.

- +

Select is similar to the native HTML select, with a few improvements to sorting and selecting.

- +

Tabs enable tabbed navigation, a standard navigation pattern in modern apps.

- +

Toasts are subtle notifications that appear over your app's content without interrupting user interaction.

- +

Toggles are an input for binary options, often used for options and switches.

- +

Toolbars are used to house information and actions relating to your app.

- +

Text is used to style or change the color of text within an application.

diff --git a/docs/contributing/how-to-contribute.mdx b/docs/contributing/how-to-contribute.mdx index 176376b5b5..03460d89b9 100644 --- a/docs/contributing/how-to-contribute.mdx +++ b/docs/contributing/how-to-contribute.mdx @@ -8,7 +8,7 @@ Thanks for the interest in contributing to Ionic Framework! ## Contributing Etiquette {/* #contributing-etiquette */} -Please refer to the [Contributor Code of Conduct](coc.mdx) for information on the rules of conduct. +Please refer to the [Contributor Code of Conduct](./coc.mdx) for information on the rules of conduct. ## Creating an Issue {/* #creating-an-issue */} diff --git a/docs/core-concepts/fundamentals.mdx b/docs/core-concepts/fundamentals.mdx index 0f8768763e..6c011e1a7c 100644 --- a/docs/core-concepts/fundamentals.mdx +++ b/docs/core-concepts/fundamentals.mdx @@ -37,7 +37,7 @@ For apps that are built with Angular and `@ionic/angular`, we recommend using th An amazing feature of apps built with web technologies (such as Ionic apps!) is that it can run on virtually any platform: desktop computers, phones, tablets, cars, refrigerators, and more! The same code base for Ionic apps can work on many platforms because it is based on web standards and common APIs that are shared across these platforms. That said, Ionic Framework is designed and tested for mobile platforms. Refer to [Browser Support](../reference/browser-support.mdx#mobile-platforms) for the platforms it officially supports. -One of the most common use cases for Ionic is to build an app which can be downloaded from both the [App Store](https://www.apple.com/ios/app-store/) and [Play Store](https://play.google.com/). Both iOS and Android software development kits (SDKs) provide [Web Views](webview.mdx) which render any Ionic app, while still allowing for _full_ Native SDK access. +One of the most common use cases for Ionic is to build an app which can be downloaded from both the [App Store](https://www.apple.com/ios/app-store/) and [Play Store](https://play.google.com/). Both iOS and Android software development kits (SDKs) provide [Web Views](./webview.mdx) which render any Ionic app, while still allowing for _full_ Native SDK access. Projects such as [Capacitor](https://capacitorjs.com/) and [Cordova](https://cordova.apache.org/) are commonly used to give Ionic apps this access to Native SDKs. This means developers can quickly build out an app using common web development tools, and still have access to native features such as the device's accelerometer, camera, GPS, and more. @@ -53,7 +53,7 @@ Developers can use standard events such as `click` as they normally would. Howev ## Properties {/* #properties */} -Properties are JavaScript properties that can be set on Ionic components to configure their behavior and appearance. Properties are defined in each component's [API documentation](/api.mdx) page. +Properties are JavaScript properties that can be set on Ionic components to configure their behavior and appearance. Properties are defined in each component's [API documentation](../api.mdx) page. ### Reactive Properties {/* #reactive-properties */} @@ -75,4 +75,4 @@ Virtual properties are designed for one-time configuration during component init The `mode` property is a virtual property that determines which platform styles to use for a component. It can be set at the component level or globally through the app configuration. In both cases, it's set once during initialization and doesn't change during the component's lifecycle. -For more information on Ionic modes, read the [Platform Styles documentation](/theming/platform-styles.mdx). +For more information on Ionic modes, read the [Platform Styles documentation](../theming/platform-styles.mdx). diff --git a/docs/deployment/progressive-web-app.mdx b/docs/deployment/progressive-web-app.mdx index b1682f5c56..4efb0c1df4 100644 --- a/docs/deployment/progressive-web-app.mdx +++ b/docs/deployment/progressive-web-app.mdx @@ -19,13 +19,13 @@ Because Ionic Apps are built with web technologies, they can run just as well as For the frameworks Ionic supports, we've created dedicated guides that go into more detail. Below are links for Angular, React, and Vue. - + Get started with progressive web apps in Angular. - + Get started with progressive web apps in React. - + Get started with progressive web apps in Vue. diff --git a/docs/developing/config.mdx b/docs/developing/config.mdx index 77e578d858..28f0d682aa 100644 --- a/docs/developing/config.mdx +++ b/docs/developing/config.mdx @@ -193,7 +193,7 @@ Below are the config options that Ionic uses. | `modalLeave` | `AnimationBuilder` | Provides a custom leave animation for all `ion-modal`, overriding the default "animation". | | `mode` | `Mode` | The mode determines which platform styles to use for the whole application. | | `navAnimation` | `AnimationBuilder` | Overrides the default "animation" of all `ion-nav` and `ion-router-outlet` across the whole application. | -| `platform` | [`PlatformConfig`](/angular/platform.mdx#customizing-platform-detection-functions) | Overrides the default platform detection methods. | +| `platform` | [`PlatformConfig`](../angular/platform.mdx#customizing-platform-detection-functions) | Overrides the default platform detection methods. | | `popoverEnter` | `AnimationBuilder` | Provides a custom enter animation for all `ion-popover`, overriding the default "animation". | | `popoverLeave` | `AnimationBuilder` | Provides a custom leave animation for all `ion-popover`, overriding the default "animation". | | `refreshingIcon` | `string` | Overrides the default icon in all `` components. | @@ -209,4 +209,4 @@ Below are the config options that Ionic uses. | `toastLeave` | `AnimationBuilder` | Provides a custom leave animation for all `ion-toast`, overriding the default "animation". | | `toggleOnOffLabels` | `boolean` | Overrides the default `enableOnOffLabels` in all `ion-toggle` components. | | `experimentalCloseWatcher` | `boolean` | **Experimental:** If `true`, the [CloseWatcher API](https://github.com/WICG/close-watcher) will be used to handle all Escape key and hardware back button presses to dismiss menus and overlays and to navigate. Note that the `hardwareBackButton` config option must also be `true`. | -| `focusManagerPriority` | [`FocusManagerPriority[]`](./managing-focus#types) | **Experimental:** When defined, Ionic will move focus to the appropriate element after each page transition. This ensures that users relying on assistive technology are informed when a page transition happens. Disabled by default. | +| `focusManagerPriority` | [`FocusManagerPriority[]`](./managing-focus.mdx#types) | **Experimental:** When defined, Ionic will move focus to the appropriate element after each page transition. This ensures that users relying on assistive technology are informed when a page transition happens. Disabled by default. | diff --git a/docs/developing/config/per-platform/index.mdx b/docs/developing/config/per-platform/index.mdx index 310f8bc1d2..7011c9de40 100644 --- a/docs/developing/config/per-platform/index.mdx +++ b/docs/developing/config/per-platform/index.mdx @@ -17,7 +17,7 @@ import TabItem from '@theme/TabItem'; Since the config is set at runtime, you will not have access to the Platform Dependency Injection. Instead, you can use the underlying functions that the provider uses directly. -Refer to the [Angular Platform Documentation](/angular/platform.mdx) for the types of platforms you can detect. +Refer to the [Angular Platform Documentation](../../../angular/platform.mdx) for the types of platforms you can detect. ::: @@ -46,7 +46,7 @@ import { isPlatform, IonicModule } from '@ionic/angular/lazy'; Since the config is set at runtime, you will not have access to the Platform Dependency Injection. Instead, you can use the underlying functions that the provider uses directly. -Refer to the [Angular Platform Documentation](/angular/platform.mdx) for the types of platforms you can detect. +Refer to the [Angular Platform Documentation](../../../angular/platform.mdx) for the types of platforms you can detect. ::: @@ -68,7 +68,7 @@ bootstrapApplication(AppComponent, { :::note -Refer to the [React Platform Documentation](/react/platform.mdx) for the types of platforms you can detect. +Refer to the [React Platform Documentation](../../../react/platform.mdx) for the types of platforms you can detect. ::: @@ -85,7 +85,7 @@ setupIonicReact({ :::note -Refer to the [Vue Platform Documentation](/vue/platform.mdx) for the types of platforms you can detect. +Refer to the [Vue Platform Documentation](../../../vue/platform.mdx) for the types of platforms you can detect. ::: diff --git a/docs/developing/managing-focus.mdx b/docs/developing/managing-focus.mdx index 78e10be4b9..a145f6ba28 100644 --- a/docs/developing/managing-focus.mdx +++ b/docs/developing/managing-focus.mdx @@ -15,7 +15,7 @@ import TabItem from '@theme/TabItem'; ## Manual Focus Management {/* #manual-focus-management */} -Ionic provides a `setFocus` API on components such as [Input](../api/input), [Searchbar](../api/searchbar), and [Textarea](../api/textarea) that allows developers to manually set focus to an element. This API should be used in place of the `autofocus` attribute and called within: +Ionic provides a `setFocus` API on components such as [Input](../api/input.mdx), [Searchbar](../api/searchbar.mdx), and [Textarea](../api/textarea.mdx) that allows developers to manually set focus to an element. This API should be used in place of the `autofocus` attribute and called within: - The `ionViewDidEnter` lifecycle event for routing applications when a page is entered. - The `didPresent` lifecycle event for overlays when an overlay is presented. @@ -245,7 +245,7 @@ export default Home; By default, Single Page Applications have no built-in way of informing screen readers that the active view has changed in a browser or webview. This means that users who rely on assistive technology do not always know if a navigation event occurred. -Developers who enable the [focusManagerPriority config](./config#ionicconfig) can delegate focus management to Ionic during page transitions. When enabled, Ionic will move focus to the correct element as specified in the config option. This will inform screen readers that a navigation event occurred. +Developers who enable the [focusManagerPriority config](./config.mdx#ionicconfig) can delegate focus management to Ionic during page transitions. When enabled, Ionic will move focus to the correct element as specified in the config option. This will inform screen readers that a navigation event occurred. ### Types {/* #types */} @@ -259,13 +259,13 @@ The following table explains what each content type represents: | Type | Description | Ionic Component | Semantic HTML Equivalent | Landmark Equivalent | | --- | --- | --- | --- | --- | -| `content` | The main portion of the view. | [Content](../api/content) | [`main`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/main) | [`role="main"`](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/Main_role) | -| `heading` | The title of the view. | [Title](../api/title) | [`h1`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/h1) | [`role="heading"`](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/heading_role) with [`aria-level="1"`](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-level) | -| `banner` | The header of the view. | [Header](../api/header) | [`header`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/header) | [`role="banner"`](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/Banner_Role) | +| `content` | The main portion of the view. | [Content](../api/content.mdx) | [`main`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/main) | [`role="main"`](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/Main_role) | +| `heading` | The title of the view. | [Title](../api/title.mdx) | [`h1`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/h1) | [`role="heading"`](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/heading_role) with [`aria-level="1"`](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-level) | +| `banner` | The header of the view. | [Header](../api/header.mdx) | [`header`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/header) | [`role="banner"`](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/Banner_Role) | :::important -Developers should assign `role="heading"` and `aria-level="1"` to the primary [Title](../api/title) on each view. Since multiple [Title](../api/title) components can be used in a single view, Ionic does not automatically assign these attributes. +Developers should assign `role="heading"` and `aria-level="1"` to the primary [Title](../api/title.mdx) on each view. Since multiple [Title](../api/title.mdx) components can be used in a single view, Ionic does not automatically assign these attributes. ::: diff --git a/docs/developing/previewing.mdx b/docs/developing/previewing.mdx index f78b65d12d..4e5e808e16 100644 --- a/docs/developing/previewing.mdx +++ b/docs/developing/previewing.mdx @@ -13,8 +13,8 @@ title: Previewing There are many different options to test native functionality depending on your target platforms and needs. - Run locally in a web browser (using [Platform Detection](../core-concepts/cross-platform.mdx) for native functionality) -- [Deploy to iOS](ios.mdx) -- [Deploy to Android](android.mdx) +- [Deploy to iOS](./ios.mdx) +- [Deploy to Android](./android.mdx) ## Run Locally in a Web Browser {/* #run-locally-in-a-web-browser */} @@ -44,7 +44,7 @@ If the external link isn't listed on the terminal, then run `ionic serve --exter ::: -When implementing native functionality, use [Platform Detection](../core-concepts/cross-platform.mdx). When you're ready to test on a real device, refer to the guides for [iOS](ios.mdx) and [Android](android.mdx). +When implementing native functionality, use [Platform Detection](../core-concepts/cross-platform.mdx). When you're ready to test on a real device, refer to the guides for [iOS](./ios.mdx) and [Android](./android.mdx). ## Simulating a Mobile Viewport {/* #simulating-a-mobile-viewport */} diff --git a/docs/developing/scaffolding.mdx b/docs/developing/scaffolding.mdx index 4dea0b5883..356c11e534 100644 --- a/docs/developing/scaffolding.mdx +++ b/docs/developing/scaffolding.mdx @@ -50,7 +50,7 @@ This command is only supported in Ionic Angular. ::: -The Ionic CLI can generate new app features with the [`ionic generate`](/cli/commands/generate.mdx) command. By running `ionic generate` in the command line, a selection prompt is displayed which lists the available features that can be generated. +The Ionic CLI can generate new app features with the [`ionic generate`](../cli/commands/generate.mdx) command. By running `ionic generate` in the command line, a selection prompt is displayed which lists the available features that can be generated. ```shell-session $ ionic generate @@ -96,4 +96,4 @@ The Ionic CLI uses the underlying framework tooling to stay close to best practi After creating the files and directories for the new page, the CLI will also update the router configuration to include the new page. This reduces the amount of manual work needed to keep the development lifecycle moving. -For more details, run `ionic g --help` from the command line or refer to the [`ionic generate` documentation](/cli/commands/generate.mdx). +For more details, run `ionic g --help` from the command line or refer to the [`ionic generate` documentation](../cli/commands/generate.mdx). diff --git a/docs/index.mdx b/docs/index.mdx index be5b39104e..e2987681ec 100644 --- a/docs/index.mdx +++ b/docs/index.mdx @@ -22,9 +22,9 @@ import DocsCards from '@components/global/DocsCards'; -Ionic is an open source UI toolkit for building performant, high-quality mobile apps using web technologies — HTML, CSS, and JavaScript — with integrations for popular frameworks like [Angular](angular/overview.mdx), [React](react/overview.mdx), and [Vue](vue/overview.mdx). +Ionic is an open source UI toolkit for building performant, high-quality mobile apps using web technologies — HTML, CSS, and JavaScript — with integrations for popular frameworks like [Angular](./angular/overview.mdx), [React](./react/overview.mdx), and [Vue](./vue/overview.mdx). -Get started building by [installing Ionic](intro/cli.mdx) or following our [First App Tutorial](intro/next.mdx#build-your-first-app) to learn the main concepts. +Get started building by [installing Ionic](./intro/cli.mdx) or following our [First App Tutorial](./intro/next.mdx#build-your-first-app) to learn the main concepts. @@ -56,11 +56,11 @@ Get started building by [installing Ionic](intro/cli.mdx) or following our [Firs ## Overview {/* #overview */} -Ionic focuses on the frontend UX and UI interaction of an app — UI controls, interactions, gestures, animations. It's easy to learn, and integrates with other libraries or frameworks, such as [Angular](angular/overview.mdx), [React](react/overview.mdx), or [Vue](vue/overview.mdx). Alternatively, it can be used standalone without any frontend framework using a simple [script include](intro/cdn.mdx). If you’d like to learn more about Ionic before diving in, we [created a video](https://youtu.be/p3AN3igqiRc) to walk you through the basics. +Ionic focuses on the frontend UX and UI interaction of an app — UI controls, interactions, gestures, animations. It's easy to learn, and integrates with other libraries or frameworks, such as [Angular](./angular/overview.mdx), [React](./react/overview.mdx), or [Vue](./vue/overview.mdx). Alternatively, it can be used standalone without any frontend framework using a simple [script include](./intro/cdn.mdx). If you’d like to learn more about Ionic before diving in, we [created a video](https://youtu.be/p3AN3igqiRc) to walk you through the basics. ### One codebase, running everywhere {/* #one-codebase-running-everywhere */} -Ionic is the only mobile app stack that enables web developers to build apps for all major app stores and the mobile web from a single codebase. And with [Adaptive Styling](theming/platform-styles.mdx), Ionic apps look and feel at home on every device. +Ionic is the only mobile app stack that enables web developers to build apps for all major app stores and the mobile web from a single codebase. And with [Adaptive Styling](./theming/platform-styles.mdx), Ionic apps look and feel at home on every device. ### A focus on performance {/* #a-focus-on-performance */} @@ -82,7 +82,7 @@ Build and deploy apps that work across multiple platforms, such as native iOS, A ### Web Standards-based {/* #web-standards-based */} -Ionic is built on top of reliable, [standardized web technologies](reference/glossary.mdx#web-standards): HTML, CSS, and JavaScript, using modern Web APIs such as Custom Elements and Shadow DOM. Because of this, Ionic components have a stable API, and aren't at the whim of a single platform vendor. +Ionic is built on top of reliable, [standardized web technologies](./reference/glossary.mdx#web-standards): HTML, CSS, and JavaScript, using modern Web APIs such as Custom Elements and Shadow DOM. Because of this, Ionic components have a stable API, and aren't at the whim of a single platform vendor. ### Beautiful Design {/* #beautiful-design */} @@ -118,7 +118,7 @@ Support for other frameworks will be considered in future releases. ## Ionic CLI {/* #ionic-cli */} -The official [Ionic CLI](cli.mdx), or Command Line Interface, is a tool that quickly scaffolds Ionic apps and provides a number of helpful commands to Ionic developers. In addition to installing and updating Ionic, the CLI comes with a built-in development server, build and debugging tools, and much more. If you are an [Appflow](#appflow) member, the CLI can be used to perform cloud builds and deployments, and administer your account. +The official [Ionic CLI](./cli.mdx), or Command Line Interface, is a tool that quickly scaffolds Ionic apps and provides a number of helpful commands to Ionic developers. In addition to installing and updating Ionic, the CLI comes with a built-in development server, build and debugging tools, and much more. If you are an [Appflow](#appflow) member, the CLI can be used to perform cloud builds and deployments, and administer your account. ## Appflow {/* #appflow */} diff --git a/docs/intro/cdn.mdx b/docs/intro/cdn.mdx index 380f5bbbea..2a4a8617f3 100644 --- a/docs/intro/cdn.mdx +++ b/docs/intro/cdn.mdx @@ -24,7 +24,7 @@ Start a new Ionic Angular app or add Ionic to your existing Angular project.

Create a new Ionic Angular app using the Ionic CLI.

@@ -32,7 +32,7 @@ Start a new Ionic Angular app or add Ionic to your existing Angular project.

Add Ionic Angular to an existing Angular project.

@@ -48,7 +48,7 @@ Start a new Ionic React app or add Ionic to your existing React project.

Create a new Ionic React app using the Ionic CLI.

@@ -56,7 +56,7 @@ Start a new Ionic React app or add Ionic to your existing React project.

Add Ionic React to an existing React project.

@@ -72,7 +72,7 @@ Start a new Ionic Vue app or add Ionic to your existing Vue project.

Create a new Ionic Vue app using the Ionic CLI.

@@ -80,7 +80,7 @@ Start a new Ionic Vue app or add Ionic to your existing Vue project.

Add Ionic Vue to an existing Vue project.

@@ -96,7 +96,7 @@ Start a new Ionic JavaScript app.

Create a new Ionic JavaScript app using Vite.

@@ -116,7 +116,7 @@ It's recommended to use [jsdelivr](https://www.jsdelivr.com/) to access the Fram ``` -With this it's possible to use all of the Ionic Framework core components without having to install a framework. The CSS bundle will include all of the Ionic [Global Stylesheets](/layout/global-stylesheets.mdx). +With this it's possible to use all of the Ionic Framework core components without having to install a framework. The CSS bundle will include all of the Ionic [Global Stylesheets](../layout/global-stylesheets.mdx). ## Ionicons CDN {/* #ionicons-cdn */} diff --git a/docs/intro/cli.mdx b/docs/intro/cli.mdx index 2aefc3f61a..20e1ec0f76 100644 --- a/docs/intro/cli.mdx +++ b/docs/intro/cli.mdx @@ -19,7 +19,7 @@ Ionic apps are created and developed primarily through the Ionic [command-line]( ## Install the Ionic CLI {/* #install-the-ionic-cli */} -Before proceeding, make sure your computer has [Node.js](../reference/glossary.mdx#node) installed. Refer to the [environment setup guide](environment.mdx) to prepare your machine. +Before proceeding, make sure your computer has [Node.js](../reference/glossary.mdx#node) installed. Refer to the [environment setup guide](./environment.mdx) to prepare your machine. Install the Ionic CLI with npm: diff --git a/docs/intro/next.mdx b/docs/intro/next.mdx index 29e50579ed..00307f2449 100644 --- a/docs/intro/next.mdx +++ b/docs/intro/next.mdx @@ -20,15 +20,15 @@ import DeveloperExperts from '@components/page/intro/next/DeveloperExperts'; Pick the JavaScript framework you plan to use while building your Ionic app: - +

A complete guide to get you up to speed with the basics of building Ionic apps with Angular.

- +

A complete guide to get you up to speed with the basics of building Ionic apps with React.

- +

A complete guide to get you up to speed with the basics of building Ionic apps with Vue.

diff --git a/docs/javascript/overview.mdx b/docs/javascript/overview.mdx index b651a85cec..37c532cf55 100644 --- a/docs/javascript/overview.mdx +++ b/docs/javascript/overview.mdx @@ -44,7 +44,7 @@ $ npm run dev █ - +

Quickly set up your first Ionic JavaScript app and learn the basics of the framework and CLI.

diff --git a/docs/javascript/quickstart.mdx b/docs/javascript/quickstart.mdx index 0f0201fd00..53bc25807f 100644 --- a/docs/javascript/quickstart.mdx +++ b/docs/javascript/quickstart.mdx @@ -16,7 +16,7 @@ import DocsCards from '@components/global/DocsCards'; Welcome! This guide will walk you through the basics of Ionic JavaScript development using Vite. You'll learn how to set up your development environment, create a simple project, explore the project structure, and understand how Ionic components work. This is perfect for getting familiar with Ionic JavaScript before building your first real app. -If you're looking for a high-level overview of what Ionic JavaScript is and how it fits into the web development ecosystem, refer to the [Ionic JavaScript Overview](overview). +If you're looking for a high-level overview of what Ionic JavaScript is and how it fits into the web development ecosystem, refer to the [Ionic JavaScript Overview](./overview.mdx). ## Prerequisites {/* #prerequisites */} @@ -231,7 +231,7 @@ This creates a custom element called `home-page` that contains the layout for yo :::tip[Learn More] -For detailed information about Ionic layout components, refer to the [Header](/api/header.mdx), [Toolbar](/api/toolbar.mdx), [Title](/api/title.mdx), and [Content](/api/content.mdx) documentation. +For detailed information about Ionic layout components, refer to the [Header](../api/header.mdx), [Toolbar](../api/toolbar.mdx), [Title](../api/title.mdx), and [Content](../api/content.mdx) documentation. ::: @@ -251,7 +251,7 @@ At this point your browser should be displaying the Home page. ## Add an Ionic Component {/* #add-an-ionic-component */} -You can enhance your Home page with more Ionic UI components. For example, add a [Button](/api/button.mdx) to navigate to another page. Update the `HomePage` component in `HomePage.js`: +You can enhance your Home page with more Ionic UI components. For example, add a [Button](../api/button.mdx) to navigate to another page. Update the `HomePage` component in `HomePage.js`: ```js title="src/pages/HomePage.js" class HomePage extends HTMLElement { @@ -306,7 +306,7 @@ class NewPage extends HTMLElement { customElements.define('new-page', NewPage); ``` -This creates a page with a [Back Button](/api/back-button.mdx) in the [Toolbar](/api/toolbar.mdx). The back button will automatically handle navigation back to the previous page, or to `/` if there is no history. +This creates a page with a [Back Button](../api/back-button.mdx) in the [Toolbar](../api/toolbar.mdx). The back button will automatically handle navigation back to the previous page, or to `/` if there is no history. Next, update the ` ``` -Visit the [components](/components.mdx) page for all of the available Ionic components. +Visit the [components](../components.mdx) page for all of the available Ionic components. ## Using Ionic Pages {/* #using-ionic-pages */} @@ -110,7 +110,7 @@ import '@ionic/vue/css/flex-utils.css'; import '@ionic/vue/css/display.css'; ``` -These stylesheets set up the overall page structure and provide [CSS utilities](/layout/css-utilities.mdx) for faster development. Some stylesheets are optional. For details on which stylesheets are required, check out [Global Stylesheets](/layout/global-stylesheets.mdx). +These stylesheets set up the overall page structure and provide [CSS utilities](../layout/css-utilities.mdx) for faster development. Some stylesheets are optional. For details on which stylesheets are required, check out [Global Stylesheets](../layout/global-stylesheets.mdx). #### 2. Set up Theming {/* #2-set-up-theming */} @@ -162,7 +162,7 @@ import './theme/variables.css'; createApp(App).use(IonicVue).mount('#app'); ``` -The `variables.css` file can be used to create custom Ionic Framework themes. The `dark.system.css` import enables [dark mode support](/theming/dark-mode.mdx) for your Ionic app when the system is set to prefer a dark appearance. You can customize the theming behavior by uncommenting different dark palette imports or adding custom CSS variables to `theme/variables.css`. +The `variables.css` file can be used to create custom Ionic Framework themes. The `dark.system.css` import enables [dark mode support](../theming/dark-mode.mdx) for your Ionic app when the system is set to prefer a dark appearance. You can customize the theming behavior by uncommenting different dark palette imports or adding custom CSS variables to `theme/variables.css`. #### 3. Update the App Component {/* #3-update-the-app-component */} @@ -330,7 +330,7 @@ Now that you have Ionic Vue integrated into your project, check out: - +

Discover how to handle routing and navigation in Ionic Vue apps using the Vue Router.

diff --git a/docs/vue/lifecycle.mdx b/docs/vue/lifecycle.mdx index 1b84568b3e..07ba4cf670 100644 --- a/docs/vue/lifecycle.mdx +++ b/docs/vue/lifecycle.mdx @@ -95,6 +95,6 @@ All the lifecycle methods in Vue (`mounted`, `beforeUnmount`, etc..) are availab Below are some tips on use cases for each of the life cycle events. - `ionViewWillEnter` - Since `ionViewWillEnter` is called every time the view is navigated to (regardless if initialized or not), it is a good method to load data from services. -- `ionViewDidEnter` - If you encounter performance problems from using `ionViewWillEnter` when loading data, you can do your data calls in `ionViewDidEnter` instead. However, this event will not fire until after the page is visible to the user, so you might want to use either a loading indicator or a skeleton screen such as [ion-skeleton-text](../api/skeleton-text), so content does not flash in un-naturally after the transition is complete. +- `ionViewDidEnter` - If you encounter performance problems from using `ionViewWillEnter` when loading data, you can do your data calls in `ionViewDidEnter` instead. However, this event will not fire until after the page is visible to the user, so you might want to use either a loading indicator or a skeleton screen such as [ion-skeleton-text](../api/skeleton-text.mdx), so content does not flash in un-naturally after the transition is complete. - `ionViewWillLeave` - Can be used for cleanup, like unsubscribing from data sources. Since `beforeUnmount` might not fire when you navigate from the current page, put your cleanup code here if you do not want it active while the screen is not in view. - `ionViewDidLeave` - When this event fires, you know the new page has fully transitioned in, so any logic you might not normally do when the view is visible can go here. diff --git a/docs/vue/navigation.mdx b/docs/vue/navigation.mdx index 957bf22afa..8ff80255b5 100644 --- a/docs/vue/navigation.mdx +++ b/docs/vue/navigation.mdx @@ -129,7 +129,7 @@ The `router-link` attribute can be set on any Ionic Vue component, and the route The `router-direction` attribute accepts values of `"forward"`, `"back"`, or `"root"` and is used to control the direction of the page transition. -The `router-animation` attribute accepts an `AnimationBuilder` function and is used to provide a custom page transition that is only used when clicking the component it is provided on. The `AnimationBuilder` type is a function that returns an Ionic Animation instance. Refer to the [Animations documentation](../utilities/animations) for more information on using animations in Ionic Vue. +The `router-animation` attribute accepts an `AnimationBuilder` function and is used to provide a custom page transition that is only used when clicking the component it is provided on. The `AnimationBuilder` type is a function that returns an Ionic Animation instance. Refer to the [Animations documentation](../utilities/animations.mdx) for more information on using animations in Ionic Vue. ```html Click Me @@ -169,7 +169,7 @@ The example above has the app navigate to `/page2` with a custom animation that ::: -Refer to the [useIonRouter documentation](./utility-functions#router) for more details as well as type information. +Refer to the [useIonRouter documentation](./utility-functions.mdx#router) for more details as well as type information. ### Navigating using `router.go` {/* #navigating-using-routergo */} @@ -522,11 +522,11 @@ Components presented via `IonModal` or `IonPopover` do not typically need an `Io ### useIonRouter {/* #useionrouter */} -▸ **useIonRouter**(): [`UseIonRouterResult`](utility-functions#useionrouterresult) +▸ **useIonRouter**(): [`UseIonRouterResult`](./utility-functions.mdx#useionrouterresult) Returns the Ionic router instance, containing API methods for navigating, customizing page transitions and routing context for native features. This function can be used in combination with the [`useRouter`](https://router.vuejs.org/api/index.html#userouter) function from Vue. -For example usages, please refer to our [Utility Functions](utility-functions#useionrouter). +For example usages, please refer to our [Utility Functions](./utility-functions.mdx#useionrouter). ## URL Parameters {/* #url-parameters */} diff --git a/docs/vue/overview.mdx b/docs/vue/overview.mdx index f04a8cb412..5c2aa1f219 100644 --- a/docs/vue/overview.mdx +++ b/docs/vue/overview.mdx @@ -18,7 +18,7 @@ import DocsCards from '@components/global/DocsCards'; ## Vue Version Support {/* #vue-version-support */} -Ionic Vue v9 supports Vue 3.5 and later. For detailed information on supported versions and our support policy, refer to the [Ionic Vue Support Policy](/reference/support.mdx#ionic-vue). +Ionic Vue v9 supports Vue 3.5 and later. For detailed information on supported versions and our support policy, refer to the [Ionic Vue Support Policy](../reference/support.mdx#ionic-vue). ## Vue Tooling {/* #vue-tooling */} @@ -44,7 +44,7 @@ $ ionic serve █ - +

Quickly set up your first Ionic Vue app and learn the basics of the framework and CLI.

@@ -52,7 +52,7 @@ $ ionic serve █

Learn more about Vue's core concepts, tools, and best practices from the official Vue documentation.

- +

Discover how to handle routing and navigation in Ionic Vue apps using the Vue Router.

diff --git a/docs/vue/platform.mdx b/docs/vue/platform.mdx index 19ea415d5b..796e105837 100644 --- a/docs/vue/platform.mdx +++ b/docs/vue/platform.mdx @@ -53,7 +53,7 @@ Below is a table listing all the possible platform values along with correspondi ## Customizing Platform Detection Functions {/* #customizing-platform-detection-functions */} -The function used to detect a specific platform can be overridden by providing an alternative function in the global [Ionic config](../developing/config). Each function takes `window` as a parameter and returns a boolean. +The function used to detect a specific platform can be overridden by providing an alternative function in the global [Ionic config](../developing/config.mdx). Each function takes `window` as a parameter and returns a boolean. ```tsx createApp(App).use(IonicVue, { diff --git a/docs/vue/quickstart.mdx b/docs/vue/quickstart.mdx index af40bdd31c..f11a5088a4 100644 --- a/docs/vue/quickstart.mdx +++ b/docs/vue/quickstart.mdx @@ -16,7 +16,7 @@ import DocsCards from '@components/global/DocsCards'; Welcome! This guide will walk you through the basics of Ionic Vue development. You'll learn how to set up your development environment, generate a simple project, explore the project structure, and understand how Ionic components work. This is perfect for getting familiar with Ionic Vue before building your first real app. -If you're looking for a high-level overview of what Ionic Vue is and how it fits into the Vue ecosystem, refer to the [Ionic Vue Overview](overview). +If you're looking for a high-level overview of what Ionic Vue is and how it fits into the Vue ecosystem, refer to the [Ionic Vue Overview](./overview.mdx). ## Prerequisites {/* #prerequisites */} @@ -31,7 +31,7 @@ If you don't have Node.js and npm, [download Node.js](https://nodejs.org/en/down ## Create a Project with the Ionic CLI {/* #create-a-project-with-the-ionic-cli */} -First, install the latest [Ionic CLI](../cli): +First, install the latest [Ionic CLI](../cli.mdx): ```shell npm install -g @ionic/cli @@ -162,17 +162,17 @@ import { IonContent, IonHeader, IonPage, IonTitle, IonToolbar } from '@ionic/vue ``` -This creates a page with a header and scrollable content area. The second header shows a [collapsible large title](/api/title.mdx#collapsible-large-titles) that displays on iOS devices when at the top of the content, then condenses to show the smaller title in the first header when scrolling down. +This creates a page with a header and scrollable content area. The second header shows a [collapsible large title](../api/title.mdx#collapsible-large-titles) that displays on iOS devices when at the top of the content, then condenses to show the smaller title in the first header when scrolling down. :::tip[Learn More] -For detailed information about Ionic layout components, refer to the [Header](/api/header.mdx), [Toolbar](/api/toolbar.mdx), [Title](/api/title.mdx), and [Content](/api/content.mdx) documentation. +For detailed information about Ionic layout components, refer to the [Header](../api/header.mdx), [Toolbar](../api/toolbar.mdx), [Title](../api/title.mdx), and [Content](../api/content.mdx) documentation. ::: ## Add an Ionic Component {/* #add-an-ionic-component */} -You can enhance your Home page with more Ionic UI components. For example, add a [Button](/api/button.mdx) at the end of the `ion-content`: +You can enhance your Home page with more Ionic UI components. For example, add a [Button](../api/button.mdx) at the end of the `ion-content`: ```vue title="src/views/HomePage.vue" @@ -221,7 +221,7 @@ import { IonBackButton, IonButtons, IonContent, IonHeader, IonPage, IonTitle, Io ``` -This creates a page with a [Back Button](/api/back-button.mdx) in the [Toolbar](/api/toolbar.mdx). The back button will automatically handle navigation back to the previous page, or to `/` if there is no history. +This creates a page with a [Back Button](../api/back-button.mdx) in the [Toolbar](../api/toolbar.mdx). The back button will automatically handle navigation back to the previous page, or to `/` if there is no history. :::warning @@ -266,7 +266,7 @@ Once that is done, update the button in `HomePage.vue`: :::info -Navigating can also be performed programmatically using Vue Router, and routes can be lazy loaded for better performance. Refer to the [Vue Navigation documentation](/vue/navigation.mdx) for more information. +Navigating can also be performed programmatically using Vue Router, and routes can be lazy loaded for better performance. Refer to the [Vue Navigation documentation](./navigation.mdx) for more information. ::: @@ -292,7 +292,7 @@ Then, include them inside of the `ion-content`: Note that we are passing the imported SVG reference, **not** the icon name as a string. -For more information, refer to the [Icon documentation](/api/icon.mdx) and the [Ionicons documentation](https://ionic.io/ionicons/). +For more information, refer to the [Icon documentation](../api/icon.mdx) and the [Ionicons documentation](https://ionic.io/ionicons/). ## Call Component Methods {/* #call-component-methods */} @@ -347,7 +347,7 @@ To call methods on Ionic components: This pattern is necessary because Ionic components are built as Web Components. The `$el` property gives you access to the actual Web Component instance where the methods are defined. -You can find available methods for each component in the [Methods](/api/content.mdx#methods) section of their API documentation. +You can find available methods for each component in the [Methods](../api/content.mdx#methods) section of their API documentation. ## Run on a Device {/* #run-on-a-device */} @@ -435,7 +435,7 @@ This guide covered the basics of creating an Ionic Vue app, adding navigation, a - +

Build a real Photo Gallery app with Ionic Vue and native device features.

@@ -443,7 +443,7 @@ This guide covered the basics of creating an Ionic Vue app, adding navigation, a

Learn more about Vue's core concepts, tools, and best practices from the official Vue documentation.

- +

Discover how to handle routing and navigation in Ionic Vue apps using the Vue Router.

diff --git a/docs/vue/troubleshooting.mdx b/docs/vue/troubleshooting.mdx index 59fc233391..79567fe7ab 100644 --- a/docs/vue/troubleshooting.mdx +++ b/docs/vue/troubleshooting.mdx @@ -36,7 +36,7 @@ import { IonButton } from '@ionic/vue'; ``` -Prefer to register your components globally once? We have you covered. Our [Build Options Guide](/vue/build-options.mdx#global-component-registration) shows you how to register Ionic Vue components globally as well as the potential downsides to be aware of when using this approach. +Prefer to register your components globally once? We have you covered. Our [Build Options Guide](./build-options.mdx#global-component-registration) shows you how to register Ionic Vue components globally as well as the potential downsides to be aware of when using this approach. ## Slot attributes are deprecated {/* #slot-attributes-are-deprecated */} @@ -77,7 +77,7 @@ ionContentRef.value.scrollToBottom(); In other framework integrations such as Ionic React, this is not needed as any `ref` you provide is automatically forwarded to the underlying Web Component instance. We are unable to do the same thing here due to limitations in how Vue manages refs. -Refer to the [Quickstart Guide](/vue/quickstart.mdx#call-component-methods) for more information. +Refer to the [Quickstart Guide](./quickstart.mdx#call-component-methods) for more information. ## Page transitions are not working {/* #page-transitions-are-not-working */} @@ -100,7 +100,7 @@ import { IonContent, IonHeader, IonPage, IonTitle, IonToolbar } from '@ionic/vue ``` -Refer to the [IonPage documentation](navigation.mdx#ionpage) for more information. +Refer to the [IonPage documentation](./navigation.mdx#ionpage) for more information. ## Ionic events bound in JavaScript are not firing {/* #ionic-events-bound-in-javascript-are-not-firing */} diff --git a/docs/vue/utility-functions.mdx b/docs/vue/utility-functions.mdx index 0fed8d8f31..6601cd4c23 100644 --- a/docs/vue/utility-functions.mdx +++ b/docs/vue/utility-functions.mdx @@ -82,7 +82,7 @@ useIonRouter(): UseIonRouterResult; - The `replace` method is the equivalent of calling `ionRouter.navigate(location, 'none', 'replace', animation)`. It swaps the current page for the new one and keeps the pages beneath it, so the back button still returns to the previous page. No transition plays unless an `animation` is passed. To clear the navigation stack instead, call `ionRouter.navigate(location, 'root', 'replace', animation)`. -Refer to the [Vue Navigation Documentation](./navigation#navigating-using-useionrouter) for more usage examples. +Refer to the [Vue Navigation Documentation](./navigation.mdx#navigating-using-useionrouter) for more usage examples. ## Hardware Back Button {/* #hardware-back-button */} @@ -109,11 +109,11 @@ interface UseBackButtonResult { useBackButton(priority: number, handler: Handler): UseBackButtonResult; ``` -Refer to the [Hardware Back Button Documentation](../developing/hardware-back-button) for more information and usage examples. +Refer to the [Hardware Back Button Documentation](../developing/hardware-back-button.mdx) for more information and usage examples. :::note -The `useBackButton` callback will only fire when your app is running in Capacitor or Cordova. Refer to [Hardware Back Button Support](/developing/hardware-back-button.mdx#support) for more information. +The `useBackButton` callback will only fire when your app is running in Capacitor or Cordova. Refer to [Hardware Back Button Support](../developing/hardware-back-button.mdx#support) for more information. ::: @@ -144,7 +144,7 @@ interface UseKeyboardResult { useKeyboard(): UseKeyboardResult; ``` -Refer to the [Keyboard Documentation](../developing/keyboard) for more information and usage examples. +Refer to the [Keyboard Documentation](../developing/keyboard.mdx) for more information and usage examples. ## Ionic Lifecycles {/* #ionic-lifecycles */} @@ -178,4 +178,4 @@ Pages in your app need to be using the `IonPage` component in order for lifecycl ::: -Refer to the [Vue Lifecycle Documentation](./lifecycle) for more information and usage examples. +Refer to the [Vue Lifecycle Documentation](./lifecycle.mdx) for more information and usage examples. diff --git a/docs/vue/your-first-app.mdx b/docs/vue/your-first-app.mdx index a2ebe602a7..3d42f4eba8 100644 --- a/docs/vue/your-first-app.mdx +++ b/docs/vue/your-first-app.mdx @@ -32,7 +32,7 @@ Highlights include: - One Vue-based codebase that runs on the web, iOS, and Android using Ionic Framework [UI components](../components.mdx). - Deployed as a native iOS and Android mobile app using [Capacitor](https://capacitorjs.com), Ionic's official native app runtime. -- Photo Gallery functionality powered by the Capacitor [Camera](/native/camera.mdx), [Filesystem](/native/filesystem.mdx), and [Preferences](/native/preferences.mdx) APIs. +- Photo Gallery functionality powered by the Capacitor [Camera](../native/camera.mdx), [Filesystem](../native/filesystem.mdx), and [Preferences](../native/preferences.mdx) APIs. Find the [complete app code](https://github.com/ionic-team/tutorial-photo-gallery-vue) referenced in this guide on GitHub. @@ -92,7 +92,7 @@ npm install @capacitor/camera @capacitor/preferences @capacitor/filesystem ### PWA Elements {/* #pwa-elements */} -Some Capacitor plugins, including the [Camera API](/native/camera.mdx), provide the web-based functionality and UI via the Ionic [PWA Elements library](https://github.com/ionic-team/pwa-elements). +Some Capacitor plugins, including the [Camera API](../native/camera.mdx), provide the web-based functionality and UI via the Ionic [PWA Elements library](https://github.com/ionic-team/pwa-elements). It's a separate dependency, so install it next: diff --git a/docs/vue/your-first-app/2-taking-photos.mdx b/docs/vue/your-first-app/2-taking-photos.mdx index 56e033fee5..05f985047a 100644 --- a/docs/vue/your-first-app/2-taking-photos.mdx +++ b/docs/vue/your-first-app/2-taking-photos.mdx @@ -11,7 +11,7 @@ sidebar_label: Taking Photos /> -Now for the fun part - adding the ability to take photos with the device’s camera using the Capacitor [Camera API](/native/camera.mdx). We’ll begin with building it for the web, then make some small tweaks to make it work on mobile (iOS and Android). +Now for the fun part - adding the ability to take photos with the device’s camera using the Capacitor [Camera API](../../native/camera.mdx). We’ll begin with building it for the web, then make some small tweaks to make it work on mobile (iOS and Android). ## Photo Gallery Composable {/* #photo-gallery-composable */} diff --git a/docs/vue/your-first-app/3-saving-photos.mdx b/docs/vue/your-first-app/3-saving-photos.mdx index 525cece2a0..2310900e7a 100644 --- a/docs/vue/your-first-app/3-saving-photos.mdx +++ b/docs/vue/your-first-app/3-saving-photos.mdx @@ -100,7 +100,7 @@ export interface UserPhoto { } ``` -We'll use the Capacitor [Filesystem API](/native/filesystem.mdx) to save the photo. First, convert the photo to base64 format. +We'll use the Capacitor [Filesystem API](../../native/filesystem.mdx) to save the photo. First, convert the photo to base64 format. Then, pass the data to the Filesystem's `writeFile` method. Recall that we display photos by setting the image's source path (`src`) to the `webviewPath` property. So, set the `webviewPath` and return the new `Photo` object. diff --git a/docs/vue/your-first-app/4-loading-photos.mdx b/docs/vue/your-first-app/4-loading-photos.mdx index a9701aadf9..cae898e7ce 100644 --- a/docs/vue/your-first-app/4-loading-photos.mdx +++ b/docs/vue/your-first-app/4-loading-photos.mdx @@ -13,7 +13,7 @@ sidebar_label: Loading Photos We’ve implemented photo taking and saving to the filesystem. There’s one last piece of functionality missing: the photos are stored in the filesystem, but we need a way to save pointers to each file so that they can be displayed again in the photo gallery. -Fortunately, this is easy: we’ll leverage the Capacitor [Preferences API](/native/preferences.mdx) to store our array of Photos in a key-value store. +Fortunately, this is easy: we’ll leverage the Capacitor [Preferences API](../../native/preferences.mdx) to store our array of Photos in a key-value store. ## Preferences API {/* #preferences-api */} diff --git a/docusaurus.config.js b/docusaurus.config.js index bdd8059a39..1a6b49df74 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -80,7 +80,8 @@ module.exports = { }, markdown: { hooks: { - onBrokenMarkdownLinks: 'warn', + // A Markdown link to a file that doesn't exist, such as after a rename. + onBrokenMarkdownLinks: 'throw', }, }, favicon: 'img/meta/favicon-96x96.png', diff --git a/versioned_docs/version-v8/angular/add-to-existing.mdx b/versioned_docs/version-v8/angular/add-to-existing.mdx index 7dbfd1a0ce..d4c9086afe 100644 --- a/versioned_docs/version-v8/angular/add-to-existing.mdx +++ b/versioned_docs/version-v8/angular/add-to-existing.mdx @@ -14,7 +14,7 @@ import DocsCards from '@components/global/DocsCards'; /> -This guide covers how to add Ionic Angular to an existing Angular project. If you're looking to start a new project from scratch, check out the [Ionic Angular Quickstart](/angular/quickstart.mdx) guide. For an overview of how Ionic Angular works with Angular, including version support and tooling, check out the [Ionic Angular Overview](/angular/overview.mdx). +This guide covers how to add Ionic Angular to an existing Angular project. If you're looking to start a new project from scratch, check out the [Ionic Angular Quickstart](./quickstart.mdx) guide. For an overview of how Ionic Angular works with Angular, including version support and tooling, check out the [Ionic Angular Overview](./overview.mdx). :::tip @@ -76,7 +76,7 @@ Replace the existing `styles` array in `angular.json` with the following: :::info -While `core.css` is required, `normalize.css`, `structure.css`, and `typography.css` are recommended but not required. They normalize cross-browser differences, ensure proper scrolling behavior, and provide consistent typography and form styling. Without them, you may need to handle these concerns yourself. For more details, refer to [Global Stylesheets](/layout/global-stylesheets.mdx). +While `core.css` is required, `normalize.css`, `structure.css`, and `typography.css` are recommended but not required. They normalize cross-browser differences, ensure proper scrolling behavior, and provide consistent typography and form styling. Without them, you may need to handle these concerns yourself. For more details, refer to [Global Stylesheets](../layout/global-stylesheets.mdx). ::: @@ -126,7 +126,7 @@ import { IonButton, IonDatetime } from '@ionic/angular/standalone'; export class App {} ``` -Visit the [components](/components.mdx) page for all of the available Ionic components. +Visit the [components](../components.mdx) page for all of the available Ionic components. ## Using Ionic Pages {/* #using-ionic-pages */} @@ -175,7 +175,7 @@ Replace the existing `styles` array in `angular.json` with the following: ] ``` -These stylesheets set up the overall page structure and provide [CSS utilities](/layout/css-utilities.mdx) for faster development. Some stylesheets are optional. For details on which stylesheets are required, check out [Global Stylesheets](/layout/global-stylesheets.mdx). +These stylesheets set up the overall page structure and provide [CSS utilities](../layout/css-utilities.mdx) for faster development. Some stylesheets are optional. For details on which stylesheets are required, check out [Global Stylesheets](../layout/global-stylesheets.mdx). #### 2. Set up Theming {/* #2-set-up-theming */} @@ -194,7 +194,7 @@ Create a `src/theme/variables.css` file with the following content: @import '@ionic/angular/css/palettes/dark.system.css'; ``` -This file enables [dark mode support](/theming/dark-mode.mdx) for your Ionic app when the system is set to prefer a dark appearance. You can customize the theming behavior by uncommenting different dark palette imports or adding custom CSS variables. +This file enables [dark mode support](../theming/dark-mode.mdx) for your Ionic app when the system is set to prefer a dark appearance. You can customize the theming behavior by uncommenting different dark palette imports or adding custom CSS variables. #### 3. Update the App Component {/* #3-update-the-app-component */} @@ -325,7 +325,7 @@ Now that you have Ionic Angular integrated into your project, check out: - +

Discover how to handle routing and navigation in Ionic Angular apps using the Angular Router.

diff --git a/versioned_docs/version-v8/angular/build-options.mdx b/versioned_docs/version-v8/angular/build-options.mdx index 9b15b55be7..5155f92af3 100644 --- a/versioned_docs/version-v8/angular/build-options.mdx +++ b/versioned_docs/version-v8/angular/build-options.mdx @@ -41,7 +41,7 @@ All Ionic imports should be imported from the `@ionic/angular/standalone` submod **Bootstrapping and Configuration** -Ionic Angular needs to be configured when the Angular application calls `bootstrapApplication` using the `provideIonicAngular` function. Developers can pass any [IonicConfig](../developing/config#ionicconfig) values as an object in this function. Note that `provideIonicAngular` needs to be called even if no custom config is passed. +Ionic Angular needs to be configured when the Angular application calls `bootstrapApplication` using the `provideIonicAngular` function. Developers can pass any [IonicConfig](../developing/config.mdx#ionicconfig) values as an object in this function. Note that `provideIonicAngular` needs to be called even if no custom config is passed. ```typescript title="main.ts" import { enableProdMode, importProvidersFrom } from '@angular/core'; @@ -210,7 +210,7 @@ All Ionic imports should be imported from the `@ionic/angular/standalone` submod **Bootstrapping and Configuration** -Ionic Angular needs to be configured in the `providers` array of `app.module.ts` using the `provideIonicAngular` function. Developers can pass any [IonicConfig](../developing/config#ionicconfig) values as an object in this function. Note that `provideIonicAngular` needs to be called even if no custom config is passed. +Ionic Angular needs to be configured in the `providers` array of `app.module.ts` using the `provideIonicAngular` function. Developers can pass any [IonicConfig](../developing/config.mdx#ionicconfig) values as an object in this function. Note that `provideIonicAngular` needs to be called even if no custom config is passed. ```typescript title="app.module.ts" import { NgModule } from '@angular/core'; diff --git a/versioned_docs/version-v8/angular/overview.mdx b/versioned_docs/version-v8/angular/overview.mdx index f207dc379e..c106b67dc2 100644 --- a/versioned_docs/version-v8/angular/overview.mdx +++ b/versioned_docs/version-v8/angular/overview.mdx @@ -18,7 +18,7 @@ import DocsCards from '@components/global/DocsCards'; ## Angular Version Support {/* #angular-version-support */} -Ionic Angular v8 supports Angular versions 16 and above. For detailed information on supported versions and our support policy, refer to the [Ionic Angular Support Policy](/reference/support.mdx#ionic-angular). +Ionic Angular v8 supports Angular versions 16 and above. For detailed information on supported versions and our support policy, refer to the [Ionic Angular Support Policy](../reference/support.mdx#ionic-angular). ## Angular Tooling {/* #angular-tooling */} @@ -44,7 +44,7 @@ $ ionic serve █ - +

Quickly set up your first Ionic Angular app and learn the basics of the framework and CLI.

@@ -52,7 +52,7 @@ $ ionic serve █

Learn more about Angular's core concepts, tools, and best practices from the official Angular documentation.

- +

Discover how to handle routing and navigation in Ionic Angular apps using the Angular Router.

diff --git a/versioned_docs/version-v8/angular/platform.mdx b/versioned_docs/version-v8/angular/platform.mdx index fbd1531266..55197202b9 100644 --- a/versioned_docs/version-v8/angular/platform.mdx +++ b/versioned_docs/version-v8/angular/platform.mdx @@ -93,7 +93,7 @@ Below is a table listing all the possible platform values along with correspondi #### Customizing Platform Detection Functions {/* #customizing-platform-detection-functions */} -The function used to detect a specific platform can be overridden by providing an alternative function in the global [Ionic config](../developing/config). Each function takes `window` as a parameter and returns a boolean. +The function used to detect a specific platform can be overridden by providing an alternative function in the global [Ionic config](../developing/config.mdx). Each function takes `window` as a parameter and returns a boolean. ```tsx import { IonicModule } from '@ionic/angular'; diff --git a/versioned_docs/version-v8/angular/quickstart.mdx b/versioned_docs/version-v8/angular/quickstart.mdx index 2c6ab73155..4e27d90e6b 100644 --- a/versioned_docs/version-v8/angular/quickstart.mdx +++ b/versioned_docs/version-v8/angular/quickstart.mdx @@ -16,7 +16,7 @@ import DocsCards from '@components/global/DocsCards'; Welcome! This guide will walk you through the basics of Ionic Angular development. You'll learn how to set up your development environment, generate a simple project, explore the project structure, and understand how Ionic components work. This is perfect for getting familiar with Ionic Angular before building your first real app. -If you're looking for a high-level overview of what Ionic Angular is and how it fits into the Angular ecosystem, refer to the [Ionic Angular Overview](overview). +If you're looking for a high-level overview of what Ionic Angular is and how it fits into the Angular ecosystem, refer to the [Ionic Angular Overview](./overview.mdx). ## Prerequisites {/* #prerequisites */} @@ -31,7 +31,7 @@ If you don't have Node.js and npm, [download Node.js](https://nodejs.org/en/down ## Create a Project with the Ionic CLI {/* #create-a-project-with-the-ionic-cli */} -First, install the latest [Ionic CLI](../cli): +First, install the latest [Ionic CLI](../cli.mdx): ```shell npm install -g @ionic/cli @@ -173,17 +173,17 @@ And the template, in the `home.page.html` file, uses those components:
``` -This creates a page with a header and scrollable content area. The second header shows a [collapsible large title](/api/title.mdx#collapsible-large-titles) that displays on iOS devices when at the top of the content, then condenses to show the smaller title in the first header when scrolling down. +This creates a page with a header and scrollable content area. The second header shows a [collapsible large title](../api/title.mdx#collapsible-large-titles) that displays on iOS devices when at the top of the content, then condenses to show the smaller title in the first header when scrolling down. :::tip[Learn More] -For detailed information about Ionic layout components, refer to the [Header](/api/header.mdx), [Toolbar](/api/toolbar.mdx), [Title](/api/title.mdx), and [Content](/api/content.mdx) documentation. +For detailed information about Ionic layout components, refer to the [Header](../api/header.mdx), [Toolbar](../api/toolbar.mdx), [Title](../api/title.mdx), and [Content](../api/content.mdx) documentation. ::: ## Add an Ionic Component {/* #add-an-ionic-component */} -You can enhance your Home page with more Ionic UI components. For example, add a [Button](/api/button.mdx) at the end of the `ion-content`: +You can enhance your Home page with more Ionic UI components. For example, add a [Button](../api/button.mdx) at the end of the `ion-content`: ```html title="src/app/home/home.page.html" @@ -214,7 +214,7 @@ ionic generate page new A route will be automatically added to `app.routes.ts`. -In `new.page.html`, you can add a [Back Button](/api/back-button.mdx) to the [Toolbar](/api/toolbar.mdx): +In `new.page.html`, you can add a [Back Button](../api/back-button.mdx) to the [Toolbar](../api/toolbar.mdx): ```html title="src/app/new/new.page.html" @@ -261,7 +261,7 @@ import { RouterLink } from '@angular/router'; :::info -Navigating can also be performed using Angular's Router service. Refer to the [Angular Navigation documentation](/angular/navigation.mdx#navigating-to-different-routes) for more information. +Navigating can also be performed using Angular's Router service. Refer to the [Angular Navigation documentation](./navigation.mdx#navigating-to-different-routes) for more information. ::: @@ -306,7 +306,7 @@ export class NewPage implements OnInit { Alternatively, you can register icons in `app.component.ts` to use them throughout your app. -For more information, refer to the [Icon documentation](/api/icon.mdx) and the [Ionicons documentation](https://ionic.io/ionicons/). +For more information, refer to the [Icon documentation](../api/icon.mdx) and the [Ionicons documentation](https://ionic.io/ionicons/). ## Call Component Methods {/* #call-component-methods */} @@ -392,7 +392,7 @@ To call methods on Ionic components: 1. Create a `ViewChild` reference for the component 2. Call the method directly on the component instance -You can find available methods for each component in the [Methods](/api/content.mdx#methods) section of their API documentation. +You can find available methods for each component in the [Methods](../api/content.mdx#methods) section of their API documentation. ## Run on a Device {/* #run-on-a-device */} @@ -419,7 +419,7 @@ This guide covered the basics of creating an Ionic Angular app, adding navigatio - +

Build a real Photo Gallery app with Ionic Angular and native device features.

@@ -427,7 +427,7 @@ This guide covered the basics of creating an Ionic Angular app, adding navigatio

Learn more about Angular's core concepts, tools, and best practices from the official Angular documentation.

- +

Discover how to handle routing and navigation in Ionic Angular apps using the Angular Router.

diff --git a/versioned_docs/version-v8/angular/your-first-app.mdx b/versioned_docs/version-v8/angular/your-first-app.mdx index 470bf5eb90..ad89d1c167 100644 --- a/versioned_docs/version-v8/angular/your-first-app.mdx +++ b/versioned_docs/version-v8/angular/your-first-app.mdx @@ -32,7 +32,7 @@ Highlights include: - One Angular-based codebase that runs on the web, iOS, and Android using Ionic Framework [UI components](../components.mdx). - Deployed as a native iOS and Android mobile app using [Capacitor](https://capacitorjs.com), Ionic's official native app runtime. -- Photo Gallery functionality powered by the Capacitor [Camera](/native/camera.mdx), [Filesystem](/native/filesystem.mdx), and [Preferences](/native/preferences.mdx) APIs. +- Photo Gallery functionality powered by the Capacitor [Camera](../native/camera.mdx), [Filesystem](../native/filesystem.mdx), and [Preferences](../native/preferences.mdx) APIs. Find the [complete app code](https://github.com/ionic-team/tutorial-photo-gallery-angular) referenced in this guide on GitHub. @@ -98,7 +98,7 @@ npm install @capacitor/camera @capacitor/preferences @capacitor/filesystem ### PWA Elements {/* #pwa-elements */} -Some Capacitor plugins, including the [Camera API](/native/camera.mdx), provide the web-based functionality and UI via the Ionic [PWA Elements library](https://github.com/ionic-team/pwa-elements). +Some Capacitor plugins, including the [Camera API](../native/camera.mdx), provide the web-based functionality and UI via the Ionic [PWA Elements library](https://github.com/ionic-team/pwa-elements). It's a separate dependency, so install it next: diff --git a/versioned_docs/version-v8/angular/your-first-app/2-taking-photos.mdx b/versioned_docs/version-v8/angular/your-first-app/2-taking-photos.mdx index fed156b847..0f62d09159 100644 --- a/versioned_docs/version-v8/angular/your-first-app/2-taking-photos.mdx +++ b/versioned_docs/version-v8/angular/your-first-app/2-taking-photos.mdx @@ -11,7 +11,7 @@ sidebar_label: Taking Photos /> -Now for the fun part - adding the ability to take photos with the device’s camera using the Capacitor [Camera API](/native/camera.mdx). We’ll begin with building it for the web, then make some small tweaks to make it work on mobile (iOS and Android). +Now for the fun part - adding the ability to take photos with the device’s camera using the Capacitor [Camera API](../../native/camera.mdx). We’ll begin with building it for the web, then make some small tweaks to make it work on mobile (iOS and Android). ## Photo Service {/* #photo-service */} diff --git a/versioned_docs/version-v8/angular/your-first-app/3-saving-photos.mdx b/versioned_docs/version-v8/angular/your-first-app/3-saving-photos.mdx index a93222a255..c0e00c26c1 100644 --- a/versioned_docs/version-v8/angular/your-first-app/3-saving-photos.mdx +++ b/versioned_docs/version-v8/angular/your-first-app/3-saving-photos.mdx @@ -86,7 +86,7 @@ export interface UserPhoto { } ``` -We'll use the Capacitor [Filesystem API](/native/filesystem.mdx) to save the photo. First, convert the photo to base64 format. +We'll use the Capacitor [Filesystem API](../../native/filesystem.mdx) to save the photo. First, convert the photo to base64 format. Then, pass the data to the Filesystem's `writeFile` method. Recall that we display photos by setting the image's source path (`src`) to the `webviewPath` property. So, set the `webviewPath` and return the new `Photo` object. diff --git a/versioned_docs/version-v8/angular/your-first-app/4-loading-photos.mdx b/versioned_docs/version-v8/angular/your-first-app/4-loading-photos.mdx index 78a53c18ca..ecaed62cf5 100644 --- a/versioned_docs/version-v8/angular/your-first-app/4-loading-photos.mdx +++ b/versioned_docs/version-v8/angular/your-first-app/4-loading-photos.mdx @@ -13,7 +13,7 @@ sidebar_label: Loading Photos We’ve implemented photo taking and saving to the filesystem. There’s one last piece of functionality missing: the photos are stored in the filesystem, but we need a way to save pointers to each file so that they can be displayed again in the photo gallery. -Fortunately, this is easy: we’ll leverage the Capacitor [Preferences API](/native/preferences.mdx) to store our array of Photos in a key-value store. +Fortunately, this is easy: we’ll leverage the Capacitor [Preferences API](../../native/preferences.mdx) to store our array of Photos in a key-value store. ## Preferences API {/* #preferences-api */} diff --git a/versioned_docs/version-v8/api.mdx b/versioned_docs/version-v8/api.mdx index 161ba1b8a3..501f9a836b 100644 --- a/versioned_docs/version-v8/api.mdx +++ b/versioned_docs/version-v8/api.mdx @@ -12,6 +12,6 @@ import APIList from '@components/page/api/APIList'; /> -Each Ionic [component](/components.mdx) consists of one or more [custom elements](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_custom_elements). Each custom element, in turn, may expose properties, methods, events, and CSS custom properties. +Each Ionic [component](./components.mdx) consists of one or more [custom elements](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_custom_elements). Each custom element, in turn, may expose properties, methods, events, and CSS custom properties. diff --git a/versioned_docs/version-v8/api/accordion-group.mdx b/versioned_docs/version-v8/api/accordion-group.mdx index 078dea45ea..96a3ed54f8 100644 --- a/versioned_docs/version-v8/api/accordion-group.mdx +++ b/versioned_docs/version-v8/api/accordion-group.mdx @@ -15,7 +15,7 @@ import EncapsulationPill from '@components/page/api/EncapsulationPill'; Accordion group is a container for accordion instances. It manages the state of the accordions and provides keyboard navigation. -Refer to the [Accordion](./accordion) documentation for more information. +Refer to the [Accordion](./accordion.mdx) documentation for more information. ## Interfaces {/* #interfaces */} diff --git a/versioned_docs/version-v8/api/accordion.mdx b/versioned_docs/version-v8/api/accordion.mdx index 95350d26fa..067354378e 100644 --- a/versioned_docs/version-v8/api/accordion.mdx +++ b/versioned_docs/version-v8/api/accordion.mdx @@ -41,7 +41,7 @@ import Toggle from '@site/static/usage/v8/accordion/toggle/index.mdx'; :::caution -Most `ionChange` events emitted by other components such as [Input](./input) and [Textarea](./textarea) bubble. As a result, these events will bubble up and cause your `ionChange` listener on the Accordion Group to fire if the associated components are used inside of an Accordion. +Most `ionChange` events emitted by other components such as [Input](./input.mdx) and [Textarea](./textarea.mdx) bubble. As a result, these events will bubble up and cause your `ionChange` listener on the Accordion Group to fire if the associated components are used inside of an Accordion. When using other components that emit `ionChange` inside of Accordion it is recommended to have the `ionChange` callback on Accordion Group check the `target` key on the event passed to the callback to verify that `ionChange` is coming from the Accordion Group and not any descendants. @@ -159,7 +159,7 @@ import Icons from '@site/static/usage/v8/accordion/customization/icons/index.mdx ### Theming {/* #theming */} -Since `ion-accordion` acts as a shell around the header and content elements, you can easily theme the accordion however you would like. You can theme the header by targeting the slotted `ion-item`. Since you are using `ion-item`, you also have access to all of the [ion-item CSS Variables](./item#css-custom-properties) and [ion-item Shadow Parts](./item#css-shadow-parts). Theming the content is also easily achieved by targeting the element that is in the `content` slot. +Since `ion-accordion` acts as a shell around the header and content elements, you can easily theme the accordion however you would like. You can theme the header by targeting the slotted `ion-item`. Since you are using `ion-item`, you also have access to all of the [ion-item CSS Variables](./item.mdx#css-custom-properties) and [ion-item Shadow Parts](./item.mdx#css-shadow-parts). Theming the content is also easily achieved by targeting the element that is in the `content` slot. import Theming from '@site/static/usage/v8/accordion/customization/theming/index.mdx'; @@ -195,13 +195,13 @@ When used inside an `ion-accordion-group`, `ion-accordion` has full keyboard sup The accordion animation works by knowing the height of the `content` slot when the animation starts. The accordion expects that this height will remain consistent throughout the animation. As a result, developers should avoid performing any operation that may change the height of the content during the animation. -For example, using [ion-img](./img) may cause layout shifts as it lazily loads images. This means that as the animation plays, `ion-img` will load the image data, and the dimensions of `ion-img` will change to account for the loaded image data. This can result in the height of the `content` slot changing. Developers have a few options for avoiding this: +For example, using [ion-img](./img.mdx) may cause layout shifts as it lazily loads images. This means that as the animation plays, `ion-img` will load the image data, and the dimensions of `ion-img` will change to account for the loaded image data. This can result in the height of the `content` slot changing. Developers have a few options for avoiding this: 1. Use an `img` element without any lazy loading. `ion-img` always uses lazy loading, but `img` does not use lazy loading by default. This is the simplest option and works well if you have small images that do not significantly benefit from lazy loading. 2. Set a minimum width and height on `ion-img`. If you need to use lazy loading and know the dimensions of the images ahead of time (such as if you are loading icons of the same size), you can set the `ion-img` to have a minimum width or height using CSS. This gives developers the benefit of lazy loading while avoiding layout shifts. This works when using an `img` element with `loading="lazy"` too! -3. If neither of these options are applicable, developers may want to consider disabling animations altogether by using the `animated` property on [ion-accordion-group](./accordion-group). +3. If neither of these options are applicable, developers may want to consider disabling animations altogether by using the `animated` property on [ion-accordion-group](./accordion-group.mdx). ## Properties {/* #properties */} diff --git a/versioned_docs/version-v8/api/action-sheet.mdx b/versioned_docs/version-v8/api/action-sheet.mdx index 7f3e50c45b..74b61f76a4 100644 --- a/versioned_docs/version-v8/api/action-sheet.mdx +++ b/versioned_docs/version-v8/api/action-sheet.mdx @@ -102,7 +102,7 @@ import CssCustomProperties from '@site/static/usage/v8/action-sheet/theming/css- ### Screen Readers {/* #screen-readers */} -Action Sheets set aria properties in order to be [accessible](../reference/glossary#a11y) to screen readers, but these properties can be overridden if they aren't descriptive enough or don't align with how the action sheet is being used in an app. +Action Sheets set aria properties in order to be [accessible](../reference/glossary.mdx#a11y) to screen readers, but these properties can be overridden if they aren't descriptive enough or don't align with how the action sheet is being used in an app. #### Role {/* #role */} diff --git a/versioned_docs/version-v8/api/alert.mdx b/versioned_docs/version-v8/api/alert.mdx index 79bab6b5af..7f9e5cf26e 100644 --- a/versioned_docs/version-v8/api/alert.mdx +++ b/versioned_docs/version-v8/api/alert.mdx @@ -118,7 +118,7 @@ If you are building an Ionic Angular app, the styles need to be added to a globa ### Screen Readers {/* #screen-readers */} -Alerts set aria properties in order to be [accessible](../reference/glossary#a11y) to screen readers, but these properties can be overridden if they aren't descriptive enough or don't align with how the alert is being used in an app. +Alerts set aria properties in order to be [accessible](../reference/glossary.mdx#a11y) to screen readers, but these properties can be overridden if they aren't descriptive enough or don't align with how the alert is being used in an app. #### Role {/* #role */} diff --git a/versioned_docs/version-v8/api/app.mdx b/versioned_docs/version-v8/api/app.mdx index ca0220d92a..3a9b33412e 100644 --- a/versioned_docs/version-v8/api/app.mdx +++ b/versioned_docs/version-v8/api/app.mdx @@ -23,11 +23,11 @@ App is a container element for an Ionic application. There should only be one `< 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 +- [Keyboard Lifecycle Events](../developing/keyboard.mdx#keyboard-lifecycle-events) without the need for any native plugins +- [Hardware Back Button Listeners](../developing/hardware-back-button.mdx) 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 +- [Ripple effect](./ripple-effect.mdx) when activating buttons on Material Design mode - Other tap and focus utilities which make the experience of using an Ionic app feel more native ## Programmatic Focus {/* #programmatic-focus */} diff --git a/versioned_docs/version-v8/api/back-button.mdx b/versioned_docs/version-v8/api/back-button.mdx index 94f5d1bb5b..331122f298 100644 --- a/versioned_docs/version-v8/api/back-button.mdx +++ b/versioned_docs/version-v8/api/back-button.mdx @@ -31,7 +31,7 @@ import Basic from '@site/static/usage/v8/back-button/basic/index.mdx'; ## Custom Back Button {/* #custom-back-button */} -By default, the back button will display the text `"Back"` with a `"chevron-back"` icon on `ios`, and an `"arrow-back-sharp"` icon on `md`. This can be customized per back button component by setting the `icon` or `text` properties. Alternatively, it can be set globally using the `backButtonIcon` or `backButtonText` properties in the global config. Refer to the [Config docs](../developing/config) for more information. +By default, the back button will display the text `"Back"` with a `"chevron-back"` icon on `ios`, and an `"arrow-back-sharp"` icon on `md`. This can be customized per back button component by setting the `icon` or `text` properties. Alternatively, it can be set globally using the `backButtonIcon` or `backButtonText` properties in the global config. Refer to the [Config docs](../developing/config.mdx) for more information. import Custom from '@site/static/usage/v8/back-button/custom/index.mdx'; diff --git a/versioned_docs/version-v8/api/breadcrumb.mdx b/versioned_docs/version-v8/api/breadcrumb.mdx index 9d1595c4a0..8789fe4cdd 100644 --- a/versioned_docs/version-v8/api/breadcrumb.mdx +++ b/versioned_docs/version-v8/api/breadcrumb.mdx @@ -15,7 +15,7 @@ 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. -Refer to the [Breadcrumbs](./breadcrumbs) documentation for more information. +Refer to the [Breadcrumbs](./breadcrumbs.mdx) documentation for more information. ## Interfaces {/* #interfaces */} diff --git a/versioned_docs/version-v8/api/buttons.mdx b/versioned_docs/version-v8/api/buttons.mdx index a9bd062443..3db313dc4c 100644 --- a/versioned_docs/version-v8/api/buttons.mdx +++ b/versioned_docs/version-v8/api/buttons.mdx @@ -21,7 +21,7 @@ import EncapsulationPill from '@components/page/api/EncapsulationPill'; -The Buttons component is a container element. It should be used inside of a [toolbar](./toolbar) and can contain several types of buttons, including standard [buttons](./button), [menu buttons](./menu-button), and [back buttons](./back-button). +The Buttons component is a container element. It should be used inside of a [toolbar](./toolbar.mdx) and can contain several types of buttons, including standard [buttons](./button.mdx), [menu buttons](./menu-button.mdx), and [back buttons](./back-button.mdx). ## Basic Usage {/* #basic-usage */} @@ -46,7 +46,7 @@ import Placement from '@site/static/usage/v8/buttons/placement/index.mdx'; ## Types of Buttons {/* #types-of-buttons */} -A button in a toolbar is styled to be clear by default, but this can be changed using the [`fill`](./button#fill) property on the button. The properties included on [back button](./back-button) and [menu button](./menu-button) in this example are for display purposes; refer to their respective documentation for proper usage. +A button in a toolbar is styled to be clear by default, but this can be changed using the [`fill`](./button.mdx#fill) property on the button. The properties included on [back button](./back-button.mdx) and [menu button](./menu-button.mdx) in this example are for display purposes; refer to their respective documentation for proper usage. import Types from '@site/static/usage/v8/buttons/types/index.mdx'; @@ -54,7 +54,7 @@ import Types from '@site/static/usage/v8/buttons/types/index.mdx'; ## Collapsible Buttons {/* #collapsible-buttons */} -The `collapse` property can be set on the buttons to collapse them when the header collapses. This is typically used with [collapsible large titles](./title#collapsible-large-titles). +The `collapse` property can be set on the buttons to collapse them when the header collapses. This is typically used with [collapsible large titles](./title.mdx#collapsible-large-titles). :::info diff --git a/versioned_docs/version-v8/api/card-content.mdx b/versioned_docs/version-v8/api/card-content.mdx index 45bfd5c282..eebe343892 100644 --- a/versioned_docs/version-v8/api/card-content.mdx +++ b/versioned_docs/version-v8/api/card-content.mdx @@ -13,7 +13,7 @@ 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. -Refer to the [Card](./card) documentation for more information. +Refer to the [Card](./card.mdx) documentation for more information. ## Properties {/* #properties */} diff --git a/versioned_docs/version-v8/api/card-header.mdx b/versioned_docs/version-v8/api/card-header.mdx index 0cd005c515..bd5662b6ec 100644 --- a/versioned_docs/version-v8/api/card-header.mdx +++ b/versioned_docs/version-v8/api/card-header.mdx @@ -13,9 +13,9 @@ 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). +Card header is a child component of card that should be placed before the card content. It can contain a [card title](./card-title.mdx) and a [card subtitle](./card-subtitle.mdx). -Refer to the [Card](./card) documentation for more information. +Refer to the [Card](./card.mdx) documentation for more information. ## Properties {/* #properties */} diff --git a/versioned_docs/version-v8/api/card-subtitle.mdx b/versioned_docs/version-v8/api/card-subtitle.mdx index 9775fde04b..f8761e9f42 100644 --- a/versioned_docs/version-v8/api/card-subtitle.mdx +++ b/versioned_docs/version-v8/api/card-subtitle.mdx @@ -13,9 +13,9 @@ 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). +Card subtitle is a child component of card that should be placed inside of a [card header](./card-header.mdx). -Refer to the [Card](./card) documentation for more information. +Refer to the [Card](./card.mdx) documentation for more information. ## Properties {/* #properties */} diff --git a/versioned_docs/version-v8/api/card-title.mdx b/versioned_docs/version-v8/api/card-title.mdx index 9499e30a12..577a4764c6 100644 --- a/versioned_docs/version-v8/api/card-title.mdx +++ b/versioned_docs/version-v8/api/card-title.mdx @@ -21,9 +21,9 @@ import EncapsulationPill from '@components/page/api/EncapsulationPill'; -Card title is a child component of card that should be placed inside of a [card header](./card-header). +Card title is a child component of card that should be placed inside of a [card header](./card-header.mdx). -Refer to the [Card](./card) documentation for more information. +Refer to the [Card](./card.mdx) documentation for more information. ## Properties {/* #properties */} diff --git a/versioned_docs/version-v8/api/card.mdx b/versioned_docs/version-v8/api/card.mdx index a9c20faf7c..a5c32db884 100644 --- a/versioned_docs/version-v8/api/card.mdx +++ b/versioned_docs/version-v8/api/card.mdx @@ -21,7 +21,7 @@ import EncapsulationPill from '@components/page/api/EncapsulationPill'; -Cards are containers that display content such as text, images, buttons, and lists. A card can be a single component, but is often made up of a header, title, subtitle, and content. Cards are broken up into several components to accommodate this structure: [card header](./card-header), [card title](./card-title), [card subtitle](./card-subtitle), and [card content](./card-content). +Cards are containers that display content such as text, images, buttons, and lists. A card can be a single component, but is often made up of a header, title, subtitle, and content. Cards are broken up into several components to accommodate this structure: [card header](./card-header.mdx), [card title](./card-title.mdx), [card subtitle](./card-subtitle.mdx), and [card content](./card-content.mdx). ## Basic Usage {/* #basic-usage */} diff --git a/versioned_docs/version-v8/api/col.mdx b/versioned_docs/version-v8/api/col.mdx index b7f78cb613..fcf539a891 100644 --- a/versioned_docs/version-v8/api/col.mdx +++ b/versioned_docs/version-v8/api/col.mdx @@ -21,13 +21,13 @@ 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. +Columns are cellular components of the [grid](./grid.mdx) system and go inside of a [row](./row.mdx). They will expand to fill the row. All content within a grid should go inside of a column. -Refer to the [grid](./grid) documentation for more information. +Refer to the [grid](./grid.mdx) documentation for more information. ## Column Alignment {/* #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](/layout/css-utilities.mdx#flex-item-properties) that can be applied to a column to customize this behavior. +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](../layout/css-utilities.mdx#flex-item-properties) that can be applied to a column to customize this behavior. ## Properties {/* #properties */} diff --git a/versioned_docs/version-v8/api/content.mdx b/versioned_docs/version-v8/api/content.mdx index c762ef1439..a7f68b96e5 100644 --- a/versioned_docs/version-v8/api/content.mdx +++ b/versioned_docs/version-v8/api/content.mdx @@ -23,7 +23,7 @@ import EncapsulationPill from '@components/page/api/EncapsulationPill'; The content component provides an easy to use content area with some useful methods to control the scrollable area. There should only be one content in a single view. -Content, along with many other Ionic components, can be customized to modify its padding, margin, and more using the global styles provided in the [CSS Utilities](/layout/css-utilities.mdx) or by individually styling it using CSS and the available [CSS Custom Properties](#css-custom-properties). +Content, along with many other Ionic components, can be customized to modify its padding, margin, and more using the global styles provided in the [CSS Utilities](../layout/css-utilities.mdx) or by individually styling it using CSS and the available [CSS Custom Properties](#css-custom-properties). ## Basic Usage {/* #basic-usage */} @@ -33,7 +33,7 @@ import Basic from '@site/static/usage/v8/content/basic/index.mdx'; ## Header & Footer {/* #header--footer */} -Content can be the only top-level component in a page, or it can be used alongside a [header](./header), [footer](./footer), or both. When used with a header or footer, it will adjust its size to fill the remaining height. +Content can be the only top-level component in a page, or it can be used alongside a [header](./header.mdx), [footer](./footer.mdx), or both. When used with a header or footer, it will adjust its size to fill the remaining height. import HeaderFooter from '@site/static/usage/v8/content/header-footer/index.mdx'; @@ -41,7 +41,7 @@ import HeaderFooter from '@site/static/usage/v8/content/header-footer/index.mdx' ## Fullscreen Content {/* #fullscreen-content */} -By default, content fills the space between a [header](./header) and [footer](./footer) but does not go behind them. In certain cases, it may be desired to have the content scroll behind the header and footer, such as when the `translucent` property is set on either of them, or `opacity` is set on the toolbar. This can be achieved by setting the `fullscreen` property on the content to `true`. +By default, content fills the space between a [header](./header.mdx) and [footer](./footer.mdx) but does not go behind them. In certain cases, it may be desired to have the content scroll behind the header and footer, such as when the `translucent` property is set on either of them, or `opacity` is set on the toolbar. This can be achieved by setting the `fullscreen` property on the content to `true`. import Fullscreen from '@site/static/usage/v8/content/fullscreen/index.mdx'; @@ -51,7 +51,7 @@ import Fullscreen from '@site/static/usage/v8/content/fullscreen/index.mdx'; To place elements outside of the scrollable area, assign them to the `fixed` slot. Doing so will [absolutely position](https://developer.mozilla.org/en-US/docs/Web/CSS/position#absolute_positioning) the element to the top left of the content. In order to change the position of the element, it can be styled using the [top, right, bottom, and left](https://developer.mozilla.org/en-US/docs/Web/CSS/position) CSS properties. -The `fixedSlotPlacement` property is used to determine if content in the `fixed` slot is placed before or after the main content in the DOM. When set to `before`, fixed slot content will be placed before the main content and will therefore receive keyboard focus before the main content receives keyboard focus. This can be useful when the main content contains an infinitely-scrolling list, preventing a [FAB](./fab) or other fixed content from being reachable by pressing the tab key. +The `fixedSlotPlacement` property is used to determine if content in the `fixed` slot is placed before or after the main content in the DOM. When set to `before`, fixed slot content will be placed before the main content and will therefore receive keyboard focus before the main content receives keyboard focus. This can be useful when the main content contains an infinitely-scrolling list, preventing a [FAB](./fab.mdx) or other fixed content from being reachable by pressing the tab key. import Fixed from '@site/static/usage/v8/content/fixed/index.mdx'; @@ -95,7 +95,7 @@ import CSSProps from '@site/static/usage/v8/content/theming/css-properties/index ### Safe Area Padding {/* #safe-area-padding */} -The content component will not automatically apply padding to any of its sides to account for the [safe area](/theming/advanced.mdx#safe-area-padding). This is because the content component is often used in conjunction with other components that apply their own padding, such as [headers](./header) and [footers](./footer). However, if the content component is being used on its own, it may be desired to apply padding to the safe area. This can be done through CSS by using the `--ion-safe-area-(dir)` variables described in [Application Variables](../theming/advanced.mdx#application-variables). +The content component will not automatically apply padding to any of its sides to account for the [safe area](../theming/advanced.mdx#safe-area-padding). This is because the content component is often used in conjunction with other components that apply their own padding, such as [headers](./header.mdx) and [footers](./footer.mdx). However, if the content component is being used on its own, it may be desired to apply padding to the safe area. This can be done through CSS by using the `--ion-safe-area-(dir)` variables described in [Application Variables](../theming/advanced.mdx#application-variables). The most common use case for this is to apply padding to the top of the content to account for the status bar. This can be done by setting the `padding-top` property to the value of the `--ion-safe-area-top` variable. diff --git a/versioned_docs/version-v8/api/datetime-button.mdx b/versioned_docs/version-v8/api/datetime-button.mdx index b1fee23dc3..5ecbfc2551 100644 --- a/versioned_docs/version-v8/api/datetime-button.mdx +++ b/versioned_docs/version-v8/api/datetime-button.mdx @@ -21,13 +21,13 @@ import EncapsulationPill from '@components/page/api/EncapsulationPill'; -Datetime Button links with a [Datetime](./datetime) component to display the formatted date and time. It also provides buttons to present the datetime in a modal, popover, and more. +Datetime Button links with a [Datetime](./datetime.mdx) component to display the formatted date and time. It also provides buttons to present the datetime in a modal, popover, and more. ## Overview {/* #overview */} Datetime Button should be used when space is constrained. This component displays buttons which show the current date and time values. When the buttons are tapped, the date or time pickers open in the overlay. -When using Datetime Button with a JavaScript framework such as Angular, React, or Vue be sure to use the [keepContentsMounted property on ion-modal](./modal#prop-keep-contents-mounted) or the [keepContentsMounted property on ion-popover](./popover#prop-keep-contents-mounted). This allows the linked datetime instance to be mounted even if the overlay has not been presented yet. +When using Datetime Button with a JavaScript framework such as Angular, React, or Vue be sure to use the [keepContentsMounted property on ion-modal](./modal.mdx#prop-keep-contents-mounted) or the [keepContentsMounted property on ion-popover](./popover.mdx#prop-keep-contents-mounted). This allows the linked datetime instance to be mounted even if the overlay has not been presented yet. ## Basic Usage {/* #basic-usage */} @@ -37,11 +37,11 @@ import Basic from '@site/static/usage/v8/datetime-button/basic/index.mdx'; ## Localization {/* #localization */} -The localized text on `ion-datetime-button` is determined by the `locale` property on the associated `ion-datetime` instance. Refer to [Datetime Localization](./datetime#localization) for more details. +The localized text on `ion-datetime-button` is determined by the `locale` property on the associated `ion-datetime` instance. Refer to [Datetime Localization](./datetime.mdx#localization) for more details. ## Format Options {/* #format-options */} -You can customize the format of the date and time in a Datetime Button by providing `formatOptions` on the associated Datetime instance. Refer to [Datetime Format Options](./datetime#format-options) for more details. +You can customize the format of the date and time in a Datetime Button by providing `formatOptions` on the associated Datetime instance. Refer to [Datetime Format Options](./datetime.mdx#format-options) for more details. import FormatOptions from '@site/static/usage/v8/datetime-button/format-options/index.mdx'; @@ -49,7 +49,7 @@ import FormatOptions from '@site/static/usage/v8/datetime-button/format-options/ ## Usage with Modals and Popovers {/* #usage-with-modals-and-popovers */} -`ion-datetime-button` must be associated with a mounted `ion-datetime` instance. As a result, [Inline Modals](./modal#inline-modals-recommended) and [Inline Popovers](./popover#inline-popovers) with the `keepContentsMounted` property set to `true` must be used. +`ion-datetime-button` must be associated with a mounted `ion-datetime` instance. As a result, [Inline Modals](./modal.mdx#inline-modals-recommended) and [Inline Popovers](./popover.mdx#inline-popovers) with the `keepContentsMounted` property set to `true` must be used. ## Properties {/* #properties */} diff --git a/versioned_docs/version-v8/api/datetime.mdx b/versioned_docs/version-v8/api/datetime.mdx index 70ab72f8d0..b0ab34d095 100644 --- a/versioned_docs/version-v8/api/datetime.mdx +++ b/versioned_docs/version-v8/api/datetime.mdx @@ -97,7 +97,7 @@ While seconds, milliseconds, and time zone can be specified using the ISO 8601 d ## Usage with Datetime Button {/* #usage-with-datetime-button */} -If you need to present a datetime in an overlay such as a modal or a popover, we recommend using [ion-datetime-button](./datetime-button). `ion-datetime-button` should be used when space is constrained. This component displays buttons which show the current date and time values. When the buttons are tapped, the date or time pickers open in the overlay. +If you need to present a datetime in an overlay such as a modal or a popover, we recommend using [ion-datetime-button](./datetime-button.mdx). `ion-datetime-button` should be used when space is constrained. This component displays buttons which show the current date and time values. When the buttons are tapped, the date or time pickers open in the overlay. ## Setting Values Asynchronously {/* #setting-values-asynchronously */} @@ -326,7 +326,7 @@ Developers can provide their own buttons for advanced custom behavior. Using the `highlightedDates` property, developers can style particular dates with custom text or background colors. This property can be defined as either an array of dates and their colors, or a callback that receives an ISO string and returns the colors to use. -When specifying colors, any valid CSS color format can be used. This includes hex codes, `rgba`, [color variables](../theming/colors), etc. +When specifying colors, any valid CSS color format can be used. This includes hex codes, `rgba`, [color variables](../theming/colors.mdx), etc. To maintain a consistent user experience, the style of selected date(s) will always override custom highlights. @@ -352,7 +352,7 @@ A callback is better when the highlighted dates are recurring, such as birthdays ### Global Theming {/* #global-theming */} -Ionic's powerful theming system can be used to easily change your entire app to match a certain theme. In this example, we used the [Color Creator](../theming/colors#new-color-creator) and the [Stepped Color Generator](../theming/themes#stepped-color-generator) to create a rose color palette that we can use for `ion-datetime`. +Ionic's powerful theming system can be used to easily change your entire app to match a certain theme. In this example, we used the [Color Creator](../theming/colors.mdx#new-color-creator) and the [Stepped Color Generator](../theming/themes.mdx#stepped-color-generator) to create a rose color palette that we can use for `ion-datetime`. The benefit of this approach is that every component, not just `ion-datetime`, can automatically take advantage of this theme. @@ -476,7 +476,7 @@ The datetime picker provides the simplicity of selecting an exact format, and pe #### Time, Month, and Year Wheels {/* #time-month-and-year-wheels */} -The wheel picker in Datetime uses [Picker](./picker) internally. Refer to [Picker Accessibility](./picker#accessibility) for more information on accessibility features with the wheel picker. +The wheel picker in Datetime uses [Picker](./picker.mdx) internally. Refer to [Picker Accessibility](./picker.mdx#accessibility) for more information on accessibility features with the wheel picker. ## Interfaces {/* #interfaces */} diff --git a/versioned_docs/version-v8/api/fab-button.mdx b/versioned_docs/version-v8/api/fab-button.mdx index d5e55b7c21..27dcad22b0 100644 --- a/versioned_docs/version-v8/api/fab-button.mdx +++ b/versioned_docs/version-v8/api/fab-button.mdx @@ -23,9 +23,9 @@ 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. +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.mdx) component. If the button is not wrapped with a fab, it will scroll with the content. -For usage examples, refer to the [fab documentation](./fab). +For usage examples, refer to the [fab documentation](./fab.mdx). ## Properties {/* #properties */} diff --git a/versioned_docs/version-v8/api/fab-list.mdx b/versioned_docs/version-v8/api/fab-list.mdx index c49d0ad627..b3234ea761 100644 --- a/versioned_docs/version-v8/api/fab-list.mdx +++ b/versioned_docs/version-v8/api/fab-list.mdx @@ -13,9 +13,9 @@ import EncapsulationPill from '@components/page/api/EncapsulationPill'; -The fab list component is a container for multiple [fab buttons](./fab-button). It contains actions related to the main fab button and is flung out on click. To specify what side the buttons should appear on, set the `side` property to `"start"`, `"end"`, `"top"`, or `"bottom"`. +The fab list component is a container for multiple [fab buttons](./fab-button.mdx). It contains actions related to the main fab button and is flung out on click. To specify what side the buttons should appear on, set the `side` property to `"start"`, `"end"`, `"top"`, or `"bottom"`. -For usage examples, refer to the [fab documentation](./fab). +For usage examples, refer to the [fab documentation](./fab.mdx). ## Properties {/* #properties */} diff --git a/versioned_docs/version-v8/api/fab.mdx b/versioned_docs/version-v8/api/fab.mdx index 7f5892f80b..f8207a2934 100644 --- a/versioned_docs/version-v8/api/fab.mdx +++ b/versioned_docs/version-v8/api/fab.mdx @@ -21,7 +21,7 @@ import EncapsulationPill from '@components/page/api/EncapsulationPill'; -Fabs are container elements that contain one or more [fab buttons](./fab-button). They should be placed in a fixed position that does not scroll with the content. Fabs should have one main fab button. Fabs can also contain one or more [fab lists](./fab-list) which contain related buttons that show when the main fab button is clicked. +Fabs are container elements that contain one or more [fab buttons](./fab-button.mdx). They should be placed in a fixed position that does not scroll with the content. Fabs should have one main fab button. Fabs can also contain one or more [fab lists](./fab-list.mdx) which contain related buttons that show when the main fab button is clicked. ## Basic Usage {/* #basic-usage */} @@ -31,7 +31,7 @@ import BasicUsage from '@site/static/usage/v8/fab/basic/index.mdx'; ## List Side {/* #list-side */} -The `side` property of the [fab list](./fab-list) component controls where it appears relative to the main fab button. A single fab can have multiple fab lists as long as they all have different values for `side`. +The `side` property of the [fab list](./fab-list.mdx) component controls where it appears relative to the main fab button. A single fab can have multiple fab lists as long as they all have different values for `side`. import ListSide from '@site/static/usage/v8/fab/list-side/index.mdx'; @@ -39,7 +39,7 @@ import ListSide from '@site/static/usage/v8/fab/list-side/index.mdx'; ## Positioning {/* #positioning */} -In order to place the fab in a fixed position, it should be assigned to the `fixed` slot of the outer [content](./content) component. Use the `vertical` and `horizontal` props to control the alignment of the fab in the viewport. The `edge` prop will cause the fab button to overlap with the app's header or footer. +In order to place the fab in a fixed position, it should be assigned to the `fixed` slot of the outer [content](./content.mdx) component. Use the `vertical` and `horizontal` props to control the alignment of the fab in the viewport. The `edge` prop will cause the fab button to overlap with the app's header or footer. import Positioning from '@site/static/usage/v8/fab/positioning/index.mdx'; @@ -47,7 +47,7 @@ import Positioning from '@site/static/usage/v8/fab/positioning/index.mdx'; ### Safe Area {/* #safe-area */} -If there is no `ion-header` or `ion-footer` component, the fab may be covered by a device's notch, status bar, or other device UI. In these cases, the [safe area](/theming/advanced.mdx#safe-area-padding) on the top and bottom is not taken into account. This can be adjusted by using the [`--ion-safe-area-(dir)` variables](/theming/advanced.mdx#application-variables). +If there is no `ion-header` or `ion-footer` component, the fab may be covered by a device's notch, status bar, or other device UI. In these cases, the [safe area](../theming/advanced.mdx#safe-area-padding) on the top and bottom is not taken into account. This can be adjusted by using the [`--ion-safe-area-(dir)` variables](../theming/advanced.mdx#application-variables). When using a fab with `vertical` set to `"top"` without an `ion-header`, the top margin needs to be set: @@ -75,7 +75,7 @@ import SafeArea from '@site/static/usage/v8/fab/safe-area/index.mdx'; In scenarios where a view contains many interactive elements, such as an infinitely-scrolling list, it may be challenging for users to navigate to the Floating Action Button (FAB) if it is placed below all the items in the DOM. -By setting the `fixedSlotPlacement` property on [Content](./content) to `before`, the FAB will be placed before the main content in the DOM. This ensures that the FAB receives keyboard focus before other interactive elements receive focus, making it easier for users to access the FAB. +By setting the `fixedSlotPlacement` property on [Content](./content.mdx) to `before`, the FAB will be placed before the main content in the DOM. This ensures that the FAB receives keyboard focus before other interactive elements receive focus, making it easier for users to access the FAB. import BeforeContent from '@site/static/usage/v8/fab/before-content/index.mdx'; diff --git a/versioned_docs/version-v8/api/footer.mdx b/versioned_docs/version-v8/api/footer.mdx index d263aa5018..a9ac4baf20 100644 --- a/versioned_docs/version-v8/api/footer.mdx +++ b/versioned_docs/version-v8/api/footer.mdx @@ -19,7 +19,7 @@ import Slots from '@ionic-internal/component-api/v8/footer/slots.mdx'; import EncapsulationPill from '@components/page/api/EncapsulationPill'; -Footer is a root component of a page that aligns itself to the bottom of the page. It is recommended to be used as a wrapper for one or more [toolbars](./toolbar), but it can be used to wrap any element. When a toolbar is used inside of a footer, the content will be adjusted so it is sized correctly, and the footer will account for any device safe areas. +Footer is a root component of a page that aligns itself to the bottom of the page. It is recommended to be used as a wrapper for one or more [toolbars](./toolbar.mdx), but it can be used to wrap any element. When a toolbar is used inside of a footer, the content will be adjusted so it is sized correctly, and the footer will account for any device safe areas. ## Basic Usage {/* #basic-usage */} diff --git a/versioned_docs/version-v8/api/grid.mdx b/versioned_docs/version-v8/api/grid.mdx index bab3725710..0fd698ea28 100644 --- a/versioned_docs/version-v8/api/grid.mdx +++ b/versioned_docs/version-v8/api/grid.mdx @@ -21,7 +21,7 @@ import EncapsulationPill from '@components/page/api/EncapsulationPill'; -The grid is a powerful mobile-first flexbox system for building custom layouts. It is composed of three units — a grid, [row(s)](row.mdx) and [column(s)](col.mdx). Columns will expand to fill the row, and will resize to fit additional columns. It is based on a 12 column layout with different breakpoints based on the screen size. The number of columns can be customized using CSS. +The grid is a powerful mobile-first flexbox system for building custom layouts. It is composed of three units — a grid, [row(s)](./row.mdx) and [column(s)](./col.mdx). Columns will expand to fill the row, and will resize to fit additional columns. It is based on a 12 column layout with different breakpoints based on the screen size. The number of columns can be customized using CSS. ## Overview {/* #overview */} @@ -31,14 +31,14 @@ The grid is a powerful mobile-first flexbox system for building custom layouts. - The `size` property indicates the number of columns to use out of the default 12 per row. So, `size="4"` can be added to a column in order to take up 1/3 of the grid, or 4 of the 12 columns. - Columns without a value for size will automatically have equal widths. For example, four columns will each automatically be 25% wide. - Column widths are set as a percentage, so they’re always fluid and sized relative to their parent element. -- There is padding between individual columns. However, the padding can be removed from the grid and columns by adding the `ion-no-padding` class to the grid. Refer to the [CSS Utilities](../layout/css-utilities) for more styles that can be applied to the grid. +- There is padding between individual columns. However, the padding can be removed from the grid and columns by adding the `ion-no-padding` class to the grid. Refer to the [CSS Utilities](../layout/css-utilities.mdx) for more styles that can be applied to the grid. - There are five grid tiers, one for each responsive breakpoint: all breakpoints (extra small), small, medium, large, and extra large. - Grid tiers are based on minimum widths, meaning they apply to their tier and all those larger than them (e.g., `size-sm="4"` applies to small, medium, large, and extra large devices). - Grids can be customized via CSS variables. Refer to [Customizing the Grid](#customizing-the-grid). ## Default Breakpoints {/* #default-breakpoints */} -The default breakpoints for the grid and the corresponding properties are defined in the table below. Breakpoint values can not be customized at this time. For more information on why they can't be customized, refer to [Variables in Media Queries](../theming/advanced#variables-in-media-queries). +The default breakpoints for the grid and the corresponding properties are defined in the table below. Breakpoint values can not be customized at this time. For more information on why they can't be customized, refer to [Variables in Media Queries](../theming/advanced.mdx#variables-in-media-queries). | Name | Value | Width Property | Offset Property | Push Property | Pull Property | Description | | --- | --- | --- | --- | --- | --- | --- | @@ -144,7 +144,7 @@ import PushPullResponsive from '@site/static/usage/v8/grid/push-pull-responsive/ ### Vertical Alignment {/* #vertical-alignment */} -All columns can be vertically aligned inside of a row by adding different classes to the row. For a list of available classes, refer to [css utilities](/layout/css-utilities#flex-container-properties). +All columns can be vertically aligned inside of a row by adding different classes to the row. For a list of available classes, refer to [css utilities](../layout/css-utilities.mdx#flex-container-properties). import VerticalAlignment from '@site/static/usage/v8/grid/vertical-alignment/index.mdx'; @@ -152,7 +152,7 @@ import VerticalAlignment from '@site/static/usage/v8/grid/vertical-alignment/ind ### Horizontal Alignment {/* #horizontal-alignment */} -All columns can be horizontally aligned inside of a row by adding different classes to the row. For a list of available classes, refer to [css utilities](/layout/css-utilities.mdx#flex-container-properties). +All columns can be horizontally aligned inside of a row by adding different classes to the row. For a list of available classes, refer to [css utilities](../layout/css-utilities.mdx#flex-container-properties). import HorizontalAlignment from '@site/static/usage/v8/grid/horizontal-alignment/index.mdx'; diff --git a/versioned_docs/version-v8/api/header.mdx b/versioned_docs/version-v8/api/header.mdx index bb1f3e4a2d..f0e5fff5e9 100644 --- a/versioned_docs/version-v8/api/header.mdx +++ b/versioned_docs/version-v8/api/header.mdx @@ -19,7 +19,7 @@ import Slots from '@ionic-internal/component-api/v8/header/slots.mdx'; import EncapsulationPill from '@components/page/api/EncapsulationPill'; -Header is a root component of a page that aligns itself to the top of the page. It is recommended to be used as a wrapper for one or more [toolbars](./toolbar), but it can be used to wrap any element. When a toolbar is used inside of a header, the content will be adjusted so it is sized correctly, and the header will account for any device safe areas. +Header is a root component of a page that aligns itself to the top of the page. It is recommended to be used as a wrapper for one or more [toolbars](./toolbar.mdx), but it can be used to wrap any element. When a toolbar is used inside of a header, the content will be adjusted so it is sized correctly, and the header will account for any device safe areas. ## Basic Usage {/* #basic-usage */} diff --git a/versioned_docs/version-v8/api/input-password-toggle.mdx b/versioned_docs/version-v8/api/input-password-toggle.mdx index cb5dae8df4..141cc1d823 100644 --- a/versioned_docs/version-v8/api/input-password-toggle.mdx +++ b/versioned_docs/version-v8/api/input-password-toggle.mdx @@ -21,13 +21,13 @@ import EncapsulationPill from '@components/page/api/EncapsulationPill'; -The InputPasswordToggle component is a companion component to [Input](./input). It allows users to toggle the visibility of text in a password input. +The InputPasswordToggle component is a companion component to [Input](./input.mdx). It allows users to toggle the visibility of text in a password input. ## Basic Usage {/* #basic-usage */} :::info -InputPasswordToggle must be used with an [Input](./input) that has its [`type`](./input.mdx#prop-type) property set to either `'text'` or `'password'`. +InputPasswordToggle must be used with an [Input](./input.mdx) that has its [`type`](./input.mdx#prop-type) property set to either `'text'` or `'password'`. Using any other `type` will cause a warning to be logged. diff --git a/versioned_docs/version-v8/api/item-divider.mdx b/versioned_docs/version-v8/api/item-divider.mdx index c783265274..3065d48f52 100644 --- a/versioned_docs/version-v8/api/item-divider.mdx +++ b/versioned_docs/version-v8/api/item-divider.mdx @@ -21,7 +21,7 @@ import EncapsulationPill from '@components/page/api/EncapsulationPill'; -Item dividers are block elements that can be used to separate [items](./item) in a list. They are similar to list headers, but instead of only being placed at the top of a list, they should go in between groups of items. +Item dividers are block elements that can be used to separate [items](./item.mdx) in a list. They are similar to list headers, but instead of only being placed at the top of a list, they should go in between groups of items. ## Basic Usage {/* #basic-usage */} diff --git a/versioned_docs/version-v8/api/item-group.mdx b/versioned_docs/version-v8/api/item-group.mdx index f52f6bdad2..6666e9fc8d 100644 --- a/versioned_docs/version-v8/api/item-group.mdx +++ b/versioned_docs/version-v8/api/item-group.mdx @@ -19,7 +19,7 @@ import Slots from '@ionic-internal/component-api/v8/item-group/slots.mdx'; import EncapsulationPill from '@components/page/api/EncapsulationPill'; -Item groups are containers that organize similar [items](./item) together. They can contain [item dividers](./item-divider) to divide the items into multiple sections. They can also be used to group [sliding items](./item-sliding). +Item groups are containers that organize similar [items](./item.mdx) together. They can contain [item dividers](./item-divider.mdx) to divide the items into multiple sections. They can also be used to group [sliding items](./item-sliding.mdx). ## Basic Usage {/* #basic-usage */} diff --git a/versioned_docs/version-v8/api/item-option.mdx b/versioned_docs/version-v8/api/item-option.mdx index f320555992..2091dbec71 100644 --- a/versioned_docs/version-v8/api/item-option.mdx +++ b/versioned_docs/version-v8/api/item-option.mdx @@ -21,9 +21,9 @@ 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. +The item option component is an button for a sliding item. It must be placed inside of [item options](./item-options.mdx). The `ionSwipe` event and the `expandable` property can be combined to create a full swipe action for the item. -Refer to the [item sliding](./item-sliding) documentation for more information. +Refer to the [item sliding](./item-sliding.mdx) documentation for more information. ## Properties {/* #properties */} diff --git a/versioned_docs/version-v8/api/item-options.mdx b/versioned_docs/version-v8/api/item-options.mdx index cf589b1631..4eb9ab4382 100644 --- a/versioned_docs/version-v8/api/item-options.mdx +++ b/versioned_docs/version-v8/api/item-options.mdx @@ -19,9 +19,9 @@ import Slots from '@ionic-internal/component-api/v8/item-options/slots.mdx'; 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). +The item options component is a container for the [item option](./item-option.mdx) buttons in a sliding item. These buttons can be placed either on the [start or end side](#side-description). -Refer to the [item sliding](./item-sliding) documentation for more information. +Refer to the [item sliding](./item-sliding.mdx) documentation for more information. ## Side Description {/* #side-description */} diff --git a/versioned_docs/version-v8/api/item-sliding.mdx b/versioned_docs/version-v8/api/item-sliding.mdx index 74e2d5a270..2a6963eaac 100644 --- a/versioned_docs/version-v8/api/item-sliding.mdx +++ b/versioned_docs/version-v8/api/item-sliding.mdx @@ -19,11 +19,11 @@ import Slots from '@ionic-internal/component-api/v8/item-sliding/slots.mdx'; import EncapsulationPill from '@components/page/api/EncapsulationPill'; -A sliding item contains an item that can be dragged to reveal option buttons. It requires an [item](./item) component as a child. All options to reveal should be placed in the [item options](./item-options) element. +A sliding item contains an item that can be dragged to reveal option buttons. It requires an [item](./item.mdx) component as a child. All options to reveal should be placed in the [item options](./item-options.mdx) element. ## Basic Usage {/* #basic-usage */} -Sliding item options are placed on the `"end"` side of the item by default. This means that options are revealed when the item is swiped from end to start, i.e. from right to left in LTR, but from left to right in RTL. To place them on the opposite side, so that they are revealed when swiping in the opposite direction, set the side attribute to `"start"` on the [item options](./item-options) element. Up to two item options can be used at the same time in order to reveal two different sets of options depending on the swiping direction. +Sliding item options are placed on the `"end"` side of the item by default. This means that options are revealed when the item is swiped from end to start, i.e. from right to left in LTR, but from left to right in RTL. To place them on the opposite side, so that they are revealed when swiping in the opposite direction, set the side attribute to `"start"` on the [item options](./item-options.mdx) element. Up to two item options can be used at the same time in order to reveal two different sets of options depending on the swiping direction. import Basic from '@site/static/usage/v8/item-sliding/basic/index.mdx'; @@ -31,7 +31,7 @@ import Basic from '@site/static/usage/v8/item-sliding/basic/index.mdx'; ## Icon Options {/* #icon-options */} -When an icon is placed alongside text in the [item option](./item-option), it will display the icon on top of the text by default. The slot on the icon can be changed to any of the available [item option slots](./item-option#slots) to change its position. +When an icon is placed alongside text in the [item option](./item-option.mdx), it will display the icon on top of the text by default. The slot on the icon can be changed to any of the available [item option slots](./item-option.mdx#slots) to change its position. import Icons from '@site/static/usage/v8/item-sliding/icons/index.mdx'; @@ -39,7 +39,7 @@ import Icons from '@site/static/usage/v8/item-sliding/icons/index.mdx'; ## Expandable Options {/* #expandable-options */} -Options can be expanded to take up the full width of the parent `ion-item` if you swipe past a certain point. This can be combined with the `ionSwipe` event on the [item options](./item-options) to call a method when the item is fully swiped. +Options can be expanded to take up the full width of the parent `ion-item` if you swipe past a certain point. This can be combined with the `ionSwipe` event on the [item options](./item-options.mdx) to call a method when the item is fully swiped. import Expandable from '@site/static/usage/v8/item-sliding/expandable/index.mdx'; diff --git a/versioned_docs/version-v8/api/item.mdx b/versioned_docs/version-v8/api/item.mdx index 069f8613b1..02d935fc0e 100644 --- a/versioned_docs/version-v8/api/item.mdx +++ b/versioned_docs/version-v8/api/item.mdx @@ -25,11 +25,11 @@ import EncapsulationPill from '@components/page/api/EncapsulationPill'; -Items are elements that can contain text, icons, avatars, images, inputs, and any other native or custom elements. Items should only be used as rows in a [List](./list) with other items. Items can be swiped, deleted, reordered, edited, and more. +Items are elements that can contain text, icons, avatars, images, inputs, and any other native or custom elements. Items should only be used as rows in a [List](./list.mdx) with other items. Items can be swiped, deleted, reordered, edited, and more. ## Basic Usage {/* #basic-usage */} -Items left align text and wrap when the text is wider than the item. We can modify this behavior using the CSS Utilities provided by Ionic Framework, such as using `.ion-text-nowrap` in the below example. Refer to the [CSS Utilities Documentation](/layout/css-utilities.mdx) for more classes that can be added to an item to transform the text. +Items left align text and wrap when the text is wider than the item. We can modify this behavior using the CSS Utilities provided by Ionic Framework, such as using `.ion-text-nowrap` in the below example. Refer to the [CSS Utilities Documentation](../layout/css-utilities.mdx) for more classes that can be added to an item to transform the text. import Basic from '@site/static/usage/v8/item/basic/index.mdx'; @@ -41,7 +41,7 @@ While items in a list take many forms, they typically support 5 different conten ### Supporting Visuals {/* #supporting-visuals */} -Supporting visuals are decorative icons or other adornments for an item. Common examples of supporting visuals are [Avatars](./avatar), [Icons](./icon), and [Thumbnails](./thumbnail). Since this content is not required to understand the intent of the item, it is typically hidden from screen readers using `aria-hidden="true"`. +Supporting visuals are decorative icons or other adornments for an item. Common examples of supporting visuals are [Avatars](./avatar.mdx), [Icons](./icon.mdx), and [Thumbnails](./thumbnail.mdx). Since this content is not required to understand the intent of the item, it is typically hidden from screen readers using `aria-hidden="true"`. If a visual is required to interact with the item, such as an icon button, then the visual is an [action](#actions) not a supporting visual. @@ -101,7 +101,7 @@ In the example below, we are creating a list with different types of text. The " The "Allow Notifications" label on the toggle has additional text underneath it that notes users can disable notifications. Since this text is short, it is placed inside of the item. -Below that list is another list containing a textarea with a [Note](./note) containing long text underneath. The textarea was placed in its own list to make it apparent that the long text is associated with the textarea and not any other fields. +Below that list is another list containing a textarea with a [Note](./note.mdx) containing long text underneath. The textarea was placed in its own list to make it apparent that the long text is associated with the textarea and not any other fields. import Text from '@site/static/usage/v8/item/content-types/text/index.mdx'; @@ -109,7 +109,7 @@ import Text from '@site/static/usage/v8/item/content-types/text/index.mdx'; ### Metadata {/* #metadata */} -Metadata provides additional context for an item such as status text or counts. Components like [Badge](./badge) or [Note](./note) are great ways of showing metadata. +Metadata provides additional context for an item such as status text or counts. Components like [Badge](./badge.mdx) or [Note](./note.mdx) are great ways of showing metadata. -In the example below, we are creating two lists with different kinds of metadata. The first list uses [Note](./note) to show how many tasks are in each to-do list. +In the example below, we are creating two lists with different kinds of metadata. The first list uses [Note](./note.mdx) to show how many tasks are in each to-do list. The second list mimics the iOS Mail app to show an inbox. This list makes use of custom metadata including an "unread message" indicator in the "start" slot as well as a timestamp and custom detail icon in the "end" slot. The "unread message" indicator is highlighted in blue to draw the user's attention to the unread messages, while the timestamp is more subtle. @@ -337,10 +337,10 @@ import CSSProps from '@site/static/usage/v8/item/theming/css-properties/index.md The following guidelines will help ensure your list items are easy to understand and use. -1. Items should only be used inside of [Lists](./list). +1. Items should only be used inside of [Lists](./list.mdx). 2. Items inside of a list should be presented in a consistent format. For example, if your items present decorative icons, the icons should be positioned in the same way between items. 3. Items should never render [nested interactives](https://dequeuniversity.com/rules/axe/4.4/nested-interactive). Screen readers are unable to select the correct interactive element when nested interactives are used. For example, avoid placing a button inside of an `ion-item` that has `button="true"`. -4. Use [content types](#content-types) correctly. The Item component is designed to be a row in a [List](./list) and should not be used as a general purpose container. +4. Use [content types](#content-types) correctly. The Item component is designed to be a row in a [List](./list.mdx) and should not be used as a general purpose container. ## Accessibility {/* #accessibility */} diff --git a/versioned_docs/version-v8/api/list-header.mdx b/versioned_docs/version-v8/api/list-header.mdx index 76662a80a3..e6addbcab9 100644 --- a/versioned_docs/version-v8/api/list-header.mdx +++ b/versioned_docs/version-v8/api/list-header.mdx @@ -13,7 +13,7 @@ import EncapsulationPill from '@components/page/api/EncapsulationPill'; -List headers are block elements that are used to describe the contents of a [list](./list). Unlike [item dividers](./item-divider), list headers should only be used once at the top of a list of [items](./item). +List headers are block elements that are used to describe the contents of a [list](./list.mdx). Unlike [item dividers](./item-divider.mdx), list headers should only be used once at the top of a list of [items](./item.mdx). ## Basic Usage {/* #basic-usage */} @@ -23,7 +23,7 @@ import Basic from '@site/static/usage/v8/list-header/basic/index.mdx'; ## Buttons in List Headers {/* #buttons-in-list-headers */} -A [button](./button) placed in a list header can be useful for showing part of a list and redirecting to the full list with the button. +A [button](./button.mdx) placed in a list header can be useful for showing part of a list and redirecting to the full list with the button. import Buttons from '@site/static/usage/v8/list-header/buttons/index.mdx'; diff --git a/versioned_docs/version-v8/api/list.mdx b/versioned_docs/version-v8/api/list.mdx index 8e284c4704..d2237a8e77 100644 --- a/versioned_docs/version-v8/api/list.mdx +++ b/versioned_docs/version-v8/api/list.mdx @@ -19,9 +19,9 @@ import Slots from '@ionic-internal/component-api/v8/list/slots.mdx'; import EncapsulationPill from '@components/page/api/EncapsulationPill'; -Lists are made up of multiple rows of [items](./item) which can contain text, buttons, toggles, icons, thumbnails, and much more. Lists generally contain items with similar data content, such as images and text. +Lists are made up of multiple rows of [items](./item.mdx) which can contain text, buttons, toggles, icons, thumbnails, and much more. Lists generally contain items with similar data content, such as images and text. -Lists support several interactions including swiping items to reveal options, dragging to [reorder](./reorder) items within the list, and deleting items. +Lists support several interactions including swiping items to reveal options, dragging to [reorder](./reorder.mdx) items within the list, and deleting items. ## Basic Usage {/* #basic-usage */} diff --git a/versioned_docs/version-v8/api/menu-button.mdx b/versioned_docs/version-v8/api/menu-button.mdx index e254c5fe22..8f2e2bd103 100644 --- a/versioned_docs/version-v8/api/menu-button.mdx +++ b/versioned_docs/version-v8/api/menu-button.mdx @@ -23,7 +23,7 @@ import EncapsulationPill from '@components/page/api/EncapsulationPill'; The Menu Button component contains an icon and automatically adds functionality to open a menu when clicked. -Refer to the [menu](./menu) documentation for more information. +Refer to the [menu](./menu.mdx) documentation for more information. ## Properties {/* #properties */} diff --git a/versioned_docs/version-v8/api/menu-toggle.mdx b/versioned_docs/version-v8/api/menu-toggle.mdx index 92c9d405e9..aa9a075eec 100644 --- a/versioned_docs/version-v8/api/menu-toggle.mdx +++ b/versioned_docs/version-v8/api/menu-toggle.mdx @@ -25,7 +25,7 @@ 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`. -Refer to the [menu](./menu#menu-toggle) documentation for more information. +Refer to the [menu](./menu.mdx#menu-toggle) documentation for more information. ## Properties {/* #properties */} diff --git a/versioned_docs/version-v8/api/menu.mdx b/versioned_docs/version-v8/api/menu.mdx index 623c283937..1e41ebf77a 100644 --- a/versioned_docs/version-v8/api/menu.mdx +++ b/versioned_docs/version-v8/api/menu.mdx @@ -33,7 +33,7 @@ import Basic from '@site/static/usage/v8/menu/basic/index.mdx'; ## Menu Toggle {/* #menu-toggle */} -The [menu toggle](./menu-toggle) component can be used to create custom button that can open or close the menu. +The [menu toggle](./menu-toggle.mdx) component can be used to create custom button that can open or close the menu. import MenuToggle from '@site/static/usage/v8/menu/toggle/index.mdx'; diff --git a/versioned_docs/version-v8/api/modal.mdx b/versioned_docs/version-v8/api/modal.mdx index b6ac40717d..94644f5be0 100644 --- a/versioned_docs/version-v8/api/modal.mdx +++ b/versioned_docs/version-v8/api/modal.mdx @@ -127,7 +127,7 @@ import CardExample from '@site/static/usage/v8/modal/card/basic/index.mdx'; :::info -[Content](./content) should be used inside of the sheet modal if you want your modal content to be scrollable. +[Content](./content.mdx) should be used inside of the sheet modal if you want your modal content to be scrollable. ::: @@ -208,7 +208,7 @@ import AnimationsExample from '@site/static/usage/v8/modal/styling/animations/in ## Custom Dialogs {/* #custom-dialogs */} -While `ion-modal` is most often used for full-page views, cards, or sheets, it is also possible to use it for custom dialogs. This is useful if developers need an interface that is more complex than what components such as [ion-alert](./alert) or [ion-loading](./loading) provide. +While `ion-modal` is most often used for full-page views, cards, or sheets, it is also possible to use it for custom dialogs. This is useful if developers need an interface that is more complex than what components such as [ion-alert](./alert.mdx) or [ion-loading](./loading.mdx) provide. import CustomDialogs from '@site/static/usage/v8/modal/custom-dialogs/index.mdx'; diff --git a/versioned_docs/version-v8/api/nav-link.mdx b/versioned_docs/version-v8/api/nav-link.mdx index 6cbfead2a6..4884345979 100644 --- a/versioned_docs/version-v8/api/nav-link.mdx +++ b/versioned_docs/version-v8/api/nav-link.mdx @@ -23,7 +23,7 @@ A navigation link is used to navigate to a specified component. The component ca It is the element form of calling the `push()`, `pop()`, and `setRoot()` methods on the navigation controller. -Refer to the [nav](./nav#using-navlink) documentation for more information. +Refer to the [nav](./nav.mdx#using-navlink) documentation for more information. ## Properties {/* #properties */} diff --git a/versioned_docs/version-v8/api/nav.mdx b/versioned_docs/version-v8/api/nav.mdx index b881d692d3..6f511e55e2 100644 --- a/versioned_docs/version-v8/api/nav.mdx +++ b/versioned_docs/version-v8/api/nav.mdx @@ -27,7 +27,7 @@ Unlike Router Outlet, Nav is not tied to a particular router. This means that if :::note -`ion-nav` is not meant to be used for routing. Instead, refer to the routing guides for [Angular](../angular/navigation), [React](../react/navigation), and [Vue](../vue/navigation), or [`ion-router`](./router) for vanilla JavaScript projects. +`ion-nav` is not meant to be used for routing. Instead, refer to the routing guides for [Angular](../angular/navigation.mdx), [React](../react/navigation.mdx), and [Vue](../vue/navigation.mdx), or [`ion-router`](./router.mdx) for vanilla JavaScript projects. ::: diff --git a/versioned_docs/version-v8/api/picker.mdx b/versioned_docs/version-v8/api/picker.mdx index c42d94b17e..b326f58f6b 100644 --- a/versioned_docs/version-v8/api/picker.mdx +++ b/versioned_docs/version-v8/api/picker.mdx @@ -54,7 +54,7 @@ import ModalExample from '@site/static/usage/v8/picker/modal/index.mdx'; ### Screen Readers {/* #screen-readers */} -Picker supports navigation using a screen reader by implementing the [`slider` role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/slider_role) on each [Picker Column](./picker-column). The following gestures can be used to navigate the Picker. +Picker supports navigation using a screen reader by implementing the [`slider` role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/slider_role) on each [Picker Column](./picker-column.mdx). The following gestures can be used to navigate the Picker. | Gesture | Function | | --- | --- | @@ -72,7 +72,7 @@ The Swipe Up and Swipe Down gestures rely on the correct key events being synthe ### Keyboard Interactions {/* #keyboard-interactions */} -Each [Picker Column](./picker-column) can be navigated using the keyboard when focused. +Each [Picker Column](./picker-column.mdx) can be navigated using the keyboard when focused. | Key | Description | | -------------------- | ------------------------------------ | diff --git a/versioned_docs/version-v8/api/radio-group.mdx b/versioned_docs/version-v8/api/radio-group.mdx index e1bbbf6ffb..94bd0aadde 100644 --- a/versioned_docs/version-v8/api/radio-group.mdx +++ b/versioned_docs/version-v8/api/radio-group.mdx @@ -19,7 +19,7 @@ import Slots from '@ionic-internal/component-api/v8/radio-group/slots.mdx'; 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, refer to the [radio](./radio) documentation. +A radio group is a container for a group of [radios](./radio.mdx). 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, refer to the [radio](./radio.mdx) documentation. ## Interfaces {/* #interfaces */} diff --git a/versioned_docs/version-v8/api/radio.mdx b/versioned_docs/version-v8/api/radio.mdx index 7623b541f3..a1278ef0e8 100644 --- a/versioned_docs/version-v8/api/radio.mdx +++ b/versioned_docs/version-v8/api/radio.mdx @@ -21,9 +21,9 @@ import EncapsulationPill from '@components/page/api/EncapsulationPill'; -Radios should be used inside of a [radio group](./radio-group). Pressing a radio will check it and uncheck the previously selected radio, if there is one. They can also be checked programmatically by setting the value property of the parent radio group to the value of the radio. +Radios should be used inside of a [radio group](./radio-group.mdx). Pressing a radio will check it and uncheck the previously selected radio, if there is one. They can also be checked programmatically by setting the value property of the parent radio group to the value of the radio. -When radios are inside of a radio group, only one radio will be checked at any time. If more than one item should be selected, [checkboxes](./checkbox) should be used instead. Radios can be disabled within a group to prevent interaction with them. +When radios are inside of a radio group, only one radio will be checked at any time. If more than one item should be selected, [checkboxes](./checkbox.mdx) should be used instead. Radios can be disabled within a group to prevent interaction with them. ## Basic Usage {/* #basic-usage */} diff --git a/versioned_docs/version-v8/api/refresher-content.mdx b/versioned_docs/version-v8/api/refresher-content.mdx index ae8fcd4e37..b63c846ebc 100644 --- a/versioned_docs/version-v8/api/refresher-content.mdx +++ b/versioned_docs/version-v8/api/refresher-content.mdx @@ -13,7 +13,7 @@ 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, refer to the [Refresher](/api/refresher.mdx) documentation. +For usage examples, refer to the [Refresher](./refresher.mdx) documentation. ## Properties {/* #properties */} diff --git a/versioned_docs/version-v8/api/refresher.mdx b/versioned_docs/version-v8/api/refresher.mdx index 6e80074f7a..8d79a36985 100644 --- a/versioned_docs/version-v8/api/refresher.mdx +++ b/versioned_docs/version-v8/api/refresher.mdx @@ -41,7 +41,7 @@ import PullProperties from '@site/static/usage/v8/refresher/pull-properties/inde ## Custom Refresher Content {/* #custom-refresher-content */} -The default icon, spinner, and text can be customized on the [refresher content](./refresher-content) based on whether the state of the refresher is `pulling` or `refreshing`. +The default icon, spinner, and text can be customized on the [refresher content](./refresher-content.mdx) based on whether the state of the refresher is `pulling` or `refreshing`. Setting `pullingIcon` will disable the [native refresher](#native-refreshers). @@ -59,7 +59,7 @@ The native refresher uses a `circular` spinner for Material Design, while iOS us Certain refresher properties such as the [Pull Properties](#pull-properties), `closeDuration` and `snapbackDuration` are not compatible because much of the native refreshers are scroll-based. Refer to [Properties](#properties) for more information on unsupported properties. -The native refreshers can be disabled by setting the `pullingIcon` on the [refresher content](#custom-refresher-content) to any icon or spinner. Refer to the [Ionicons](https://ionic.io/ionicons) and [Spinner](./spinner) documentation for accepted values. +The native refreshers can be disabled by setting the `pullingIcon` on the [refresher content](#custom-refresher-content) to any icon or spinner. Refer to the [Ionicons](https://ionic.io/ionicons) and [Spinner](./spinner.mdx) documentation for accepted values. ## Usage with Virtual Scroll {/* #usage-with-virtual-scroll */} diff --git a/versioned_docs/version-v8/api/reorder-group.mdx b/versioned_docs/version-v8/api/reorder-group.mdx index f0166270b6..5ae7b0f9ec 100644 --- a/versioned_docs/version-v8/api/reorder-group.mdx +++ b/versioned_docs/version-v8/api/reorder-group.mdx @@ -19,9 +19,9 @@ import Slots from '@ionic-internal/component-api/v8/reorder-group/slots.mdx'; 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, the `ionReorderEnd` event is dispatched. A handler for this event should be implemented that calls the `complete` method. +The reorder group is a container for items using the [reorder](./reorder.mdx) component. When the user drags an item and drops it, the `ionReorderEnd` event is dispatched. A handler for this event should be implemented that calls the `complete` method. -The `detail` property of the `ionReorderEnd` 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` an index. For example usage of the reorder group, refer to the [reorder](./reorder) documentation. +The `detail` property of the `ionReorderEnd` 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` an index. For example usage of the reorder group, refer to the [reorder](./reorder.mdx) documentation. ## Interfaces {/* #interfaces */} diff --git a/versioned_docs/version-v8/api/reorder.mdx b/versioned_docs/version-v8/api/reorder.mdx index 1619b6a0f8..89a90a7cce 100644 --- a/versioned_docs/version-v8/api/reorder.mdx +++ b/versioned_docs/version-v8/api/reorder.mdx @@ -21,7 +21,7 @@ import EncapsulationPill from '@components/page/api/EncapsulationPill'; -Reorder is a component that allows an item to be dragged to change its order within a group of items. It must be used within a [reorder group](./reorder-group) to provide a visual drag and drop interface. +Reorder is a component that allows an item to be dragged to change its order within a group of items. It must be used within a [reorder group](./reorder-group.mdx) to provide a visual drag and drop interface. The reorder is the anchor used to drag and drop the items. Once the reorder is complete, the `ionReorderEnd` event will be dispatched from the reorder group and the `complete` method needs to be called. diff --git a/versioned_docs/version-v8/api/route-redirect.mdx b/versioned_docs/version-v8/api/route-redirect.mdx index 469882a3bd..1351e276af 100644 --- a/versioned_docs/version-v8/api/route-redirect.mdx +++ b/versioned_docs/version-v8/api/route-redirect.mdx @@ -23,7 +23,7 @@ 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.mdx) 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.mdx) and the Angular router. ::: diff --git a/versioned_docs/version-v8/api/route.mdx b/versioned_docs/version-v8/api/route.mdx index d163c3e8e1..d60865b6d4 100644 --- a/versioned_docs/version-v8/api/route.mdx +++ b/versioned_docs/version-v8/api/route.mdx @@ -26,7 +26,7 @@ The route component takes a component and renders it when the Browser URL matche :::note -Note: this component should only be used with vanilla and Stencil JavaScript projects. For Angular projects, use [`ion-router-outlet`](router-outlet.mdx) 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.mdx) and the Angular router. ::: diff --git a/versioned_docs/version-v8/api/router-link.mdx b/versioned_docs/version-v8/api/router-link.mdx index ff3551cf13..6cc4f6ff46 100644 --- a/versioned_docs/version-v8/api/router-link.mdx +++ b/versioned_docs/version-v8/api/router-link.mdx @@ -29,7 +29,7 @@ Note: this component should only be used with vanilla and Stencil JavaScript pro ::: -Refer to the [Router](./router) documentation for more information. +Refer to the [Router](./router.mdx) documentation for more information. ## Properties {/* #properties */} diff --git a/versioned_docs/version-v8/api/router.mdx b/versioned_docs/version-v8/api/router.mdx index 46247301f3..9f1814b6f3 100644 --- a/versioned_docs/version-v8/api/router.mdx +++ b/versioned_docs/version-v8/api/router.mdx @@ -23,7 +23,7 @@ The router is a component for handling routing inside vanilla and Stencil JavaSc :::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.mdx), [React](../react/navigation.mdx), and [Vue](../vue/navigation.mdx) for framework-specific routing solutions. ::: diff --git a/versioned_docs/version-v8/api/row.mdx b/versioned_docs/version-v8/api/row.mdx index e58056000f..b25a1d7e04 100644 --- a/versioned_docs/version-v8/api/row.mdx +++ b/versioned_docs/version-v8/api/row.mdx @@ -21,13 +21,13 @@ import EncapsulationPill from '@components/page/api/EncapsulationPill'; -Rows are horizontal components of the [grid](./grid) system and contain varying numbers of [columns](./col). They ensure the columns are positioned properly. +Rows are horizontal components of the [grid](./grid.mdx) system and contain varying numbers of [columns](./col.mdx). They ensure the columns are positioned properly. -Refer to the [grid](./grid) documentation for more information. +Refer to the [grid](./grid.mdx) documentation for more information. ## Row Alignment {/* #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](/layout/css-utilities.mdx#flex-container-properties) that can be applied to a row to customize this behavior. +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](../layout/css-utilities.mdx#flex-container-properties) that can be applied to a row to customize this behavior. ## Properties {/* #properties */} diff --git a/versioned_docs/version-v8/api/segment-button.mdx b/versioned_docs/version-v8/api/segment-button.mdx index f2b55011ee..7c5f271746 100644 --- a/versioned_docs/version-v8/api/segment-button.mdx +++ b/versioned_docs/version-v8/api/segment-button.mdx @@ -21,7 +21,7 @@ import EncapsulationPill from '@components/page/api/EncapsulationPill'; -Segment buttons are groups of related buttons inside of a [segment](segment.mdx). They are displayed in a horizontal row. A segment button can be selected by default by setting the `value` of the segment to the `value` of the segment button. Only one segment button can be selected at a time. +Segment buttons are groups of related buttons inside of a [segment](./segment.mdx). They are displayed in a horizontal row. A segment button can be selected by default by setting the `value` of the segment to the `value` of the segment button. Only one segment button can be selected at a time. ## Basic Usage {/* #basic-usage */} diff --git a/versioned_docs/version-v8/api/segment.mdx b/versioned_docs/version-v8/api/segment.mdx index 45ab434da4..9629952313 100644 --- a/versioned_docs/version-v8/api/segment.mdx +++ b/versioned_docs/version-v8/api/segment.mdx @@ -27,7 +27,7 @@ Their functionality is similar to tabs, where selecting one will deselect all ot ## Basic Usage {/* #basic-usage */} -Segments consist of [segment buttons](./segment-button) with a `value` property on each button. Set the `value` property on the segment to match the value of a button to select that button. Segments can also be disabled to prevent users from interacting with them. +Segments consist of [segment buttons](./segment-button.mdx) with a `value` property on each button. Set the `value` property on the segment to match the value of a button to select that button. Segments can also be disabled to prevent users from interacting with them. import Basic from '@site/static/usage/v8/segment/basic/index.mdx'; diff --git a/versioned_docs/version-v8/api/select-option.mdx b/versioned_docs/version-v8/api/select-option.mdx index 3becdeb92f..eee3511f6a 100644 --- a/versioned_docs/version-v8/api/select-option.mdx +++ b/versioned_docs/version-v8/api/select-option.mdx @@ -23,7 +23,7 @@ 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, refer to the [Select](./select) documentation. +For usage examples, refer to the [Select](./select.mdx) documentation. ## Properties {/* #properties */} diff --git a/versioned_docs/version-v8/api/select.mdx b/versioned_docs/version-v8/api/select.mdx index d9ac9eb977..0ca38c9316 100644 --- a/versioned_docs/version-v8/api/select.mdx +++ b/versioned_docs/version-v8/api/select.mdx @@ -89,7 +89,7 @@ import MultipleSelectionExample from '@site/static/usage/v8/select/basic/multipl ## Interfaces {/* #interfaces */} -By default, select uses [ion-alert](alert.mdx) to open up the overlay of options in an alert. The interface can be changed to use [ion-action-sheet](action-sheet.mdx), [ion-popover](popover.mdx), or [ion-modal](modal.mdx) by passing `action-sheet`, `popover`, or `modal`, respectively, to the `interface` property. Read on to the other sections for the limitations of the different interfaces. +By default, select uses [ion-alert](./alert.mdx) to open up the overlay of options in an alert. The interface can be changed to use [ion-action-sheet](./action-sheet.mdx), [ion-popover](./popover.mdx), or [ion-modal](./modal.mdx) by passing `action-sheet`, `popover`, or `modal`, respectively, to the `interface` property. Read on to the other sections for the limitations of the different interfaces. ### Alert {/* #alert */} @@ -181,7 +181,7 @@ import ButtonTextExample from '@site/static/usage/v8/select/customization/button Since select uses the alert, action sheet, popover, and modal interfaces, options can be passed to these components through the `interfaceOptions` property. This can be used to pass a custom header, subheader, css class, and more. -Refer to the [ion-alert docs](alert.mdx), [ion-action-sheet docs](action-sheet.mdx), [ion-popover docs](popover.mdx), and [ion-modal docs](modal.mdx) for the properties that each interface accepts. +Refer to the [ion-alert docs](./alert.mdx), [ion-action-sheet docs](./action-sheet.mdx), [ion-popover docs](./popover.mdx), and [ion-modal docs](./modal.mdx) for the properties that each interface accepts. Note: `interfaceOptions` will not override `inputs` or `buttons` with the `alert` interface. @@ -223,12 +223,12 @@ import StylingSelectExample from '@site/static/usage/v8/select/customization/sty Customizing the interface dialog should be done by following the styling sections (CSS shadow parts, CSS custom properties, and slots) in that interface's documentation: -- [Alert](alert.mdx#css-shadow-parts) -- [Action Sheet](action-sheet.mdx#css-shadow-parts) -- [Popover](popover.mdx#css-shadow-parts) -- [Modal](modal.mdx#css-shadow-parts) +- [Alert](./alert.mdx#css-shadow-parts) +- [Action Sheet](./action-sheet.mdx#css-shadow-parts) +- [Popover](./popover.mdx#css-shadow-parts) +- [Modal](./modal.mdx#css-shadow-parts) -However, the Select Option does set a class for easier styling and allows for the ability to pass a class to the overlay option, refer to the [Select Options documentation](select-option.mdx) for usage examples of customizing options. +However, the Select Option does set a class for easier styling and allows for the ability to pass a class to the overlay option, refer to the [Select Options documentation](./select-option.mdx) for usage examples of customizing options. ### Custom Toggle Icons {/* #custom-toggle-icons */} diff --git a/versioned_docs/version-v8/api/tab-bar.mdx b/versioned_docs/version-v8/api/tab-bar.mdx index 1d692e9a47..dd74f16256 100644 --- a/versioned_docs/version-v8/api/tab-bar.mdx +++ b/versioned_docs/version-v8/api/tab-bar.mdx @@ -24,7 +24,7 @@ import EncapsulationPill from '@components/page/api/EncapsulationPill'; -The tab bar is a UI component that contains a set of [tab buttons](tab-button.mdx). A tab bar must be provided inside of [tabs](tabs.mdx) to communicate with each [tab](tab.mdx). +The tab bar is a UI component that contains a set of [tab buttons](./tab-button.mdx). A tab bar must be provided inside of [tabs](./tabs.mdx) to communicate with each [tab](./tab.mdx). ## Usage {/* #usage */} diff --git a/versioned_docs/version-v8/api/tab-button.mdx b/versioned_docs/version-v8/api/tab-button.mdx index 4b3fb4f998..51da800950 100644 --- a/versioned_docs/version-v8/api/tab-button.mdx +++ b/versioned_docs/version-v8/api/tab-button.mdx @@ -16,9 +16,9 @@ import EncapsulationPill from '@components/page/api/EncapsulationPill'; -A tab button is a UI component that is placed inside of a [tab bar](tab-bar.mdx). The tab button can specify the layout of the icon and label and connect to a [tab view](tab.mdx). +A tab button is a UI component that is placed inside of a [tab bar](./tab-bar.mdx). The tab button can specify the layout of the icon and label and connect to a [tab view](./tab.mdx). -Refer to the [tabs documentation](tabs.mdx) for more details on configuring tabs. +Refer to the [tabs documentation](./tabs.mdx) for more details on configuring tabs. ## Usage {/* #usage */} diff --git a/versioned_docs/version-v8/api/tab.mdx b/versioned_docs/version-v8/api/tab.mdx index d40b721d7d..7e08cfa814 100644 --- a/versioned_docs/version-v8/api/tab.mdx +++ b/versioned_docs/version-v8/api/tab.mdx @@ -21,7 +21,7 @@ import EncapsulationPill from '@components/page/api/EncapsulationPill'; -The tab component is a child component of [tabs](tabs.mdx). 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. +The tab component is a child component of [tabs](./tabs.mdx). 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 @@ -31,7 +31,7 @@ In JavaScript, this component can be used with the `ion-tabs` component configur ::: -Refer to the [tabs documentation](tabs.mdx) for more details on configuring tabs. +Refer to the [tabs documentation](./tabs.mdx) for more details on configuring tabs. ## Properties {/* #properties */} diff --git a/versioned_docs/version-v8/api/tabs.mdx b/versioned_docs/version-v8/api/tabs.mdx index e00472283a..fa6a4f626c 100644 --- a/versioned_docs/version-v8/api/tabs.mdx +++ b/versioned_docs/version-v8/api/tabs.mdx @@ -21,7 +21,7 @@ import EncapsulationPill from '@components/page/api/EncapsulationPill'; -Tabs are a top level navigation component to implement a tab-based navigation. The component is a container of individual [Tab](tab.mdx) components. +Tabs are a top level navigation component to implement a tab-based navigation. The component is a container of individual [Tab](./tab.mdx) components. The `ion-tabs` component does not have any styling and works as a router outlet in order to handle navigation. It does not provide any UI feedback or mechanism to switch between tabs. In order to do so, an `ion-tab-bar` should be provided as a direct child of `ion-tabs`. @@ -47,7 +47,7 @@ import Router from '@site/static/usage/v8/tabs/router/index.mdx'; :::tip[Best Practices] -Ionic has guides on best practices for routing patterns with tabs. Check out the guides for [Angular](/angular/navigation#working-with-tabs), [React](/react/navigation#working-with-tabs), and [Vue](/vue/navigation#working-with-tabs) for additional information. +Ionic has guides on best practices for routing patterns with tabs. Check out the guides for [Angular](../angular/navigation.mdx#working-with-tabs), [React](../react/navigation.mdx#working-with-tabs), and [Vue](../vue/navigation.mdx#working-with-tabs) for additional information. ::: diff --git a/versioned_docs/version-v8/api/text.mdx b/versioned_docs/version-v8/api/text.mdx index 5fcbcb015b..5624131f5f 100644 --- a/versioned_docs/version-v8/api/text.mdx +++ b/versioned_docs/version-v8/api/text.mdx @@ -31,7 +31,7 @@ import Basic from '@site/static/usage/v8/text/basic/index.mdx'; ## Theming {/* #theming */} -The text component can be customized by changing any of the default [colors](/theming/colors.mdx) Ionic provides. +The text component can be customized by changing any of the default [colors](../theming/colors.mdx) Ionic provides. ## Properties {/* #properties */} diff --git a/versioned_docs/version-v8/api/title.mdx b/versioned_docs/version-v8/api/title.mdx index 581b6b342e..3f37d9c0e4 100644 --- a/versioned_docs/version-v8/api/title.mdx +++ b/versioned_docs/version-v8/api/title.mdx @@ -21,7 +21,7 @@ import EncapsulationPill from '@components/page/api/EncapsulationPill'; -Title is a text component that sets the title for a [toolbar](./toolbar). It can be used to describe the screen or section a user is currently on or the app being used. +Title is a text component that sets the title for a [toolbar](./toolbar.mdx). It can be used to describe the screen or section a user is currently on or the app being used. ## Basic {/* #basic */} @@ -31,7 +31,7 @@ import Basic from '@site/static/usage/v8/title/basic/index.mdx'; ## Collapsible Large Titles {/* #collapsible-large-titles */} -The large title will display when the [content](./content) is scrolled to the start of the scroll container. When the title is scrolled behind the header, the condensed title will fade in. +The large title will display when the [content](./content.mdx) is scrolled to the start of the scroll container. When the title is scrolled behind the header, the condensed title will fade in. :::info @@ -59,7 +59,7 @@ When creating headings, we typically recommend using [semantic heading elements To achieve this, developers should use the [`heading` role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/heading_role) on Title. This will indicate to assistive technologies that Title is a type of heading. From there, developers should use the [`aria-level` attribute](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-level) to set the heading level. -For example, if we wanted to make a Title behave like an `h1` element, we would set `role="heading"` and `aria-level="1"` on the Title. This is necessary when using the [Focus Manager](../developing/managing-focus#assistive-technology-focus-management). +For example, if we wanted to make a Title behave like an `h1` element, we would set `role="heading"` and `aria-level="1"` on the Title. This is necessary when using the [Focus Manager](../developing/managing-focus.mdx#assistive-technology-focus-management). Since multiple Title elements can be used on a view in conjunction with semantic heading elements, Ionic does not automatically set the Title's `role` or `aria-level`. It is the responsibility of the developer to handle this. diff --git a/versioned_docs/version-v8/api/toast.mdx b/versioned_docs/version-v8/api/toast.mdx index a431fa1b85..0c2da90b2f 100644 --- a/versioned_docs/version-v8/api/toast.mdx +++ b/versioned_docs/version-v8/api/toast.mdx @@ -94,7 +94,7 @@ import StackedPlayground from '@site/static/usage/v8/toast/layout/index.mdx'; ## Icons {/* #icons */} -An icon can be added next to the content inside of the toast. In general, icons in toasts should be used to add additional style or context, not to grab the user's attention or elevate the priority of the toast. If you wish to convey a higher priority message to the user or guarantee a response, we recommend using an [Alert](alert.mdx) instead. +An icon can be added next to the content inside of the toast. In general, icons in toasts should be used to add additional style or context, not to grab the user's attention or elevate the priority of the toast. If you wish to convey a higher priority message to the user or guarantee a response, we recommend using an [Alert](./alert.mdx) instead. import IconPlayground from '@site/static/usage/v8/toast/icon/index.mdx'; @@ -114,7 +114,7 @@ Toasts are intended to be subtle notifications and are not intended to interrupt ### Screen Readers {/* #screen-readers */} -Toasts set aria properties in order to be [accessible](../reference/glossary#a11y) to screen readers, but these properties can be overridden if they aren't descriptive enough or don't align with how the toast is being used in an app. +Toasts set aria properties in order to be [accessible](../reference/glossary.mdx#a11y) to screen readers, but these properties can be overridden if they aren't descriptive enough or don't align with how the toast is being used in an app. #### Role {/* #role */} @@ -122,7 +122,7 @@ Toasts set aria properties in order to be [accessible](../reference/glossary#a11 `aria-live` causes screen readers to announce the content of the toast when it is updated. However, since the attribute is set to `'polite'`, screen readers should not interrupt the current task. -Since toasts are intended to be subtle notification, `aria-live` should never be set to `"assertive"`. If developers need to interrupt the user with an important message, we recommend using an [alert](./alert). +Since toasts are intended to be subtle notification, `aria-live` should never be set to `"assertive"`. If developers need to interrupt the user with an important message, we recommend using an [alert](./alert.mdx). #### Toast Buttons Description {/* #toast-buttons-description */} @@ -208,13 +208,13 @@ const toast = await toastController.create({ While this is not a complete list, here are some guidelines to follow when using toasts. -- Do not require user interaction to dismiss toasts. For example, having a "Dismiss" button in the toast is fine, but the toast should also automatically dismiss on its own after a timeout period. If you need user interaction for a notification, consider using an [alert](./alert) instead. +- Do not require user interaction to dismiss toasts. For example, having a "Dismiss" button in the toast is fine, but the toast should also automatically dismiss on its own after a timeout period. If you need user interaction for a notification, consider using an [alert](./alert.mdx) instead. - For toasts with long messages, consider adjusting the `duration` property to allow users enough time to read the content of the toast. - If adding buttons to a toast, always provide alternative ways of completing the actions associated with each button. This ensures that even if the toast dismisses before a user can read it, they can still complete the actions shown in the toast. -- Avoid showing a toast with buttons from inside another overlay such as a [modal](./modal). Modals and other overlays implement [focus trapping](./modal#focus-trapping) that will prevent screen readers from moving focus to the toast to complete the actions. This may be confusing for users since the toast will still be announced by screen readers. This is true even if alternative ways of completing the actions associated with each button are implemented. Consider creating a [live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/ARIA_Live_Regions) within the focus-trapped modal instead of using a toast. +- Avoid showing a toast with buttons from inside another overlay such as a [modal](./modal.mdx). Modals and other overlays implement [focus trapping](./modal.mdx#focus-trapping) that will prevent screen readers from moving focus to the toast to complete the actions. This may be confusing for users since the toast will still be announced by screen readers. This is true even if alternative ways of completing the actions associated with each button are implemented. Consider creating a [live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/ARIA_Live_Regions) within the focus-trapped modal instead of using a toast. ## Interfaces {/* #interfaces */} diff --git a/versioned_docs/version-v8/api/toggle.mdx b/versioned_docs/version-v8/api/toggle.mdx index 956d337882..6e942d1c89 100644 --- a/versioned_docs/version-v8/api/toggle.mdx +++ b/versioned_docs/version-v8/api/toggle.mdx @@ -39,7 +39,7 @@ import OnOff from '@site/static/usage/v8/toggle/on-off/index.mdx'; ## Toggles in a List {/* #toggles-in-a-list */} -Toggles can also be used in a list view by using the [Item](./item) and [List](./list) components. +Toggles can also be used in a list view by using the [Item](./item.mdx) and [List](./list.mdx) components. import List from '@site/static/usage/v8/toggle/list/index.mdx'; diff --git a/versioned_docs/version-v8/api/toolbar.mdx b/versioned_docs/version-v8/api/toolbar.mdx index 6adc21cc8c..e80d48200a 100644 --- a/versioned_docs/version-v8/api/toolbar.mdx +++ b/versioned_docs/version-v8/api/toolbar.mdx @@ -21,13 +21,13 @@ import EncapsulationPill from '@components/page/api/EncapsulationPill'; -Toolbars are generally positioned above or below content and provide content and actions for the current screen. When placed within the [content](./content), toolbars will scroll with the content. +Toolbars are generally positioned above or below content and provide content and actions for the current screen. When placed within the [content](./content.mdx), toolbars will scroll with the content. Toolbars can contain several different components including titles, buttons, icons, back buttons, menu buttons, searchbars, segments, progress bars, and more. ## Basic Usage {/* #basic-usage */} -It is recommended to put a toolbar inside of a [header](./header) or [footer](./footer) for proper positioning. When a toolbar is placed in a header it will appear fixed at the top of the content. When it is placed in a footer it will appear fixed at the bottom. Fullscreen content will scroll behind a toolbar in a header or footer. A [title](./title) component can be used to display text inside of the toolbar. +It is recommended to put a toolbar inside of a [header](./header.mdx) or [footer](./footer.mdx) for proper positioning. When a toolbar is placed in a header it will appear fixed at the top of the content. When it is placed in a footer it will appear fixed at the bottom. Fullscreen content will scroll behind a toolbar in a header or footer. A [title](./title.mdx) component can be used to display text inside of the toolbar. import Basic from '@site/static/usage/v8/toolbar/basic/index.mdx'; @@ -35,9 +35,9 @@ import Basic from '@site/static/usage/v8/toolbar/basic/index.mdx'; ## Buttons in Toolbars {/* #buttons-in-toolbars */} -Buttons placed in a toolbar should be placed inside of the [buttons](./buttons) component. The buttons component can be positioned inside of the toolbar using a named [slot](#slots). The `"primary"` and `"secondary"` slots behave differently in `ios` and `md` mode. +Buttons placed in a toolbar should be placed inside of the [buttons](./buttons.mdx) component. The buttons component can be positioned inside of the toolbar using a named [slot](#slots). The `"primary"` and `"secondary"` slots behave differently in `ios` and `md` mode. -The buttons component can wrap a standard [button](./button), [back button](./back-button), [menu button](./menu-button), or several of any of them. A button in a toolbar is styled to be clear by default, but this can be changed using the [`fill`](./button#fill) property on the button. The properties included on back button and menu button in this example are for display purposes; refer to their respective documentation for proper usage. +The buttons component can wrap a standard [button](./button.mdx), [back button](./back-button.mdx), [menu button](./menu-button.mdx), or several of any of them. A button in a toolbar is styled to be clear by default, but this can be changed using the [`fill`](./button.mdx#fill) property on the button. The properties included on back button and menu button in this example are for display purposes; refer to their respective documentation for proper usage. import Buttons from '@site/static/usage/v8/toolbar/buttons/index.mdx'; @@ -45,7 +45,7 @@ import Buttons from '@site/static/usage/v8/toolbar/buttons/index.mdx'; ## Searchbars in Toolbars {/* #searchbars-in-toolbars */} -A [searchbar](./searchbar) can be placed inside of a toolbar to search through the content. It should be the only child component of the toolbar, and will take up the full width and height. +A [searchbar](./searchbar.mdx) can be placed inside of a toolbar to search through the content. It should be the only child component of the toolbar, and will take up the full width and height. import Searchbars from '@site/static/usage/v8/toolbar/searchbars/index.mdx'; @@ -53,7 +53,7 @@ import Searchbars from '@site/static/usage/v8/toolbar/searchbars/index.mdx'; ## Segments in Toolbars {/* #segments-in-toolbars */} -[Segments](./segment) are generally used in toolbars to toggle between two different content views on the same page. They can be placed in a toolbar with other components, such as buttons, but should not be placed alongside a title. +[Segments](./segment.mdx) are generally used in toolbars to toggle between two different content views on the same page. They can be placed in a toolbar with other components, such as buttons, but should not be placed alongside a title. import Segments from '@site/static/usage/v8/toolbar/segments/index.mdx'; @@ -61,7 +61,7 @@ import Segments from '@site/static/usage/v8/toolbar/segments/index.mdx'; ## Progress Bars in Toolbars {/* #progress-bars-in-toolbars */} -A [progress bar](./progress-bar) is used as a loading indicator to show an ongoing process in an app. Progress bars can be placed with any other components inside of a toolbar as they will align with the bottom of the toolbar. +A [progress bar](./progress-bar.mdx) is used as a loading indicator to show an ongoing process in an app. Progress bars can be placed with any other components inside of a toolbar as they will align with the bottom of the toolbar. import ProgressBars from '@site/static/usage/v8/toolbar/progress-bars/index.mdx'; diff --git a/versioned_docs/version-v8/cli.mdx b/versioned_docs/version-v8/cli.mdx index 08bf2b907c..9d16276a4f 100644 --- a/versioned_docs/version-v8/cli.mdx +++ b/versioned_docs/version-v8/cli.mdx @@ -11,7 +11,7 @@ sidebar_label: Overview /> -The Ionic command-line interface ([CLI](/reference/glossary.mdx#cli)) is the go-to tool for developing Ionic apps. +The Ionic command-line interface ([CLI](./reference/glossary.mdx#cli)) is the go-to tool for developing Ionic apps. ## Installation {/* #installation */} @@ -41,14 +41,14 @@ For some commands, such as `ionic serve`, the help documentation is contextual t ## Architecture {/* #architecture */} -The Ionic CLI is built with [TypeScript](/reference/glossary.mdx#typescript) and [Node.js](/reference/glossary.mdx#node). It supports Node 10.3+, but the latest Node LTS is always recommended. Follow development on the open source [GitHub repository](https://github.com/ionic-team/ionic-cli). +The Ionic CLI is built with [TypeScript](./reference/glossary.mdx#typescript) and [Node.js](./reference/glossary.mdx#node). It supports Node 10.3+, but the latest Node LTS is always recommended. Follow development on the open source [GitHub repository](https://github.com/ionic-team/ionic-cli). ## Troubleshooting {/* #troubleshooting */} To troubleshoot issues with the Ionic CLI, the following may be useful: - Make sure the latest version of the Ionic CLI is installed. Get the installed Ionic CLI version by running `ionic --version`. The Ionic CLI version is not related to the Ionic Framework version. -- Make sure the latest Node LTS is installed. Refer to [Node & npm](/intro/environment.mdx#node--npm) environment setup. +- Make sure the latest Node LTS is installed. Refer to [Node & npm](./intro/environment.mdx#node--npm) environment setup. - The `--verbose` flag prints debugging messages, which may narrow down the issue. -- Connection issues may be due to improperly configured proxy settings. Refer to [Using a Proxy](/cli/using-a-proxy.mdx) to configure request proxying. -- The global Ionic CLI configuration directory is `~/.ionic` on all platforms. It can safely be deleted and the Ionic CLI will repopulate it, but all configuration (including user sessions) will be lost. Configure this directory with [CLI environment variables](/cli/configuration.mdx#environment-variables). +- Connection issues may be due to improperly configured proxy settings. Refer to [Using a Proxy](./cli/using-a-proxy.mdx) to configure request proxying. +- The global Ionic CLI configuration directory is `~/.ionic` on all platforms. It can safely be deleted and the Ionic CLI will repopulate it, but all configuration (including user sessions) will be lost. Configure this directory with [CLI environment variables](./cli/configuration.mdx#environment-variables). diff --git a/versioned_docs/version-v8/cli/configuration.mdx b/versioned_docs/version-v8/cli/configuration.mdx index 4a5cc4fc14..eb3d7615f4 100644 --- a/versioned_docs/version-v8/cli/configuration.mdx +++ b/versioned_docs/version-v8/cli/configuration.mdx @@ -14,7 +14,7 @@ title: Configuration Configuration values are stored in JSON files. The Ionic CLI maintains a global configuration file, usually located at `~/.ionic/config.json`, and project configuration files, usually at the project's root directory as `ionic.config.json`. -The CLI provides commands for setting and printing config values from project config files and the global CLI config file. Run `ionic config --help` or refer to the documentation for usage of [`ionic config get`](/cli/commands/config-get.mdx) and [`ionic config set`](/cli/commands/config-set.mdx). +The CLI provides commands for setting and printing config values from project config files and the global CLI config file. Run `ionic config --help` or refer to the documentation for usage of [`ionic config get`](./commands/config-get.mdx) and [`ionic config set`](./commands/config-set.mdx). ### Project Configuration File {/* #project-configuration-file */} @@ -52,7 +52,7 @@ Each Ionic project has a project configuration file, usually at the project's ro The CLI will look for the following environment variables: - `IONIC_CONFIG_DIRECTORY`: The directory of the global CLI config. Defaults to `~/.ionic`. -- `IONIC_HTTP_PROXY`: Set a URL for proxying all CLI requests through. Refer to [Using a Proxy](using-a-proxy.mdx). +- `IONIC_HTTP_PROXY`: Set a URL for proxying all CLI requests through. Refer to [Using a Proxy](./using-a-proxy.mdx). - `IONIC_TOKEN`: Automatically authenticates with [Appflow](https://ionic.io/appflow). ## Flags {/* #flags */} diff --git a/versioned_docs/version-v8/cli/livereload.mdx b/versioned_docs/version-v8/cli/livereload.mdx index 62dca1c3d3..aa12e4e7dc 100644 --- a/versioned_docs/version-v8/cli/livereload.mdx +++ b/versioned_docs/version-v8/cli/livereload.mdx @@ -59,7 +59,7 @@ Remember, with the `--external` option, others on your Wi-Fi network will be abl ## Tips {/* #tips */} -- With Cordova, use the `--device`, `--emulator`, and `--target` options to narrow down target devices. Use the `--list` option to list all targets. See usage in the [command docs](/cli/commands/cordova-run.mdx). +- With Cordova, use the `--device`, `--emulator`, and `--target` options to narrow down target devices. Use the `--list` option to list all targets. See usage in the [command docs](./commands/cordova-run.mdx). - You can separate the dev server process and the deploy process by using `ionic serve` and the `--livereload-url` option of `ionic cordova run` or `ionic capacitor run`. - For Android, it is possible to configure [adb](https://developer.android.com/studio/command-line/adb) to always forward ports while the adb server is running (refer to `adb reverse`). With port forwarding set up, an external address would no longer be required. You can also setup the adb bridge over TCP such that subsequent deploys no longer need a USB cable. - If you are using a development container with Angular, live reload may not work. To fix it, set `projects.app.architect.serve.configurations.development.poll` to `1` in `angular.json`. diff --git a/versioned_docs/version-v8/components.mdx b/versioned_docs/version-v8/components.mdx index 371f3a42f1..5b5f1e8c88 100644 --- a/versioned_docs/version-v8/components.mdx +++ b/versioned_docs/version-v8/components.mdx @@ -19,156 +19,156 @@ import DocsCards from '@components/global/DocsCards'; `} -Ionic apps are made of high-level building blocks called Components, which allow you to quickly construct the UI for your app. Ionic comes stock with a number of components, including cards, lists, and tabs. Once you're familiar with the basics, refer to the [API Index](api.mdx) for a complete list of each component and sub-component. +Ionic apps are made of high-level building blocks called Components, which allow you to quickly construct the UI for your app. Ionic comes stock with a number of components, including cards, lists, and tabs. Once you're familiar with the basics, refer to the [API Index](./api.mdx) for a complete list of each component and sub-component. - +

Accordions provide collapsible sections in your content to reduce vertical space while providing a way of organizing and grouping information.

- +

Action Sheets display a set of options with the ability to confirm or cancel an action.

- +

Alerts are a great way to offer the user the ability to choose a specific action or list of actions.

- +

Badges are a small component that typically communicate a numerical value to the user.

- +

Breadcrumbs are navigation items that are used to indicate where a user is on an app.

- +

Buttons let your users take action. They're an essential way to interact with and navigate through an app.

- + Cards are a great way to display an important piece of content, and can contain images, buttons, text, and more. - +

Checkboxes can be used to let the user know they need to make a binary decision.

- +

Chips are a compact way to display data or actions.

- +

Content is the quintessential way to interact with and navigate through an app.

- +

Date & time pickers are used to present an interface that makes it easy for users to select dates and times.

- +

Floating action buttons are circular buttons that perform a primary action on a screen.

- +

The grid is a powerful mobile-first system for building custom layouts.

- +

Beautifully designed icons for use in web, iOS, and Android apps.

- +

Infinite scroll allows you to load new data as the user scrolls through your app.

- +

Inputs provides a way for users to enter data in your app.

- + Items are elements that can contain text, icons, avatars, images, inputs, and any other native or custom elements. Items can be swiped, deleted, reordered, edited, and more. - +

Lists can display rows of information, such as a contact list, playlist, or menu.

- + A collection of media components, including avatars, icons, images, and thumbnails, designed to enhance visual content. - +

Menus are a common navigation pattern. They can be permanently on-screen, or revealed when needed.

- +

Modals slide in and off screen to display a temporary UI and are often used for login or sign-up pages.

- +

Navigation is how users move between different pages in your app.

- +

Popover provides an easy way to present information or options without changing contexts.

- +

Progress indicators visualize the progression of an operation or activity.

- +

Radio inputs allow you to present a set of exclusive options.

- +

Range sliders let users select a value by dragging a knob along a track.

- +

Refresher provides pull-to-refresh functionality on a content component.

- +

Reorder lets users drag and drop to reorder a list of items.

- +

Routing allows navigation based on the current path.

- +

Searchbar is used to search or filter items, usually from a toolbar.

- +

Segments provide a set of exclusive buttons that can be used as a filter or view switcher.

- +

Select is similar to the native HTML select, with a few improvements to sorting and selecting.

- +

Tabs enable tabbed navigation, a standard navigation pattern in modern apps.

- +

Toasts are subtle notifications that appear over your app's content without interrupting user interaction.

- +

Toggles are an input for binary options, often used for options and switches.

- +

Toolbars are used to house information and actions relating to your app.

- +

Text is used to style or change the color of text within an application.

diff --git a/versioned_docs/version-v8/contributing/how-to-contribute.mdx b/versioned_docs/version-v8/contributing/how-to-contribute.mdx index 176376b5b5..03460d89b9 100644 --- a/versioned_docs/version-v8/contributing/how-to-contribute.mdx +++ b/versioned_docs/version-v8/contributing/how-to-contribute.mdx @@ -8,7 +8,7 @@ Thanks for the interest in contributing to Ionic Framework! ## Contributing Etiquette {/* #contributing-etiquette */} -Please refer to the [Contributor Code of Conduct](coc.mdx) for information on the rules of conduct. +Please refer to the [Contributor Code of Conduct](./coc.mdx) for information on the rules of conduct. ## Creating an Issue {/* #creating-an-issue */} diff --git a/versioned_docs/version-v8/core-concepts/fundamentals.mdx b/versioned_docs/version-v8/core-concepts/fundamentals.mdx index 0f8768763e..6c011e1a7c 100644 --- a/versioned_docs/version-v8/core-concepts/fundamentals.mdx +++ b/versioned_docs/version-v8/core-concepts/fundamentals.mdx @@ -37,7 +37,7 @@ For apps that are built with Angular and `@ionic/angular`, we recommend using th An amazing feature of apps built with web technologies (such as Ionic apps!) is that it can run on virtually any platform: desktop computers, phones, tablets, cars, refrigerators, and more! The same code base for Ionic apps can work on many platforms because it is based on web standards and common APIs that are shared across these platforms. That said, Ionic Framework is designed and tested for mobile platforms. Refer to [Browser Support](../reference/browser-support.mdx#mobile-platforms) for the platforms it officially supports. -One of the most common use cases for Ionic is to build an app which can be downloaded from both the [App Store](https://www.apple.com/ios/app-store/) and [Play Store](https://play.google.com/). Both iOS and Android software development kits (SDKs) provide [Web Views](webview.mdx) which render any Ionic app, while still allowing for _full_ Native SDK access. +One of the most common use cases for Ionic is to build an app which can be downloaded from both the [App Store](https://www.apple.com/ios/app-store/) and [Play Store](https://play.google.com/). Both iOS and Android software development kits (SDKs) provide [Web Views](./webview.mdx) which render any Ionic app, while still allowing for _full_ Native SDK access. Projects such as [Capacitor](https://capacitorjs.com/) and [Cordova](https://cordova.apache.org/) are commonly used to give Ionic apps this access to Native SDKs. This means developers can quickly build out an app using common web development tools, and still have access to native features such as the device's accelerometer, camera, GPS, and more. @@ -53,7 +53,7 @@ Developers can use standard events such as `click` as they normally would. Howev ## Properties {/* #properties */} -Properties are JavaScript properties that can be set on Ionic components to configure their behavior and appearance. Properties are defined in each component's [API documentation](/api.mdx) page. +Properties are JavaScript properties that can be set on Ionic components to configure their behavior and appearance. Properties are defined in each component's [API documentation](../api.mdx) page. ### Reactive Properties {/* #reactive-properties */} @@ -75,4 +75,4 @@ Virtual properties are designed for one-time configuration during component init The `mode` property is a virtual property that determines which platform styles to use for a component. It can be set at the component level or globally through the app configuration. In both cases, it's set once during initialization and doesn't change during the component's lifecycle. -For more information on Ionic modes, read the [Platform Styles documentation](/theming/platform-styles.mdx). +For more information on Ionic modes, read the [Platform Styles documentation](../theming/platform-styles.mdx). diff --git a/versioned_docs/version-v8/deployment/progressive-web-app.mdx b/versioned_docs/version-v8/deployment/progressive-web-app.mdx index b1682f5c56..15ad25af87 100644 --- a/versioned_docs/version-v8/deployment/progressive-web-app.mdx +++ b/versioned_docs/version-v8/deployment/progressive-web-app.mdx @@ -19,13 +19,13 @@ Because Ionic Apps are built with web technologies, they can run just as well as For the frameworks Ionic supports, we've created dedicated guides that go into more detail. Below are links for Angular, React, and Vue. - + Get started with progressive web apps in Angular. - + Get started with progressive web apps in React. - + Get started with progressive web apps in Vue. diff --git a/versioned_docs/version-v8/developing/config.mdx b/versioned_docs/version-v8/developing/config.mdx index 1b6ef0ed8d..eca4f3f5a3 100644 --- a/versioned_docs/version-v8/developing/config.mdx +++ b/versioned_docs/version-v8/developing/config.mdx @@ -195,7 +195,7 @@ Below are the config options that Ionic uses. | `navAnimation` | `AnimationBuilder` | Overrides the default "animation" of all `ion-nav` and `ion-router-outlet` across the whole application. | | `pickerEnter` | `AnimationBuilder` | Provides a custom enter animation for all `ion-picker`, overriding the default "animation". | | `pickerLeave` | `AnimationBuilder` | Provides a custom leave animation for all `ion-picker`, overriding the default "animation". | -| `platform` | [`PlatformConfig`](/angular/platform.mdx#customizing-platform-detection-functions) | Overrides the default platform detection methods. | +| `platform` | [`PlatformConfig`](../angular/platform.mdx#customizing-platform-detection-functions) | Overrides the default platform detection methods. | | `popoverEnter` | `AnimationBuilder` | Provides a custom enter animation for all `ion-popover`, overriding the default "animation". | | `popoverLeave` | `AnimationBuilder` | Provides a custom leave animation for all `ion-popover`, overriding the default "animation". | | `refreshingIcon` | `string` | Overrides the default icon in all `` components. | @@ -211,4 +211,4 @@ Below are the config options that Ionic uses. | `toastLeave` | `AnimationBuilder` | Provides a custom leave animation for all `ion-toast`, overriding the default "animation". | | `toggleOnOffLabels` | `boolean` | Overrides the default `enableOnOffLabels` in all `ion-toggle` components. | | `experimentalCloseWatcher` | `boolean` | **Experimental:** If `true`, the [CloseWatcher API](https://github.com/WICG/close-watcher) will be used to handle all Escape key and hardware back button presses to dismiss menus and overlays and to navigate. Note that the `hardwareBackButton` config option must also be `true`. | -| `focusManagerPriority` | [`FocusManagerPriority[]`](./managing-focus#types) | **Experimental:** When defined, Ionic will move focus to the appropriate element after each page transition. This ensures that users relying on assistive technology are informed when a page transition happens. Disabled by default. | +| `focusManagerPriority` | [`FocusManagerPriority[]`](./managing-focus.mdx#types) | **Experimental:** When defined, Ionic will move focus to the appropriate element after each page transition. This ensures that users relying on assistive technology are informed when a page transition happens. Disabled by default. | diff --git a/versioned_docs/version-v8/developing/config/per-platform/index.mdx b/versioned_docs/version-v8/developing/config/per-platform/index.mdx index feb1d4429b..6571c280eb 100644 --- a/versioned_docs/version-v8/developing/config/per-platform/index.mdx +++ b/versioned_docs/version-v8/developing/config/per-platform/index.mdx @@ -17,7 +17,7 @@ import TabItem from '@theme/TabItem'; Since the config is set at runtime, you will not have access to the Platform Dependency Injection. Instead, you can use the underlying functions that the provider uses directly. -Refer to the [Angular Platform Documentation](/angular/platform.mdx) for the types of platforms you can detect. +Refer to the [Angular Platform Documentation](../../../angular/platform.mdx) for the types of platforms you can detect. ::: @@ -42,7 +42,7 @@ import { isPlatform, IonicModule } from '@ionic/angular'; Since the config is set at runtime, you will not have access to the Platform Dependency Injection. Instead, you can use the underlying functions that the provider uses directly. -Refer to the [Angular Platform Documentation](/angular/platform.mdx) for the types of platforms you can detect. +Refer to the [Angular Platform Documentation](../../../angular/platform.mdx) for the types of platforms you can detect. ::: @@ -64,7 +64,7 @@ bootstrapApplication(AppComponent, { :::note -Refer to the [React Platform Documentation](/react/platform.mdx) for the types of platforms you can detect. +Refer to the [React Platform Documentation](../../../react/platform.mdx) for the types of platforms you can detect. ::: @@ -81,7 +81,7 @@ setupIonicReact({ :::note -Refer to the [Vue Platform Documentation](/vue/platform.mdx) for the types of platforms you can detect. +Refer to the [Vue Platform Documentation](../../../vue/platform.mdx) for the types of platforms you can detect. ::: diff --git a/versioned_docs/version-v8/developing/managing-focus.mdx b/versioned_docs/version-v8/developing/managing-focus.mdx index 6250d99b6c..555e22c7ac 100644 --- a/versioned_docs/version-v8/developing/managing-focus.mdx +++ b/versioned_docs/version-v8/developing/managing-focus.mdx @@ -15,7 +15,7 @@ import TabItem from '@theme/TabItem'; ## Manual Focus Management {/* #manual-focus-management */} -Ionic provides a `setFocus` API on components such as [Input](../api/input), [Searchbar](../api/searchbar), and [Textarea](../api/textarea) that allows developers to manually set focus to an element. This API should be used in place of the `autofocus` attribute and called within: +Ionic provides a `setFocus` API on components such as [Input](../api/input.mdx), [Searchbar](../api/searchbar.mdx), and [Textarea](../api/textarea.mdx) that allows developers to manually set focus to an element. This API should be used in place of the `autofocus` attribute and called within: - The `ionViewDidEnter` lifecycle event for routing applications when a page is entered. - The `didPresent` lifecycle event for overlays when an overlay is presented. @@ -243,7 +243,7 @@ export default Home; By default, Single Page Applications have no built-in way of informing screen readers that the active view has changed in a browser or webview. This means that users who rely on assistive technology do not always know if a navigation event occurred. -Developers who enable the [focusManagerPriority config](./config#ionicconfig) can delegate focus management to Ionic during page transitions. When enabled, Ionic will move focus to the correct element as specified in the config option. This will inform screen readers that a navigation event occurred. +Developers who enable the [focusManagerPriority config](./config.mdx#ionicconfig) can delegate focus management to Ionic during page transitions. When enabled, Ionic will move focus to the correct element as specified in the config option. This will inform screen readers that a navigation event occurred. ### Types {/* #types */} @@ -257,13 +257,13 @@ The following table explains what each content type represents: | Type | Description | Ionic Component | Semantic HTML Equivalent | Landmark Equivalent | | --- | --- | --- | --- | --- | -| `content` | The main portion of the view. | [Content](../api/content) | [`main`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/main) | [`role="main"`](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/Main_role) | -| `heading` | The title of the view. | [Title](../api/title) | [`h1`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/h1) | [`role="heading"`](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/heading_role) with [`aria-level="1"`](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-level) | -| `banner` | The header of the view. | [Header](../api/header) | [`header`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/header) | [`role="banner"`](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/Banner_Role) | +| `content` | The main portion of the view. | [Content](../api/content.mdx) | [`main`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/main) | [`role="main"`](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/Main_role) | +| `heading` | The title of the view. | [Title](../api/title.mdx) | [`h1`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/h1) | [`role="heading"`](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/heading_role) with [`aria-level="1"`](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-level) | +| `banner` | The header of the view. | [Header](../api/header.mdx) | [`header`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/header) | [`role="banner"`](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/Banner_Role) | :::important -Developers should assign `role="heading"` and `aria-level="1"` to the primary [Title](../api/title) on each view. Since multiple [Title](../api/title) components can be used in a single view, Ionic does not automatically assign these attributes. +Developers should assign `role="heading"` and `aria-level="1"` to the primary [Title](../api/title.mdx) on each view. Since multiple [Title](../api/title.mdx) components can be used in a single view, Ionic does not automatically assign these attributes. ::: diff --git a/versioned_docs/version-v8/developing/previewing.mdx b/versioned_docs/version-v8/developing/previewing.mdx index f78b65d12d..4e5e808e16 100644 --- a/versioned_docs/version-v8/developing/previewing.mdx +++ b/versioned_docs/version-v8/developing/previewing.mdx @@ -13,8 +13,8 @@ title: Previewing There are many different options to test native functionality depending on your target platforms and needs. - Run locally in a web browser (using [Platform Detection](../core-concepts/cross-platform.mdx) for native functionality) -- [Deploy to iOS](ios.mdx) -- [Deploy to Android](android.mdx) +- [Deploy to iOS](./ios.mdx) +- [Deploy to Android](./android.mdx) ## Run Locally in a Web Browser {/* #run-locally-in-a-web-browser */} @@ -44,7 +44,7 @@ If the external link isn't listed on the terminal, then run `ionic serve --exter ::: -When implementing native functionality, use [Platform Detection](../core-concepts/cross-platform.mdx). When you're ready to test on a real device, refer to the guides for [iOS](ios.mdx) and [Android](android.mdx). +When implementing native functionality, use [Platform Detection](../core-concepts/cross-platform.mdx). When you're ready to test on a real device, refer to the guides for [iOS](./ios.mdx) and [Android](./android.mdx). ## Simulating a Mobile Viewport {/* #simulating-a-mobile-viewport */} diff --git a/versioned_docs/version-v8/developing/scaffolding.mdx b/versioned_docs/version-v8/developing/scaffolding.mdx index 4dea0b5883..356c11e534 100644 --- a/versioned_docs/version-v8/developing/scaffolding.mdx +++ b/versioned_docs/version-v8/developing/scaffolding.mdx @@ -50,7 +50,7 @@ This command is only supported in Ionic Angular. ::: -The Ionic CLI can generate new app features with the [`ionic generate`](/cli/commands/generate.mdx) command. By running `ionic generate` in the command line, a selection prompt is displayed which lists the available features that can be generated. +The Ionic CLI can generate new app features with the [`ionic generate`](../cli/commands/generate.mdx) command. By running `ionic generate` in the command line, a selection prompt is displayed which lists the available features that can be generated. ```shell-session $ ionic generate @@ -96,4 +96,4 @@ The Ionic CLI uses the underlying framework tooling to stay close to best practi After creating the files and directories for the new page, the CLI will also update the router configuration to include the new page. This reduces the amount of manual work needed to keep the development lifecycle moving. -For more details, run `ionic g --help` from the command line or refer to the [`ionic generate` documentation](/cli/commands/generate.mdx). +For more details, run `ionic g --help` from the command line or refer to the [`ionic generate` documentation](../cli/commands/generate.mdx). diff --git a/versioned_docs/version-v8/index.mdx b/versioned_docs/version-v8/index.mdx index 63c436e408..b0a1bc8466 100644 --- a/versioned_docs/version-v8/index.mdx +++ b/versioned_docs/version-v8/index.mdx @@ -22,9 +22,9 @@ import DocsCards from '@components/global/DocsCards'; -Ionic is an open source UI toolkit for building performant, high-quality mobile apps using web technologies — HTML, CSS, and JavaScript — with integrations for popular frameworks like [Angular](angular/overview.mdx), [React](react/overview.mdx), and [Vue](vue/overview.mdx). +Ionic is an open source UI toolkit for building performant, high-quality mobile apps using web technologies — HTML, CSS, and JavaScript — with integrations for popular frameworks like [Angular](./angular/overview.mdx), [React](./react/overview.mdx), and [Vue](./vue/overview.mdx). -Get started building by [installing Ionic](intro/cli.mdx) or following our [First App Tutorial](intro/next.mdx#build-your-first-app) to learn the main concepts. +Get started building by [installing Ionic](./intro/cli.mdx) or following our [First App Tutorial](./intro/next.mdx#build-your-first-app) to learn the main concepts. @@ -56,11 +56,11 @@ Get started building by [installing Ionic](intro/cli.mdx) or following our [Firs ## Overview {/* #overview */} -Ionic focuses on the frontend UX and UI interaction of an app — UI controls, interactions, gestures, animations. It's easy to learn, and integrates with other libraries or frameworks, such as [Angular](angular/overview.mdx), [React](react/overview.mdx), or [Vue](vue/overview.mdx). Alternatively, it can be used standalone without any frontend framework using a simple [script include](intro/cdn.mdx). If you’d like to learn more about Ionic before diving in, we [created a video](https://youtu.be/p3AN3igqiRc) to walk you through the basics. +Ionic focuses on the frontend UX and UI interaction of an app — UI controls, interactions, gestures, animations. It's easy to learn, and integrates with other libraries or frameworks, such as [Angular](./angular/overview.mdx), [React](./react/overview.mdx), or [Vue](./vue/overview.mdx). Alternatively, it can be used standalone without any frontend framework using a simple [script include](./intro/cdn.mdx). If you’d like to learn more about Ionic before diving in, we [created a video](https://youtu.be/p3AN3igqiRc) to walk you through the basics. ### One codebase, running everywhere {/* #one-codebase-running-everywhere */} -Ionic is the only mobile app stack that enables web developers to build apps for all major app stores and the mobile web from a single codebase. And with [Adaptive Styling](theming/platform-styles.mdx), Ionic apps look and feel at home on every device. +Ionic is the only mobile app stack that enables web developers to build apps for all major app stores and the mobile web from a single codebase. And with [Adaptive Styling](./theming/platform-styles.mdx), Ionic apps look and feel at home on every device. ### A focus on performance {/* #a-focus-on-performance */} @@ -82,7 +82,7 @@ Build and deploy apps that work across multiple platforms, such as native iOS, A ### Web Standards-based {/* #web-standards-based */} -Ionic is built on top of reliable, [standardized web technologies](reference/glossary.mdx#web-standards): HTML, CSS, and JavaScript, using modern Web APIs such as Custom Elements and Shadow DOM. Because of this, Ionic components have a stable API, and aren't at the whim of a single platform vendor. +Ionic is built on top of reliable, [standardized web technologies](./reference/glossary.mdx#web-standards): HTML, CSS, and JavaScript, using modern Web APIs such as Custom Elements and Shadow DOM. Because of this, Ionic components have a stable API, and aren't at the whim of a single platform vendor. ### Beautiful Design {/* #beautiful-design */} @@ -118,7 +118,7 @@ Support for other frameworks will be considered in future releases. ## Ionic CLI {/* #ionic-cli */} -The official [Ionic CLI](cli.mdx), or Command Line Interface, is a tool that quickly scaffolds Ionic apps and provides a number of helpful commands to Ionic developers. In addition to installing and updating Ionic, the CLI comes with a built-in development server, build and debugging tools, and much more. If you are an [Appflow](#appflow) member, the CLI can be used to perform cloud builds and deployments, and administer your account. +The official [Ionic CLI](./cli.mdx), or Command Line Interface, is a tool that quickly scaffolds Ionic apps and provides a number of helpful commands to Ionic developers. In addition to installing and updating Ionic, the CLI comes with a built-in development server, build and debugging tools, and much more. If you are an [Appflow](#appflow) member, the CLI can be used to perform cloud builds and deployments, and administer your account. ## Appflow {/* #appflow */} diff --git a/versioned_docs/version-v8/intro/cdn.mdx b/versioned_docs/version-v8/intro/cdn.mdx index 380f5bbbea..c20d2a1f7c 100644 --- a/versioned_docs/version-v8/intro/cdn.mdx +++ b/versioned_docs/version-v8/intro/cdn.mdx @@ -24,7 +24,7 @@ Start a new Ionic Angular app or add Ionic to your existing Angular project.

Create a new Ionic Angular app using the Ionic CLI.

@@ -32,7 +32,7 @@ Start a new Ionic Angular app or add Ionic to your existing Angular project.

Add Ionic Angular to an existing Angular project.

@@ -48,7 +48,7 @@ Start a new Ionic React app or add Ionic to your existing React project.

Create a new Ionic React app using the Ionic CLI.

@@ -56,7 +56,7 @@ Start a new Ionic React app or add Ionic to your existing React project.

Add Ionic React to an existing React project.

@@ -72,7 +72,7 @@ Start a new Ionic Vue app or add Ionic to your existing Vue project.

Create a new Ionic Vue app using the Ionic CLI.

@@ -80,7 +80,7 @@ Start a new Ionic Vue app or add Ionic to your existing Vue project.

Add Ionic Vue to an existing Vue project.

@@ -96,7 +96,7 @@ Start a new Ionic JavaScript app.

Create a new Ionic JavaScript app using Vite.

@@ -116,7 +116,7 @@ It's recommended to use [jsdelivr](https://www.jsdelivr.com/) to access the Fram ``` -With this it's possible to use all of the Ionic Framework core components without having to install a framework. The CSS bundle will include all of the Ionic [Global Stylesheets](/layout/global-stylesheets.mdx). +With this it's possible to use all of the Ionic Framework core components without having to install a framework. The CSS bundle will include all of the Ionic [Global Stylesheets](../layout/global-stylesheets.mdx). ## Ionicons CDN {/* #ionicons-cdn */} diff --git a/versioned_docs/version-v8/intro/cli.mdx b/versioned_docs/version-v8/intro/cli.mdx index 2aefc3f61a..20e1ec0f76 100644 --- a/versioned_docs/version-v8/intro/cli.mdx +++ b/versioned_docs/version-v8/intro/cli.mdx @@ -19,7 +19,7 @@ Ionic apps are created and developed primarily through the Ionic [command-line]( ## Install the Ionic CLI {/* #install-the-ionic-cli */} -Before proceeding, make sure your computer has [Node.js](../reference/glossary.mdx#node) installed. Refer to the [environment setup guide](environment.mdx) to prepare your machine. +Before proceeding, make sure your computer has [Node.js](../reference/glossary.mdx#node) installed. Refer to the [environment setup guide](./environment.mdx) to prepare your machine. Install the Ionic CLI with npm: diff --git a/versioned_docs/version-v8/intro/next.mdx b/versioned_docs/version-v8/intro/next.mdx index 29e50579ed..2735e9f0d8 100644 --- a/versioned_docs/version-v8/intro/next.mdx +++ b/versioned_docs/version-v8/intro/next.mdx @@ -20,15 +20,15 @@ import DeveloperExperts from '@components/page/intro/next/DeveloperExperts'; Pick the JavaScript framework you plan to use while building your Ionic app: - +

A complete guide to get you up to speed with the basics of building Ionic apps with Angular.

- +

A complete guide to get you up to speed with the basics of building Ionic apps with React.

- +

A complete guide to get you up to speed with the basics of building Ionic apps with Vue.

diff --git a/versioned_docs/version-v8/javascript/overview.mdx b/versioned_docs/version-v8/javascript/overview.mdx index b651a85cec..e77dbc1913 100644 --- a/versioned_docs/version-v8/javascript/overview.mdx +++ b/versioned_docs/version-v8/javascript/overview.mdx @@ -44,7 +44,7 @@ $ npm run dev █ - +

Quickly set up your first Ionic JavaScript app and learn the basics of the framework and CLI.

diff --git a/versioned_docs/version-v8/javascript/quickstart.mdx b/versioned_docs/version-v8/javascript/quickstart.mdx index 0f0201fd00..53bc25807f 100644 --- a/versioned_docs/version-v8/javascript/quickstart.mdx +++ b/versioned_docs/version-v8/javascript/quickstart.mdx @@ -16,7 +16,7 @@ import DocsCards from '@components/global/DocsCards'; Welcome! This guide will walk you through the basics of Ionic JavaScript development using Vite. You'll learn how to set up your development environment, create a simple project, explore the project structure, and understand how Ionic components work. This is perfect for getting familiar with Ionic JavaScript before building your first real app. -If you're looking for a high-level overview of what Ionic JavaScript is and how it fits into the web development ecosystem, refer to the [Ionic JavaScript Overview](overview). +If you're looking for a high-level overview of what Ionic JavaScript is and how it fits into the web development ecosystem, refer to the [Ionic JavaScript Overview](./overview.mdx). ## Prerequisites {/* #prerequisites */} @@ -231,7 +231,7 @@ This creates a custom element called `home-page` that contains the layout for yo :::tip[Learn More] -For detailed information about Ionic layout components, refer to the [Header](/api/header.mdx), [Toolbar](/api/toolbar.mdx), [Title](/api/title.mdx), and [Content](/api/content.mdx) documentation. +For detailed information about Ionic layout components, refer to the [Header](../api/header.mdx), [Toolbar](../api/toolbar.mdx), [Title](../api/title.mdx), and [Content](../api/content.mdx) documentation. ::: @@ -251,7 +251,7 @@ At this point your browser should be displaying the Home page. ## Add an Ionic Component {/* #add-an-ionic-component */} -You can enhance your Home page with more Ionic UI components. For example, add a [Button](/api/button.mdx) to navigate to another page. Update the `HomePage` component in `HomePage.js`: +You can enhance your Home page with more Ionic UI components. For example, add a [Button](../api/button.mdx) to navigate to another page. Update the `HomePage` component in `HomePage.js`: ```js title="src/pages/HomePage.js" class HomePage extends HTMLElement { @@ -306,7 +306,7 @@ class NewPage extends HTMLElement { customElements.define('new-page', NewPage); ``` -This creates a page with a [Back Button](/api/back-button.mdx) in the [Toolbar](/api/toolbar.mdx). The back button will automatically handle navigation back to the previous page, or to `/` if there is no history. +This creates a page with a [Back Button](../api/back-button.mdx) in the [Toolbar](../api/toolbar.mdx). The back button will automatically handle navigation back to the previous page, or to `/` if there is no history. Next, update the ` ``` -Visit the [components](/components.mdx) page for all of the available Ionic components. +Visit the [components](../components.mdx) page for all of the available Ionic components. ## Using Ionic Pages {/* #using-ionic-pages */} @@ -110,7 +110,7 @@ import '@ionic/vue/css/flex-utils.css'; import '@ionic/vue/css/display.css'; ``` -These stylesheets set up the overall page structure and provide [CSS utilities](/layout/css-utilities.mdx) for faster development. Some stylesheets are optional. For details on which stylesheets are required, check out [Global Stylesheets](/layout/global-stylesheets.mdx). +These stylesheets set up the overall page structure and provide [CSS utilities](../layout/css-utilities.mdx) for faster development. Some stylesheets are optional. For details on which stylesheets are required, check out [Global Stylesheets](../layout/global-stylesheets.mdx). #### 2. Set up Theming {/* #2-set-up-theming */} @@ -162,7 +162,7 @@ import './theme/variables.css'; createApp(App).use(IonicVue).mount('#app'); ``` -The `variables.css` file can be used to create custom Ionic Framework themes. The `dark.system.css` import enables [dark mode support](/theming/dark-mode.mdx) for your Ionic app when the system is set to prefer a dark appearance. You can customize the theming behavior by uncommenting different dark palette imports or adding custom CSS variables to `theme/variables.css`. +The `variables.css` file can be used to create custom Ionic Framework themes. The `dark.system.css` import enables [dark mode support](../theming/dark-mode.mdx) for your Ionic app when the system is set to prefer a dark appearance. You can customize the theming behavior by uncommenting different dark palette imports or adding custom CSS variables to `theme/variables.css`. #### 3. Update the App Component {/* #3-update-the-app-component */} @@ -330,7 +330,7 @@ Now that you have Ionic Vue integrated into your project, check out: - +

Discover how to handle routing and navigation in Ionic Vue apps using the Vue Router.

diff --git a/versioned_docs/version-v8/vue/lifecycle.mdx b/versioned_docs/version-v8/vue/lifecycle.mdx index 1b84568b3e..07ba4cf670 100644 --- a/versioned_docs/version-v8/vue/lifecycle.mdx +++ b/versioned_docs/version-v8/vue/lifecycle.mdx @@ -95,6 +95,6 @@ All the lifecycle methods in Vue (`mounted`, `beforeUnmount`, etc..) are availab Below are some tips on use cases for each of the life cycle events. - `ionViewWillEnter` - Since `ionViewWillEnter` is called every time the view is navigated to (regardless if initialized or not), it is a good method to load data from services. -- `ionViewDidEnter` - If you encounter performance problems from using `ionViewWillEnter` when loading data, you can do your data calls in `ionViewDidEnter` instead. However, this event will not fire until after the page is visible to the user, so you might want to use either a loading indicator or a skeleton screen such as [ion-skeleton-text](../api/skeleton-text), so content does not flash in un-naturally after the transition is complete. +- `ionViewDidEnter` - If you encounter performance problems from using `ionViewWillEnter` when loading data, you can do your data calls in `ionViewDidEnter` instead. However, this event will not fire until after the page is visible to the user, so you might want to use either a loading indicator or a skeleton screen such as [ion-skeleton-text](../api/skeleton-text.mdx), so content does not flash in un-naturally after the transition is complete. - `ionViewWillLeave` - Can be used for cleanup, like unsubscribing from data sources. Since `beforeUnmount` might not fire when you navigate from the current page, put your cleanup code here if you do not want it active while the screen is not in view. - `ionViewDidLeave` - When this event fires, you know the new page has fully transitioned in, so any logic you might not normally do when the view is visible can go here. diff --git a/versioned_docs/version-v8/vue/navigation.mdx b/versioned_docs/version-v8/vue/navigation.mdx index 84e8981f75..56a13f7fe3 100644 --- a/versioned_docs/version-v8/vue/navigation.mdx +++ b/versioned_docs/version-v8/vue/navigation.mdx @@ -128,7 +128,7 @@ The `router-link` attribute can be set on any Ionic Vue component, and the route The `router-direction` attribute accepts values of `"forward"`, `"back"`, or `"root"` and is used to control the direction of the page transition. -The `router-animation` attribute accepts an `AnimationBuilder` function and is used to provide a custom page transition that is only used when clicking the component it is provided on. The `AnimationBuilder` type is a function that returns an Ionic Animation instance. Refer to the [Animations documentation](../utilities/animations) for more information on using animations in Ionic Vue. +The `router-animation` attribute accepts an `AnimationBuilder` function and is used to provide a custom page transition that is only used when clicking the component it is provided on. The `AnimationBuilder` type is a function that returns an Ionic Animation instance. Refer to the [Animations documentation](../utilities/animations.mdx) for more information on using animations in Ionic Vue. ```html Click Me @@ -168,7 +168,7 @@ The example above has the app navigate to `/page2` with a custom animation that ::: -Refer to the [useIonRouter documentation](./utility-functions#router) for more details as well as type information. +Refer to the [useIonRouter documentation](./utility-functions.mdx#router) for more details as well as type information. ### Navigating using `router.go` {/* #navigating-using-routergo */} @@ -521,11 +521,11 @@ Components presented via `IonModal` or `IonPopover` do not typically need an `Io ### useIonRouter {/* #useionrouter */} -▸ **useIonRouter**(): [`UseIonRouterResult`](utility-functions#useionrouterresult) +▸ **useIonRouter**(): [`UseIonRouterResult`](./utility-functions.mdx#useionrouterresult) Returns the Ionic router instance, containing API methods for navigating, customizing page transitions and routing context for native features. This function can be used in combination with the [`useRouter`](https://router.vuejs.org/api/index.html#userouter) function from Vue. -For example usages, please refer to our [Utility Functions](utility-functions#useionrouter). +For example usages, please refer to our [Utility Functions](./utility-functions.mdx#useionrouter). ## URL Parameters {/* #url-parameters */} diff --git a/versioned_docs/version-v8/vue/overview.mdx b/versioned_docs/version-v8/vue/overview.mdx index 4d46eaccb0..b3f0dd7afe 100644 --- a/versioned_docs/version-v8/vue/overview.mdx +++ b/versioned_docs/version-v8/vue/overview.mdx @@ -18,7 +18,7 @@ import DocsCards from '@components/global/DocsCards'; ## Vue Version Support {/* #vue-version-support */} -Ionic Vue v8 supports Vue 3.x. For detailed information on supported versions and our support policy, refer to the [Ionic Vue Support Policy](/reference/support.mdx#ionic-vue). +Ionic Vue v8 supports Vue 3.x. For detailed information on supported versions and our support policy, refer to the [Ionic Vue Support Policy](../reference/support.mdx#ionic-vue). ## Vue Tooling {/* #vue-tooling */} @@ -44,7 +44,7 @@ $ ionic serve █ - +

Quickly set up your first Ionic Vue app and learn the basics of the framework and CLI.

@@ -52,7 +52,7 @@ $ ionic serve █

Learn more about Vue's core concepts, tools, and best practices from the official Vue documentation.

- +

Discover how to handle routing and navigation in Ionic Vue apps using the Vue Router.

diff --git a/versioned_docs/version-v8/vue/platform.mdx b/versioned_docs/version-v8/vue/platform.mdx index 19ea415d5b..796e105837 100644 --- a/versioned_docs/version-v8/vue/platform.mdx +++ b/versioned_docs/version-v8/vue/platform.mdx @@ -53,7 +53,7 @@ Below is a table listing all the possible platform values along with correspondi ## Customizing Platform Detection Functions {/* #customizing-platform-detection-functions */} -The function used to detect a specific platform can be overridden by providing an alternative function in the global [Ionic config](../developing/config). Each function takes `window` as a parameter and returns a boolean. +The function used to detect a specific platform can be overridden by providing an alternative function in the global [Ionic config](../developing/config.mdx). Each function takes `window` as a parameter and returns a boolean. ```tsx createApp(App).use(IonicVue, { diff --git a/versioned_docs/version-v8/vue/quickstart.mdx b/versioned_docs/version-v8/vue/quickstart.mdx index f611477b2f..73956abaea 100644 --- a/versioned_docs/version-v8/vue/quickstart.mdx +++ b/versioned_docs/version-v8/vue/quickstart.mdx @@ -16,7 +16,7 @@ import DocsCards from '@components/global/DocsCards'; Welcome! This guide will walk you through the basics of Ionic Vue development. You'll learn how to set up your development environment, generate a simple project, explore the project structure, and understand how Ionic components work. This is perfect for getting familiar with Ionic Vue before building your first real app. -If you're looking for a high-level overview of what Ionic Vue is and how it fits into the Vue ecosystem, refer to the [Ionic Vue Overview](overview). +If you're looking for a high-level overview of what Ionic Vue is and how it fits into the Vue ecosystem, refer to the [Ionic Vue Overview](./overview.mdx). ## Prerequisites {/* #prerequisites */} @@ -31,7 +31,7 @@ If you don't have Node.js and npm, [download Node.js](https://nodejs.org/en/down ## Create a Project with the Ionic CLI {/* #create-a-project-with-the-ionic-cli */} -First, install the latest [Ionic CLI](../cli): +First, install the latest [Ionic CLI](../cli.mdx): ```shell npm install -g @ionic/cli @@ -161,17 +161,17 @@ import { IonContent, IonHeader, IonPage, IonTitle, IonToolbar } from '@ionic/vue ``` -This creates a page with a header and scrollable content area. The second header shows a [collapsible large title](/api/title.mdx#collapsible-large-titles) that displays on iOS devices when at the top of the content, then condenses to show the smaller title in the first header when scrolling down. +This creates a page with a header and scrollable content area. The second header shows a [collapsible large title](../api/title.mdx#collapsible-large-titles) that displays on iOS devices when at the top of the content, then condenses to show the smaller title in the first header when scrolling down. :::tip[Learn More] -For detailed information about Ionic layout components, refer to the [Header](/api/header.mdx), [Toolbar](/api/toolbar.mdx), [Title](/api/title.mdx), and [Content](/api/content.mdx) documentation. +For detailed information about Ionic layout components, refer to the [Header](../api/header.mdx), [Toolbar](../api/toolbar.mdx), [Title](../api/title.mdx), and [Content](../api/content.mdx) documentation. ::: ## Add an Ionic Component {/* #add-an-ionic-component */} -You can enhance your Home page with more Ionic UI components. For example, add a [Button](/api/button.mdx) at the end of the `ion-content`: +You can enhance your Home page with more Ionic UI components. For example, add a [Button](../api/button.mdx) at the end of the `ion-content`: ```vue title="src/views/HomePage.vue" @@ -220,7 +220,7 @@ import { IonBackButton, IonButtons, IonContent, IonHeader, IonPage, IonTitle, Io ``` -This creates a page with a [Back Button](/api/back-button.mdx) in the [Toolbar](/api/toolbar.mdx). The back button will automatically handle navigation back to the previous page, or to `/` if there is no history. +This creates a page with a [Back Button](../api/back-button.mdx) in the [Toolbar](../api/toolbar.mdx). The back button will automatically handle navigation back to the previous page, or to `/` if there is no history. :::warning @@ -265,7 +265,7 @@ Once that is done, update the button in `HomePage.vue`: :::info -Navigating can also be performed programmatically using Vue Router, and routes can be lazy loaded for better performance. Refer to the [Vue Navigation documentation](/vue/navigation.mdx) for more information. +Navigating can also be performed programmatically using Vue Router, and routes can be lazy loaded for better performance. Refer to the [Vue Navigation documentation](./navigation.mdx) for more information. ::: @@ -291,7 +291,7 @@ Then, include them inside of the `ion-content`: Note that we are passing the imported SVG reference, **not** the icon name as a string. -For more information, refer to the [Icon documentation](/api/icon.mdx) and the [Ionicons documentation](https://ionic.io/ionicons/). +For more information, refer to the [Icon documentation](../api/icon.mdx) and the [Ionicons documentation](https://ionic.io/ionicons/). ## Call Component Methods {/* #call-component-methods */} @@ -346,7 +346,7 @@ To call methods on Ionic components: This pattern is necessary because Ionic components are built as Web Components. The `$el` property gives you access to the actual Web Component instance where the methods are defined. -You can find available methods for each component in the [Methods](/api/content.mdx#methods) section of their API documentation. +You can find available methods for each component in the [Methods](../api/content.mdx#methods) section of their API documentation. ## Run on a Device {/* #run-on-a-device */} @@ -399,7 +399,7 @@ This guide covered the basics of creating an Ionic Vue app, adding navigation, a - +

Build a real Photo Gallery app with Ionic Vue and native device features.

@@ -407,7 +407,7 @@ This guide covered the basics of creating an Ionic Vue app, adding navigation, a

Learn more about Vue's core concepts, tools, and best practices from the official Vue documentation.

- +

Discover how to handle routing and navigation in Ionic Vue apps using the Vue Router.

diff --git a/versioned_docs/version-v8/vue/troubleshooting.mdx b/versioned_docs/version-v8/vue/troubleshooting.mdx index cfd789eb78..a142e7ee7e 100644 --- a/versioned_docs/version-v8/vue/troubleshooting.mdx +++ b/versioned_docs/version-v8/vue/troubleshooting.mdx @@ -36,7 +36,7 @@ import { IonButton } from '@ionic/vue'; ``` -Prefer to register your components globally once? We have you covered. Our [Build Options Guide](/vue/build-options.mdx#global-component-registration) shows you how to register Ionic Vue components globally as well as the potential downsides to be aware of when using this approach. +Prefer to register your components globally once? We have you covered. Our [Build Options Guide](./build-options.mdx#global-component-registration) shows you how to register Ionic Vue components globally as well as the potential downsides to be aware of when using this approach. ## Slot attributes are deprecated {/* #slot-attributes-are-deprecated */} @@ -74,7 +74,7 @@ ionContentRef.value.scrollToBottom(); In other framework integrations such as Ionic React, this is not needed as any `ref` you provide is automatically forwarded to the underlying Web Component instance. We are unable to do the same thing here due to limitations in how Vue manages refs. -Refer to the [Quickstart Guide](/vue/quickstart.mdx#call-component-methods) for more information. +Refer to the [Quickstart Guide](./quickstart.mdx#call-component-methods) for more information. ## Page transitions are not working {/* #page-transitions-are-not-working */} @@ -97,7 +97,7 @@ import { IonContent, IonHeader, IonPage, IonTitle, IonToolbar } from '@ionic/vue ``` -Refer to the [IonPage documentation](navigation.mdx#ionpage) for more information. +Refer to the [IonPage documentation](./navigation.mdx#ionpage) for more information. ## Ionic events bound in JavaScript are not firing {/* #ionic-events-bound-in-javascript-are-not-firing */} diff --git a/versioned_docs/version-v8/vue/utility-functions.mdx b/versioned_docs/version-v8/vue/utility-functions.mdx index c7d6a75b67..ca8ef3e601 100644 --- a/versioned_docs/version-v8/vue/utility-functions.mdx +++ b/versioned_docs/version-v8/vue/utility-functions.mdx @@ -71,7 +71,7 @@ useIonRouter(): UseIonRouterResult; - The `replace` method is the equivalent of calling `ionRouter.navigate(location, 'root', 'replace', animation)`. -Refer to the [Vue Navigation Documentation](./navigation#navigating-using-useionrouter) for more usage examples. +Refer to the [Vue Navigation Documentation](./navigation.mdx#navigating-using-useionrouter) for more usage examples. ## Hardware Back Button {/* #hardware-back-button */} @@ -98,11 +98,11 @@ interface UseBackButtonResult { useBackButton(priority: number, handler: Handler): UseBackButtonResult; ``` -Refer to the [Hardware Back Button Documentation](../developing/hardware-back-button) for more information and usage examples. +Refer to the [Hardware Back Button Documentation](../developing/hardware-back-button.mdx) for more information and usage examples. :::note -The `useBackButton` callback will only fire when your app is running in Capacitor or Cordova. Refer to [Hardware Back Button Support](/developing/hardware-back-button.mdx#support) for more information. +The `useBackButton` callback will only fire when your app is running in Capacitor or Cordova. Refer to [Hardware Back Button Support](../developing/hardware-back-button.mdx#support) for more information. ::: @@ -133,7 +133,7 @@ interface UseKeyboardResult { useKeyboard(): UseKeyboardResult; ``` -Refer to the [Keyboard Documentation](../developing/keyboard) for more information and usage examples. +Refer to the [Keyboard Documentation](../developing/keyboard.mdx) for more information and usage examples. ## Ionic Lifecycles {/* #ionic-lifecycles */} @@ -167,4 +167,4 @@ Pages in your app need to be using the `IonPage` component in order for lifecycl ::: -Refer to the [Vue Lifecycle Documentation](./lifecycle) for more information and usage examples. +Refer to the [Vue Lifecycle Documentation](./lifecycle.mdx) for more information and usage examples. diff --git a/versioned_docs/version-v8/vue/your-first-app.mdx b/versioned_docs/version-v8/vue/your-first-app.mdx index 9bccc51235..a2d31d6405 100644 --- a/versioned_docs/version-v8/vue/your-first-app.mdx +++ b/versioned_docs/version-v8/vue/your-first-app.mdx @@ -32,7 +32,7 @@ Highlights include: - One Vue-based codebase that runs on the web, iOS, and Android using Ionic Framework [UI components](../components.mdx). - Deployed as a native iOS and Android mobile app using [Capacitor](https://capacitorjs.com), Ionic's official native app runtime. -- Photo Gallery functionality powered by the Capacitor [Camera](/native/camera.mdx), [Filesystem](/native/filesystem.mdx), and [Preferences](/native/preferences.mdx) APIs. +- Photo Gallery functionality powered by the Capacitor [Camera](../native/camera.mdx), [Filesystem](../native/filesystem.mdx), and [Preferences](../native/preferences.mdx) APIs. Find the [complete app code](https://github.com/ionic-team/tutorial-photo-gallery-vue) referenced in this guide on GitHub. @@ -92,7 +92,7 @@ npm install @capacitor/camera @capacitor/preferences @capacitor/filesystem ### PWA Elements {/* #pwa-elements */} -Some Capacitor plugins, including the [Camera API](/native/camera.mdx), provide the web-based functionality and UI via the Ionic [PWA Elements library](https://github.com/ionic-team/pwa-elements). +Some Capacitor plugins, including the [Camera API](../native/camera.mdx), provide the web-based functionality and UI via the Ionic [PWA Elements library](https://github.com/ionic-team/pwa-elements). It's a separate dependency, so install it next: diff --git a/versioned_docs/version-v8/vue/your-first-app/2-taking-photos.mdx b/versioned_docs/version-v8/vue/your-first-app/2-taking-photos.mdx index de565f1e75..f184ba22e0 100644 --- a/versioned_docs/version-v8/vue/your-first-app/2-taking-photos.mdx +++ b/versioned_docs/version-v8/vue/your-first-app/2-taking-photos.mdx @@ -11,7 +11,7 @@ sidebar_label: Taking Photos /> -Now for the fun part - adding the ability to take photos with the device’s camera using the Capacitor [Camera API](/native/camera.mdx). We’ll begin with building it for the web, then make some small tweaks to make it work on mobile (iOS and Android). +Now for the fun part - adding the ability to take photos with the device’s camera using the Capacitor [Camera API](../../native/camera.mdx). We’ll begin with building it for the web, then make some small tweaks to make it work on mobile (iOS and Android). ## Photo Gallery Composable {/* #photo-gallery-composable */} diff --git a/versioned_docs/version-v8/vue/your-first-app/3-saving-photos.mdx b/versioned_docs/version-v8/vue/your-first-app/3-saving-photos.mdx index 40b740e674..b9db75939b 100644 --- a/versioned_docs/version-v8/vue/your-first-app/3-saving-photos.mdx +++ b/versioned_docs/version-v8/vue/your-first-app/3-saving-photos.mdx @@ -92,7 +92,7 @@ export interface UserPhoto { } ``` -We'll use the Capacitor [Filesystem API](/native/filesystem.mdx) to save the photo. First, convert the photo to base64 format. +We'll use the Capacitor [Filesystem API](../../native/filesystem.mdx) to save the photo. First, convert the photo to base64 format. Then, pass the data to the Filesystem's `writeFile` method. Recall that we display photos by setting the image's source path (`src`) to the `webviewPath` property. So, set the `webviewPath` and return the new `Photo` object. diff --git a/versioned_docs/version-v8/vue/your-first-app/4-loading-photos.mdx b/versioned_docs/version-v8/vue/your-first-app/4-loading-photos.mdx index 2c81458b28..0192dd8f27 100644 --- a/versioned_docs/version-v8/vue/your-first-app/4-loading-photos.mdx +++ b/versioned_docs/version-v8/vue/your-first-app/4-loading-photos.mdx @@ -13,7 +13,7 @@ sidebar_label: Loading Photos We’ve implemented photo taking and saving to the filesystem. There’s one last piece of functionality missing: the photos are stored in the filesystem, but we need a way to save pointers to each file so that they can be displayed again in the photo gallery. -Fortunately, this is easy: we’ll leverage the Capacitor [Preferences API](/native/preferences.mdx) to store our array of Photos in a key-value store. +Fortunately, this is easy: we’ll leverage the Capacitor [Preferences API](../../native/preferences.mdx) to store our array of Photos in a key-value store. ## Preferences API {/* #preferences-api */}